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

jianke11發表於2019-01-28

0. 前言

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

對於時常關注GitHub Trending列表的筆者來說，迫切需要一個更簡單的方式隨時隨地去跟隨GitHub最新的技術潮流；
已有的一些GitHub小程式客戶端顏值與功能並不能滿足筆者的要求；
聽說iOS開發沒人要了，掌握一門新的開發技能，又何嘗不可？
其實也沒那麼多原因，既然想做，那就去做，開心最重要。

1. Gitter

GitHub：github.com/huangjianke…，可能是目前顏值最高的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.

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

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

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

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

爬取Trending Repositories


async function fetchRepositories({

  language = '',

  since = 'daily',

} = {}) {

  const url = `${GITHUB_URL}/trending/${language}?since=${since}`;

  const data = await fetch(url);

  const $ = cheerio.load(await data.text());

  return (

    $('.repo-list li')

      .get()

      // eslint-disable-next-line complexity

      .map(repo => {

        const $repo = $(repo);

        const title = $repo

          .find('h3')

          .text()

          .trim();

        const relativeUrl = $repo

          .find('h3')

          .find('a')

          .attr('href');

        const currentPeriodStarsString =

          $repo

            .find('.float-sm-right')

            .text()

            .trim() || /* istanbul ignore next */ '';

        const builtBy = $repo

          .find('span:contains("Built by")')

          .parent()

          .find('[data-hovercard-type="user"]')

          .map((i, user) => {

            const altString = $(user)

              .children('img')

              .attr('alt');

            const avatarUrl = $(user)

              .children('img')

              .attr('src');

            return {

              username: altString

                ? altString.slice(1)

                : /* istanbul ignore next */ null,

              href: `${GITHUB_URL}${user.attribs.href}`,

              avatar: removeDefaultAvatarSize(avatarUrl),

};

})

          .get();

        const colorNode = $repo.find('.repo-language-color');

        const langColor = colorNode.length

          ? colorNode.css('background-color')

          : null;

        const langNode = $repo.find('[itemprop=programmingLanguage]');

        const lang = langNode.length

          ? langNode.text().trim()

          : /* istanbul ignore next */ null;

        return omitNil({

          author: title.split(' / ')[0],

          name: title.split(' / ')[1],

          url: `${GITHUB_URL}${relativeUrl}`,

          description:

            $repo

              .find('.py-1 p')

              .text()

              .trim() || /* istanbul ignore next */ '',

          language: lang,

          languageColor: langColor,

          stars: parseInt(

            $repo

              .find(`[href="${relativeUrl}/stargazers"]`)

              .text()

              .replace(',', '') || /* istanbul ignore next */ 0,

            10

          ),

          forks: parseInt(

            $repo

              .find(`[href="${relativeUrl}/network"]`)

              .text()

              .replace(',', '') || /* istanbul ignore next */ 0,

            10

          ),

          currentPeriodStars: parseInt(

            currentPeriodStarsString.split(' ')[0].replace(',', '') ||

              /* istanbul ignore next */ 0,

            10

          ),

          builtBy,

});

})

);

}

複製程式碼

爬取Trending Developers

async function fetchDevelopers({ language = '', since = 'daily' } = {}) {

  const data = await fetch(

    `${GITHUB_URL}/trending/developers/${language}?since=${since}`

  );

  const $ = cheerio.load(await data.text());

  return $('.explore-content li')

    .get()

    .map(dev => {

      const $dev = $(dev);

      const relativeUrl = $dev.find('.f3 a').attr('href');

      const name = getMatchString(

        $dev

          .find('.f3 a span')

          .text()

          .trim(),

        /^\((.+)\)$/i

      );

      $dev.find('.f3 a span').remove();

      const username = $dev

        .find('.f3 a')

        .text()

        .trim();

      const $repo = $dev.find('.repo-snipit');

      return omitNil({

        username,

        name,

        url: `${GITHUB_URL}${relativeUrl}`,

        avatar: removeDefaultAvatarSize($dev.find('img').attr('src')),

        repo: {

          name: $repo

            .find('.repo-snipit-name span.repo')

            .text()

            .trim(),

          description:

            $repo

              .find('.repo-snipit-description')

              .text()

              .trim() || /* istanbul ignore next */ '',

          url: `${GITHUB_URL}${$repo.attr('href')}`,

},

});

});
}
複製程式碼

Trending列表雲函式

// 雲函式入口函式
exports.main = async (event, context) => {
  const { type, language, since } = event
  let res = null;
  let date = new Date()
  if (type === 'repositories') {
    const cacheKey = `repositories::${language || 'nolang'}::${since ||
    'daily'}`;
    const cacheData = await db.collection('repositories').where({
      cacheKey: cacheKey
    }).orderBy('cacheDate', 'desc').get()
    if (cacheData.data.length !== 0 &&
      ((date.getTime() - cacheData.data[0].cacheDate)  < 1800 * 1000)) {
      res = JSON.parse(cacheData.data[0].content)
    } else {
      res = await fetchRepositories({ language, since });
      await db.collection('repositories').add({
        data: {
          cacheDate: date.getTime(),
          cacheKey: cacheKey,
          content: JSON.stringify(res)
        }
      })
    }
  } else if (type === 'developers') {
    const cacheKey = `developers::${language || 'nolang'}::${since || 'daily'}`;
    const cacheData = await db.collection('developers').where({
      cacheKey: cacheKey
    }).orderBy('cacheDate', 'desc').get()
    if (cacheData.data.length !== 0 &&
      ((date.getTime() - cacheData.data[0].cacheDate)  < 1800 * 1000)) {
      res = JSON.parse(cacheData.data[0].content)
    } else {
      res = await fetchDevelopers({ language, since });
      await db.collection('developers').add({
        data: {
          cacheDate: date.getTime(),
          cacheKey: cacheKey,
          content: JSON.stringify(res)
        }
      })
    }
  }
  return {
    data: res
  }
}
複製程式碼

Markdown解析

嗯，這是一個大坑。

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

wxParse：作者最後一次提交已是兩年前了，經過自己的嘗試，也確實發現已經不適合如README.md的解析
wemark：一款很優秀的微信小程式Markdown渲染庫，但經過筆者嘗試之後，發現對README.md的解析並不完美
towxml：目前發現是微信小程式最完美的Markdown渲染庫，已經能近乎完美的對README.md進行解析並展示

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

Markdown解析雲函式

const Towxml = require('towxml');
const towxml = new Towxml();

// 雲函式入口函式
exports.main = async (event, context) => {
  const { func, type, content } = event
  let res
  if (func === 'parse') {
    if (type === 'markdown') {
      res = await towxml.toJson(content || '', 'markdown');
    } else {
      res = await towxml.toJson(content || '', 'html');
    }
  }
  return {
    data: res
  }
}
複製程式碼

markdown.js元件

import Taro, { Component } from '@tarojs/taro'
import PropTypes from 'prop-types'
import { View, Text } from '@tarojs/components'
import { AtActivityIndicator } from 'taro-ui'

import './markdown.less'

import Towxml from '../towxml/main'

const render = new Towxml()

export default class Markdown extends Component {
  static propTypes = {
    md: PropTypes.string,
    base: PropTypes.string
  }

  static defaultProps = {
    md: null,
    base: null
  }

  constructor(props) {
    super(props)
    this.state = {
      data: null,
      fail: false
    }
  }

  componentDidMount() {
    this.parseReadme()
  }

  parseReadme() {
    const { md, base } = this.props
    let that = this
    wx.cloud.callFunction({
      // 要呼叫的雲函式名稱
      name: 'parse',
      // 傳遞給雲函式的event引數
      data: {
        func: 'parse',
        type: 'markdown',
        content: md,
      }
    }).then(res => {
      let data = res.result.data
      if (base && base.length > 0) {
        data = render.initData(data, {base: base, app: this.$scope})
      }
      that.setState({
        fail: false,
        data: data
      })
    }).catch(err => {
      console.log('cloud', err)
      that.setState({
        fail: true
      })
    })
  }

  render() {
    const { data, fail } = this.state
    if (fail) {
      return (
        <View className='fail' onClick={this.parseReadme.bind(this)}>
          <Text className='text'>load failed, try it again?</Text>
        </View>
      )
    }
    return (
      <View>
      {
        data ? (
          <View>
            <import src='../towxml/entry.wxml' />
            <template is='entry' data='{{...data}}' />
          </View>
        ) : (
          <View className='loading'>
            <AtActivityIndicator size={20} color='#2d8cf0' content='loading...' />
          </View>
        )
      }
      </View>
    )
  }
}
複製程式碼

Redux

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

// 獲取個人資訊
export const getUserInfo = createApiAction(USERINFO, (params) => api.get('/user', params))
複製程式碼

export function createApiAction(actionType, func = () => {}) {
  return (
    params = {},
    callback = { success: () => {}, failed: () => {} },
    customActionType = actionType,
  ) => async (dispatch) => {
    try {
      dispatch({ type: `${customActionType  }_request`, params });
      const data = await func(params);
      dispatch({ type: customActionType, params, payload: data });

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

      callback.failed && callback.failed({ payload: e })
    }
  }
}
複製程式碼

  getUserInfo() {
    if (hasLogin()) {
      userAction.getUserInfo().then(()=>{
        Taro.hideLoading()
        Taro.stopPullDownRefresh()
      })
    } else {
      Taro.hideLoading()
      Taro.stopPullDownRefresh()
    }
  }

const mapStateToProps = (state, ownProps) => {
  return {
    userInfo: state.user.userInfo
  }
}
export default connect(mapStateToProps)(Index)
複製程式碼

export default function user (state = INITIAL_STATE, action) {
  switch (action.type) {
    case USERINFO:
      return {
        ...state,
        userInfo: action.payload.data
      }
    default:
      return state
  }
}
複製程式碼

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

4. 結語篇

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

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

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

Gitter：高顏值GitHub小程式客戶端誕生記
2019-02-01
Github客戶端
基於 Electron + React 的超高顏值喜馬拉雅客戶端 - Mob 誕生記
2019-05-13
React客戶端
一個高顏值Flutter版WanAndroid客戶端
2020-04-11
FlutterNaNAndroid客戶端
高顏值、多平臺、功能強大的redis客戶端
2022-03-28
Redis客戶端
github客戶端使用
2016-07-06
Github客戶端
客戶端筆記
2021-01-03
客戶端筆記
總理答中外記者，在“國務院客戶端”小程式就能看
2020-05-28
客戶端
GitHub Windows客戶端無法登入
2014-01-13
GithubWindows客戶端
github客戶端fork的簡單教程
2017-12-14
Github客戶端
HttpClient客戶端網路程式設計——高可用、高併發
2021-02-09
HTTPclient客戶端程式設計
使用Flutter開發Github客戶端及學習歷程的小結
2019-06-27
FlutterGithub客戶端
小程式原生高顏值元件庫--ColorUI元件庫
2019-02-28
元件UI
爆款小程式是如何誕生的?
2018-04-09
客戶端儲存筆記
2017-04-26
客戶端筆記
為何我們要用 React 來寫小程式 - Taro 誕生記
2018-06-25
React
IE客戶客戶端程式開發的利器Bindows
2003-10-12
客戶端
PathToGo 誕生記
2018-03-02
Go
Javascript誕生記
2011-06-24
JavaScript
「iOS」高仿【少數派】客戶端程式碼+思路講解
2017-11-26
iOS客戶端
胖客戶端程式總結
2014-11-26
客戶端
C++客戶端程式（socket）
2013-07-02
C++客戶端
一隻優雅的小爬蟲誕生記
2019-01-28
爬蟲
parceljs 中文文件24小時誕生記
2017-12-08
JS
《C程式設計伴侶》誕生記
2012-08-13
C程式程式設計
Java OAuth 2.0 客戶端程式設計（二）: 客戶端憑據授權
2015-08-13
JavaOAuth客戶端程式設計
Eureka高可用叢集服務端和客戶端配置
2023-02-25
服務端客戶端
淘寶客戶端安全生產體系建設
2021-12-01
客戶端
.net客戶端呼叫activeMQ程式碼
2009-11-23
客戶端MQ
ElasticSearch 高階 REST 客戶端翻譯（待續......)
2018-07-15
ElasticsearchREST客戶端
Flutter 開發一個 GitHub 客戶端 | 掘金技術徵文
2018-07-19
FlutterGithub客戶端
Redis學習筆記（十）客戶端
2020-05-18
Redis筆記客戶端
筆記：MMM客戶端啟動流程
2014-02-27
筆記客戶端
ORACLE 中記錄客戶端MAC地址
2014-11-08
Oracle客戶端Mac
dubbo客戶端
2018-11-07
客戶端
Pulsar客戶端
2018-12-03
客戶端
mqtt 客戶端
2020-09-25
MQQT客戶端
golang實現tcp客戶端服務端程式
2020-12-27
GolangTCP客戶端服務端
[BI專案記]-搭建程式碼管理環境之客戶端
2015-05-23
客戶端