Skip to content
基于React实现的可换源电子书阅读器,额,虽然可以看任何小说,但还是要支持正版呀!
JavaScript CSS HTML
Branch: v2
Clone or download
Latest commit 1dd46b5 Sep 11, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
api 新增阅读页 Apr 12, 2017
dist 😎 Sep 11, 2017
public 修复pc浏览器无法点击书籍列表的bug Sep 11, 2017
src
.babelrc 切换到preact Aug 3, 2017
.editorconfig ⚽️ Jul 17, 2017
.eslintignore ⚽️ Jul 17, 2017
.eslintrc ⚽️ Jul 17, 2017
.gitignore 更新 Aug 7, 2017
.npmignore ⚽️ Jul 17, 2017
.travis.yml ⚽️ Jul 17, 2017
README.md 😎 Sep 11, 2017
look.js 切换到preact Aug 3, 2017
package.json
postcss.config.js ⚽️ Jul 17, 2017
server.js 更新 Aug 10, 2017
webpack.config.js 😎 Aug 10, 2017
webpack.dev.config.js 更新 Aug 10, 2017
webpack.dll.config.js 修复preact不支持热更新的问题 Aug 3, 2017

README.md

iReader v2

0813

在线地址:ireader.liumin.me

github:https://github.com/liumin1128/ireader

前端技术交流QQ新群:648060073(盗火)


没想到吧,我胡汉三又回来啦!

还记得上次写这篇文章时我还没有毕业,现在已经踏出校门了,当时留下的小坑,现在是时候填上了。

上一个版本收到不(gen)少(ben)反(mei)馈(you),多数童鞋感觉挺好玩的,但体验不行,加载很慢、卡顿等等。于是我这次仅仅实现了看书这个核心功能,主要把时间花在优化体验上。在这本文中,我尽可能不记流水账,少说废话,如有错误欢迎指正、交流。

let's go

这次我没有使用任何脚现成的手架工具和ui框架,因为本项目比较小,在时间允许的情况下,还是希望尽可能自己走一遍流程。

开发环境依然是react全家桶,基于最新版的webpack3、react15.6、react-router4、redux、redux-saga实现,就是不折腾不痛快。过程中略有小坑,比如热更新啦,dll动态链接库啦,preact不兼容啦,以及最新版本带来的不兼容什么的,不过都已经被社区大神趟平了。

初始化项目,就是上面说的那套开发环境,我已经打包到自用的脚手架工具cat-cli中了,这是一个非常简(chu)单(zhi)易(lan)用(zhao)的脚手架工具,里面都是干货,喜欢的就拿去玩吧。

cat-cli3

npm i -g cat-cli
cat-cli new ireader // 新建项目,默认使用webpack3模板
cd ireader
npm i
npm run dll         // 编译动态链接库
npm start           // 启动项目,默认8000端口
// 请一定要看这段话,因为这个工具没有任何提示。。。

store的设计与实现

首先来实现阅读器部分,有了上一次的经验再结合现有api,我们可以总结出一个电子书阅读器的三个核心概念:书源章节列表章节内容。换源就是在书源中切换、跳转章节就是在章节列表中切换,我们只需要记录当前书源和当前章节就可以完整保存用户阅读进度。至于书籍详情当然也不能少,我们得知道当前到底看的是那一本书。

reader代表阅读器和当前书籍,这里我们跳过优质书源,原因大家都懂。 ╮( ̄▽ ̄)╭

阅读器

const initState = {
  currentSource: 1,   // 当前源下标:默认为1,跳过优质书源
  currentChapter: 0,  // 当前章节下标
  source: [],         // 源列表
  chapters: [],       // 章节列表
  chapter: {},        // 当前章节
  detail: {},         // 书籍详情
};

function reader(state = initState, action) {
  switch (action.type) {
    case 'reader/save':
      return {
        ...state,
        ...action.payload,
      };
    case 'reader/clear':
      return initState;
    default:
      return {
        ...state,
      };
  }
}

书架

因为我们并不是要做只能阅读一本书的鸡肋,我们要的是能在多本书籍之间快速切换,不但能够保存阅读进度(当前书源和当前章节),并且可以在缓存中读取数据,过滤掉那些不必要的服务器请求。

为此,我们可以模仿现实中的书架来实现这个功能:前面提到的reader是当前正在阅读的书籍,它是完整的包含了一本书籍所有信息的个体,而书架则是很多个这样的个体的集合。因此切换书籍的动作,其实就是将书籍放回书架,再从书架中拿出一本书的过程,如果在书架中找到了这本书,便直接取出,进而得到上次阅读这本书的全部数据,如果没有找到这本书,就从服务器获取并初始化阅读器。

function store(state = {}, action) {
  switch (action.type) {
    case 'store/put': { // 将书籍放入书架
      if (action.key) {
        return {
          ...state,
          [action.key]: {
            ...state[action.key],
            ...action.payload,
          },
        };
      } else {
        return {
          ...state,
        };
      }
    }
    case 'store/save': // 初始化书架
      return {
        ...state,
        ...action.payload,
      };
    case 'store/delete': // 删除书籍
      return {
        ...state,
        [action.key]: undefined,
      };
    case 'store/clear': // 清空书架
      return {};
    default:
      return {
        ...state,
      };
  }
}

export default store;

effects

获取书源,可以说是项目中最核心的功能了,开始写的时候只有两三行,不久就变的很冗长了。其实这个方法叫换源有些欠妥,应该叫做换书,代码写的一般,姑且将console当成注释吧。主要功能就是实现了上文提到的将当前阅读书籍放回书架,并取出新书这个功能。并且这个方法只有在阅读一本新书时才会调用。

要考虑的情况基本就是用户第一次打开应用,没有当前阅读书籍,此时直接获取书源进行下一步下一步即可。当用户已经在看一本书,并且切换到同一本书时,直接返回,如果另一本书,则将当前数据,连同书籍信息一起打包放回书架,当然在此之前要先查看书架中有无这本书,有则取出,无则继续获取书源。需要注意的是,这里不要使用数组,而是将书籍id作为键值存在书架中,这会使得获取和查找都十分方便。

需要注意的一点是,项目本质上是web应用,用户可能从url进入任意页面,所以要做好异常情况的处理,例如没有书籍详情等。

获取源

function* getSource({ query }) {
  try {
    const { id } = query;
    const { reader: { id: currentId, detail: { title } } } = yield select();
    if (currentId) {
      if (id !== currentId) {
        const { reader, store: { [id]: book } } = yield select();
        console.log(`将《${title}》放回书架`);
        yield put({ type: 'store/put', payload: { ...reader }, key: currentId });
        yield put({ type: 'reader/clear' });
        if (book && book.detail && book.source) {
          console.log(`从书架取回《${book.detail.title}`);
          yield put({ type: 'reader/save', payload: { ...book } });
          return;
        }
      } else {
        return;
      }
    }
    let { search: { detail } } = yield select();
    if (!detail._id) {
      console.log('详情不存在,前往获取');
      detail = yield call(readerServices.getDetail, id);
    }
    const data = yield call(readerServices.getSource, id);
    console.log(`从网络获取《${detail.title}`);
    yield put({ type: 'reader/save', payload: { source: data, id, detail } });
    console.log(`阅读:${detail.title}`);
    yield getChapterList();
  } catch (error) {
    console.log(error);
  }
}

章节列表 & 章节内容 获取章节列表和章节内容比较简单,只需稍稍做些异常情况的处理即可。

function* getChapterList() {
  try {
    const { reader: { source, currentSource } } = yield select();
    if (currentSource >= source.length) {
      console.log('什么鬼?你是怎么造成的这个错误');
      yield put({ type: 'reader/save', payload: { currentSource: 0 } });
      yield getChapterList();
      return;
    }
    const { _id, name = '未知来源' } = source[currentSource];
    console.log(`书源: ${name}`);
    const { chapters } = yield call(readerServices.getChapterList, _id);
    yield put({ type: 'reader/save', payload: { chapters } });
    yield getChapter();
  } catch (error) {
    console.log(error);
  }
}

function* getChapter() {
  try {
    const { reader: { chapters, currentChapter } } = yield select();
    const { link } = chapters[currentChapter || 0];
    const { chapter } = yield call(readerServices.getChapter, link);
    if (chapter) {
      console.log(`章节: ${chapter.title}`);
      yield put({ type: 'reader/save', payload: { chapter } });
      window.scrollTo(0, 0);
    } else {
      console.log('章节获取失败');
      yield getNextSource();
    }
  } catch (error) {
    console.log(error);
  }
}

换源实现

同是核心功能,这个必须有。换源其实非常简单,在上一版本中我们已经实现了在列表中手动切换书源,不过体验并不怎么好,因为用户并不知道那个书源是可用的,有可能一连切换34个书源都是挂的,所以这次我们干脆做个智(sha)能(gua)换源吧。

换源其实就是操作标记书源的指针,这很容易,我们关心的是何时换源。经过测试,发现获取章节列表这一步几乎都没有问题,错误基本上是发生在获取章节这一步。因此,我们只要在章节列表中稍作判断即可实现自动换源。换源方法如下。

function* getNextSource() {
  try {
    const { reader: { source, currentSource } } = yield select();
    let nextSource = (currentSource || 1) + 1;
    console.log(nextSource);
    if (nextSource >= source.length) {
      console.log('没有可用书源,切换回优质书源');
      nextSource = 0;
    }
    console.log(`正在尝试切换到书源: ${source[nextSource] && source[nextSource].name}`);
    yield put({ type: 'reader/save', payload: { currentSource: nextSource } });
    yield getChapterList();
  } catch (error) {
    console.log(error);
  }
}

效果如下,当1号书源出错后我们自动跳转到下一个书源,很方便有木有。

切换章节

非常简单,稍微做下异常处理就好。

function* goToChapter({ payload }) {
  try {
    const { reader: { chapters } } = yield select();
    const nextChapter = payload.nextChapter;
    if (nextChapter > chapters.length) {
      console.log('没有下一章啦');
      return;
    }
    if (nextChapter < 0) {
      console.log('没有上一章啦');
      return;
    }
    yield put({ type: 'reader/save', payload: { currentChapter: nextChapter } });
    yield getChapter();
  } catch (error) {
    console.log(error);
  }
}

以上基本上已经完整实现了阅读器的核心部分,至于搜索和详情页,限于篇幅不再赘述。

ui部分

看过上一个版本的兄弟应该知道,上一个版本使用了material-ui,楼主再次表示非常喜欢这套ui。但它实在是太重了,而我们希望这个项目是轻量且高效的,最后还是决定自行设计ui,工作量倒也不大。

首页

首页比较纠结,曾经放了很多自以为炫酷的高斯模糊和动画,但过多的效果会降低体验,最终还是选择了走了简洁的路子。

上半部分是当前阅读书籍,仅显示一些关键信息。下半部分是书架,存放以往的阅读进度。

![图层 2](http://ooi7vpwhj.bkt.clouddn.com/图层 2.png)

从redux获取数据

const { detail } = state.reader;
const list = state.store;
const store = Object.keys(list).map((id) => {
    // 找出书架上所有书籍的详细信息
    return list[id] ? list[id].detail : {};
}).filter((i) => {
    // 过滤掉异常数据和当前阅读
    return i._id && i._id !== detail._id;
});

阅读器

未标题-1-恢复的

ok,扯了许久,终于见到本尊了,这是阅读器最核心的页面,谈不上有什么设计,就是追求简洁易用。

主体部分就是原生的body,这样滚动起来会非常流畅。需要注意下api提供的数据如何显示在react中。代码很短,大意就是将换行符作为依据转换成数组显示,这样方便设置css样式。

export default ({ content, style }) => (<div className={styles.content} style={style}>
  { content && content.split('\n').map(i => <p>{i}</p>) }
</div>);

稍微体验下可以发现,头部可收缩,显示当前书籍和当前章节,以及一个关闭按钮。基于react-headroom组件实现。

为了追求简洁,我们把菜单放到了页面最下方,这样页面滚动到最下面点击下一章很方便,但如果只是想设置也必须滚动到最下面,这就有点不太方便了。

菜单只有4个,设置、章节列表、上一章和下一章。点击设置会弹出框,支持换肤和调节字体大小,这些只是基本的,有时间再做亮度调节自动翻页和语音朗读吧。实现方法很简单,贴出这段代码你一定秒懂。

this.stopEvent = (e) => {
      // 阻止合成事件间的冒泡
      e.stopPropagation();
      // 阻止合成事件与最外层document上的事件间的冒泡
      e.nativeEvent.stopImmediatePropagation();
      e.preventDefault();
      return false;
};

章节列表更(mei)加(you)简(yong)易(xin),稍微注意下如何将当前章节显示在列表中吧。我是利用锚点链接实现的,再配合一个sider组件,某修仙传几千章节跳转起来也很轻松。

this.skip = () => {
      setTimeout(() => {
        document.getElementById(this.range.value).scrollIntoView(false);
      }, 100);
 }

换肤

说起来很好实现,无非是先预设一套主题参数,需要哪个点那个。

export const COLORS = [
  {
    background: '#b6b6b6',
  }, {
    background: '#999484',
  }, {
    background: '#a0b89c',
  }, {
    background: '#cec0a4',
  }, {
    background: '#d5b2be',
  }, {
    color: 'rgba(255,255,255,0.8)',
    background: '#011721',
  }, {
    color: 'rgba(255,255,255,0.7)',
    background: '#2c2926',
  }, {
    background: '#c4ada4',
  },
];

在redux中维护一个setting字段,专门放用户设置。在阅读器中获取并设置为主题即可。

function mapStateToProps(state) {
  const { chapter, currentChapter = 0, detail } = state.reader;
  const { logs } = state.common;
  return {
    logs,
    chapter,
    detail,
    currentChapter,
    ...state.setting,
  };
}
```javascript
切换皮肤的时候将新的数据保存到redux就实现了换肤功能。

```javascript
// 换颜色
this.setting = (key, val) => {
 this.props.dispatch({
   type: 'setting/save',
   payload: {
     [key]: val,
   },
 });
};
// 调整字体大小
this.setStyle = (num) => {
 const fontSize = this.props.style.fontSize + num;
 this.props.dispatch({
   type: 'setting/save',
   payload: {
     style: {
       ...this.props.style,
       fontSize,
     },
   },
 });
};

删除实现

为了不再增加新的ui,决定使用长按删除。但是这个列表不仅需要支持长按和短按,还需要支持滚动,我又不想使用hammer.js这种重型库,只得手写了一个同时支持长按和短按的组件。凑合用吧,还能离咋地。

export default ({ children, onPress, onTap }) => {
  let timeout;
  let pressed = false;
  let cancel = false;
  function touchStart() {
    timeout = setTimeout(() => {
      pressed = true;
      if (onPress) onPress();
    }, 500);
    return false;
  }
  function touchEnd() {
    clearTimeout(timeout);
    if (pressed) {
      pressed = false;
      return;
    }
    if (cancel) {
      cancel = false;
      return;
    }
    if (onTap) onTap();
    return false;
  }
  function touchCancel() {
    cancel = true;
  }
  return (<div
    onTouchMove={touchCancel}
    onTouchCancel={touchCancel}
    onTouchStart={touchStart}
    onTouchEnd={touchEnd}
  >
    { children }
  </div>);
};

至于长按弹窗的ui我懒得设计了,短时间也做不出什么好的效果,还是继续使用sweet-alert2吧,这个插件着实不错。

未标题-1-恢复的

至此我们已经实现了全部功能和ui。

优化

移动端优化

<meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0;" name="viewport" />
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<meta name="apple-mobile-web-app-capable" content="yes">
// 这个比较重要,可以在ios系统自带safari中添加到主屏幕,这条设置会启用全屏模式,体验不错
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" href="icon.png"/>
<link rel="apple-touch-startup-image" sizes="2048x1496" href="">
<link rel="apple-touch-icon" href="icon.png"/>

css

* {
    user-select: none;
    // 禁止用户选中文本
    
    -webkit-appearance: none;
    // 改变按钮默认风格
    
    -webkit-touch-callout: none;
    // 禁用系统默认菜单
}

input {
    user-select: auto;
    -webkit-touch-callout: auto;
    // 解除对input组件的限制,否则无法正常输入
}

fastclick

import FastClick from 'fastclick';
FastClick.attach(document.body);

你懂得,移除移动端300毫秒延迟,不过这会带来其他问题,比如长按事件异常,滚动事件异常什么的。因为滑动touchmove触发了touchend事件,需要先取消掉touchstart上挂载的动作。

体积减小

在上一个版本中,项目打包后竟然有700k+,首次加载速度不忍直视。前面已经提到,放弃各种框架和动画之后,体积已经大幅减少。不过有react,react-router,redux,redux-saga这些依赖在,体积再小也小不到那里去。但好消息是我们可以使用preact替换react,从而节省约120kb左右。

只需要安装preact并设置别名即可。此处有几个小坑,一是别名的第三句,找了好久才在有个issue下发现,没有就无法运行。二是preact和react-hot-loader不太兼容,一起用会导致热更新失效。三是preact仍然有不兼容react的地方,需要仔细验证。

npm i -S preact preact-compat

resolve: {
 alias: {
   react: 'preact-compat',
   'react-dom': 'preact-compat',
   'preact-compat': 'preact-compat/dist/preact-compat',
   //比较坑的是最后一句官网并未给出,导致一直报错,找了很久
 },
},

以及一系列优化以及gzip之后,项目index.js减小到了74kb,相比上一版只有十分之一大小。

最后

项目中所有数据来自追书神器,非常感谢!! 本项目仅作用于在实战中学习前端技术,请勿他用。下一步作者或许会做一个音乐播放器?有经验的小伙伴可以一起。github你懂得


在线地址:ireader.liumin.me

github:https://github.com/liumin1128/ireader

大爷~ 常来玩嘛,欢迎贡献代码哟~

cnpm i -D babel-core babel-eslint babel-loader babel-preset-es2015 babel-preset-stage-0 babel-preset-react webpack webpack-dev-server html-webpack-plugin eslint@^3.19.0 eslint-plugin-import eslint-loader eslint-config-airbnb eslint-plugin-jsx-a11y eslint-plugin-react babel-plugin-import file-loader babel-plugin-transform-runtime babel-plugin-transform-remove-console redux-devtools style-loader less-loader css-loader postcss-loader autoprefixer rimraf extract-text-webpack-plugin copy-webpack-plugin react-hot-loader@next less

cnpm i -S react react-dom react-router react-router-dom redux react-redux redux-saga material-ui@next material-ui-icons

cnpm i -S preact preact-compat react-router react-router-dom redux react-redux redux-saga

proxy: {
  '/api': {
    target: 'http://api.zhuishushenqi.com/',
    changeOrigin: true,
    pathRewrite: { '^/api': '' },
  },
  '/chapter': {
    target: 'http://chapter2.zhuishushenqi.com/',
    changeOrigin: true,
    pathRewrite: { '^/api': '' },
  },
},
You can’t perform that action at this time.