前言
用Node做前後端分離帶來了性能與流程上的優勢,但也伴隨不少挑戰。在淘寶複雜的業務與技術架構下,後端必須依賴Java搭建基礎架構並提供業務接口,而Node最重要的工作之一就是代理這些接口,方便前端整合數據做頁面渲染。如何做好代理、讓前後端開發分離後仍能在流程上無縫銜接,正是本文要探討的問題。

由於後端接口方式多種多樣,開發者編寫Node訪問代碼的方式也可能各異。如果不及時做統一處理,就會帶來一系列問題:
每個人各寫各的接口訪問代碼,工程目錄與編碼風格混亂,維護困難;各自實現mock數據,開發完還要手動移除;為切換日常、預發、線上環境各自維護配置;接口調用方式無法在各業務model間便捷復用;接口描述約定散落代碼各處,易與後端文檔不一致;分離開發後聯調與測試回歸成本依然很高。
於是我們希望有一個框架,能統一描述並管理項目依賴的所有外部接口,提供靈活的建模與調用方式,並支持便捷的多環境切換,讓前後端無縫結合。ModelProxy正是這樣一個輕量級框架,它是Midway Framework的核心構件之一,也可單獨使用。
接口訪問代碼編寫方式統一、含義清晰,降低維護難度;內部採用工廠+單例模式,一次配置多次復用,並可自由定制組裝業務Model(依賴注入);可便捷切換線上、日常、預發環境;內置river-mock、mockjs等mock引擎;用接口配置文件統一管理接口依賴描述;支持浏覽器端共享Model,代理過程對浏覽器透明;配置文件本身是結構化描述文檔,可用River工具集自動生成文檔並做自動化測試,形成開發閉環。

開發者先按指定json格式,把項目依賴的後端接口描述寫入 interface.json,必要時為每個接口編寫規則文件(interface rules),用於開發階段mock數據或聯調階段用River驗證。配置完成後,即可按需創建業務model。
第一步,在工程目錄創建接口配置文件 interface.json:
{
"title": "pad淘寶項目數據接口集合定義",
"version": "1.0.0",
"engine": "mockjs",
"rulebase": "./interfaceRules/",
"status": "online",
"interfaces": [ {
"name": "主搜索接口",
"id": "Search.getItems",
"urls": {
"online": "https://s.m.taobao.com/client/search.do"
}
} ]
}
第二步,在代碼中創建並使用model:
// 引入模塊
var ModelProxy = require( 'modelproxy' );
// 全局初始化引入接口配置文件(初始化工作有且只有一次)
ModelProxy.init( './interface.json' );
// 創建model
var searchModel = new ModelProxy( {
searchItems: 'Search.getItems' // 自定義方法名: 配置文件中的接口ID
} );
// 使用model,參數即實際接口所需參數
searchModel.searchItems( { q: 'iphone6' } )
.done( function( data ) {
console.log( data );
} )
.error( function( err ) {
console.log( err );
} );
用接口ID創建,取ID最後'.'後的單詞作方法名:
ModelProxy.create( 'Search.getItem' );
用鍵值JSON對象,自定義方法名:
ModelProxy.create( {
getName: 'Session.getUserName',
getMyCarts: 'Cart.getCarts'
} );
用數組形式,取最後'.'後的單詞作方法名(生成 Cart_getItem、getItem、suggest、getName):
ModelProxy.create( [ 'Cart.getItem', 'Search.getItem', 'Search.suggest', 'Session.User.getName' ] );
前綴形式,所有滿足前綴的接口ID會被引入,並取後半部分作方法名:
ModelProxy.create( 'Search.*' );
var model = new ModelProxy( 'Search.*' );
model.suggest( { q: '女' } )
.list( { keyword: 'iphone6' } )
.getNav( { key: '流行服裝' } )
.done( function( data1, data2, data3 ) {
// 參數順序與方法調用順序一致
console.log( data1, data2, data3 );
} );
var model = new ModelProxy( {
getUser: 'Session.getUser',
getMyOrderList: 'Order.getOrder'
} );
model.getUser( { sid: 'fdkaldjfgsakls0322yf8' } )
.done( function( data ) {
var uid = data.uid;
this.getMyOrderList( { id: uid } )
.done( function( data ) {
console.log( data );
} );
} );
ModelProxy不僅能在Node端使用,也能在浏覽器端使用,只需引入官方提供的 modelproxy-client.js:
<!-- 引入modelproxy模塊,該模塊由KISSY封裝為標準模塊-->
<script src="modelproxy-client.js" ></script>
<script type="text/javascript">
KISSY.use( "modelproxy", function( S, ModelProxy ) {
// 配置基礎路徑,與攔截路徑一致,全局配置有且只有一次
ModelProxy.configBase( '/model/' );
var searchModel = ModelProxy.create( 'Search.*' );
searchModel
.list( { q: 'ihpone6' } )
.list( { q: '沖鋒衣' } )
.suggest( { q: 'i' } )
.getNav( { q: '滑板' } )
.done( function( data1, data2, data3, data4 ) {
console.log( {
"list_ihpone6": data1,
"list_沖鋒衣": data2,
"suggest_i": data3,
"getNav_滑板": data4
} );
} );
} );
</script>
ModelProxy還能配合Midway另一核心組件Midway-XTPL,實現數據、模板與渲染過程在浏覽器端和服務器端的全共享。更多詳情可查閱官方文檔。
ModelProxy以配置化的輕量級姿態存在,提供友好的接口model組裝與使用方式,很好地解決了前後端分離中的接口使用規範問題。整個開發過程中,接口只需定義描述一次,前端即可引用,並借助River工具自動生成文檔、與後端形成契約並做自動化測試,極大優化了軟件工程流程。
【注】River是阿裡集團研發的前後端統一接口規範及相關工具集合的統稱。