2020年技術(shù)架構(gòu)規(guī)范

1、1 引言1.1 目的通過對系統(tǒng)整體架構(gòu)和技術(shù)規(guī)范的描述，為下一步大規(guī)模設(shè)計(jì)開發(fā)提供基礎(chǔ)和規(guī)范。1.2 對象與范圍項(xiàng)目管理人員，開發(fā)人員，測試人員。1.3 概述系統(tǒng)一期，以實(shí)現(xiàn)功能為主，效率性能為輔，但設(shè)計(jì)兼顧未來性能的擴(kuò)展，以減少未來重構(gòu)的工作量。webapp按邏輯分為兩層，第一層用戶服務(wù)接入，第二層內(nèi)部服務(wù)。第一層一期不分模塊，以二級目錄形式表示不同模塊，第二層根據(jù)不同服務(wù)分模塊，第一層和第二層之間使用hessian通信。第一層和第二層獨(dú)立部署，第二層的不同模塊也可以獨(dú)立部署。下一期考慮第一層分模塊的二級域名獨(dú)立部署，并實(shí)現(xiàn)單點(diǎn)登錄。web app采用集群負(fù)載均衡，數(shù)據(jù)庫采用負(fù)載均衡和讀寫分

2、離，以滿足一定的性能需求。 文檔描述了各層結(jié)構(gòu)和模塊使用的技術(shù)和框架。最后描述了開發(fā)的規(guī)范和用到的開發(fā)工具。文檔只是描述了一期的架構(gòu)，2 系統(tǒng)架構(gòu)圖一期系統(tǒng)架構(gòu)如下3 層次和模塊233.1 前端負(fù)載均衡nginx是一個(gè)口碑很好的開源免費(fèi)WEB服務(wù)器，國內(nèi)很多大型網(wǎng)站都轉(zhuǎn)選nginx平臺，比如騰訊，豆瓣等。Nginx可以實(shí)現(xiàn)動靜分離和web app的負(fù)載均衡。3.1.1 動靜分離動靜分離可以很好得分擔(dān)服務(wù)器的負(fù)載，有兩種方式實(shí)現(xiàn)動靜分離。1使用2級域名，配置專門的靜態(tài)文件服務(wù)器。2利用nginx的url轉(zhuǎn)發(fā)功能，把靜態(tài)請求轉(zhuǎn)發(fā)到靜態(tài)服務(wù)器或在nginx本地處理，動態(tài)請求轉(zhuǎn)發(fā)到應(yīng)用服務(wù)器。我們目前

3、部署上采用第二種方式，同時(shí)也實(shí)現(xiàn)第一種方式。系統(tǒng)可以配置動態(tài)服務(wù)器地址和靜態(tài)服務(wù)器地址，在生成頁面時(shí)獲取這兩個(gè)地址，對圖片、js腳本、css和靜態(tài)頁面使用靜態(tài)配置生成url，對ajax請求和動態(tài)頁面使用動態(tài)服務(wù)器地址生成url。3.1.2 負(fù)載均衡nginx可以配置upstream服務(wù)器組，實(shí)現(xiàn)組內(nèi)的負(fù)載均衡。通過ip_hash的方式把動態(tài)請求轉(zhuǎn)發(fā)到組內(nèi)的某臺服務(wù)器，同時(shí)保證客戶端在IP不變的情況下一直訪問同一臺服務(wù)器，解決session保持問題。3.2 Web app網(wǎng)站前端，基于j2ee，spring框架開發(fā)。3.2.1 頁面展示和控制系統(tǒng)有三種頁面方式。1 動態(tài)同步請求，通過veloci

4、ty模板生成頁面，客戶端刷新整個(gè)頁面。2 ajax異步請求。Ajax異步請求又有三種形式：與velocity模板結(jié)合返回html串；返回json格式；直接返回簡單的字符串。3 模板生成的純靜態(tài)頁面前臺頁面采用的框架和第三方技術(shù)有：1 jquery-core （事件處理，ajax請求，頁面刷新）。2 Jqzoom （圖片放大器）3Jquery-validator（輸入驗(yàn)證）3.2.2 權(quán)限安全控制使用apache shiro框架實(shí)現(xiàn)權(quán)限控制。Shiro是一個(gè)強(qiáng)大、使用簡單的權(quán)限安全框架。同時(shí)Shiro也能與cas單點(diǎn)登錄整合，方便在下一期擴(kuò)展多個(gè)應(yīng)用模塊?？蚣馨褭?quán)限系統(tǒng)分成subject（當(dāng)前用

5、戶），manager(管理所有用戶)，realms(權(quán)限數(shù)據(jù))三層。支持基于實(shí)際資源和基于角色的權(quán)限校驗(yàn)，同時(shí)我們擴(kuò)展shiro的UsernamePasswordToken，Realm實(shí)現(xiàn)基于驗(yàn)證碼和數(shù)據(jù)庫用戶密碼的用戶登錄驗(yàn)證。在過濾器層，我們暫時(shí)只使用shiro的3種類型過濾器控制訪問：1AnonymousFilter  匿名過濾器 任何人可以訪問。2AuthenticatingFilter 認(rèn)證過濾器 必須通過身份認(rèn)真才能訪問（跳轉(zhuǎn)到登錄頁面）?？梢詫Ξ?dāng)前subject直接調(diào)用方法完成判斷是否登錄，登錄，注銷等操作，方便對登錄功能的擴(kuò)展。3.2.3 控制器層采用spring 基

6、于注解的控制器，控制器支持velocity視圖返回，ajax json返回和ajax text返回。3.2.4 數(shù)據(jù)驗(yàn)證使用和擴(kuò)展apache的common-validator。3.2.5 邏輯層采用spring基于注解的事務(wù)控制。3.2.6 數(shù)據(jù)持久層采用ibatis框架，基于sqlmap配置實(shí)現(xiàn)數(shù)據(jù)的讀寫，sqlmap配置可以控制底層sql語句，便于數(shù)據(jù)庫的調(diào)優(yōu)。3.2.7 緩存的處理使用緩存可以降低與數(shù)據(jù)庫的交互次數(shù)，極大提高系統(tǒng)性能。我們采用ehcache緩存框架。用到兩種緩存方式：1 頁面緩存：直接在過濾器層對頁面進(jìn)行緩存處理，在過濾器層就可以返回緩存的頁面，不用轉(zhuǎn)到控制器去處理。對

7、于頁面比較復(fù)雜，調(diào)用業(yè)務(wù)邏輯比較多的頁面，采用頁面緩存效果很好，比如首頁。2 基于注解的方法緩存，可以對方法的返回值緩存，存入的參數(shù)可以組成key。可以在邏輯層使用緩存，也可以在持久層試用。對于請求簡單，訪問量大，但修改頻率比較低的數(shù)據(jù)進(jìn)行緩存可以達(dá)到很好的效果。比如商品分類，系統(tǒng)數(shù)據(jù)字典，地區(qū)等數(shù)據(jù)。Ehcache支持分布式緩存，ehcache支持服務(wù)器之間通過rmi調(diào)用保持所有服務(wù)器之間緩存同步。緩存的兩種過期機(jī)制：1 定時(shí)過期，直接通過ehcache的配置確定緩存過期頻率。2 主動通知，管理員在后臺系統(tǒng)進(jìn)行某些操作后，通過hessian遠(yuǎn)程調(diào)用通知應(yīng)用服務(wù)器緩存過期。只需通知一臺應(yīng)用服務(wù)

8、器，應(yīng)用服務(wù)器之間通過ehcache自帶分布式緩存復(fù)制方式同步緩存。后臺管理系統(tǒng)可以提供刷新緩存功能，管理員在后臺管理系統(tǒng)主動刷新緩存。3.2.8 去其他模塊之間的通信通過hessian遠(yuǎn)程調(diào)用框架，實(shí)現(xiàn)與其他模塊功能之間的通信。Hessian是一個(gè)基于http的二進(jìn)制遠(yuǎn)程過程調(diào)用框架，比webservice更高效。與Spring框架很好結(jié)合，開發(fā)簡單。3.3 后臺管理系統(tǒng)管理員用來維護(hù)網(wǎng)站的系統(tǒng)。基于j2ee spring框架。與網(wǎng)站前臺使用到的技術(shù)差不多，現(xiàn)只介紹不同點(diǎn)：3.3.1 頁面的展示大部分請求采用頁面刷新的機(jī)制。頭部，中部左側(cè)菜單和底部固定不變。中部右側(cè)iframe為主操作區(qū)，每

9、次操作刷新頁面。商品描述的編輯需要使用到富文本編輯器，我們采用開源的TinyMCE，TinyMCE在國內(nèi)應(yīng)用比較廣泛。3.3.2 緩存機(jī)制后臺系統(tǒng)訪問不是很頻繁，同事管理員需要的是實(shí)時(shí)的數(shù)據(jù)，所以后臺管理系統(tǒng)不對數(shù)據(jù)進(jìn)行緩存。3.3.3 權(quán)限管理采用sping security框架進(jìn)行權(quán)限的控制，基于用戶、角色和資源的授權(quán)機(jī)制。3.4 支付模塊：支付模塊主要功能是訂單的管理，與銀行等支付系統(tǒng)的交互?；趈2ee spring框架。采用spring mvc模式。3.4.1 與銀行和其他支付系統(tǒng)的交互需要提供一個(gè)Url地址，供銀行在用戶完成支付后回調(diào)，通知系統(tǒng)已經(jīng)支付成功。3.4.2 與內(nèi)部模塊之

10、間的通信主要來自網(wǎng)站前端的調(diào)用?；趆essian機(jī)制。3.5 物流模塊支付模塊目前主要功能是調(diào)用物流公司的接口跟蹤物流狀態(tài)，隨著系統(tǒng)的不斷發(fā)展，在擁有自己的物流后，可能發(fā)展成一個(gè)龐大的系統(tǒng)?；趈2ee spring框架。采用spring mvc模式。基于hessian機(jī)制對外提供遠(yuǎn)程效用服務(wù)。3.6 郵件模塊郵件模塊主要用來向客戶發(fā)送郵件?；趈2ee spring框架。采用spring mvc模式。3.6.1 郵件發(fā)送使用 java mail包發(fā)送郵件，支持以固定模板發(fā)送郵件。3.6.2 定時(shí)發(fā)送使用spring+quartz框架實(shí)現(xiàn)定時(shí)任務(wù)發(fā)送郵件。3.6.3 與內(nèi)部模塊之間的通信為網(wǎng)

11、站前端和后臺管理系統(tǒng)提供遠(yuǎn)程調(diào)用服務(wù)?；趆essian機(jī)制。3.7 短信模塊短信模塊主要用來向客戶發(fā)送短信?；趈2ee spring框架。采用spring mvc模式。3.7.1 郵件發(fā)送調(diào)用短信設(shè)備api發(fā)送短信，支持以固定模板發(fā)送短信。3.7.2 定時(shí)發(fā)送使用spring+quartz框架實(shí)現(xiàn)定時(shí)任務(wù)發(fā)送短信。3.7.3 與內(nèi)部模塊之間的通信為網(wǎng)站前端和后臺管理系統(tǒng)提供遠(yuǎn)程調(diào)用服務(wù)?；趆essian機(jī)制。3.8 進(jìn)銷存模塊調(diào)用A8系統(tǒng)接口，實(shí)現(xiàn)庫存的管理。基于j2ee spring框架。采用spring mvc模式。3.8.1 Web service調(diào)用采用spring+xfile

12、框架調(diào)用a8系統(tǒng)webservice。3.8.2 與內(nèi)部模塊之間的通信為網(wǎng)站前端和后臺管理系統(tǒng)提供遠(yuǎn)程調(diào)用服務(wù)?；趆essian機(jī)制。3.9 搜索模塊為網(wǎng)站提供搜索服務(wù)。包括商品檢索和問答式搜索的問題檢索。基于j2ee spring框架。采用spring mvc模式。3.9.1 檢索框架我們使用國產(chǎn)開源coreSeek搜索引擎，基于俄國開源項(xiàng)目Sphinx研發(fā)并獨(dú)立開發(fā)的搜索引擎。自帶中文分詞器mmseg，有大量中文文檔。提供JAVAAPI。索引建立效率高并且與業(yè)務(wù)無關(guān)。在國內(nèi)有大量成功案例。3.9.2 與內(nèi)部模塊之間的通信為網(wǎng)站前端提供遠(yuǎn)程調(diào)用服務(wù)?；趆essian機(jī)制。3.10 第三方

13、服務(wù)調(diào)用模塊調(diào)用第三方合作服務(wù)商的接口?；趈2ee spring框架。采用spring mvc模式。3.10.1 Web service調(diào)用采用spring+xfile 框架調(diào)用第三方服務(wù)webservice。3.10.2 與內(nèi)部模塊之間的通信為網(wǎng)站前端和后臺管理系統(tǒng)提供遠(yuǎn)程調(diào)用服務(wù)。基于hessian機(jī)制。3.11 對外服務(wù)接口對外部系統(tǒng)提供webservice接口服務(wù)3.11.1 Web service服務(wù)采用spring+xfile 框架對外提供webservice服務(wù)。3.11.2 與內(nèi)部模塊之間的通信調(diào)用內(nèi)部其他模塊的服務(wù)?；趆essian機(jī)制。3.12 數(shù)據(jù)庫使用mysql5.

14、5數(shù)據(jù)庫存儲數(shù)據(jù)，并使用讀寫分離機(jī)制提高數(shù)據(jù)庫性能。3.12.1 數(shù)據(jù)庫讀寫分離我們使用開源的mysql代理Amoeba實(shí)現(xiàn)數(shù)據(jù)庫的讀寫分離，把寫請求發(fā)送到主服務(wù)器，讀請求發(fā)送到從服務(wù)器，主從之間通過mysql自帶的復(fù)制機(jī)制實(shí)現(xiàn)數(shù)據(jù)的同步。3.12.2 數(shù)據(jù)庫負(fù)載均衡Amoeba支持輪詢和權(quán)重兩種負(fù)載均衡機(jī)制，我們使用權(quán)重負(fù)載機(jī)制實(shí)現(xiàn)讀服務(wù)器的負(fù)載均衡。3.12.3 數(shù)據(jù)庫表引擎的選擇主服務(wù)器必須使用innodb支持事務(wù)的存儲引擎，行級鎖表。而從服務(wù)器可以考慮使用myisam引擎，不支持事務(wù)，表級鎖表，具有更高的讀寫效率，但不支持外鍵。3.12.4 主從數(shù)據(jù)庫的差異優(yōu)化主服務(wù)器只需要建立唯一索

15、引和外鍵約束，其它針對對查詢優(yōu)化的索引可以不建立，這要可以提高主服務(wù)器的性能。從服務(wù)器字段使用char而不用varchar，沒有varchar, text, blob字段的表是靜態(tài)表，反之是動態(tài)表，靜態(tài)表的檢索效率要比動態(tài)表好若干倍。4 工程命名工程以動物命名，結(jié)合了各種動物特征與我們各工程的職責(zé)：公共接口工具 magpie（喜鵲） 網(wǎng)站前臺服務(wù) bull（公牛）物流 cheetah （獵豹）支付 lion （獅子）進(jìn)銷存接口  fox（狐貍）搜索 dog （狗）郵件 eagle  （鷹）短信 pigeon （鴿子）后臺管理 horse(馬)調(diào)用第三方合作接口 mouse(

16、老鼠)對外服務(wù)接口  camel(駱駝)5 工程規(guī)范5.1 工程目錄結(jié)構(gòu)src 源碼WebContentWEN-INFlib jar包c(diǎn)onfig 配置文件views 視圖模板layout 布局模板screen 頁面模板 各模塊common 公共的 styles 樣式文件 resources資源文件 scripts js文件common 公共js 各模塊，各開源js項(xiàng)目5.2 包結(jié)構(gòu)包命名基本原則：小寫字母開頭，如果有多個(gè)單詞，除第一個(gè)單詞之外的單詞首字母大寫5.2.1 公共工具接口工程5.2.2 各模塊工程數(shù)據(jù)對象：com.zjdelai.emall.工程名.domain.業(yè)務(wù)子模

17、塊 持久層dao接口：工程名.dao.業(yè)務(wù)子模塊 持久層dao接口實(shí)現(xiàn)： com.zjdelai.emall.工程名.dao.業(yè)務(wù)子模塊.持久層框架名（ibatis） 持久層sqlmap： com.zjdelai.emall.工程名.dbMap.業(yè)務(wù)子模塊.數(shù)據(jù)庫類型(mysql)業(yè)務(wù)邏輯接口： com.zjdelai.emall.工程名.service.業(yè)務(wù)子模塊 業(yè)務(wù)邏輯實(shí)現(xiàn)： com.zjdelai.emall.工程名.service.業(yè)務(wù)子模塊.impl Web控制器action： com. zjdelai.emall.工程名.web.action.業(yè)務(wù)子模塊 Web驗(yàn)證器：com.

18、zjdelai.emall.工程名.web.validator.業(yè)務(wù)子模塊 Web過濾器：com. zjdelai.emall.工程名.web.filter工具：com.zjdelai.emall.工程名.util遠(yuǎn)程調(diào)用接口實(shí)現(xiàn)：com.zjdelai.emall.5.3 類、接口命名類命名基本原則：首字母大寫，多個(gè)單詞的首字母大寫接口命名基本原則：以大寫字母"I"開頭，如果有多個(gè)單詞，每個(gè)單詞頭字母大寫I數(shù)據(jù)對象：數(shù)據(jù)庫表名.javaDao接口： I+數(shù)據(jù)對象名+Dao.javadao實(shí)現(xiàn)：數(shù)據(jù)對象名+Dao+框架名(Ibatis).javasqlmap：數(shù)據(jù)對象名.x

19、ml業(yè)務(wù)邏輯接口：I+數(shù)據(jù)對象名+Manager.java業(yè)務(wù)邏輯實(shí)現(xiàn)：數(shù)據(jù)對象名+ManagerImpl.javaWeb action： domain名+Action.javaWeb validator： domain名+Validator.javaDto：*Dto.java遠(yuǎn)程調(diào)用接口： I+數(shù)據(jù)對象名+Sercice.java遠(yuǎn)程調(diào)用實(shí)現(xiàn)：數(shù)據(jù)對象名+SerciceImpl.java5.4 變量和方法命名類變量、局部變量命名規(guī)范：變量名首字母必須小寫，如果該變量名有多個(gè)單詞組成，后面的單詞首字母大寫，單詞與單詞之間不要使用_做連接。類常量命名規(guī)范：所有字母大寫，如果有多個(gè)單詞組成，單詞與

20、單詞之間以_隔開。而且該變量必須是公共、靜態(tài)、final類型。方法命名規(guī)范：方法名首字母必須小寫，如果該變量名有多個(gè)單詞組成，后面的單詞首字母大寫，單詞與單詞之間不要使用_做連接。方法參數(shù)名命名規(guī)范：參數(shù)名首字母必須小寫，如果該變量名有多個(gè)單詞組成，后面的單詞首字母大寫，單詞與單詞之間不要使用_做連接。5.5 注釋5.5.1 類、接口的注釋類、接口必須要有注釋。描述類、接口的功能，作者，版本，最近修改時(shí)間。類的注釋必須寫在該類的聲明語法之前。在注釋中要描述該類的基本作用，作者，日期，版本。/* * XXXX功能類 * * author XXX * version */5.5.2 類、接口的變量

21、和常量注釋類、接口的變量和常量必須有注釋，變量和常量注釋必須寫在變量和常量定義之前，簡單描述其代表的意義。/* XXXXXX*/5.5.3 類、接口方法注釋方法必須要有注釋，方法注釋必須寫在方法定義之前。該注釋包括：方法其功能的簡單 描述，方法的參數(shù)、返回值類型、返回值意義簡單的描述，跑出異常描述/* * XXXXXX功能 * param a a參數(shù)的意義 * param b b參數(shù)的意義* return 返回類型 返回的意義 * throws XXXX異常 * throws XXXX異常 */5.5.4 邏輯代碼注釋邏輯代碼必須注釋。每個(gè)條件判斷和每個(gè)循環(huán)都需要有注釋。其它關(guān)鍵代碼也需要注釋/* * 當(dāng)XXXX的時(shí)候