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

時間  2019-11-25
標籤 一個 基於 react 整套 技術 node.js node 前端 頁面 製做 工具 欄目 React 简体版
原文   原文鏈接

pagemaker是一個前端頁面製做工具，方便產品，運營和視覺的同窗迅速開發簡單的前端頁面，從而能夠解放前端同窗的工做量。此項目創意來自網易樂得內部項目nfop中的pagemaker項目。原來項目的前端是採用jquery和模板ejs作的，每次組件的更新都會重繪整個dom，性能不是很好。由於當時react特別火，加上項目自己的適合，最後決定採用react來試試水。由於原來整個項目是包含不少子項目一塊兒，因此後臺的實現也沒有參考，徹底重寫。css

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

線上地址前端

1、功能特色

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

2、用到的技術

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

3、腳手架工具

由於項目用的技術比較多，採用腳手架工具能夠省去咱們搭建項目的時間。通過搜索，我發現有三個用的比較多：node

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

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

4、核心代碼分析

1. Store

Store 就是保存數據的地方，你能夠把它當作一個容器。整個應用只能有一個 Store。jquery

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 ，拆不拆分均可以。android

devToolsEnhancer是個中間件（middleware）。用於在開發環境時使用Redux DevTools來調試redux。webpack

2. Action

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

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屬性，還有其餘附帶的信息。git

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演示

本項目中，咱們採用支持 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流程圖

用戶能接觸到的只有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，路由切換交給後臺。

5、使用說明

左邊一欄是組件列表，在移動端點擊左上角的雙右箭頭便可看到。點擊對應的組件，網頁中間會出現相應的組件信息。單擊出來的組件頭，能夠切換展開與隱藏。更新相應的組件信息，在右側能夠看到實時預覽。移動端須要點擊右下角的黃色按鈕（支持拖動）。

在中間區域的最上面有個內容配置區。左邊有導入、導出、清空功能。導入支持支持導入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文件。這個功能是針對管理員的，普通用戶無須理會。

6、兼容性和打包優化

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地址 | 個人博客

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程