一個基於React整套技術棧+Node.js的前端頁面製作工具

Teal發表於2019-03-03
ReactNode.js前端

pagemaker是一個前端頁面製作工具，方便產品，運營和視覺的同學迅速開發簡單的前端頁面，從而可以解放前端同學的工作量。此專案創意來自網易樂得內部專案nfop中的pagemaker專案。原來專案的前端是採用jquery和模板ejs做的，每次元件的更新都會重繪整個dom，效能不是很好。因為當時react特別火，加上專案本身的適合，最後決定採用react來試試水。因為原來整個專案是包含很多子專案一起，所以後臺的實現也沒有參考，完全重寫。

本專案只是原來專案的簡單實現，去除了用的不多和複雜的元件。但麻雀雖小五臟俱全，本專案採用了react的一整套技術棧，適合那些對react有過前期學習，想通過demo來加深理解並動手實踐的同學。建議學習本demo的之前，先學習/複習下相關的知識點：React 技術棧系列教程、Immutable 詳解及 React 中實踐。

線上地址

一、功能特點

  1. 元件豐富。有標題、圖片、按鈕、正文、音訊、視訊、統計、jscss輸入。
  2. 實時預覽。每次修改都可以立馬看到最新的預覽。
  3. 支援三種匯入方式，支援匯出配置檔案。
  4. 支援恢復現場功能(關閉頁面配置不丟失)
  5. 支援Undo/Redo操作。(元件個數發生變化為觸發點)
  6. 可以隨時釋出、修改、刪除已釋出的頁面。
  7. 本專案密碼統一採用bcrypt編碼，即使拖庫也不會洩漏自己的密碼。
  8. 每個頁面都有一個釋出密碼，從而可以方便多人管理也可防止別人修改。
  9. 頁面前端架構採用react+redux，並採用immutable資料結構。可以將每次元件的更新最小化，從而達到頁面效能的最優化。
  10. 後臺對上傳的圖片自動進行壓縮，防止檔案過大
  11. 適配移動端

二、用到的技術

1. 前端

  1. React
  2. Redux
  3. React-Redux
  4. Immutable
  5. React-Router
  6. fetch
  7. es6
  8. es7

2. 後臺

  1. Node
  2. Express

3. 工具

  1. Webpack
  2. Sass
  3. Pug

三、腳手架工具

因為專案用的技術比較多，採用腳手架工具可以省去我們搭建專案的時間。經過搜尋，我發現有三個用的比較多：

  1. create-react-app
    create-react-app star數
    create-react-app star數
  2. react-starter-kit
    react-starter-kit star數
    react-starter-kit star數
  3. react-boilerplate
    react-boilerplate star數
    react-boilerplate star數

github上的star數都很高，第一個是Facebook官方出的react demo。但是看下來，三個專案都比較龐大，引入了很多不需要的功能包。後來搜尋了下，發現一個好用的腳手架工具：yeoman，大家可以選擇相應的generator。我選擇的是react-webpack。專案比較清爽，需要大家自己搭建redux和immutable環境，以及後臺express。其實也好，鍛鍊下自己構建專案的能力。

四、核心程式碼分析

1. Store

Store 就是儲存資料的地方，你可以把它看成一個容器。整個應用只能有一個 Store。

import { createStore } from 'redux';
import { combineReducers } from 'redux-immutable';

import unit from './reducer/unit';
// import content from './reducer/content';

let devToolsEnhancer = null;
if (process.env.NODE_ENV === 'development') {
    devToolsEnhancer = require('remote-redux-devtools');
}

const reducers = combineReducers({ unit });
let store = null;
if (devToolsEnhancer) {
    store = createStore(reducers, devToolsEnhancer.default({ realtime: true, port: config.reduxDevPort }));
}
else {
    store = createStore(reducers);
}
export default store;
複製程式碼

Redux 提供createStore這個函式，用來生成 Store。由於整個應用只有一個 State 物件，包含所有資料，對於大型應用來說，這個 State 必然十分龐大，導致 Reducer 函式也十分龐大。Redux 提供了一個 combineReducers 方法，用於 Reducer 的拆分。你只要定義各個子 Reducer 函式，然後用這個方法，將它們合成一個大的 Reducer。當然，我們這裡只有一個 unit 的 Reducer ，拆不拆分都可以。

devToolsEnhancer是個中介軟體（middleware）。用於在開發環境時使用Redux DevTools來除錯redux。

2. Action

Action 描述當前發生的事情。改變 State 的唯一辦法，就是使用 Action。它會運送資料到 Store。

import Store from '../store';

const dispatch = Store.dispatch;

const actions = {
    addUnit: (name) => dispatch({ type: 'AddUnit', name }),
    copyUnit: (id) => dispatch({ type: 'CopyUnit', id }),
    editUnit: (id, prop, value) => dispatch({ type: 'EditUnit', id, prop, value }),
    removeUnit: (id) => dispatch({ type: 'RemoveUnit', id }),
    clear: () => dispatch({ type: 'Clear'}),
    insert: (data, index) => dispatch({ type: 'Insert', data, index}),
    moveUnit: (fid, tid) => dispatch({ type: 'MoveUnit', fid, tid }),
};

export default actions;
複製程式碼

State 的變化，會導致 View 的變化。但是，使用者接觸不到 State，只能接觸到 View。所以，State 的變化必須是 View 導致的。Action 就是 View 發出的通知，表示 State 應該要發生變化了。程式碼中，我們定義了actions物件，他有很多屬性，每個屬性都是函式，函式的輸出是派發了一個action物件，通過Store.dispatch發出。action是一個包含了必須的type屬性，還有其他附帶的資訊。

3. Immutable

Immutable Data 就是一旦建立，就不能再被更改的資料。對 Immutable 物件的任何修改或新增刪除操作都會返回一個新的 Immutable 物件。詳細介紹，推薦知乎上的Immutable 詳解及 React 中實踐。我們專案裡用的是Facebook 工程師 Lee Byron 花費 3 年時間打造的immutable.js庫。具體的API大家可以去官網學習。

熟悉 React 的都知道，React 做效能優化時有一個避免重複渲染的大招，就是使用 shouldComponentUpdate()，但它預設返回 true，即始終會執行 render() 方法，然後做 Virtual DOM 比較，並得出是否需要做真實 DOM 更新，這裡往往會帶來很多無必要的渲染併成為效能瓶頸。當然我們也可以在 shouldComponentUpdate() 中使用使用 deepCopy 和 deepCompare 來避免無必要的 render()，但 deepCopy 和 deepCompare 一般都是非常耗效能的。

Immutable 則提供了簡潔高效的判斷資料是否變化的方法，只需 ===(地址比較) 和 is( 值比較) 比較就能知道是否需要執行 render()，而這個操作幾乎 0 成本，所以可以極大提高效能。修改後的 shouldComponentUpdate 是這樣的：

import { is } from 'immutable';

shouldComponentUpdate: (nextProps = {}, nextState = {}) => {
  const thisProps = this.props || {}, thisState = this.state || {};

  if (Object.keys(thisProps).length !== Object.keys(nextProps).length ||
      Object.keys(thisState).length !== Object.keys(nextState).length) {
    return true;
  }

  for (const key in nextProps) {
    if (thisProps[key] !== nextProps[key] || ！is(thisProps[key], nextProps[key])) {
      return true;
    }
  }

  for (const key in nextState) {
    if (thisState[key] !== nextState[key] || ！is(thisState[key], nextState[key])) {
      return true;
    }
  }
  return false;
}
複製程式碼

使用 Immutable 後，如下圖，當紅色節點的 state 變化後，不會再渲染樹中的所有節點，而是隻渲染圖中綠色的部分：

immutable演示
immutable演示

本專案中，我們採用支援 class 語法的 pure-render-decorator 來實現。我們希望達到的效果是：當我們編輯元件的屬性時，其他元件並不被渲染，而且preview裡，只有被修改的preview元件update，而其他preview元件不渲染。為了方便觀察元件是否被渲染，我們人為的給元件增加了data-id的屬性，其值為Math.random()的隨機值。效果如下圖所示：

immutable實際效果圖

可見，當我們去改變標題元件標題文字的時候，只有標題元件和標題預覽元件會被重新渲染，其他元件和預覽元件並沒有。這就是immutable帶來的效能提升的地方。原來的專案當元件多了之後，渲染會卡頓，有時候甚至短暫黑屏。

4. Reducer

Store 收到 Action 以後，必須給出一個新的 State，這樣 View 才會發生變化。這種 State 的計算過程就叫做 Reducer。

import immutable from 'immutable';

const unitsConfig = immutable.fromJS({
    META: {
        type: 'META',
        name: 'META資訊配置',
        title: '',
        keywords: '',
        desc: ''
    },
    TITLE: {
        type: 'TITLE',
        name: '標題',
        text: '',
        url: '',
        color: '#000',
        fontSize: "middle",
        textAlign: "center",
        padding: [0, 0, 0, 0],
        margin: [10, 0, 20, 0]
    },
    IMAGE: {
        type: 'IMAGE',
        name: '圖片',
        address: '',
        url: '',
        bgColor: '#fff',
        padding: [0, 0, 0, 0],
        margin: [10, 0, 20, 0]
    },
    BUTTON: {
        type: 'BUTTON',
        name: '按鈕',
        address: '',
        url: '',
        txt: '',
        margin: [
            0, 30, 20, 30
        ],
        buttonStyle: "yellowStyle",
        bigRadius: true,
        style: 'default'
    },
    TEXTBODY: {
        type: 'TEXTBODY',
        name: '正文',
        text: '',
        textColor: '#333',
        bgColor: '#fff',
        fontSize: "small",
        textAlign: "center",
        padding: [0, 0, 0, 0],
        margin: [0, 30, 20, 30],
        changeLine: true,
        retract: true,
        bigLH: true,
        bigPD: true,
        noUL: true,
        borderRadius: true
    },
    AUDIO: {
        type: 'AUDIO',
        name: '音訊',
        address: '',
        size: 'middle',
        position: 'topRight',
        bgColor: '#9160c3',
        loop: true,
        auto: true
    },
    VIDEO: {
        type: 'VIDEO',
        name: '視訊',
        address: '',
        loop: true,
        auto: true,
        padding: [0, 0, 20, 0]
    },
    CODE: {
        type: 'CODE',
        name: 'JSCSS',
        js: '',
        css: ''
    },
    STATISTIC: {
        type: 'STATISTIC',
        name: '統計',
        id: ''
    }
})

const initialState = immutable.fromJS([
    {
        type: 'META',
        name: 'META資訊配置',
        title: '',
        keywords: '',
        desc: '',
        // 非常重要的屬性，表明這次state變化來自哪個元件！
        fromType: ''
    }
]);


function reducer(state = initialState, action) {
    let newState, localData, tmp
    // 初始化從localstorage取資料
    if (state === initialState) {
        localData = localStorage.getItem('config');
        !!localData && (state = immutable.fromJS(JSON.parse(localData)));
        // sessionStorage的初始化
        sessionStorage.setItem('configs', JSON.stringify([]));
        sessionStorage.setItem('index', 0);
    }
    switch (action.type) {
        case 'AddUnit': {
            tmp = state.push(unitsConfig.get(action.name));
            newState = tmp.setIn([0, 'fromType'], action.name);
            break
        }
        case 'CopyUnit': {
            tmp = state.push(state.get(action.id));
            newState = tmp.setIn([0, 'fromType'], state.getIn([action.id, 'type']));
            break
        }
        case 'EditUnit': {
            tmp = state.setIn([action.id, action.prop], action.value);
            newState = tmp.setIn([0, 'fromType'], state.getIn([action.id, 'type']));
            break
        }
        case 'RemoveUnit': {
            const type = state.getIn([action.id, 'type']);
            tmp = state.splice(action.id, 1);
            newState = tmp.setIn([0, 'fromType'], type);
            break
        }
        case 'Clear': {
            tmp = initialState;
            newState = tmp.setIn([0, 'fromType'], 'ALL');
            break
        }
        case 'Insert': {
            tmp = immutable.fromJS(action.data);
            newState = tmp.setIn([0, 'fromType'], 'ALL');
            break
        }
        case 'MoveUnit':{
            const {fid, tid} = action;
            const fitem = state.get(fid);
            if (fitem && fid != tid) {
                tmp = state.splice(fid, 1).splice(tid, 0, fitem);
            } else {
                tmp = state;
            }
            newState = tmp.setIn([0, 'fromType'], '');
            break;
        }
        default:
            newState = state;
    }
    // 更新localstorage，便於恢復現場
    localStorage.setItem('config', JSON.stringify(newState.toJS()));

    // 撤銷，恢復操作(僅以元件數量變化為觸發點，否則儲存資料巨大，也沒必要)
    let index = parseInt(sessionStorage.getItem('index'));
    let configs = JSON.parse(sessionStorage.getItem('configs'));
    if(action.type == 'Insert' && action.index){
        sessionStorage.setItem('index', index + action.index);
    }else{
        if(newState.toJS().length != state.toJS().length){
            // 元件的數量有變化，刪除歷史記錄index指標狀態之後的所有configs，將這次變化的config作為最新的記錄
            configs.splice(index + 1, configs.length - index - 1, JSON.stringify(newState.toJS()));
            sessionStorage.setItem('configs', JSON.stringify(configs));
            sessionStorage.setItem('index', configs.length - 1);
        }else{
            // 元件數量沒有變化，index不變。但是要更新儲存的config配置
            configs.splice(index, 1, JSON.stringify(newState.toJS()));
            sessionStorage.setItem('configs', JSON.stringify(configs));
        }
    }
    
    // console.log(JSON.parse(sessionStorage.getItem('configs')));
    return newState
}

export default reducer;
複製程式碼

Reducer是一個函式，它接受Action和當前State作為引數，返回一個新的State。unitsConfig是儲存著各個元件初始配置的物件集合，所有新新增的元件都從裡邊取初始值。State有一個初始值：initialState，包含META元件，因為每個web頁面必定有一個META資訊，而且只有一個，所以頁面左側元件列表裡不包含它。

reducer會根據action的type不同，去執行相應的操作。但是一定要注意，immutable資料操作後要記得賦值。每次結束後我們都會去修改fromType值，是因為有的元件，比如AUDIO、CODE等修改後，預覽的js程式碼需要重新執行一次才可以生效，而其他元件我們可以不用去執行，提高效能。

當然，我們頁面也做了現場恢復功能(localStorage)，也得益於immutable資料結構，我們實現了Redo/Undo的功能。Redo/Undo的功能僅會在元件個數有變化的時候計作一次版本，否則錄取的的資訊太多，會對效能造成影響。當然，元件資訊發生變化我們是會去更新陣列的。

5. 工作流程

如下圖所示：

redux流程圖
redux流程圖

使用者能接觸到的只有view層，就是元件裡的各種輸入框，單選多選等。使用者與之發生互動，會發出action。React-Redux提供connect方法，用於從UI元件生成容器元件。connect方法接受兩個引數：mapStateToProps和mapDispatchToProps，按照React-Redux的API，我們需要將Store.dispatch(action)寫在mapDispatchToProps函式裡邊，但是為了書寫方便和直觀看出這個action是哪裡發出的，我們沒有遵循這個API，而是直接寫在在程式碼中。

然後，Store 自動呼叫 Reducer，並且傳入兩個引數：當前 State 和收到的 Action。 Reducer 會返回新的 State 。State 一旦有變化，Store 就會呼叫監聽函式。在React-Redux規則裡，我們需要提供mapStateToProps函式，建立一個從（外部的）state物件到（UI元件的）props物件的對映關係。mapStateToProps會訂閱 Store，每當state更新的時候，就會自動執行，重新計算 UI 元件的引數，從而觸發UI元件的重新渲染。大家可以看我們content.js元件的最後程式碼：

export default connect(
    state => ({
        unit: state.get('unit'),
    })
)(Content);
複製程式碼

connect方法可以省略mapStateToProps引數，那樣的話，UI元件就不會訂閱Store，就是說 Store 的更新不會引起 UI 元件的更新。像header和footer元件，就是純UI元件。

為什麼我們的各個子元件都可以拿到state狀態，那是因為我們在最頂層元件外面又包了一層 元件。入口檔案index.js程式碼如下：

import "babel-polyfill";
import React from 'react';
import ReactDom from 'react-dom';
import { Provider } from 'react-redux';
import { Router, Route, IndexRoute, browserHistory } from 'react-router';

import './index.scss';

import Store from './store';

import App from './components/app';

ReactDom.render(
    <Provider store={Store}>
        <Router history={browserHistory}>
            <Route path="/" component={App}>

            </Route>
        </Router>
    </Provider>,
    document.querySelector('#app')
);
複製程式碼

我們的react-router採用的是browserHistory，使用的是HTML5的History API，路由切換交給後臺。

五、使用說明

左邊一欄是元件列表，在移動端點選左上角的雙右箭頭即可看到。點選對應的元件，網頁中間會出現相應的元件資訊。單擊出來的元件頭，可以切換展開與隱藏。更新相應的元件資訊，在右側可以看到實時預覽。移動端需要點選右下角的黃色按鈕（支援拖動）。

在中間區域的最上面有個內容配置區。左邊有匯入、匯出、清空功能。匯入支援支援匯入json配置檔案，這個配置檔案可以在我們配置完準備釋出的時候點選匯出即可生成。還支援直接輸入釋出目錄名稱，比如：lmlc；或者輸入完整的線上地址，比如：https://pagemaker.wty90.com/release/lmlc.html；當然也支援貼上配置檔案內容。清空會清空掉現在的所有配置的元件。內容配置區的右邊是Redo/Undo功能。為了效能考慮，這裡只以元件個數發生變化為觸發點。

右側是預覽區域。中間區域內容一有變化，右側會實時更新展示。當專案配置完成想要釋出的時候，點選右側區域左上角的釋出按鈕，會出現一個彈窗。第一個輸入框是釋出目錄，如果是新專案需要建立釋出密碼。如果要更新已存在的專案，需要確認釋出密碼。平臺密碼是：pagemaker。如需更改，在data資料夾下修改password.json檔案內容的value值。我們採用的是bcrypt編碼。大家可以去BCrypt Calculator網站，方便計算出編碼值。右上角有個檢視按鈕，可以檢視採用 pagemaker 已經發布的頁面。

隱藏功能：點選預覽區域蘋果手機的home鍵，會出現清理無用檔案的彈窗，因為下載檔案會在伺服器端建立一個快取檔案。還有一些使用者上傳的圖片等一直沒有釋出，在伺服器端會一直堆積。這個需要提供後臺密碼，修改同平臺密碼，在data資料夾下的server_code.json檔案。這個功能是針對管理員的，普通使用者無須理會。

六、相容性和打包優化

1. 相容性

為了讓頁面更好的相容IE9+和android瀏覽器，因為專案使用了babel，所以採用babel-polyfill和babel-plugin-transform-runtime外掛。

2. Antd按需載入

Antd完整包特別大，有10M多。而我們專案裡主要是採用了彈窗元件，所以我們應該採用按需載入。只需在.babelrc檔案裡配置一下即可，詳見官方說明。

3. webpack配置externals屬性

專案最後打包的main.js非常大，有接近10M多。在網上搜了很多方法，最後發現webpack配置externals屬性的方法非常好。可以利用pc的多檔案並行下載，降低自己伺服器的壓力和流量，同時可以利用cdn的快取資源。配置如下所示：

externals: {
    "jquery": "jQuery",
    "react": "React",
    "react-dom": "ReactDOM",
    'CodeMirror': 'CodeMirror',
    'immutable': 'Immutable',
    'react-router': 'ReactRouter'
}
複製程式碼

externals屬性告訴webpack，如下的這些資源不進行打包，從外部引入。一般都是一些公共檔案，比如jquery、react等。注意，因為這些檔案從外部引入，所以在npm install的時候，有些依賴這些公共檔案的包安裝會報warning，所以看到這些大家不要緊張。經過處理，main.js檔案大小降到3.7M，然後nginx配置下gzip編碼壓縮，最終將檔案大小降到872KB。因為在移動端，檔案載入還是比較慢的，我又給頁面加了loading效果。

歡迎大家star學習交流：github地址 | 我的部落格

相關文章