微信小程式專案重構之Redux狀態管理

Coolgirl_FE發表於2018-01-15
微信小程式Redux

1.以往處理狀態的一些方式

第一種：App上掛globalData 這種方式就是直接寫在App裡面啦，取值賦值比較方便

App.js
App({
  globalData: {
    name: '前端學者'，
    // ...other globalData
  },
  // ...other globalData
});

// 取值
var name = getApp().globalData.name;
// 賦值
getApp().globalData.name = '改個名字';
複製程式碼

第二種：自己定義一個或者多個用於儲存資料的libData檔案，自己造輪子，愛折騰的就直接擼吧

例如libData.js
module.exports = {
  name: '前端學者'，
    // ...other globalData
}
// ...other

// 簡單使用
var store = require('./path/to/lib/libData.js');
// 取值
var name = store.name;
// 賦值
store.name = '改個名字';
複製程式碼

第三種：把要使用的資料存在頁面data或者直接存在頁面上，比較分散而且不利於管理和維護，但是對於超小且需要快速實現的專案也足夠了。別笑，我們前端不怕這樣寫，O(∩_∩)O哈哈~

dataInPage.js
Page({
  data: {
    name: '前端學者'
  },
  name: '前端學者'
});

// 取值
var name = this.data.name;
var name = this.name;
// 賦值
this.setData('name', '改個名字');
this.name = '改個名字');
複製程式碼

2.對於處理狀態資料，有時候可能還會混著使用上面的幾種方式，隨著專案複雜度提升，狀態將難以管理。

所以呢，我們需要借鑑web端現有的一些優秀成熟的方案，今天的主角就是它了，大家都可能很熟悉，歡迎Redux出場！網上各類的資料已經很詳細地介紹，不清楚的同學務必瞭解Redux，這裡只詳細說明一下怎麼在小程式裡面使用，和在React中的用法非常相似，因為核心庫mina-redux.js(原名wechat-weapp-redux)的作者就是這麼改過來的，這個輪子已經非常棒了。下面直接上程式碼了，程式碼雖然多，但具有實站參考價值，所以直接貼上來了。

不使用任何構建工具，把微信開發者工具中專案設定的鉤子全部打上，大方地使用import和export吧，現在不需要自己寫構建了

  • ES6 轉 ES5
  • 上傳程式碼時樣式自動補全
  • 程式碼上傳時自動壓縮
  • 不校驗安全域名、TLS版本以及HTTPS證照

核心還是Redux，和幾個好用的相關庫，這幾個都是從網上精簡了拿過來的，沒有用到npm等包管理工具

lib資料夾下：
  • redux.js(核心檔案，必選)
  • redux-logger(core.js, deep-diff.js, defaults.js, diff.js, helpers.js, index.js 這些都是為了列印日誌用的，可選)
  • redux-thunk.js(非同步action中間處理，推薦)
  • mina-redux.js(核心檔案，把redux的dispatch和倉庫資料同步到頁面上，必選)
  • remote-redux-devtool.js(遠端除錯使用，可以直觀看到資料流向，非常強大，可選)
  • remotedev-server.js(遠端除錯服務，可選，方便除錯)
  • regenerator-runtime.js(facebook的非同步庫，與redux沒有任何關係，可選，極力推薦)
先寫redux相關的type action reducer
app.redux.js (個人喜好把type action reducer寫在一個檔案)
/**
 * 處理小程式生命週期和載入的一些資料
 */
import regeneratorRuntime from '../lib/regenerator-runtime';
import util from '../lib/util';
import api from '../lib/api';
import { minaScecne } from '../config/config';

const WX_SYSTEM_INFO = 'WX_SYSTEM_INFO';
const WX_USER_INFO = 'WX_USER_INFO';
const WX_ON_LAUNCH = 'WX_ON_LAUNCH';

const WX_GET_CODE = 'WX_GET_CODE';
const WX_API_PROMISIFY = 'WX_API_PROMISIFY';

const LOGIN_BEGIN = 'LOGIN_BEGIN';
const LOGIN_PENDING = 'LOGIN_PENDING';
const LOGIN_SUCCESS = 'LOGIN_SUCCESS';
const LOGIN_FAIL = 'LOGIN_FAIL';

// 用法1
// 不用中介軟體，一個action每次只能dispatch一個action
export const wxApiPromisify = () => ({
  type: WX_API_PROMISIFY,
  data: util.initWxMethod()
})

export const wxSystemInfo = (data) => ({
  type: WX_SYSTEM_INFO,
  data: data
})

export const wxUserInfo = (data) => ({
  type: WX_USER_INFO,
  data: data
})

export const wxOnLaunch = (data = {}) => {
  const { scene, query, path } = data;
  Object.keys(minaScecne).map((item => {
    if (scene.toString() === item) {
      data.sceneText = minaScecne[item]
    }
  }));
  return {
    type: WX_ON_LAUNCH,
    data: data
  }
}

// 用法2
// app上以store.dispatch(actionMethodName)的方式呼叫，可以組合action
export const login = async dispatch => {
  const wxLoginResult = await wx.async.login();
  await dispatch({
    type: WX_GET_CODE,
    data: wxLoginResult
  })
  await dispatch({
    type: LOGIN_BEGIN,
    data: {
      isFetching: false
    }
  })
  await dispatch({
    type: LOGIN_PENDING,
    data: {
      isFetching: true
    }
  })
  if(wxLoginResult.code){
    try {
      const apiLoginResult = await api.user.login({ code: wxLoginResult.code });
      await dispatch({
        type: LOGIN_SUCCESS,
        data: apiLoginResult
      })
      wx.setStorageSync('token', apiLoginResult.data.token)
    } catch (error) {
      await dispatch({
        type: LOGIN_FAIL,
        data: error
      })
    }
  } else {
    await dispatch({
      type: LOGIN_FAIL,
      data: wxLoginResult.errMsg
    })
  }
}

// 用法3
// 使用thunk中介軟體可以對一個action進行細化出多個狀態，比如請求，可以做用於處理ui loading
// TODO 寫個request action helper 封裝一下，不用每次寫那麼多...
export const thunkExampleAction = () => (
  async dispatch => {
    const wxLoginResult = await wx.async.login();
    await dispatch({
      type: WX_GET_CODE,
      data: wxLoginResult
    })
    await dispatch({
      type: LOGIN_BEGIN,
      data: {
        isFetching: false
      }
    })
    await dispatch({
      type: LOGIN_PENDING,
      data: {
        isFetching: true
      }
    })
    if(wxLoginResult.code){
      try {
        const apiLoginResult = await api.user.login({ code: wxLoginResult.code });
        await dispatch({
          type: LOGIN_SUCCESS,
          data: apiLoginResult
        })
        wx.setStorageSync('token', apiLoginResult.data.token)
      } catch (error) {
        await dispatch({
          type: LOGIN_FAIL,
          data: error
        })
      }
    } else {
      await dispatch({
        type: LOGIN_FAIL,
        data: wxLoginResult.errMsg
      })
    }
  }
);

// 倉庫資料結構預定義
const initState = {
  wxApiPromisify: {
    isFinish: false
  },
  wxSystemInfo: {},
  wxUserInfo: {},
  wxOnLaunch: {},
  wxLogin: {
    code: null,
    token: null,
    userId: null,
    phone: null,
    errMsg: null
  },
  userLogin: {
    isFetching: false,
    data: null
  }
};

export const appReducer = (state = initState, action) => {
  switch (action.type) {
    case WX_API_PROMISIFY:
      return Object.assign({}, state, { wxApiPromisify: { isFinish: action.data } });
    case WX_GET_CODE:
      return Object.assign({}, state, { wxLogin: action.data });
    case WX_SYSTEM_INFO:
      return Object.assign({}, state, { wxSystemInfo: action.data});
    case WX_USER_INFO:
      return Object.assign({}, state, { wxUserInfo: action.data});
    case WX_ON_LAUNCH:
      return Object.assign({}, state, { wxOnLaunch: action.data});
    case LOGIN_BEGIN:
      var userLogin = action.data;
      userLogin.isFetching = false;
      return Object.assign({}, state, { userLogin });
    case LOGIN_PENDING:
      var userLogin = action.data;
      userLogin.isFetching = true;
      return Object.assign({}, state, { userLogin });
    case LOGIN_SUCCESS:
      var userLogin = action.data;
      userLogin.isFetching = false;
      return Object.assign({}, state, { userLogin });
    case LOGIN_FAIL:
      var userLogin = action.data;
      userLogin.isFetching = false;
      return Object.assign({}, state, { userLogin });
    default:
      return state;
  }
};
複製程式碼
app.js 小程式啟動入口
import regeneratorRuntime from './lib/regenerator-runtime';
import util from './lib/util';  // 自定義的工具庫
import { createStore, applyMiddleware, combineReducers, compose } from './lib/redux';
import thunk from './lib/redux-thunk';
import { Provider } from './lib/mina-redux';

// 所有的reducer 主要分為小程式相關和業務相關兩類
import { appReducer } from './redux/app.redux';
import { channelReducer } from './redux/channel.redux';
import { practiceReducer } from './redux/practice.redux';

// 小程式專案常用的操作相關action，如處理小程式啟動option，小程式api Promise化，系統資訊，小程式使用者資訊，api登入等
import { wxOnLaunch, wxApiPromisify, wxSystemInfo, wxUserInfo, login } from './redux/app.redux';

import composeWithDevTools from './lib/remote-redux-devtool';
import logger from './lib/redux-logger/index';

// 建立倉庫
export const store = createStore(combineReducers({
  appReducer,
  channelReducer,
  practiceReducer,
}), compose(
  applyMiddleware(thunk, logger),
  composeWithDevTools({ hostname: '127.0.0.1', port: 8080, secure: false })
));


App(Provider(store)({
  async onLaunch(option) {
    // 處理小程式啟動option
    store.dispatch(wxOnLaunch(option));
    
    // 小程式api Promise化
    store.dispatch(wxApiPromisify());

    // 獲取小程式系統資訊
    store.dispatch(wxSystemInfo(wx.getSystemInfoSync()));

    // 獲取小程式使用者資訊
    store.dispatch(wxUserInfo(await wx.async.getUserInfo()));

    // 使用者登入(小程式登入 + api登入)
    login(store.dispatch);
  }
}));
複製程式碼
home.js 頁面
import regeneratorRuntime from '../../lib/regenerator-runtime';
import util from '../../lib/util';
import { connect } from '../../lib/mina-redux';
import { getChannelList } from '../../redux/channel.redux';

const pageConfig = {
  data: {
    userLogin: {
      data: null,
    },
    channelList: {
      data: [],
      isFetching: false,
    }
  },
  async onLoad(option) {
    try {
      console.log(` ${getCurrentPages().slice(-1)[0]['__route__']} onLoad`);
      util.initPageOnLoad.call(this, option);

      wx.showLoading({
        title: '載入中...',
        mask: true,
      });

      // 首先一切後端一切api呼叫必須在登入後，這裡首先等待app生命週期裡面拿到登入許可權token
      await util.waitfor(this.data, ['userLogin', 'data', 'token'], 0, null, 50);

      // 之後就可以愉快地進行各種api資料流了，
      await this.getChannelList();
      wx.hideLoading();
    } catch (error) {
      console.error(` `, error);
      // TODO
    }
  }
}

// 定義頁面上的data，這個是自動注入到page data上的，需要什麼就用什麼，據說小程式有page data的效能瓶頸，按需注入吧
const mapStateToPage = state => ({
  ...state.appReducer,
  ...state.channelReducer,
});

// 定義頁面上的方法，直接this.actionName(param)就可以了呼叫了
const mapDispatchToPage = dispatch => ({
  getChannelList: async () => {
    await dispatch(getChannelList());
  }
});

// 串起來
const nextConfig = connect(mapStateToPage, mapDispatchToPage)(pageConfig);

Page(nextConfig);
複製程式碼

3.雖然程式碼很長，看起來可能很不爽，但是個人覺得已經比之前優雅多了，稍微熟悉一下就好，最後看下最終效果(^__^) 嘻嘻……

先開啟除錯，然後瀏覽器訪問http://localhost:8080即可，或者使用Redux DevTools除錯外掛
$ npm install -g remotedev-server 
$ remotedev --hostname=localhost --port=8080

[Busy] Launching SocketCluster
   [Active] SocketCluster started
            Version: 6.8.0
            Environment: dev
            WebSocket engine: uws
            Port: 8080
            Master PID: 14961
            Worker count: 1
            Broker count: 1
複製程式碼
微信開發者工具 AppData pages/home/home 資料截圖

微信小程式專案重構之Redux狀態管理

微信開發者工具 Console 日誌截圖

微信小程式專案重構之Redux狀態管理

Redux RemoteDev 工具 state資料結構Chart圖

微信小程式專案重構之Redux狀態管理

Redux RemoteDev 工具 action時間軸及Tree結構

微信小程式專案重構之Redux狀態管理

Redux RemoteDev 工具 Log monitor

微信小程式專案重構之Redux狀態管理

Redux DevTools具有很多強大的功能，如傳說中的“時光穿梭”等，可以實現很多很好玩的功能

THANKS

[教程]微信小程式整合Redux，引入豐富周邊工具

相關文章