Gitter：高顏值GitHub小程式客戶端誕生記

機器之心發表於2019-02-01
Github客戶端

0. 前言

嗯，可能一進來大部分人都會覺得，為什麼還會有人重複造輪子，GitHub 第三方客戶端都已經爛大街啦。確實，一開始我自己也是這麼覺得的，也問過自己是否真的有意義再去做這樣一個專案。思考再三，以下原因也決定了我願意去做一個讓自己滿意的 GitHub 第三方客戶端。

  • 對於時常關注 GitHub Trending 列表的筆者來說，迫切需要一個更簡單的方式隨時隨地去跟隨 GitHub 最新的技術潮流；

  • 已有的一些 GitHub 小程式客戶端顏值與功能並不能滿足筆者的要求；

  • 聽說 iOS 開發沒人要了，掌握一門新的開發技能，又何嘗不可？

  • 其實也沒那麼多原因，既然想做，那就去做，開心最重要。

1. Gitter

Gitter：高顏值GitHub小程式客戶端誕生記

  • GitHub：https://github.com/huangjianke/Gitter，可能是目前顏值最高的 GitHub 小程式客戶端，歡迎 star

  • 資料來源：GitHub API v3

目前實現的功能有：

  • 實時檢視 Trending

  • 顯示使用者列表

  • 倉庫和使用者的搜尋

  • 倉庫：詳情展示、README.md 展示、Star/Unstar、Fork、Contributors 展示、檢視倉庫檔案內容

  • 開發者：Follow/Unfollow、顯示使用者的 followers/following

  • Issue：檢視 issue 列表、新增 issue、新增 issue 評論

  • 分享倉庫、開發者

  • ...

Gitter 的初衷並不是想把網頁端所有功能照搬到小程式上，因為那樣的體驗並不會很友好，比如說，筆者自己也不想在手機上閱讀程式碼，那將會是一件很痛苦的事。

在保證使用者體驗的前提下，讓使用者用更簡單的方式得到自己想要的，這是一件有趣的事。

2. 探索篇

技術選型

第一次覺得，在茫茫前端的世界裡，自己是那麼渺小。

當決定去做這個專案的時候，就開始了馬不停蹄的技術選型，但擺在自己面前的選擇是那麼的多，也不得不感慨，前端的世界，真的很精彩。

  • 原生開發：基本上一開始就放棄了，開發體驗很不友好；

  • WePY：之前用這個框架已經開發過一個小程式，詩詞墨客，不得不說，坑是真多，用過的都知道；

  • mpvue：用 Vue 的方式去開發小程式，個人覺得文件並不是很齊全，加上近期維護比較少，可能是趨於穩定了？

  • Taro：用 React 的方式去開發小程式，Taro 團隊的小夥伴維護真的很勤快，也很耐心的解答大家疑問，文件也比較齊全，開發體驗也很棒，還可以一鍵生成多端執行的程式碼 (暫沒嘗試)

貨比三家，經過一段時間的嘗試及踩坑，綜合自己目前的能力，最終確定了 Gitter 的技術選型：

Taro + Taro UI + Redux + 雲開發 Node.js

頁面設計

其實，作為一名 Coder，曾經一直想找個 UI 設計師妹子做老婆的 (肯定有和我一樣想法的 Coder)，多搭配啊。現在想想，code 不是生活的全部，現在的我一樣很幸福。

話回正題，沒有設計師老婆頁面設計怎麼辦？畢竟筆者想要的是一款高顏值的 GitHub 小程式。

嗯，不慌，默默的拿出了筆者沉寂已久的 Photoshop 和 Sketch。不敢說自己的設計能力如何，Gitter 的設計至少是能讓筆者自己心情愉悅的，倘若哪位設計愛好者想對 Gitter 的設計進行改良，歡迎歡迎，十二分的歡迎！

3. 開發篇

Talk is cheap. Show me the code.

作為一篇技術性文章，怎可能少得了程式碼。

在這裡主要寫寫幾個踩坑點，作為一個前端小白，相信各位讀者均是筆者的前輩，還望多多指教！

Trending

進入開發階段沒多久，就遇到了第一個坑。GitHub 居然沒有提供 Trending 列表的 API！！！

也沒有過多的去想 GitHub 為什麼不提供這個 API，只想著怎麼去儘快填好這個坑。一開始嘗試使用 Scrapy 寫一個爬蟲對網頁端的 Trending 列表資訊進行定時爬取及儲存供小程式端使用，但最終還是放棄了這個做法，因為筆者並沒有伺服器與已經備案好的域名，小程式的雲開發也只支援 Node.js 的部署。

開源的力量還是強大，最終找到了 github-trending-api，稍作修改，成功部署到小程式雲開發後臺，在此，感謝原作者的努力。

  • 爬取Trending Repositories

  1. async function fetchRepositories({
  2.   language = '',
  3.   since = 'daily',
  4. } = {}) {
  5.   const url = `${GITHUB_URL}/trending/${language}?since=${since}`;
  6.   const data = await fetch(url);
  7.   const $ = cheerio.load(await data.text());
  8.   return (
  9.     $('.repo-list li')
  10.       .get()
  11.       // eslint-disable-next-line complexity
  12.       .map(repo => {
  13.         const $repo = $(repo);
  14.         const title = $repo
  15.           .find('h3')
  16.           .text()
  17.           .trim();
  18.         const relativeUrl = $repo
  19.           .find('h3')
  20.           .find('a')
  21.           .attr('href');
  22.         const currentPeriodStarsString =
  23.           $repo
  24.             .find('.float-sm-right')
  25.             .text()
  26.             .trim() || /* istanbul ignore next */ '';
  27.         const builtBy = $repo
  28.           .find('span:contains("Built by")')
  29.           .parent()
  30.           .find('[data-hovercard-type="user"]')
  31.           .map((i, user) => {
  32.             const altString = $(user)
  33.               .children('img')
  34.               .attr('alt');
  35.             const avatarUrl = $(user)
  36.               .children('img')
  37.               .attr('src');
  38.             return {
  39.               username: altString
  40.                 ? altString.slice(1)
  41.                 : /* istanbul ignore next */ null,
  42.               href: `${GITHUB_URL}${user.attribs.href}`,
  43.               avatar: removeDefaultAvatarSize(avatarUrl),
  44. };
  45. })
  46.           .get();
  47.         const colorNode = $repo.find('.repo-language-color');
  48.         const langColor = colorNode.length
  49.           ? colorNode.css('background-color')
  50.           : null;
  51.         const langNode = $repo.find('[itemprop=programmingLanguage]');
  52.         const lang = langNode.length
  53.           ? langNode.text().trim()
  54.           : /* istanbul ignore next */ null;
  55.         return omitNil({
  56.           author: title.split(' / ')[0],
  57.           name: title.split(' / ')[1],
  58.           url: `${GITHUB_URL}${relativeUrl}`,
  59.           description:
  60.             $repo
  61.               .find('.py-1 p')
  62.               .text()
  63.               .trim() || /* istanbul ignore next */ '',
  64.           language: lang,
  65.           languageColor: langColor,
  66.           stars: parseInt(
  67.             $repo
  68.               .find(`[href="${relativeUrl}/stargazers"]`)
  69.               .text()
  70.               .replace(',', '') || /* istanbul ignore next */ 0,
  71.             10
  72.           ),
  73.           forks: parseInt(
  74.             $repo
  75.               .find(`[href="${relativeUrl}/network"]`)
  76.               .text()
  77.               .replace(',', '') || /* istanbul ignore next */ 0,
  78.             10
  79.           ),
  80.           currentPeriodStars: parseInt(
  81.             currentPeriodStarsString.split(' ')[0].replace(',', '') ||
  82.               /* istanbul ignore next */ 0,
  83.             10
  84.           ),
  85.           builtBy,
  86. });
  87. })
  88. );
  89. }

  • 爬取Trending Developers

  1. async function fetchDevelopers({ language = '', since = 'daily' } = {}) {
  2.   const data = await fetch(
  3.     `${GITHUB_URL}/trending/developers/${language}?since=${since}`
  4.   );
  5.   const $ = cheerio.load(await data.text());
  6.   return $('.explore-content li')
  7.     .get()
  8.     .map(dev => {
  9.       const $dev = $(dev);
  10.       const relativeUrl = $dev.find('.f3 a').attr('href');
  11.       const name = getMatchString(
  12.         $dev
  13.           .find('.f3 a span')
  14.           .text()
  15.           .trim(),
  16.         /^\((.+)\)$/i
  17.       );
  18.       $dev.find('.f3 a span').remove();
  19.       const username = $dev
  20.         .find('.f3 a')
  21.         .text()
  22.         .trim();
  23.       const $repo = $dev.find('.repo-snipit');
  24.       return omitNil({
  25.         username,
  26.         name,
  27.         url: `${GITHUB_URL}${relativeUrl}`,
  28.         avatar: removeDefaultAvatarSize($dev.find('img').attr('src')),
  29.         repo: {
  30.           name: $repo
  31.             .find('.repo-snipit-name span.repo')
  32.             .text()
  33.             .trim(),
  34.           description:
  35.             $repo
  36.               .find('.repo-snipit-description')
  37.               .text()
  38.               .trim() || /* istanbul ignore next */ '',
  39.           url: `${GITHUB_URL}${$repo.attr('href')}`,
  40. },
  41. });
  42. });
  43. }

  • Trending列表雲函式

  1. // 雲函式入口函式
  2. exports.main = async (event, context) => {
  3.   const { type, language, since } = event
  4.   let res = null;
  5.   let date = new Date()
  6.   if (type === 'repositories') {
  7.     const cacheKey = `repositories::${language || 'nolang'}::${since ||
  8.     'daily'}`;
  9.     const cacheData = await db.collection('repositories').where({
  10.       cacheKey: cacheKey
  11.     }).orderBy('cacheDate', 'desc').get()
  12.     if (cacheData.data.length !== 0 &&
  13.       ((date.getTime() - cacheData.data[0].cacheDate)  < 1800 * 1000)) {
  14.       res = JSON.parse(cacheData.data[0].content)
  15.     } else {
  16.       res = await fetchRepositories({ language, since });
  17.       await db.collection('repositories').add({
  18.         data: {
  19.           cacheDate: date.getTime(),
  20.           cacheKey: cacheKey,
  21.           content: JSON.stringify(res)
  22.         }
  23.       })
  24.     }
  25.   } else if (type === 'developers') {
  26.     const cacheKey = `developers::${language || 'nolang'}::${since || 'daily'}`;
  27.     const cacheData = await db.collection('developers').where({
  28.       cacheKey: cacheKey
  29.     }).orderBy('cacheDate', 'desc').get()
  30.     if (cacheData.data.length !== 0 &&
  31.       ((date.getTime() - cacheData.data[0].cacheDate)  < 1800 * 1000)) {
  32.       res = JSON.parse(cacheData.data[0].content)
  33.     } else {
  34.       res = await fetchDevelopers({ language, since });
  35.       await db.collection('developers').add({
  36.         data: {
  37.           cacheDate: date.getTime(),
  38.           cacheKey: cacheKey,
  39.           content: JSON.stringify(res)
  40.         }
  41.       })
  42.     }
  43.   }
  44.   return {
  45.     data: res
  46.   }
  47. }

Markdown 解析

嗯，這是一個大坑。

在做技術調研的時候，發現小程式端 Markdown 解析主要有以下方案：

  • wxParse：作者最後一次提交已是兩年前了，經過自己的嘗試，也確實發現已經不適合如 README.md 的解析

  • wemark：一款很優秀的微信小程式 Markdown 渲染庫，但經過筆者嘗試之後，發現對 README.md 的解析並不完美

  • towxml：目前發現是微信小程式最完美的 Markdown 渲染庫，已經能近乎完美的對 README.md 進行解析並展示

在 Markdown 解析這一塊，最終採用的也是 towxml，但發現在解析效能這一塊，目前並不是很優秀，對一些比較大的資料解析也超出了小程式所能承受的範圍，還好貼心的作者 (sbfkcel) 提供了服務端的支援，在此感謝作者的努力！

  • Markdown解析雲函式

  1. const Towxml = require('towxml');
  2. const towxml = new Towxml();
  3. // 雲函式入口函式
  4. exports.main = async (event, context) => {
  5.   const { func, type, content } = event
  6.   let res
  7.   if (func === 'parse') {
  8.     if (type === 'markdown') {
  9.       res = await towxml.toJson(content || '', 'markdown');
  10.     } else {
  11.       res = await towxml.toJson(content || '', 'html');
  12.     }
  13.   }
  14.   return {
  15.     data: res
  16.   }
  17. }

  • markdown.js元件

  1. import Taro, { Component } from '@tarojs/taro'
  2. import PropTypes from 'prop-types'
  3. import { View, Text } from '@tarojs/components'
  4. import { AtActivityIndicator } from 'taro-ui'
  5. import './markdown.less'
  6. import Towxml from '../towxml/main'
  7. const render = new Towxml()
  8. export default class Markdown extends Component {
  9.   static propTypes = {
  10.     md: PropTypes.string,
  11.     base: PropTypes.string
  12.   }
  13.   static defaultProps = {
  14.     md: null,
  15.     base: null
  16.   }
  17.   constructor(props) {
  18.     super(props)
  19.     this.state = {
  20.       data: null,
  21.       fail: false
  22.     }
  23.   }
  24.   componentDidMount() {
  25.     this.parseReadme()
  26.   }
  27.   parseReadme() {
  28.     const { md, base } = this.props
  29.     let that = this
  30.     wx.cloud.callFunction({
  31.       // 要呼叫的雲函式名稱
  32.       name: 'parse',
  33.       // 傳遞給雲函式的event引數
  34.       data: {
  35.         func: 'parse',
  36.         type: 'markdown',
  37.         content: md,
  38.       }
  39.     }).then(res => {
  40.       let data = res.result.data
  41.       if (base && base.length > 0) {
  42.         data = render.initData(data, {base: base, app: this.$scope})
  43.       }
  44.       that.setState({
  45.         fail: false,
  46.         data: data
  47.       })
  48.     }).catch(err => {
  49.       console.log('cloud', err)
  50.       that.setState({
  51.         fail: true
  52.       })
  53.     })
  54.   }
  55. 

  56.   render() {
  57.     const { data, fail } = this.state
  58.     if (fail) {
  59.       return (
  60.         <View className='fail' onClick={this.parseReadme.bind(this)}>
  61.           <Text className='text'>load failed, try it again?</Text>
  62.         </View>
  63.       )
  64.     }
  65.     return (
  66.       <View>
  67.       {
  68.         data ? (
  69.           <View>
  70.             <import src='../towxml/entry.wxml' />
  71.             <template is='entry' data='{{...data}}' />
  72.           </View>
  73.         ) : (
  74.           <View className='loading'>
  75.             <AtActivityIndicator size={20} color='#2d8cf0' content='loading...' />
  76.           </View>
  77.         )
  78.       }
  79.       </View>
  80.     )
  81.   }
  82. }

Redux

其實，筆者在該專案中，對 Redux 的使用並不多。一開始，筆者覺得所有的介面請求都應該通過 Redux 操作，後面才發現，並不是所有的操作都必須使用 Redux，最後，在本專案中，只有獲取個人資訊的時候使用了 Redux。

  1. // 獲取個人資訊
  2. export const getUserInfo = createApiAction(USERINFO, (params) => api.get('/user', params))
  1. export function createApiAction(actionType, func = () => {}) {
  2.   return (
  3.     params = {},
  4.     callback = { success: () => {}, failed: () => {} },
  5.     customActionType = actionType,
  6.   ) => async (dispatch) => {
  7.     try {
  8.       dispatch({ type: `${customActionType  }_request`, params });
  9.       const data = await func(params);
  10.       dispatch({ type: customActionType, params, payload: data });
  11. 

  12.       callback.success && callback.success({ payload: data })
  13.       return data
  14.     } catch (e) {
  15.       dispatch({ type: `${customActionType  }_failure`, params, payload: e })
  16. 

  17.       callback.failed && callback.failed({ payload: e })
  18.     }
  19.   }
  20. }
  1.   getUserInfo() {
  2.     if (hasLogin()) {
  3.       userAction.getUserInfo().then(()=>{
  4.         Taro.hideLoading()
  5.         Taro.stopPullDownRefresh()
  6.       })
  7.     } else {
  8.       Taro.hideLoading()
  9.       Taro.stopPullDownRefresh()
  10.     }
  11.   }
  12. const mapStateToProps = (state, ownProps) => {
  13.   return {
  14.     userInfo: state.user.userInfo
  15.   }
  16. }
  17. export default connect(mapStateToProps)(Index)
  1. export default function user (state = INITIAL_STATE, action) {
  2.   switch (action.type) {
  3.     case USERINFO:
  4.       return {
  5.         ...state,
  6.         userInfo: action.payload.data
  7.       }
  8.     default:
  9.       return state
  10.   }
  11. }

目前，筆者對 Redux 還是處於一知半解的狀態，嗯，學習的路還很長。

4. 結語篇

當 Gitter 第一個版本通過稽核的時候，心情是很激動的，就像自己的孩子一樣，看著他一點一點的長大，筆者也很享受這樣一個專案從無到有的過程，在此，對那些幫助過筆者的人一併表示感謝。

當然，目前功能和體驗上可能有些不大完善，也希望大家能提供一些寶貴的意見，Gitter 走向完美的路上希望有你！

最後，希望 Gitter 小程式能對你有所幫助！

相關文章