MewX/light-novel-library_Wenku8_Android — 2.8k Stars

Topics

#2014-now #android #android-studio #continuous-integration #eclipse-android #free #gradle #java #light-novel #material-design #mewx #reader #umeng #volley #wenku8

Language breakdown

No language data available.

▸ Files click to expand

README

:point_left: HISTORICAL ISSUE AND THAT'S WHAT WE ALL KNOW :sob:

如果您想打赏我用爱发电的代码，可以点击这个链接帮我充电 ❤️：

如果你走失了，可以来TG群：https://t.me/wk8app

文档目录 ==========

写在前面
Repo目录说明
App程序结构简明

- 1.x 版本 - 主要视图 - 源代码结构 - 0.5.2.1 典藏版 - 预览图 - 源代码结构 - UMENG统计数据

App存档文件结构

- 总览 - 存档流程 - 技术细节

App二次开发指引

- 如何用其他文库的文档兼容本app

用到的开源库
开发者的碎碎念
LICENSE

写在前面 ==========

Material Design风格的轻小说文库App完全开源了！想实践Material Design的可以参考本项目的源代码，不清楚的、以及各种相关话题都可以发issue交流~

这个项目是我第一次写安卓App，首先看了一本入门书籍，是chinapub写书评赠送的《第一行代码 Android》，然后便开始着手写这个app了。从2014年10月份开始动手写，都是些零零散散的时间，写到12月底也就是0.5.2.0版本，那时基本上是啥都不会，写的代码也是烂的不行。后来内测用户群里面有个设计师提出来设计Material Design（后面简称MD）风格的app，于是就打算重新开发。也是拖啊拖，到7月底才完成新的app，如果满打满算的话，应该是历时一整个月，手写代码量2W行以上。

本app完全是出于兴趣以及作为一个项目经历，所以完全无偿开发、源代码也是完全开源！欢迎大家交流。之前迟迟不开源新的MD，一方面是觉得写得太不容易了，各种谷歌查资料，还为红杏插件贡献了好几十 \(:3」∠)\ 另一方面是正式用git管理，Wenku8的站长也禁止将API公开，所以分来两个版本管理也很麻烦，还有一方面是因为代码非常乱，没有整理。

注：1.x版本源代码有部分是拷贝0520的，而0520的风格非常糟糕，比如AsyncTask的isLoading定义在类外这样。所以编码风格会有不统一，新写的代码我还是比较满意的，老的代码也是因为修改的需求不大，所以也就没有重构了。编码风格的建议也欢迎发issue~

为什么App里面说要尽快缓存感兴趣的小说？为什么现在这么紧急地开放源代码？

请参阅文档末尾的开发者的碎碎念。

Repo目录说明 ==========

design-source/

设计师提供的app制作效果图，大家可以参考学习~

eclipse-android/

0.5.1.0030版本的源代码（eclipse+ADT版本），这份源代码阉割了API部分，所以编译后也无法正常获取数据。

eclipse-android-old/

0.5.2.1典藏版的源代码（Android Studio版本），完整从私有库里拷贝出来的。release版本和正式版发布地址一样。

graph-source/

老版的制图源文件，当时自己弄得，完全就是随性而无章法 =。=

studio-android/

1.x正式版的所有源代码存放处，MD风格的App完整源码，可编译通过并正常运行！（Android Studio版本）

App程序结构简明 ==========

1.x 版本

新版的MD风格App，设计图纸在design-source/，工程文件在studio-android/。

三方库的引用全部采用Gradle dependency，在混淆方面会直接忽略，加密强度低，不过开发起来各种方便~

主要视图

App启动界面

Model & Controller: activity/WelcomeActivity.java View: layout/layout_welcome.xml

侧栏菜单栏

Model & Controller: fragment/NavigationDrawerFragment.java View: layout/layoutmainmenu.xml

最近更新列表

Model & Controller: fragment/FavFragment.java Adapter: adapter/NovelItemAdapter.java View: layout/fragment_latest.xml

搜索界面

搜索界面 Model & Controller: activity/SearchActivity.java Adapter: adapter/SearchHistoryAdapter.java View: layout/layout_search.xml 搜索结果界面 Model & Controller: activity/SearchResultActivity.java Adapter: adapter/NovelItemAdapterUpdate.java View: layout/layoutsearchresult.xml

排行榜列表

Model & Controller: fragment/RKListFragment.java Adapter: adapter/NovelItemAdapterUpdate.java View: layout/fragmentrklist.xml + (layout/fragmentnovelitemlist.xml)s

本地书架（收藏）列表

Model & Controller: fragment/FavFragment.java Adapter: adapter/NovelItemAdapterUpdate.java View: layout/fragmentnovelitem_list.xml

小说详细信息

Model & Controller: activity/NovolInfoActivity.java View: layout/layoutnovelinfo.xml

小说章节选择

Model & Controller: activity/NovolChapterActivity.java View: layout/layoutnovelchapter.xml

左右滑动阅读引擎

Model & Controller: reader/activity/Wenku8ReaderActivityV1.java View: layout/layoutreaderswipetemp.xml + (layout/layoutreaderswipepage.xml)s

上下滑动阅读引擎

Model & Controller: activity/VerticalReaderActivity.java View: layout/layoutverticalreader_temp.xml

设置界面

Model & Controller: fragment/ConfigFragment.java View: layout/fragment_config.xml

源代码结构

0.5.2.1 典藏版

老版的App，启动和运行方面都比MD版本流畅，针对旧机型维护。Eclipse版本源码见eclipse-android/目录（非最新），Android Studio版本源码见eclipse-android-old/目录（典藏版最新），老版的图片资源都是用Fireworks做的，源文件见graph-source/目录。

预览图

源代码结构

这边引入了不少三方库，但是方法笨拙，主要采用复制、合并源代码的方式，所以文件目录会比较乱。但是加密强度高 \(:3」∠)\ 以后做商业软件还是建议这样操作，虽然麻烦，但是混淆之后烦的要命~

UMENG统计数据（2015/10/01残念）

新版的app用户量10天增长到了1W用户量，全是托wenku8的福。照现在的增长速度速度估计用户量峰值是3W左右。

还有几个有趣的统计图分享一下：

1.x-statistic-entry

App存档文件结构 ==========

存档文件示例可以到release区下载查看~

总览

存档流程

App开启后初始化UIL，接下来所有的图片都使用UIL载入，每次加载一个图片都会自动生成cache目录下的以CRC32为文件名缓存文件；
App启动即读取settings.wk8，每次设置被改变了也会立即保存设置；
进入小说信息界面，会自动保存当前小说的封面于imgs目录；
小说的收藏功能会将aid写入saves/bookshelf_local.wk8，取消收藏会取消写入并删除本地的相关xml内容（图片不会删除）；
小说的下载功能分为4种：

- 检查更新：仅更新当前小说在saves/intro中的文件，每个小说3个文件，更新后刷新Activity。 - aid-intro.xml 小说信息摘要 - aid-introfull.xml 小说完整介绍 - aid-volume.xml 小说卷信息 - 更新下载：先更新当前小说在saves/intro中的文件，然后按照aid-volume.xml中的信息，下载小说具体内容（存在saves/novel中），每次下载完毕后检查xml中是否含有图片，如果有图片则插入下载图片的任务（这就是为什么下载的时候进度条会跳变了 2331）； - 覆盖下载：与更新下载不同的是，这种方式是强制覆盖所有文件，而更新下载会跳过已下载的同名文件； - 分卷下载：更新下载的分卷版；

小说在章节长按章节可以选择以下两种阅读引擎：

- 左右翻页引擎V1：进入时读取saves/readsavesv1.wk8，退出时保存进度； - 上下滑动引擎（旧）：进入时读取saves/read_saves.wk8，退出时保存进度；

调用搜索记录时会自动读取saves/search_history.wk8，每次搜索一次即保存最新搜索记录；
用户登录后会生成saves/cert.wk8和saves/avatar.jpg，每次启动app时自动登陆；若未联网，点击头像或有访问请求时会自动登录；若登陆失败，会删除这两个凭据文件；

技术细节

主要是存档的实现和兼容存档的规范。

saves/bookshelf_local.wk8

文件内容示例：

1098||1939||1924||1749||278

文件保存规则：

收藏只保存aid，aid之间用||分隔，读取时调用str.split("\\|\\|");；
每个aid对应saves/intro目录下3个文件：aid-intro.xml、aid-introfull.xml、aid-volume.xml，如果缺少一个文件的话则会忽略该aid对应的书，可以通过检查更新（下拉书架、小说信息界面的检查更新）来修复该错误；

saves/read_saves.wk8

文件内容示例：

66761,,23799,,25575||66752,,134,,15090||63125,,1139,,3059|| 63126,,904,,2824||63127,,11299,,157217

文件保存规则：

上下滑动阅读存档基本元素是cid,,position,,height：

- cid: chapter id，对应saves/novel里面的文件名； - position: 滚动的位置，当前屏幕顶部的位置(px)； - height: ScrollView的总高度(px)；

每个基本元素之间用||分隔，读取时调用str.split("\\|\\|");；
每次记录阅读的最底部位置，往下翻再上翻只记录最底下位置；
一个误判区是100px，如果不小心点进去再退出，则不会记录，只有翻过100px才会记录进度；
每一章一个记录，只添加不删除 =。=

saves/readsavesv1.wk8

文件内容示例：

1863:65378:65380:10:0||1922:67426:67427:0:0||1656:56193:56194:38:0|| 1244:38825:38827:0:0||1163:35537:35538:0:0||1151:35126:35128:0:0|| 1247:38920:38922:230:0||1759:60160:60161:159:0||1886:66259:66261:0:0|| 1016:51951:51952:0:0||1749:59813:59814:0:0||1575:52853:52855:0:0|| 278:10165:10166:36:0||1213:37499:37503:0:0||1928:67584:67585:0:0|| 1446:47586:47588:90:0||1755:60043:60044:0:0||1519:50813:50814:0:0|| 1932:67774:67782:255:55||1701:57929:57935:0:0

文件保存规则：

基本元素是aid:cid:vid:paraid:wordid：

- aid: 小说id - cid: 卷id - vid: 章id - paraid: 段id（从0开始） - wordid: 字在段中的id（从0开始）

每个基本元素之间用||分隔，读取时调用str.split("\\|\\|");；
每一本书一条记录，卷末自动删除记录，相当于阅读完毕；
记录的原理和分页算法相关的，分页算法是通过指定一个段落(paraid)的一个起始字符(wordid)，然后动态分页；

saves/search_history.wk8

文件内容示例：

[田中][1到][音][刀剑][1日日日][进击的巨人][光还在][人类衰退][古][寒蝉]

文件保存规则：

每一项通过[]分开，UTF-8无BOM编码；
0520版本会在开头加一个数字：

- 0: 搜索作者，例如：[0田中] - 1: 搜索小说名，例如：[1到]

默认保存10条，在GlobalConfig.java中记录；

saves/settings.wk8

文件内容示例：

readerlinedistance::::10|||| menubgpath::::/storage/emulated/0/tencent/QQ_Images/5699e514d0bb9779.png|||| readerbackgroundpath::::0|||| version::::1|||| readerparagraphdistance::::14|||| language::::SC|||| menubgid::::0|||| readerfontsize::::18|||| readerfontpath::::0

键的代码片段：

public enum SettingItems { version, // (int) 1 language, menubgid, // (int) 1-5 by system, 0 for user menubgpath, // (String) for user custom readerfontpath, // (String) path to ttf, "0" means default readerfontsize, // (int) sp (8 - 32) readerlinedistance, // (int) dp (0 - 32) readerparagraphdistance, // (int) dp (0 - 48) readerparagraphedge_distance, // (int) dp (0 - 16) readerbackgroundpath, // (String) path to an image, day mode only, "0" means default }

文件保存规则：

采用键值对的形式，代码中使用ContentValue存储；
存储文件时，键与值用::::分隔，键值对与键值对用||||分隔；
存键的时候使用的是enum.toString()方法获取，避免硬编码产生的低级错误；

saves/cert.wk8

文件内容示例：

Z0M5a0daRXBsZG5SMFZpaFhlPT0K |b1FQOUVXYjFja1d1SlRkazVtV3BSWGI9Cg==

文件保存规则：用户名|密码，换行是系统函数自动产生的，不影响读取。

加密流程： 1. 原文: str 2. 一遍加密: base64(str) 3. 大小写互转: switch(base64(str)) 4. 两遍加密: base64(switch(base64(str))) 5. 除了等号外，前后字符交换: swap(base64(switch(base64(str)))) 6. 三次加密: base64(swap(base64(switch(base64(str)))))

解密流程：同理

App二次开发指引 ==========

本App目前决定暂停维护了……

原因一方面是开发者自己要准备年底的研究生考试；另一方面也是最主要的方面，鹅厂大规模购置轻小说版权，这边有一些暂时不能公开的原因，总之本三方app得告一段落了，具体可以阅读开发者的碎碎念。

前几天我用HTTrack抓取了lknovel.cn的数据库，总共20G，太过于庞大，文件数20W，我的xp爬虫机已卡死。但是由于服务器在国内，速度还不错，用1~2天扒完。

后来我又尝试抓取wenku8.com，服务器在美国，这边速度太慢了，抓了一整天才1G，我估计wenku8的数据量大约有30G，实在hold不住。

所以尽管API开源了，但是因为内陆速度实在太慢，我都没有兴趣抓取了，所以劝大家去抓其他站： linovel.com 可以用HTTrack设置总目录页面为入口，深度5，然后设定MAX 10000000，图片采用探索模式即可（一般的扒站工具抓不下来图片），服务器没有防护； lknovel.cn 可以用HTTrack设置章节页面及小说信息界面为入口（excel生成url即可），深度2，设定MAX 10000000，服务器没有防护。 wenku8.com 速度太慢了，数据量还大，插图还在文末，没啥性价比，别抓了。

也就是说以后本app将没有数据源了，如果想继续做app的话那就只能通过抓取html提纯的方式，如果有开发者感兴趣，想通过抓取的方式继续本app（比如说：可以同时抓取lknovel、linovel、wenku8的数据展示给用户），可以阅读下面的部分：

如何用其他文库的文档兼容本app

目前wenku8的书目2000不到，也就是说aid是4位数；linovel、lknovel的aid也都是4位数，而且都没有wenku8的大，所以：

在aid方面，可以采取aid+10000000的方式，比如linovel的aid是+1000万，lknovel的aid是+2000万，这样本地书架的内容就错开了。

在存档方面：

aid-intro.xml 可以采取两种文件格式：最小文件体：

扩展文件体（可以自定义字段）但是已定义的字段有这些：

aid-introfull.xml 的文件内容示例：旅行于各地贩卖并收购物品的商人克拉福·罗伦斯，拜访帕斯罗村并离开后，在自己的马车上发现了不知从哪里跑来的东西。拨开从帕斯罗村购买的小麦束后，竟然发现一位拥有兽耳与尾巴的美少女。少女自称为贤狼赫萝，是带给帕斯罗村长期丰收的少女。 “虽然咱长久以来被尊为神，不过，咱就是咱，咱是赫萝。”见到少女的一只手变化成狼脚的罗伦斯，虽然一边怀疑赫萝的身份，但一边也答应让想回到出生遥远北方的少女一同旅行。

aid-volume.xml 文件内容示例：

vid.xml 小说内容示例（目前版本支持图文混排，自动提纯多余换行和前导空格）：一场死亡游戏即将揭开序幕 SAO玩家·桐人，以完全攻略为目标，在游戏舞台「艾恩葛朗特」城堡里展开一连串严酷的冒险。途中与女剑士·亚丝娜的相遇，也为桐人带来命中注定的契机—— 川原砾出身于光之国度，居住在亚兹罗斯。人生就是独行剑士。虽然嘴里一直逞强说自己不需要一起组队的伙伴，但是最近因为许多任务的难易度提高而感到相当棘手。虽然一辈子都没办法单独去唱KTV，但希望至少能升级到独自去吃烧肉的等级。 http://pic.wenku8.com/pictures/0/471/17513/3213.jpg http://pic.wenku8.com/pictures/0/471/17513/3214.jpg http://pic.wenku8.com/pictures/0/471/17513/3215.jpg http://pic.wenku8.com/pictures/0/471/17513/3216.jpg

只要将抓取的内容通过正则表达式或者可更新的lua脚本，就可以实现抓包了，那么文库主界面可以换成这样：

文库入口(Material Card)：轻国文库轻之文库轻小说文库 etc

点进去是搜索界面，然后搜索、下载、转换成可以识别的格式这样。目前我打听到的是国内文库还是会免费维持下去的！

如果有学生党or开发者有兴趣，可以和我联系~

用到的开源库 ==========

- jgilfelt / SystemBarTint (Apache License 2.0) 用于设置Kitkat以上版本StatusBar和NavigationBar颜色透明度等。 - nostra13 / Android-Universal-Image-Loader (Apache License 2.0) 著名的UIL，用于管理图片缓存和加载的库，非常方便，不会OOM。 - astuetz / PagerSlidingTabStrip (Apache License 2.0) -> branch: jpardogo / PagerSlidingTabStrip Material风格的标签及页面库，jpardogo的分支在自定制方面功能更强。 - jpardogo / GoogleProgressBar (Apache License 2.0) -> branch: MewX / google-progress-bar 谷歌风格的加载动画，我的分支添加了Google Doodle-notifier的样式。原版的样式是圆角矩形，这边间距细节什么的模仿的不是很完美。 - Google / Volley (Apache License 2.0) Google发布的大规模并发加载库。原版不支持byte返回值，我这边稍加修改了。 - afollestad / material-dialogs (MIT License) 完美的Material Dialog兼容库！ - futuresimple / android-floating-action-button (Apache License 2.0) 可以展开的FAB，动画效果很自然，但是不支持ripple比较遗憾，而且阴影会截断。 - vinc3m1 / RoundedImageView (Apache License 2.0) 圆形ImageView，显示头像用的。 - chrisbanes / SmoothProgressBar (BEER-WARE LICENSE) 平滑进度条，这里用在小说信息、搜索结果页面的ActionBar下部。 - davemorrissey / subsampling-scale-image-view (Apache License 2.0) 支持局部加载的ImageView，用于小说查看大图，用一般的ImageView容易OOM。 - martiansutdio / SlidingLayout (Unknown License) 针对电子书的划屏库，非常省内存，只有3页，自由度不高，但是毕竟拿来主义 =。= - AnderWeb / discreteSeekBar (Apache License 2.0) 动画效果不错的SeekBar，用在小说阅读的设置和跳转页面中。

开发者的碎碎念 ==========

本来app是不打算开源的，比如说代码写得不好，开源的话还要维护两个版本之类的理由……

主要还是学习Material走了很多弯路，很多尝试也都在历史push里面能看到，谷歌这边推出系统的Design，而且官方的app也开发的很好了，但是开发者真正要用的除了support-design库，就只有三方库了。不过各方面还是没有Google Play Store这款app做得好啊。我各种舍不得代码呢，不希望app被复制这种心态=。= 然而事实证明是我想多了……

不过，最近又接到各种死亡预告，于是这个app也快要寿终正寝了 233 现在完全开源，包括APPKEY啊、API啥的都开放了~欢迎大家交流学习~

分享一下这次开发app的经验教训吧：

依赖于网站的app，一定要确保网站不会左右app发展。

目前的情况是网站战略变化，导致本app的接口服务会停止，取而代之的是另一个合作的app（非三方）。之前说大家抓紧缓存的意思是，趁目前还能用，抓紧下载，指不定以后要付费啥的呢，照鹅厂这动作！

所以我觉得，自己做app最好顺便把服务网站给一套做掉，就像空之文库那样有一份服务器镜像，这样LK出问题不会殃及空文。

开发app类型要慎重。

这边博文也写了，版权敏感的软件市场是不轻易收的，要提供版权证明。所以这边一直上不了架，轻文因为有原创的成分在，所以可以上架。现在国内审查越来越严了哎……

用户操作指引很重要。

这个app里面隐藏了很多小功能，比如：用户找不到搜索功能，长按章节可以选择左右翻页或者上下滑动阅读，长按历史搜索可以删除某条记录。又比如：音量键可以翻页、单击也可以翻页，还可以切换章节etc。就包括看图用户也不会，这边看图把按钮放在ActionBar上是为了避免与翻页操作冲突，但是用户说找不到图 =。= 也比方说自定义字体、图片什么的说了不能在外置SD卡，但是用户还是不能按照要求的操作。

所以进入界面的时候应该用户友好，弹出一个操作提示，所以这方面是在下输了！

原有的用户黏着性需要很强大的优势才能打破。

本来轻小说有个app叫空之文库，我这边app出来之后，用户量确实增加了不少，但是插图在文末这点确实是最大的软肋，因为轻小说有不少的用户是中学生，这部分用户说难听点就是比较叽歪，但是为了用户量，作为替代品目标的app，确实需要在功能上满足绝大多数用户的需求。所以轻文出来之后，这边用户量确实流失了不少。

LICENSE ==========

GNU GENERAL PUBLIC LICENSE

Version 2, June 1991

Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

......