新聞中心
前言
使用Node做前后端分離的開發(fā)模式帶來了一些性能及開發(fā)流程上的優(yōu)勢(見《前后端分離的思考與實踐 一》), 但同時也面臨不少挑戰(zhàn)。在淘寶復雜的業(yè)務及技術架構下,后端必須依賴Java搭建基礎架構,同時提供相關業(yè)務接口供前端使用。Node在整個環(huán)境中最重要的工作之一就是代理這些業(yè)務接口,以方便前端(Node端和瀏覽器端)整合數(shù)據(jù)做頁面渲染。如何做好代理工作,使得前后端開發(fā)分離之后,仍然可以在流程上無縫銜接,是我們需要考慮的問題。本文將就該問題做相關探討,并提出解決方案。

創(chuàng)新互聯(lián)公司長期為1000+客戶提供的網(wǎng)站建設服務,團隊從業(yè)經(jīng)驗10年,關注不同地域、不同群體,并針對不同對象提供差異化的產(chǎn)品和服務;打造開放共贏平臺,與合作伙伴共同營造健康的互聯(lián)網(wǎng)生態(tài)環(huán)境。為寧蒗企業(yè)提供專業(yè)的成都網(wǎng)站建設、網(wǎng)站制作,寧蒗網(wǎng)站改版等技術服務。擁有十載豐富建站經(jīng)驗和眾多成功案例,為您定制開發(fā)。
由于后端提供的接口方式可能多種多樣,同時開發(fā)人員在編寫Node端代碼訪問這些接口的方式也有可能多種多樣。如果我們在接口訪問方式及使用上不做統(tǒng)一架構處理,則會帶來以下一些問題:
1. 每一個開發(fā)人員使用各自的代碼風格編寫接口訪問代碼,造成工程目錄及編碼風格混亂,維護相對困難。
2. 每一個開發(fā)人員編寫自己的mock數(shù)據(jù)方式,開發(fā)完畢之后,需要手工修改代碼移除mock。
3. 每一個開發(fā)人員為了實現(xiàn)接口的不同環(huán)境切換(日常,預發(fā),線上),可能各自維護了一些配置文件。
4. 數(shù)據(jù)接口調(diào)用方式無法被各個業(yè)務model非常方便地復用。
5. 對于數(shù)據(jù)接口的描述約定散落在代碼的各個角落,有可能跟后端人員約定的接口文檔不一致。
6. 整個項目分離開發(fā)之后,對于接口的聯(lián)調(diào)或者測試回歸成本依然很高,需要涉及到每一個接口提供者和使用者。
于是我們希望有這樣一個框架,通過該框架提供的機制去描述工程項目中依賴的所有外部接口,對他們進行統(tǒng)一管理,同時提供靈活的接口建模及調(diào)用方式,并且提供便捷的線上環(huán)境和生產(chǎn)環(huán)境切換方法,使前后端開發(fā)無縫結合。ModelProxy就是滿足這樣要求的輕量級框架,它是Midway Framework 核心構件之一,也可以單獨使用。使用ModelProxy可以帶來如下優(yōu)點:
1. 不同的開發(fā)者對于接口訪問代碼編寫方式統(tǒng)一,含義清晰,降低維護難度。
2. 框架內(nèi)部采用工廠+單例模式,實現(xiàn)接口一次配置多次復用。并且開發(fā)者可以隨意定制組裝自己的業(yè)務Model(依賴注入)。
3. 可以非常方便地實現(xiàn)線上,日常,預發(fā)環(huán)境的切換。
4. 內(nèi)置river-mock和mockjs等mock引擎,提供mock數(shù)據(jù)非常方便。
5. 使用接口配置文件,對接口的依賴描述做統(tǒng)一的管理,避免散落在各個代碼之中。
6. 支持瀏覽器端共享Model,瀏覽器端可以使用它做前端數(shù)據(jù)渲染。整個代理過程對瀏覽器透明。
7. 接口配置文件本身是結構化的描述文檔,可以使用river工具集合,自動生成文檔。也可使用它做相關自動化接口測試,使整個開發(fā)過程形成一個閉環(huán)。
ModelProxy工作原理圖及相關開發(fā)過程圖覽
在上圖中,開發(fā)者首先需要將工程項目中所有依賴的后端接口描述,按照指定的json格式,寫入interface.json配置文件。必要時,需要對每個接口編寫一個規(guī)則文件,也即圖中interface rules部分。該規(guī)則文件用于在開發(fā)階段mock數(shù)據(jù)或者在聯(lián)調(diào)階段使用River工具集去驗證接口。規(guī)則文件的內(nèi)容取決于采用哪一種mock引擎(比如 mockjs, river-mock 等等)。配置完成之后,即可在代碼中按照自己的需求創(chuàng)建自己的業(yè)務model。
下面是一個簡單的例子:
【例一】
- ***步 在工程目錄中創(chuàng)建接口配置文件interface.json, 并在其中添加主搜接口json定義
- {
- "title": "pad淘寶項目數(shù)據(jù)接口集合定義",
- "version": "1.0.0",
- "engine": "mockjs",
- "rulebase": "./interfaceRules/",
- "status": "online",
- "interfaces": [ {
- "name": "主搜索接口",
- "id": "Search.getItems",
- "urls": {
- "online": "http://s.m.taobao.com/client/search.do"
- }
- } ]
- }
- 第二步 在代碼中創(chuàng)建并使用model
- // 引入模塊
- var ModelProxy = require( 'modelproxy' );
- // 全局初始化引入接口配置文件 (注意:初始化工作有且只有一次)
- ModelProxy.init( './interface.json' );
- // 創(chuàng)建model 更多創(chuàng)建模式請參后文
- var searchModel = new ModelProxy( {
- searchItems: 'Search.getItems' // 自定義方法名: 配置文件中的定義的接口ID
- } );
- // 使用model, 注意: 調(diào)用方法所需要的參數(shù)即為實際接口所需要的參數(shù)。
- searchModel.searchItems( { q: 'iphone6' } )
- // !注意 必須調(diào)用 done 方法指定回調(diào)函數(shù),來取得上面異步調(diào)用searchItems獲得的數(shù)據(jù)!
- .done( function( data ) {
- console.log( data );
- } )
- .error( function( err ) {
- console.log( err );
- } );
#p#
ModelProxy的功能豐富性在于它支持各種形式的profile以創(chuàng)建需要業(yè)務model:
- 使用接口ID創(chuàng)建>生成的對象會取ID***’.'號后面的單詞作為方法名
- ModelProxy.create( 'Search.getItem' );
使用鍵值JSON對象>自定義方法名: 接口ID
- ModelProxy.create( {
- getName: 'Session.getUserName',
- getMyCarts: 'Cart.getCarts'
- } );
- 使用數(shù)組形式>取*** . 號后面的單詞作為方法名
下例中生成的方法調(diào)用名依次為: Cart_getItem, getItem, suggest, getName
- ModelProxy.create( [ 'Cart.getItem', 'Search.getItem', 'Search.suggest', 'Session.User.getName' ] );
- 前綴形式>所有滿足前綴的接口ID會被引入對象,并取其后半部分作為方法名
- ModelProxy.create( 'Search.*' );
同時,使用這些Model,你可以很輕易地實現(xiàn)合并請求或者依賴請求,并做相關模板渲染
【例二】 合并請求
- var model = new ModelProxy( 'Search.*' );
- // 合并請求 (下面調(diào)用的model方法除done之外,皆為配置接口id時指定)
- model.suggest( { q: '女' } )
- .list( { keyword: 'iphone6' } )
- .getNav( { key: '流行服裝' } )
- .done( function( data1, data2, data3 ) {
- // 參數(shù)順序與方法調(diào)用順序一致
- console.log( data1, data2, data3 );
- } );
【例三】 依賴請求
- var model = new ModelProxy( {
- getUser: 'Session.getUser',
- getMyOrderList: 'Order.getOrder'
- } );
- // 先獲得用戶id,然后再根據(jù)id號獲得訂單列表
- model.getUser( { sid: 'fdkaldjfgsakls0322yf8' } )
- .done( function( data ) {
- var uid = data.uid;
- // 二次數(shù)據(jù)請求依賴***次取得的id號
- this.getMyOrderList( { id: uid } )
- .done( function( data ) {
- console.log( data );
- } );
- } );
此外ModelProxy不僅在Node端可以使用,也可以在瀏覽器端使用。只需要在頁面中引入官方包提供的modelproxy-client.js即可。
【例四】瀏覽器端使用ModelProxy
同時,ModelProxy可以配合Midway另一核心組件Midway-XTPL一起使用,實現(xiàn)數(shù)據(jù)和模板以及相關渲染過程在瀏覽器端和服務器端的全共享。關于ModelProxy的詳細教程及文檔請移步https://github.com/purejs/modelproxy
總結
ModelProxy以一種配置化的輕量級框架存在,提供友好的接口model組裝及使用方式,同時很好的解決前后端開發(fā)模式分離中的接口使用規(guī)范問題。在整個項目開發(fā)過程中,接口始終只需要定義描述一次,前端開發(fā)人員即可引用,同時使用River工具自動生成文檔,形成與后端開發(fā)人員的契約,并做相關自動化測試,極大地優(yōu)化了整個軟件工程開發(fā)過程。
【注】River 是阿里集團研發(fā)的前后端統(tǒng)一接口規(guī)范及相關工具集合的統(tǒng)稱
網(wǎng)頁題目:Midway-ModelProxy — 輕量級的接口配置建模框架
網(wǎng)站路徑:http://fisionsoft.com.cn/article/ccedgpj.html


咨詢
建站咨詢
