Gitter：高颜值GitHub小程序客户端诞生记

前言

\n

嗯，可能一进来大部分人都会觉得，为什么还会有人重复造轮子，GitHub第三方客户端都已经烂大街啦。确实，一开始我自己也是这么觉得的，也问过自己是否真的有意义再去做这样一个项目。思考再三，以下原因也决定了我愿意去做一个让自己满意的GitHub第三方客户端。

\n

• \n
• \n

  对于时常关注GitHub Trending列表的笔者来说，迫切需要一个更简单的方式随时随地去跟随GitHub最新的技术潮流；

  \n\n
• \n

  已有的一些GitHub小程序客户端颜值与功能并不能满足笔者的要求；

  \n\n
• \n

  听说iOS开发没人要了，掌握一门新的开发技能，又何尝不可？

  \n\n
• \n

  其实也没那么多原因，既然想做，那就去做，开心最重要。

  \n\n

\n

1. Gitter

\n

\n

• \n
• \n

  GitHub：https://github.com/huangjianke/Gitter，可能是目前颜值最高的GitHub小程序客户端，欢迎star

  \n\n
• \n

  数据来源：

  \n\n

\n

GitHub API v3：https://developer.github.com/v3/

\n

目前实现的功能有：

\n

• \n
• \n

  实时查看Trending

  \n\n
• \n

  显示用户列表

  \n\n
• \n

  仓库和用户的搜索

  \n\n
• \n

  仓库：详情展示、README.md展示、Star/Unstar、Fork、Contributors展示、查看仓库文件内容

  \n\n
• \n

  开发者：Follow/Unfollow、显示用户的followers/following

  \n\n
• \n

  Issue：查看issue列表、新增issue、新增issue评论

  \n\n
• \n

  分享仓库、开发者

  \n\n
• \n

  …

  \n\n

\n

Gitter的初衷并不是想把网页端所有功能照搬到小程序上，因为那样的体验并不会很友好，比如说，笔者自己也不想在手机上阅读代码，那将会是一件很痛苦的事。

\n

在保证用户体验的前提下，让用户用更简单的方式得到自己想要的，这是一件有趣的事。

\n

2. 探索篇

\n

技术选型

\n

第一次觉得，在茫茫前端的世界里，自己是那么渺小。

\n

当决定去做这个项目的时候，就开始了马不停蹄的技术选型，但摆在自己面前的选择是那么的多，也不得不感慨，前端的世界，真的很精彩。

\n

• \n
• \n

  原生开发：基本上一开始就放弃了，开发体验很不友好；

  \n\n
• \n

  WePY：之前用这个框架已经开发过一个小程序，诗词墨客，不得不说，坑是真多，用过的都知道；

  \n\n
• \n

  mpvue：用Vue的方式去开发小程序，个人觉得文档并不是很齐全，加上近期维护比较少，可能是趋于稳定了？

  \n\n
• \n

  Taro：用React的方式去开发小程序，Taro团队的小伙伴维护真的很勤快，也很耐心的解答大家疑问，文档也比较齐全，开发体验也很棒，还可以一键生成多端运行的代码(暂没尝试)

  \n\n

\n

货比三家，经过一段时间的尝试及踩坑，综合自己目前的能力，最终确定了Gitter的技术选型：

\n

Taro + Taro UI + Redux + 云开发 Node.js

\n

页面设计

\n

其实，作为一名Coder，曾经一直想找个UI设计师妹子做老婆的(肯定有和我一样想法的Coder)，多搭配啊。现在想想，code不是生活的全部，现在的我一样很幸福。

\n

话回正题，没有设计师老婆页面设计怎么办？毕竟笔者想要的是一款高颜值的GitHub小程序。

\n

嗯，不慌，默默的拿出了笔者沉寂已久的Photoshop和Sketch。不敢说自己的设计能力如何，Gitter的设计至少是能让笔者自己心情愉悦的，倘若哪位设计爱好者想对Gitter的设计进行改良，欢迎欢迎，十二分的欢迎！

\n

3. 开发篇

\n

\n

Talk is cheap. Show me the code.

\n

\n

作为一篇技术性文章，怎可能少得了代码。

\n

在这里主要写写几个踩坑点，作为一个前端小白，相信各位读者均是笔者的前辈，还望多多指教！

\n

Trending

\n

进入开发阶段没多久，就遇到了第一个坑。GitHub居然没有提供Trending列表的API！！！

\n

也没有过多的去想GitHub为什么不提供这个API，只想着怎么去尽快填好这个坑。一开始尝试使用Scrapy写一个爬虫对网页端的Trending列表信息进行定时爬取及存储供小程序端使用，但最终还是放弃了这个做法，因为笔者并没有服务器与已经备案好的域名，小程序的云开发也只支持Node.js的部署。

\n

开源的力量还是强大，最终找到了github-trending-api，稍作修改，成功部署到小程序云开发后台，在此，感谢原作者的努力。

\n

• \n
• Trending列表云函数\n

\n

// 云函数入口函数\nexports.main = async (event, context) =\u0026gt; {\n  const { type, language, since } = event\n  let res = null;\n  let date = new Date()\n  const cacheKey = `repositories::${language || 'nolang'}::${since ||\n  'daily'}`;\n  const cacheData = await db.collection('repositories').where({\n    cacheKey: cacheKey\n  }).orderBy('cacheDate', 'desc').get()\n  if (cacheData.data.length !== 0 \u0026amp;\u0026amp;\n    ((date.getTime() - cacheData.data[0].cacheDate)  \u0026lt; 1800 * 1000)) {\n    res = JSON.parse(cacheData.data[0].content)\n  } else {\n    res = await fetchRepositories({ language, since });\n    await db.collection('repositories').add({\n      data: {\n        cacheDate: date.getTime(),\n        cacheKey: cacheKey,\n        content: JSON.stringify(res)\n      }\n    })\n  }\n  return {\n    data: res\n  }\n}\n

\n

Markdown解析

\n

嗯，这是一个大坑。

\n

在做技术调研的时候，发现小程序端Markdown解析主要有以下方案：

\n

• \n
• \n

  wxParse：作者最后一次提交已是两年前了，经过自己的尝试，也确实发现已经不适合如README.md的解析

  \n\n
• \n

  wemark：一款很优秀的微信小程序Markdown渲染库，但经过笔者尝试之后，发现对README.md的解析并不完美

  \n\n
• \n

  towxml：目前发现是微信小程序最完美的Markdown渲染库，已经能近乎完美的对README.md进行解析并展示

  \n\n

\n

在Markdown解析这一块，最终采用的也是towxml，但发现在解析性能这一块，目前并不是很优秀，对一些比较大的数据解析也超出了小程序所能承受的范围，还好贴心的作者(sbfkcel)提供了服务端的支持，在此感谢作者的努力！

\n

• \n
• Markdown解析云函数\n

\n

const Towxml = require('towxml');\nconst towxml = new Towxml();\n// 云函数入口函数\nexports.main = async (event, context) =\u0026gt; {\n  const { func, type, content } = event\n  let res\n  if (func === 'parse') {\n    if (type === 'markdown') {\n      res = await towxml.toJson(content || '', 'markdown');\n    } else {\n      res = await towxml.toJson(content || '', 'html');\n    }\n  }\n  return {\n    data: res\n  }\n}\n

\n

• \n
• markdown.js组件\n

\n

// 云函数解析markdown\nparseReadme() {\n  const { md, base } = this.props\n  let that = this\n  wx.cloud.callFunction({\n    // 要调用的云函数名称\n    name: 'parse',\n    // 传递给云函数的event参数\n    data: {\n      func: 'parse',\n      type: 'markdown',\n      content: md,\n    }\n  }).then(res =\u0026gt; {\n    let data = res.result.data\n    if (base \u0026amp;\u0026amp; base.length \u0026gt; 0) {\n      data = render.initData(data, {base: base, app: this.$scope})\n    }\n    that.setState({\n      fail: false,\n      data: data\n    })\n  }).catch(err =\u0026gt; {\n    console.log('cloud', err)\n    that.setState({\n      fail: true\n    })\n  })\n}\n

\n

// Markdown渲染\nrender() {\n  const { data } = this.state\n  return (\n    \u0026lt;View\u0026gt;\n    {\n      data ? (\n        \u0026lt;View\u0026gt;\n          \u0026lt;import src='../towxml/entry.wxml' /\u0026gt;\n          \u0026lt;template is='entry' data='{{...data}}' /\u0026gt;\n        \u0026lt;/View\u0026gt;\n      ) : (\n        \u0026lt;View className='loading'\u0026gt;\n          \u0026lt;AtActivityIndicator size={20} color='#2d8cf0' content='loading...' /\u0026gt;\n        \u0026lt;/View\u0026gt;\n      )\n    }\n    \u0026lt;/View\u0026gt;\n  )\n}\n

\n

Redux

\n

其实，笔者在该项目中，对Redux的使用并不多。一开始，笔者觉得所有的接口请求都应该通过Redux操作，后面才发现，并不是所有的操作都必须使用Redux，最后，在本项目中，只有获取个人信息的时候使用了Redux。

\n

// 获取个人信息\nexport const getUserInfo = createApiAction(USERINFO, (params) =\u0026gt; api.get('/user', params))\n

\n

// action\nexport function createApiAction(actionType, func = () =\u0026gt; {}) {\n  return (\n    params = {},\n    callback = { success: () =\u0026gt; {}, failed: () =\u0026gt; {} },\n    customActionType = actionType,\n  ) =\u0026gt; async (dispatch) =\u0026gt; {\n    try {\n      dispatch({ type: `${customActionType  }_request`, params });\n      const data = await func(params);\n      dispatch({ type: customActionType, params, payload: data });\n\n      callback.success \u0026amp;\u0026amp; callback.success({ payload: data })\n      return data\n    } catch (e) {\n      dispatch({ type: `${customActionType  }_failure`, params, payload: e })\n\n      callback.failed \u0026amp;\u0026amp; callback.failed({ payload: e })\n    }\n  }\n}\n

\n

getUserInfo() {\n  if (hasLogin()) {\n    userAction.getUserInfo().then(()=\u0026gt;{\n      Taro.hideLoading()\n      Taro.stopPullDownRefresh()\n    })\n  } else {\n    Taro.hideLoading()\n    Taro.stopPullDownRefresh()\n  }\n}\nconst mapStateToProps = (state, ownProps) =\u0026gt; {\n  return {\n    userInfo: state.user.userInfo\n  }\n}\nexport default connect(mapStateToProps)(Index)\n

\n

// reducers\nexport default function user (state = INITIAL_STATE, action) {\n  switch (action.type) {\n    case USERINFO:\n      return {\n        ...state,\n        userInfo: action.payload.data\n      }\n    default:\n      return state\n  }\n}\n

\n

目前，笔者对Redux还是处于一知半解的状态，嗯，学习的路还很长。

\n

有需要的同学可以前往开源仓库查看相应的完整源码，还请多多指教。

\n

4. 结语篇

\n

当Gitter第一个版本通过审核的时候，心情是很激动的，就像自己的孩子一样，看着他一点一点的长大，笔者也很享受这样一个项目从无到有的过程，在此，对那些帮助过笔者的人一并表示感谢。

\n

当然，目前功能和体验上可能有些不大完善，也希望大家能提供一些宝贵的意见，Gitter走向完美的路上希望有你！

\n

最后，希望Gitter小程序能对你有所帮助！

\n

更多内容，请关注前端之巅。

\n

\n