24 小时从 0 到 1 开发阴阳师小程序

1,982 阅读9分钟
原文链接: www.rapospectre.com

0.序

玩阴阳师的肝帝们都知道,每天早上5点和下午6点会刷新两次封印任务,每次做任务时最蛋疼的就是找各种怪物对应的副本以及神秘线索。 阴阳师提供了 网易精灵 可以进行一些数据查询,但体验实在太感人,所以大多数人选择使用搜素引擎搜索怪物分布及神秘线索。

而每次使用搜索引擎查找又十分不方便,所以笔者决定写一个查询阴阳师妖怪分布的小程序,力求做到使用快捷体验更快捷,把更多的时间留给狗粮和御魂。

恰好上周末有两天时间,所以立马开写。

1.构思与设计 ( 3小时 )

1.1 构思

  1. 要做的小程序主要功能就是查询功能,所以主页应该像搜索引擎一样简洁,搜索框是肯定需要的;
  2. 主页包含热门搜索,缓存最热式神的搜索;
  3. 搜索支持完整匹配或者单字匹配;
  4. 点击搜索结果直接跳转到式神详情页;53. 式神详情页应该包含式神的图鉴、名称、稀有度、出没地点,并且出没地点按妖怪数量从多到少排序;
  5. 加入数据报错及提建议的功能;
  6. 支持用户个人的搜索历史;
  7. 小程序的名字,综合考虑小程序的功能最后决定叫做 式神猎手 ( 其实这是最后开发完成后才想好的 );

1.2 设计

构思好后笔者就开始用笔者半吊子的 PS 水平设计了下草图,大概是这个样子:

嗯,最主要的首页和详情页设计好就行,然后就可以开始具体考虑怎么做了!

1.3 技术架构

  1. 前端毫无疑问就是微信小程序咯;
  2. 后端使用 Django 提供 Restful API 服务;
  3. 当前最热搜索用 redis 做缓存服务器进行缓存;
  4. 个人搜索记录就使用微信小程序提供的 localstorage ;
  5. 式神分布信息使用爬虫爬取清洗,格式化为 json , 入库前再做人工检查;
  6. 式神图片及图标直接爬取官方资料;
  7. 自己制作爬不到的式神图片及图标;
  8. 小程序要求 HTTPS 连接,恰好笔者之前搞过,可以直接看这里 HTTPS 免费部署指南

到此,正式开发前的准备得当后,我们就可以开始正式开发了

2. API 服务开发 ( 5小时 )

Django 的 API 服务开发笔者之前经常做,所以有比较完整的解决方案,可以参考这里 django-simple-serializer

之所以花了 5 个小时是因为近 4 个小时在增加 django-simple-serializer 对 Django ManyToManyField 中 through 特性的支持。

简而言之, through 特性就是可以使多对多关系的中间表增添一些额外的字段或属性,例如: 怪物副本和怪物之间的多对多关系就需要增加一个储存每个副本有多少只相应怪物数量的字段 count。

搞定 through 支持后 API 的构建就很快啦,主要有五个 API :

  1. 搜索接口;
  2. 式神详情接口;
  3. 式神副本接口;
  4. 热门搜索接口;
  5. 反馈接口;

写好接口后添加一些 mock data 以供测试;

3. 前端开发 ( 8小时 )

前端花了最久的时间。

一方面笔者真的是个后端工程师,前端属于半路出家,另一方面小程序有一些坑。 当然,最主要的是一直在调整界面效果,这里花了大量时间。

写小程序的整体体验笔者感觉就和写 vue.js 一摸一样,只不过一些 html 标签没办法使用,而是需要按小程序官方提供的组件进行书写, 这里有一点感受就是,小程序本身组件化的设计思路应该是借鉴了 React 而语法之类的应该是借鉴了 vue.js 。

最后前端开发完毕后主要分为这几个页面:

  1. 主页 ( 搜索页 );
  2. 式神详情页;
  3. 我的页面 ( 主要是放搜索历史和免责申明等等东西 );
  4. 反馈界面;
  5. 声明界面 ( 为何需要这个界面? 因为所有图片及一些资源都是直接抓取阴阳师官方的资源,所以这里需要申明只是非盈利性质的使用,版权乱七八糟的都还是阴阳师的 )。

哎,丑媳妇早晚要见公婆,这里不得不放最后开发出来的界面图了

对于微信小程序的入门及基础,笔者就不在这里多讲了,相信到现在对微信小程序有关注的开发者或多或少自己写个简单的 demo 肯定是没问题的,我就主要讲一讲我在开发中遇到的坑:

3.1 background-image 属性

在写式神详情页的时候两个地方需要用到 background-image 属性设置背景图,在微信开发者工具中一切显示正常,但一到真机调试就没有办法显示,最后发现小程序的 background-image 在真机不支持引用本地资源,解决方案有两种:

  1. 使用网络图片: 考虑到背景图的大小,笔者放弃了这种方案;
  2. 使用 base64 编码图片。

正常来讲,css 中的 background-image 就支持 base64 ,这种方案相当于把图片直接用 base64 编码成一段 base64 码进行储存,在使用时这样使用即可:

  1. background-image: url(data:image/image-format;base64,XXXX);

image-format 为图片本身的格式,而 xxxx 就是图片经过 base64 后得到的编码。这种方式其实是一种变相引用本地资源的方式,好处在于可以减少请求图片的次数,而缺点则是会增大 css 文件并使其不是那么好看。

最后笔者选择第二种方式主要还是考虑到图片的大小以及 wxss 的增大在可接受范围内。

3.2 template

小程序支持模版,但要注意模板拥有自己的作用域,只能使用data传入的数据。

另外,在传入数据时需要将相关数据解构传入,在模版内部是直接以 {{ xxxx }} 的形式进行访问,而不是像在循环中 {{ item.xxx }} 这种访问形式;

关于解构:

  1. <template is="xxx" data="{{...object}}"/>

三个 . 就是解构操作;

一般 template 都会放在 单独的 template 文件中让其他文件进行调用,而不会直接写在正常的 wxml 中。 比如笔者目录大概是这样的:

  1. ├── app.js
  2. ├── app.json
  3. ├── app.wxss
  4. ├── pages
  5. │ ├── feedback
  6. │ ├── index
  7. │ ├── my
  8. │ ├── onmyoji
  9. │ ├── statement
  10. │ └── template
  11. │ ├── template.js
  12. │ ├── template.json
  13. │ ├── template.wxml
  14. │ └── template.wxss
  15. ├── static
  16. └── utils

关于其他文件调用 template,直接使用 import 即可:

  1. <import src="../template/template.wxml" />

然后在需要引用模版的地方:

  1. <template is="xxx" data="{{...object}}"/>
  2. <!--is 后填写模版名称-->

这里遇到另一个问题,template 对应的样式写在 template 对应的 wxss 中并没有作用,需要写在调用 template 的文件的 wxss 中,比如 index 需要使用 template 则需要将对应的 css 写在 my/my.wxss 中。

4. 爬取图片资源 ( 2小时 )

式神的图标及形象图基本上阴阳师官网都有,这里自己做也不现实,所以果断写爬虫爬下来然后存到自己的 cdn 。

大图和小图都在 http://yys.163.com/shishen/index.html 这里可以找到。 一开始考虑爬取网页然后 beautiful soup 提取数据,后面发现式神数据竟然是异步加载的,那就更简单了,分析网页得到 https://g37simulator.webapp.163.com/get_heroid_list 直接返回了式神信息的 json 信息,所以很容易写个爬虫就可以搞定了:

  1. # coding: utf-8
  2. import json
  3. import requests
  4. import urllib
  5. from xpinyin import Pinyin
  6. url = "https://g37simulator.webapp.163.com/get_heroid_list?callback=jQuery11130959811888616583_1487429691764&rarity=0&page=1&per_page=200&_=1487429691765"
  7. result = requests.get(url).content.replace('jQuery11130959811888616583_1487429691764(', '').replace(')', '')
  8. json_data = json.loads(result)
  9. hellspawn_list = json_data['data']
  10. p = Pinyin()
  11. for k, v in hellspawn_list.iteritems():
  12. file_name = p.get_pinyin(v.get('name'), '')
  13. print 'id: {0} name: {1}'.format(k, v.get('name'))
  14. big_url = "https://yys.res.netease.com/pc/zt/20161108171335/data/shishen_big/{0}.png".format(k)
  15. urllib.urlretrieve(big_url, filename='big/{0}@big.png'.format(file_name))
  16. avatar_url = "https://yys.res.netease.com/pc/gw/20160929201016/data/shishen/{0}.png".format(k)
  17. urllib.urlretrieve(avatar_url, filename='icon/{0}@icon.png'.format(file_name))

然而,爬完数据后发现一个问题,网易官方的图片都是无码高清大图,对于笔者这种穷 ds 大图放在 cdn 上两天就得破产,所以需要批量将图片转成既不太大又能看的过去。嗯,这里就可以用到 ps 的批处理能力了。

  1. 打开 ps ,然后选择爬到的一张图片;
  2. 选择菜单栏上的“窗口”然后选择“动作;
  3. 在“动作”选项下,新建一个动作;
  4. 点击圆形录制按钮开始录制动作;
  5. 按正常处理图片等顺序将一张图片存为 web 格式;
  6. 点击方形停止按钮停止录制动作;
  7. 选择菜单栏上的 文件-自动-批处理-选择之前录制的动作-配置好输入文件夹和输出文件夹;
  8. 点击确定就可以啦;

等批处理结束,期间刷个御魂啥的应该就好了,然后将得到的所有图片上传到静态资源服务器,图片这里就处理完啦。

5. 式神数据爬取 ( 4小时 )

式神分布数据网上比较杂并且数据很多有偏差,所以斟酌再三决定采用半人工半自动的方式,爬到的数据输出为 json:

  1. {
  2. "scene_name": "探索第一章",
  3. "team_list": [{
  4. "name": "天邪鬼绿1",
  5. "index": 1,
  6. "monsters": [{
  7. "name": "天邪鬼绿",
  8. "count": 1
  9. },{
  10. "name": "提灯小僧",
  11. "count": 2
  12. }]
  13. },{
  14. "name": "天邪鬼绿2",
  15. "index": 2,
  16. "monsters": [{
  17. "name": "天邪鬼绿",
  18. "count": 1
  19. },{
  20. "name": "提灯小僧",
  21. "count": 2
  22. }]
  23. },{
  24. "name": "提灯小僧1",
  25. "index": 3,
  26. "monsters": [{
  27. "name": "天邪鬼绿",
  28. "count": 2
  29. },{
  30. "name": "提灯小僧",
  31. "count": 1
  32. }]
  33. },{
  34. "name": "提灯小僧2",
  35. "index": 4,
  36. "monsters": [{
  37. "name": "灯笼鬼",
  38. "count": 2
  39. },{
  40. "name": "提灯小僧",
  41. "count": 1
  42. }]
  43. },{
  44. "name": "首领",
  45. "index": 5,
  46. "monsters": [{
  47. "name": "九命猫",
  48. "count": 3
  49. }]
  50. }]
  51. }

然后再人工检查一遍,当然还是会有遗漏,所以数据报错的功能就很重要啦。

这一部分实际写代码的时间可能只有半个多小时,剩下时间一直在检查数据;

一切检查结束后写个脚本直接将 json 导入到数据库中,检查无误后用 fabric 发布到线上服务器进行测试;

6. 测试 ( 2小时 )

最后一步基本上就是在手机上体验查错,修改一些效果,关闭调试模式准备提交审核;

此时已经是周日,哦,不对,应该是周一早上一点钟了:

不得不说,小程序团队审核速度很快啊,周一下午就审核通过了,然后果断上线。

最后放效果图:

感兴趣的同学欢迎扫码体验哟:

手机长按不能进入小程序,需要在 微信-发现-小程序-搜索-式神猎手 进入

7. 结尾

以上所有内容均已开源,欢迎大家参考:

后端: 式神猎手后端 ( github.com/bluedazzle/… )
小程序端: 式神猎手小程序 ( github.com/bluedazzle/… )
API 解决方案: django-simple-serializer ( github.com/bluedazzle/… )