前端項目重構的些許收穫

題圖：Pixabay

這個項目開始之初，趕時間上線。不少地方基本沒怎麼管代碼規範，直到一期完畢回過頭來看以前寫的代碼，不忍直視。爲了以後接手的人能更加輕鬆，也爲了本身以後debug更加順手，邊開始二期的部分需求，邊重構一期的部分代碼，仍是有部分收穫。

項目技術棧是：

• nodejs
• javascript
• react
• redux
• react-router
• webpack

以前的架構是react-router2，後面換成了react-router4。代碼看起來更加的模塊化。

入口模塊化

項目自己是一個系統合集，用戶根據權限的不一樣會展現不一樣的菜單導航。目前是有3個部分：

每一個模塊單獨的action、router、reducer與server。

webpack切片打包

entry: {
	index: './index.jsx',
	1: './1/router/index.jsx',
	2: './2/router/index.jsx',
	3: './3/router/index.jsx',
	vendor: [
		'react',
		'react-router-dom',
		'antd',
		'prop-types',
		'react-router-redux',
		'react-redux',
		'redux',
		'lodash',
		'react-dom',
	],
},
複製代碼

路由

根路由只需指向每一個模塊的路由文件便可

<Route path="/" exact component={IndexComponent} />
{/* xxx路由 start */}
<Route path="/xxx1" component={1Layout} />
{/* xxx路由 start */}
<Route path="/xxx2" component={2Layout} />
{/* xxx路由 start */}
<Route path="/xxx3" component={3Layout} />
複製代碼

權限、接口轉發

由於各個系統的後端不是同一批人，部署的機器也不是固定的，因而用 node 作了一層接口轉發，前端頁面訪問固定的地址，而後經過 node 去訪問不一樣的後端機器。同時權限部分須要攜帶cookie跨域，正好 node 一塊兒作了。

測試、正式

這是以前的區分線上線下打包的地址，因爲webpack沒有作過多的設置，因而暫時用這樣的方式區分打包環境。可是我更想用 shell 腳原本區分，能夠更方便的直接調試線上接口。

const isLocal = location.host.indexOf('localhost') === 0;
export const serverUrl = !IS_PRODUCTION ? devUrl : isLocal ? devUrl : `//${location.host}`;
複製代碼

枚舉

前端靜態枚舉值

不容許頁面出現如下字樣：

• 1，2，3 ...int類型
• '成功'，'失敗'，... 等字符類型

// 靜態枚舉值及請求API參數
this._private = {
	dispatch: props.dispatch,
	// 路由方法
	history: props.history,
	// 當前手機系統
	os: '',
	...
};
複製代碼

錯誤碼 ，規範化錯誤提示

const errnoToErrmsg = {
 unknownError: 1001,
 paramLost: 1002,
 paramInvalid: 1003,
 authFailed: 1006,
 signExpired: 1007,
	...
}
複製代碼

狀態值 ，規範前端業務代碼

const xxxStatus = {
	toBeAssigned: '待分配',
	pending: '待處理',
	processing: '處理中',
	processed: '已處理',
	notDealtWith: '不處理',
	description(rawValue) {
		switch (rawValue) {
		case this.toBeAssigned:
			return '1';
		case this.pending:
			return '2';
		case this.processing:
			return '3';
		case this.processed:
			return '4';
		case this.notDealtWith:
			return '5';
		default:
			return '';
		}
	},
};
    
export { FeedbackStatus };
複製代碼

先後端字段映射

前端是駝峯命名法，後端是下劃線「_」，因此須要作一個映射，同時也更加方便debug。暫時用以下笨方法。這一塊寫在node那層比較好。

export const ToFE = {
	errno: 'errno',
	errmsg: 'errmsg',
}
    
export const ToBackup = {
	errno: 'errno',
	errmsg: 'errmsg',
}

import { ToFE, ToBackup } from '../config/define';
    
class Tools {
	/**
	 * isObject
	 * @param {*} data
	 */
	isObject(data) {
		return Object.prototype.toString.call(data) === '[object Object]';
	}
	/**
	 * isArray
	 * @param {*} data
	 */
	isArray(data) {
		return Object.prototype.toString.call(data) === '[object Array]';
	}
	/**
	 * field Transfer
	 * 後端"_"格式字段映射到前端駝峯命名字段
	 * @param {*} data
	 * recursion => 遞歸遍歷對象和數組兩種類型的數據
	 */
	fieldTransfer(data) {
		// 對象類型
		if (this.isObject(data)) {
			return this.objectTransfer(data);
		}
		if (this.isArray(data)) {
			return this.arrTransfer(data);
		}
		return data;
	}
    
	// 對象遍歷
	objectTransfer(data) {
		let result = {};
		for (const item in data) {
			if (this.isObject(data[item])) {
				result[ToFE[`${item}`] || item] = this.objectTransfer(data[item]);
				continue;
			}
			if (this.isArray(data[item])) {
				result[ToFE[`${item}`] || item] = this.arrTransfer(data[item]);
				continue;
			}
			result[ToFE[`${item}`] || item] = data[item];
		}
		return result;
	}
    
	// 數組遍歷
	arrTransfer(data) {
		let result = [];
		for (let i = 0, j = data.length; i < j; i++) {
			if (this.isObject(data[i])) {
				result[i] = this.objectTransfer(data[i]);
				continue;
			}
			if (this.isArray(data[i])) {
				result[i] = this.arrTransfer(data[i]);
				continue;
			}
			result[i] = data[i];
		}
		return result;
	}
    
	// 接口參數對象構建
	buildParams(parameters) {
		if (!this.isObject(parameters)) {
			throw 'parameters must be array object';
		}
		const params = {};
		if (Object.keys(parameters) === 0) {
			return params;
		}
    
		for (let key in parameters) {
			parameters[key] !== '' && (params[ToBackup[key]] = parameters[key]);
		}
		return params;
	}
}
    
export default new Tools();
複製代碼

API層

目前 tools.buildParams(parameters) 這一塊的傳參還在糾結以對象傳仍是以數組傳，以數組傳直接傳 arguments 就能夠，缺點是傳參以黑盒來傳，沒法判斷參數，沒法快速debug；優勢是_fetchxxx裏的參數也不須要列出，直接一個對象就行。 以對象傳須要本身構建，缺點是須要重複寫一次參數；優勢是更加直觀。

/**
 * xxx接口
 * /xxx/v1/xxx/xxx
 * @param {*}
 * firstLevel => (可選參數) => xxx
 * midLevel => (可選參數) => xxx
 * lastLevel => (可選參數) => xxx
 * startAt => (可選參數) => xxx
 * endAt => (可選參數) => xxx
 */
export const _fetchxxx = ({
	firstLevel = '',
	midLevel = '',
	lastLevel = '',
	startAt = '',
	endAt = '',
}) => {
	const parameters = { firstLevel, midLevel, lastLevel, startAt, endAt };
	const params = tools.buildParams(parameters);
	return request(`${xxx}xxx/xxx`, {
		method: 'post',
		body: qs.stringify(params),
	}).then(data => tools.fieldTransfer(data));
};
複製代碼

緩存

統一緩存命名規範，防止緩存衝突

class LocalStorage {
 set(key, val) {
 window.localStorage && localStorage.setItem(key, JSON.stringify(val));
 }
 get(key) {
 return window.localStorage && JSON.parse(localStorage.getItem(key));
 }
 remove(key) {
 window.localStorage && localStorage.removeItem(key);
 }
 sSet(key, val) {
 window.sessionStorage && sessionStorage.setItem(key, JSON.stringify(val));
 }
 sGet(key) {
 return window.sessionStorage && JSON.parse(sessionStorage.getItem(key));
 }
 sRemove(key) {
 window.sessionStorage && sessionStorage.removeItem(key);
 }
}
    
let Storage = new LocalStorage();
    
Storage.KEYS = {
 TOKEN: 'TOKEN',
 PV_KEY: 'PV_KEY'
};
    
Object.freeze && Object.freeze(Storage.KEYS);
    
export default Storage;
複製代碼

Feature

• 模塊按需加載，自定義各模塊間通訊機制
• 模塊註冊腳手架，前端接入提供註冊工具，模塊單獨部署，動態註冊，獨立 CDN。編譯由服務端統一執行
• 服務端項目代碼自身預編譯，提升執行性能、下降部署風險
• 編譯結果統一保存，支持按分支名切換、回滾

Flag

還有不少好玩的東西能夠搞，每一次的優化都是對自身的一次重構。2018 fighting！！！