Skip to content
This repository has been archived by the owner on Aug 22, 2021. It is now read-only.
/ mpvueBookStore Public archive

计算机设计大赛国家二等奖项目: 悦读ECUT

Notifications You must be signed in to change notification settings

yzh990918/mpvueBookStore

Repository files navigation

悦读ECUT

现如今学生们的阅读量越来越小,为了重拾学生们对读书的热情,我们开发了这款“悦 读 ECUT”。悦读 ECUT 是一款集合了图书阅读,教师文章上传,音乐播放为一体的微信小程 序。与市面上大多数阅读器不同的是它做到了音乐与阅读相结合,既节省了 app 来回切换的 时间又能激起读者们的兴趣。同时可以上传教师文章,使得学生浏览教师文章不再繁琐。 悦读 ECUT 主要面向东华,及各高校学生,使学生能更好的“悦读”文章。

本项目已获取中国计算机设计大赛国家二等奖和江西省计算机作品赛三等奖

注意事项

该项目的阅读功能只允许调试查看,因为无法正式上线,所以会看到一下情况

更新: 服务器已过期,请自行下载运行

开发难点笔记

音乐播放器部分

需求分析

榜单歌曲列表获取

首先调用服务器上网易云的API获取榜单数据,进入播放器页面进行调用,用解构的方式取出需要的数据,组成一个新对象。最后push到定义的数组里面去

 const {id, name, ar: [{name: singer}], al: {name: album, picUrl}} = item
      this.playMusicItem = {
        id,
        name,
        singer,
        picUrl,
        album,
        index,
        src: `https://music.163.com/song/media/outer/url?id=${id}.mp3`
      }

音乐播放器主要功能实现

第一步就是用vuex存放数据,比如歌曲暂停还是播放,播放列表数组,当前歌曲,当前播放模式等。然后就是开始写业务,首先在created钩子里面new一个后台音乐播放器实例(getBackgroundAudioManager)。然后将页面骨架初步写完。点击模式时通过computed改变图标,然后调用不同的Action生成不同模式下的歌曲列表,比如随机播放,这个时候我就需要书写一个洗牌算法把里面的歌曲列表打乱,最后再提交修改。

然后最重要的是监听点击上一首下一首或者播放暂停的时候先去调用微信的audio暂停播放这些API,然后要去实时修改vuex里面数据,比如我点击下一首,这个要做的事: 1.将歌曲当前时间置为0 2.将歌曲在播放列表里面的index+1,然后修改vuex的currentSong,最后是调用微信API封装的播放方法,监听到歌曲能够播放就讲isPlay设为true,调用播放钩子,然后设置一下显示的时间

洗牌算法

function getRandomInt (min, max) {
  // 取min-max的数据
  return Math.floor(Math.random() * (max - min + 1) + min)
}
export function shuffle (arr) {
  // 当前数组值与取到的随机数组值交换 从而打乱数据
  let _arr = arr.slice()
  for (let i = 0; i < _arr.length; i++) {
    let j = getRandomInt(0, i)
    let t = _arr[i]
    _arr[i] = _arr[j]
    _arr[j] = t
  }
  return _arr
}

切换播放模式部分代码

 changeMode () {
      const mode = (this.mode + 1) % 3
      this.setPlayMode(mode)
      let list = null
      if (this.mode === playMode.random) {
        list = shuffle(this.sequencelist)
        setTimeout(() => {
          this.setPlaylist(list)
        }, 300)
      } else {
        list = this.sequencelist
        this.setPlaylist(list)
      }
    }

阅读器部分

需求分析

渲染和解析电子书

首先要访问在nginx上存放的epub资源,然后通过epubjs进行解析渲染

<script>
  //引入epubjs库  
import { mapMutations, mapGetters } from "vuex";
import Epub from "epubjs";
global.ePub = Epub;
export default {
  name: "",
  props: [""],
  data() {
    return {
      Bookfilename: ""
    };
  },
//首次渲染时将参数传递 然后设置vuex数据 之后调用init方法
  mounted() {
    this.Bookfilename = this.$route.params.fileName;
    this.setFileName(this.Bookfilename);
    this.initEpub();
  },

  methods: {
    ...mapGetters(["fileName"]),
    ...mapMutations({
      setFileName: "SET_FILENAME"
    }),
    initEpub() {
      //拼接字符串  
      const url = "https://store.yangxiansheng.top/epub/";
      let BookUrl = url + `${this.Bookfilename}.epub`;
      window.console.log(BookUrl);
      // 解析电子书路径
      this.book = new Epub(BookUrl);
      // 渲染关键钩子 拿到rendition对象
      this.redition = this.book.renderTo("read", {
        //宽高为书籍宽高  
        width: innerWidth,
        height: innerHeight,
        //兼容微信  
        method: "default"
      });
      this.redition.display();
    }
  }
};

使用epubjs解析关键

  1. dom上挂载read节点
  2. 创建epub实例 ,渲染API为rederTo('dom',attribute)
  3. 显示渲染内容 display()

设置字号和字体

字号

引入vant-slide帮助快速搭建滑块,监听`@change`事件,设置字号大小阈值为`12`到`24`
 <Slider
              :min="12"
              :max="24"
              bar-height="4px"
              active-color="#5f5f56"
              button-size="15"
              v-model="value"
              inactive-color="#d4d4cf"
              @change="onChange"
            ></Slider>     

在监听事件中拿到value,改变图书字体大小,关键函数:this.rendition.themes.fontSize(fontsize)

onChange(value) {
      this.CurrentBook.rendition.themes.fontSize(value);
      saveFontSize(this.fileName, value);//保存字体大小进入缓存
    }

设置字体大小后,发现了一个问题,那就是当我们再次进入阅读器时,之前设置的字体大小重新刷新了,所以我根据此问题引入了缓存web-storage-cache

使用该方法书写业务代码

例: 在刚开始加载图书信息时(this.book.redition.display().then(()=>{})) 初始化加载

 loadingFontsize() {
      // 取到fontSize
      let fontSize = getFontSize(this.fileName);
      // 没有就写入当前默认的值
      if (!fontSize) {
        fontSize = 16;
        saveFontSize(this.fileName, fontSize);
        this.redition.themes.fontSize(fontSize);
      }
      // 读取到就更改字体大小
      this.redition.themes.fontSize(fontSize);
      saveFontSize(this.fileName, fontSize);
    },

改变值的时候也要存入

字体

首先根据w3c规则 css3开始可以引入外部样式文件来引入自定义字体文件,所以添加了这个功能。

第一步在阿里巴巴图标库下载字体文件,然后放入自己服务器上通过nginx访问

第二步 书写设置字体面板组件,这里引入vant-poup组件弹出层,再弹出层里填写内容

同样通过vuex变量来控制弹出层面板显示

然后就是设置字体了,同样epubjs的钩子要使用到this.rendition.themes.font()

注: defaultFontFamily:默认字体 CurrentBook书籍对象 都是之前初始化设置的vuex全局变量

初始化注册字体文件

this.redition.hook.content.register((contents)=>{
    contents.addStylesheet() //添加字体样式文件  
})  //epubjs钩子注册方法 添加样式文件

addStylesheet() 方法必须存入url, 可以将url换成nginx服务器样式文件路径

切换字体事件

setfamily(font) {
      // 设置 不同的字体 关键函数 但还需要注册字体文件 使用hook钩子
      this.setfontfamily(font);
      if (this.defaultFontFamily === "Default") {
        this.CurrentBook.rendition.themes.font("Times New Roman");
        saveFontFamily(this.fileName, "Default");
      } else {
        this.CurrentBook.rendition.themes.font(font);
        saveFontFamily(this.fileName, font);
      }
    },

这样就完成了字体的切换,这里也需要设置storage初始化,同理。

更换主题

更换主题这里思路大致这样:

通过点击面板选择主题的名字,初始化阅读器时注册主题文件,然后通过动态添加css文件覆盖样式的方式实现主题切换

注册主题文件

 initTheme() {
      let themelist = themeList();
      let Currenttheme = getTheme(this.fileName);
      if (!Currenttheme) {
          //如果缓存中没有就设置为default的主题
        saveTheme(this.fileName, "Default");
        this.settheme("Default");
        this.redition.themes.select("Default");
      }
      // 注册主题属性
      themelist.forEach(theme => {
        this.redition.themes.register(theme.name, theme.style);
      });
      this.settheme(Currenttheme);
      this.redition.themes.select(Currenttheme);
    },

动态添加样式

添加css文件方法:创建link的dom,注入属性,然后添加到借点树中
export function addLink(href) {
  const link = document.createElement("link");
  link.setAttribute("rel", "stylesheet");
  link.setAttribute("type", "text/css");
  link.setAttribute("href", href);
  document.getElementsByTagName("head")[0].appendChild(link);
}

发现问题: 点击事件创建了很多css文件

分析问题:创建css文件我们应该去遍历之前的创建的文件,然后进行删除,写完删除的逻辑之后基本上切换主题就能够实现了。

监听面板点击事件

 setTheme(theme) {
      this.settheme(theme);//vuex设置theme
      this.CurrentBook.rendition.themes.select(theme);//更换主题
      saveTheme(this.fileName, theme);
      this.initGlobaltheme();//初始化主题 动态添加css文件
    },

每次点击时,都将之前创建的css文件删除,然后添加点击的主题css文件

 initGlobaltheme() {
      removeAllCss();
      switch (this.defaultTheme) {
        case "Default":
          addLink(`https://store.yangxiansheng.top/theme/theme_default.css`);
          break;
        case "Eye":
          addLink(`https://store.yangxiansheng.top/theme/theme_eye.css`);
          break;
        case "Gold":
          addLink(`https://store.yangxiansheng.top/theme/theme_gold.css`);
          break;
        case "Night":
          addLink(`https://store.yangxiansheng.top/theme/theme_night.css`);
          break;
        default:
          this.saveTheme(this.defaultTheme);
          addLink(`https://store.yangxiansheng.top/theme/theme_default.css`);
          break;
      }
    }

这样切换主题功能就实现了。

切换进度条

切换进度条关键分页算法(简易) 设置750个字符一页,书一行的宽度大于375,那么这也页就大于750个字 this.book.loctions.generate拿到页数

this.book.ready(),then(()=>{
    return this.book.locations.generate(750*(window.innerWidth/375)*(getFontsize(this.fileName) / 16))
}).then(()=>{
    this.setProgressFinished(true) //加载完cif的标志设为true
})

拖动换章

监听滑块的时间中 拿到cfifromPercentage(vaule/100)当前进度条内容,然后就display()出页面即可

上一章

定义vuex守卫 `section`,默认为零,通过epub的`this.book.section(vaule).href`获取到章节内容对象,然后进行显示.
  preveSection(){
      if(this.BookValiable && this.section > 0){  
        this.setSection(this.section - 1).then(()=>{
            // 拿到sectionInfo对象 对象里的href就是对应章节内容
            const sectioninfo = this.Currentbook.section(this.section)
            if(this.section && this.section.href)
            this.CurrentBook.rendition.display(sectioninfo.href)
        })
      }
  }

下一章

```js nextSection(){ // this.Currentbook.spine 对应章节的信息对象 if(this.BookValiable && this.section < this.Currentbook.spine.length - 1){ this.setSection(this.section + 1).then(()=>{ const sectioninfo = this.Currentbook.section(this.section) if(this.section && this.section.href) this.CurrentBook.rendition.display(sectioninfo.href) }) } } ```

目录

获取图片封面

this.book.loaded.coverthis.book.archive.createUrl

通过这两个函数获取

this.book.loaded.cover.then((cover)=>{
    this.book.archive.createUrl(cover).then(url=>{
        this.setCover(url)
        console.log(url)
    })
})

获取书籍的基本信息

`this.book.loaded.metadata.then((meta)=>{})`
metadata.title 标题
metadata.creator 作者

获取目录

`this.book.`loaded.navigation.then(())

重点算法: 将树状的结构数组拆分然后 合并到一个数组

...[array] 扩展运算符拆分数组

[].concat(...[array]) 合并拆分后的数组

拿到的数组结构

[
	 {
         id:1,
         subitems:[
             {
                 id:2,
            	 subitems:[
             				{
             					id:3,subitems:[]
             				},
    						{
                                id:4,subitems:[]
                            }
         					]
             },
             {
                 id:5,
                 subitems:[]
             }
        			 ]
     },
    {
        id:6,
        subitems:[]
    }
]

期待拿到的值

[
    {
    id:1,
    subitems:[{id:2,subitems:[{},{}]},{id:6,subitems:[{},{}]}]
    },
    {
    id:2,
    subitems:[{id:3,subitems:[]},{id:4,subitems:[]}]
    },
    {
    id:3,
    subitems:[]
    },
    {
    id:4,
    subitems:[]
    },
    {
    id:5,
    subitems:[]
    },
    {
    id:6,
    subitems:[]
    },
]
function flaten(array){
    // 先遍历数组 然后将一级item 二级item(拆分先)合并 组成新的数组
    return [].concat(array.map(item=>[].concat[item,...item.subitem]))
}

//递归优化 遍历深层树
function flaten(array){
    return [].concat(...arr.map(item=>[].concat(item,...flaten(item.subitem))))
}

拿到 目录数组后判断字段parent 如果是undefined---一级目录

拿到了一维数组的目录结构后,接下来要定义层级结构显示

let nav = flaten(navigation)
function find(item,level = 0){
    if(!item.parent){
        // 一级
        return level
    }else{
        // subitems里面有parent:parentid
        //过滤筛选出 item.id = item.parent 拿到父元素 层级加一
        return find(nav.filter(parentItem => parentItem.id===item.parent)[0],++level)
    }
}
//添加属性 得到层级数组
nav.forEach((item)=>{
    item.level = find(item)
})

epubAPI

初始化epubjs
global.ePub = Epub

解析一本电子书
new Epub(url)
 this.rendition = this.book.renderTo("read", {
        //宽高为书籍宽高  
        width: innerWidth,
        height: innerHeight,
        //兼容微信  
        method: "default"
      });

渲染一本电子书
this.rendition.display()

监听touch事件,控制翻页动作
this.rendition.on('touchstart',e=>{
    
})

拿到手指的触摸位置和触碰时间
touchStartX = e.changeedTouches[0].clientX
time = e.timeStamp

上一页
this.rendition.prev()

下一页
this.rendition.next()

设置字体大小
this.rendition.themes.fontSize(value)

设置字体family (需要注册)
this.renditio.themes.font(fontfamilyName)

注册字体文件
this.rendition.hooks.conetnt.register((contents)=>{
    Promise.all([
        contents.addStylesheet(url)
        ...
    ])
})

注册主题文件 (themelist---提前准备好的themelist)
themelist.forEach(theme =>{
  this.rendition.themes.register(theme.name,theme.style)  
})

设置主题
this.redition.themes.select(theme.name)

粗略分出一本书的总页数(做进度条)
this.book.ready().then(()=>{
    return this.book.locations.generate(rules)
    例:
    return this.book.locations.generate(750*(window.innerWidth / 375) * (getFontsize(this,filename)/16))
    这里 一页的宽度和字体大小决定一页是否超过750字 默认750字一屏
})

获取当前页的位置信息
this.currentBook.rendition.currentLocation()
可以用到的(start.cfi end.cfi ...)

获取cfi(当前页的内容)信息
value: 当前的进度百分比
this.book.locations.cfiFromPercentage(value),可以直接渲染到页面

通过进度条获取当前页面cfi 页面内容
this.book.locations.percentageFromCfi(percentage)


获取章节信息
section 获取的章节数
sectionInfo = this.book.section(section)
sectionInfo.href  章节内容

上一章下一章 
sectionInfo = this.book.section(section) | section-1|section + 1
显示切换后的章节内容 (跳到指定章节)
this.book.rendition.display(sectionInfo.href)

获取书籍章节信息
this.book.spine (length ...等信息)

获取当前章节信息
this,book.navigation.get(sectionInfo.href)

获取当前章节名称
this,book.navigation.get(sectionInfo.href).label

获取封面
this.book.loaded.cover
this.book.archive.createUrl(cover=>{})
this.setCover(url)

this.book.loaded.cover.then((cover)=>{
    this.book.archive.createUrl(cover).then(url=>{
        this.setCover(url)
        console.log(url)
    })
})

相关功能

完整功能截图

相关截图

首页

分类

书架

个人中心

书单列表

书籍详情

悦读音乐

日志

阅读器

体验版二维码

About

计算机设计大赛国家二等奖项目: 悦读ECUT

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published