系統(tǒng)架構(gòu)設(shè)計說明書

北京泛在時代教育技術(shù)有限責(zé)任公司安徽電大資源庫系統(tǒng)架構(gòu)設(shè)計說明書北京泛在時代教育技術(shù)有限責(zé)任公司安徽電大資源庫系統(tǒng)架構(gòu)設(shè)計說明書1安徽電大資源庫系統(tǒng)架構(gòu)設(shè)計說明書版本歷史編號日期版本變更說明作者審批16月21日V1.0創(chuàng)建文檔楊榮峰目錄1. 第一章概述 31.1. 設(shè)計原則 31.1.1. 規(guī)范性原則 31.1.2. 標(biāo)準(zhǔn)化原則 31.1.3. 先進性原則 31.1.4. 開放性原則 31.1.5. 靈活性原則 41.2. 設(shè)計目標(biāo) 41.2.1. 高可用性與高可靠性 41.2.2. 高安全性 41.2.3. 高可擴展性 52. 第二章響應(yīng)數(shù)據(jù)包格式規(guī)范 55.1. Json輸出格式 55.2. 錯誤響應(yīng)輸出格式 65.3. 輸出格式示例 63. 第六章錯誤碼定義 74. 第七章API接口細則 8

第一章概述設(shè)計原則規(guī)范性原則本系統(tǒng)設(shè)計與開發(fā)必須遵循國家相關(guān)法律、法規(guī)，尤其是有關(guān)涉及計算機信息系統(tǒng)建設(shè)的有關(guān)標(biāo)準(zhǔn)要求，遵循安徽省有關(guān)計算機信息系統(tǒng)建設(shè)的有關(guān)標(biāo)準(zhǔn)和規(guī)范要求。本系統(tǒng)的資源，需要支持國家元數(shù)據(jù)標(biāo)準(zhǔn)GB/T21365-2008和LOM（LearningObjectMetadate，學(xué)習(xí)對象元數(shù)據(jù)）標(biāo)準(zhǔn)。本系統(tǒng)轉(zhuǎn)碼時，資源編碼相關(guān)技術(shù)標(biāo)準(zhǔn)參照《安徽廣播電視大學(xué)課程資源建設(shè)技術(shù)標(biāo)準(zhǔn)（試行）》（皖電大資[2018]5號）文件執(zhí)行。標(biāo)準(zhǔn)化原則本系統(tǒng)在設(shè)計時應(yīng)盡量使用現(xiàn)有的已經(jīng)被標(biāo)準(zhǔn)化的技術(shù)，以保證技術(shù)上的先進性和擴展性，而且使用符合所采用標(biāo)準(zhǔn)(包括國際標(biāo)準(zhǔn)和國內(nèi)標(biāo)準(zhǔn))的第三方軟件和工具以降低設(shè)計的工作量和風(fēng)險。先進性原則本系統(tǒng)技術(shù)架構(gòu)的設(shè)計及所選主體產(chǎn)品的技術(shù)架構(gòu)具有先進及前瞻性，所選主體產(chǎn)品在技術(shù)上處于領(lǐng)先水平、技術(shù)相對成熟，以保證在將來較長的一段時間內(nèi)系統(tǒng)不會落伍，支持企業(yè)不斷發(fā)展。開放性原則本系統(tǒng)在設(shè)計時應(yīng)盡量使用通用、標(biāo)準(zhǔn)化技術(shù)與規(guī)范，保證本系統(tǒng)與外部系統(tǒng)間數(shù)據(jù)共享與互操作采用統(tǒng)一、標(biāo)準(zhǔn)、開放的編程接口。靈活性原則隨著安徽電大的業(yè)務(wù)發(fā)展，對本系統(tǒng)的要求也將必然隨之變化，為保證系統(tǒng)能夠快速響應(yīng)業(yè)務(wù)的變化，保證對業(yè)務(wù)的持續(xù)支持，系統(tǒng)需要建設(shè)在一個靈活的技術(shù)架構(gòu)基礎(chǔ)之上。系統(tǒng)的靈活性對業(yè)務(wù)變化的適應(yīng)主要包括兩個方面：一個是業(yè)務(wù)需求的變化，包括業(yè)務(wù)流程、業(yè)務(wù)類別的變化等；另一個是業(yè)務(wù)量的變化，包括業(yè)務(wù)數(shù)據(jù)、發(fā)生頻率的變化等。當(dāng)上述變化發(fā)生時，系統(tǒng)應(yīng)能夠保證短時間、低成本、高質(zhì)量的進行調(diào)整。設(shè)計目標(biāo)高可用性與高可靠性根據(jù)系統(tǒng)的重要程度，制定最高可靠性級別；避免單點故障，在任何時候都需要保本系統(tǒng)的正常使用(網(wǎng)絡(luò)接入備份、應(yīng)用系統(tǒng)雙機、存儲系統(tǒng)鏡像等等)；做到本系統(tǒng)和外部系統(tǒng)的單一接口連接，并對該接口建立良好的安全監(jiān)控機制；當(dāng)使用用戶增長時，可以動態(tài)擴展服務(wù)器的多個層面，包括應(yīng)用服務(wù)器、數(shù)據(jù)庫服務(wù)器的均衡負(fù)載集群。高安全性代碼安全保障（輸入驗證、身份權(quán)證、授權(quán)、配置管理、敏感數(shù)據(jù)、加密、參數(shù)操作、異常管理、審核和記錄等等）；對敏感的核心功能采用HTTPS協(xié)議加密安全傳輸通道，確保傳輸安全；內(nèi)部系統(tǒng)和外部系統(tǒng)的單一接口連接，并對該接口建立良好的安全監(jiān)控機制；敏感的業(yè)務(wù)數(shù)據(jù)、用戶數(shù)據(jù)或身份驗證/授權(quán)數(shù)據(jù)加密，或放置私有網(wǎng)絡(luò)；基于OAuth2.0協(xié)議實現(xiàn)用戶訪問控制，與基于角色的權(quán)限控制(RBAC)；當(dāng)使用用戶增長時，可以動態(tài)擴展服務(wù)器的多個層面，包括應(yīng)用服務(wù)器、數(shù)據(jù)庫服務(wù)器的均衡負(fù)載；對系統(tǒng)運行狀況與用戶操作日志進行監(jiān)控;數(shù)據(jù)備份恢復(fù)。高可擴展性本系統(tǒng)的伸縮性架構(gòu)最重要的技術(shù)手段就是使用集群功能。在完備的軟件設(shè)計構(gòu)架基礎(chǔ)上，通過不斷地向集群中添加服務(wù)器來增強整個集群的處理能力。作為一個不斷發(fā)展中的應(yīng)用系統(tǒng)，系統(tǒng)設(shè)計時需要考慮到系統(tǒng)不斷擴展的要求，以形成一個易于管理、可持續(xù)發(fā)展的體系結(jié)構(gòu)。設(shè)計范圍本系統(tǒng)架構(gòu)設(shè)計說明書的設(shè)計范圍如下表所示：分類名稱描述功能需求業(yè)務(wù)功能滿足業(yè)務(wù)要求的功能集合及實現(xiàn)方案，業(yè)務(wù)功能集合應(yīng)與需求匹配。技術(shù)功能提供底層技術(shù)支撐的功能集合及其實現(xiàn)方案，技術(shù)功能集合服務(wù)于業(yè)務(wù)功能。數(shù)據(jù)庫存儲配置信息和業(yè)務(wù)數(shù)據(jù)的數(shù)據(jù)架構(gòu)。非功能需求高可用性保障應(yīng)用系統(tǒng)和數(shù)據(jù)庫穩(wěn)定可靠運行的技術(shù)方案。性能保障實現(xiàn)應(yīng)用系統(tǒng)和數(shù)據(jù)庫良好運行性能的技術(shù)策略?？蓴U展性支持應(yīng)用系統(tǒng)和數(shù)據(jù)庫具有良好擴充性的技術(shù)方案。第二章總體架構(gòu)本系統(tǒng)由基礎(chǔ)平臺、業(yè)務(wù)組件與客戶端工具三部分構(gòu)成。基礎(chǔ)平臺是本系統(tǒng)運行的基礎(chǔ)，它不僅提供用戶身份驗證、行為數(shù)據(jù)采集、消息傳遞、視頻轉(zhuǎn)碼等底層服務(wù)來支撐業(yè)務(wù)功能的實現(xiàn)，而且也提供不同類型的交互框架完成業(yè)務(wù)功能的應(yīng)用；業(yè)務(wù)組件是本系統(tǒng)業(yè)務(wù)功能的最終實現(xiàn)，它基于基礎(chǔ)平臺提供的服務(wù)構(gòu)建，并宿主于平臺的交互框架中提供業(yè)務(wù)功能；客戶端工具雖然是本系統(tǒng)的一個構(gòu)成部分，但可以完全獨立于本系統(tǒng)，它的主要職能是為本系統(tǒng)作相應(yīng)的輔助工作。本系統(tǒng)的總體架構(gòu)如下圖所示：由上圖可見，在本系統(tǒng)的總體架構(gòu)中，除基礎(chǔ)平臺、業(yè)務(wù)組件和客戶端工具之外，還有一套數(shù)據(jù)庫。因為數(shù)據(jù)庫是本系統(tǒng)三個組成部分的底層數(shù)據(jù)支撐，不單獨存在，所以不視為本系統(tǒng)的獨立構(gòu)成部分。基礎(chǔ)平臺基礎(chǔ)平臺以平臺方式為本系統(tǒng)提供系統(tǒng)運行的基礎(chǔ)環(huán)境?；A(chǔ)平臺擁有數(shù)據(jù)、功能兩類基礎(chǔ)服務(wù)，為業(yè)務(wù)組件提供數(shù)據(jù)訪問、業(yè)務(wù)支撐等底層接口，用于提高通用功能的復(fù)用度，降低業(yè)務(wù)組件實現(xiàn)的復(fù)雜度；基礎(chǔ)平臺在為業(yè)務(wù)組件提供基礎(chǔ)服務(wù)的同時也實現(xiàn)對業(yè)務(wù)組件的管理配置；最終，這些業(yè)務(wù)組件將被裝配在基礎(chǔ)平臺提供的交互框架中，實現(xiàn)與終端用戶的界面交互?；A(chǔ)平臺的總體架構(gòu)如下圖所示：數(shù)據(jù)服務(wù)基礎(chǔ)平臺中的數(shù)據(jù)服務(wù)由數(shù)據(jù)訪問服務(wù)和數(shù)據(jù)交換服務(wù)兩類服務(wù)組成。數(shù)據(jù)訪問服務(wù)用于實現(xiàn)對單個數(shù)據(jù)庫的讀寫操作；數(shù)據(jù)交換服務(wù)用于實現(xiàn)多個數(shù)據(jù)庫之間的數(shù)據(jù)交換。數(shù)據(jù)服務(wù)的詳細組成如下表所示：分類名稱描述數(shù)據(jù)訪問服務(wù)直接訪問組件按照微軟標(biāo)準(zhǔn)的數(shù)據(jù)訪問規(guī)范，通過SQL語句直接對數(shù)據(jù)庫進行數(shù)據(jù)讀寫操作的組件實體訪問組件按照微軟標(biāo)準(zhǔn)的XML實體數(shù)據(jù)訪問規(guī)范，以對象的方式對XML實體文件進行操作的組件數(shù)據(jù)交換服務(wù)服務(wù)器內(nèi)交換組件單服務(wù)器內(nèi)進行數(shù)據(jù)交換的存儲過程或組件服務(wù)器間交換組件多服務(wù)器間進行數(shù)據(jù)交換的SSIS包（低頻、定時）即時運行接口即時運行交換組件的服務(wù)接口定時運行引擎按計劃調(diào)度執(zhí)行交換組件的服務(wù)，使用數(shù)據(jù)庫的代理計劃調(diào)度設(shè)定執(zhí)行周期的組件，使用數(shù)據(jù)庫的計劃任務(wù)功能服務(wù)業(yè)務(wù)服務(wù)交互框架業(yè)務(wù)組件業(yè)務(wù)組件建立在基礎(chǔ)平臺之上，是一組用于資源庫系統(tǒng)業(yè)務(wù)管理的程序集，分為數(shù)據(jù)維護類組件、管理應(yīng)用類組件、應(yīng)用展現(xiàn)類組件，統(tǒng)計報表組件和對外接口。數(shù)據(jù)維護類組件用于對沒有業(yè)務(wù)邏輯的字典數(shù)據(jù)、配置數(shù)據(jù)、規(guī)則數(shù)據(jù)的維護，此類數(shù)據(jù)需要預(yù)先維護供其他組件使用。管理應(yīng)用類組件一般對有業(yè)務(wù)邏輯關(guān)系的數(shù)據(jù)進行管理，此類數(shù)據(jù)都有很明確的數(shù)據(jù)流向，最終服務(wù)于應(yīng)用展現(xiàn)。應(yīng)用展現(xiàn)類組件提供資源分類展示、資源搜索、資源播放、資源評價、資源分享、資源統(tǒng)計分析等功能，是本系統(tǒng)核心價值所在。統(tǒng)計報表組件依據(jù)數(shù)據(jù)源不同分為源數(shù)據(jù)報表和分析報表，通過對業(yè)務(wù)數(shù)據(jù)的加工，以報表的方式呈現(xiàn)給管理者，用于管理監(jiān)控、決策分析。對外接口是業(yè)務(wù)組件與外部數(shù)據(jù)交互的紐帶，通過對外接口實現(xiàn)本系統(tǒng)與外部系統(tǒng)的數(shù)據(jù)交互。業(yè)務(wù)組件具體劃分見下圖：客戶端工具數(shù)據(jù)庫第三章功能架構(gòu)基礎(chǔ)平臺后臺引擎服務(wù)接口系統(tǒng)管理業(yè)務(wù)交互業(yè)務(wù)組件基礎(chǔ)數(shù)據(jù)與報表管理應(yīng)用應(yīng)用展現(xiàn)客戶端工具第四章技術(shù)架構(gòu)系統(tǒng)平臺層操作系統(tǒng)平臺本系統(tǒng)的操作系統(tǒng)平臺采用微軟WindowsServer2012R2。操作系統(tǒng)是最底層的應(yīng)用系統(tǒng)運行環(huán)境，操作系統(tǒng)的性能是影響應(yīng)用系統(tǒng)性能的關(guān)鍵因素。WindowsServer2012R2完全基于64位技術(shù)，在性能和管理等方面，系統(tǒng)的整體優(yōu)勢非常明顯。本系統(tǒng)不但利用了WindowsServer2012R2的性能優(yōu)勢，而且也利用了WindowsServer2012R2的很多服務(wù)特性。這些特性包括：使用WindowsServer2012R2的IIS部署Web服務(wù)器；使用WindowsService部署后臺引擎；使用群集實現(xiàn)雙機負(fù)載均衡和故障轉(zhuǎn)移。應(yīng)用服務(wù)平臺本系統(tǒng)的應(yīng)用服務(wù)平臺采用微軟.NetFramework。.NetFramework為高效開發(fā)提供了可能，它提供超過4500個類，封裝了全功能的特性，例如XML，數(shù)據(jù)訪問，文件上傳，正則表達式，圖像生成，性能監(jiān)測與記錄，事務(wù)處理，消息隊列，SMTP發(fā)信等。利用這些特性，本系統(tǒng)開發(fā)人員只需專注于撰寫應(yīng)用程序的業(yè)務(wù)邏輯代碼，并且通過這些少量的業(yè)務(wù)邏輯代碼即可實現(xiàn)應(yīng)用要求。采用.NetFramework不但可以減少項目開發(fā)的周期，而且還支持開發(fā)人員構(gòu)建不同類型的混合應(yīng)用程序。無論是ASP.NET應(yīng)用程序，Windows窗體應(yīng)用程序，Windows服務(wù)，分布式應(yīng)用程序，.NetFramework均提供統(tǒng)一IDE進行開發(fā)和整合。數(shù)據(jù)庫服務(wù)平臺本系統(tǒng)的數(shù)據(jù)庫服務(wù)平臺采用微軟SQLServer2012R2。在常規(guī)應(yīng)用系統(tǒng)中，數(shù)據(jù)庫會是性能的最大瓶頸，高性能的數(shù)據(jù)庫引擎將是應(yīng)用系統(tǒng)高效運行的保障。SQLServer2012R2不僅提供了64位的高性能查詢引擎，也提供了包括分區(qū)表、優(yōu)化向?qū)У忍岣邤?shù)據(jù)庫性能的手段，利用這些方法，將有效保證本系統(tǒng)的性能。資源數(shù)據(jù)是本系統(tǒng)的核心，在保障系統(tǒng)高效運行的情況下，也要保證系統(tǒng)穩(wěn)定運行、數(shù)據(jù)安全可靠。SQLServer2012R2提供了鏡像、故障轉(zhuǎn)移群集、日志傳送等高可用手段保證本系統(tǒng)的服務(wù)高可用性和數(shù)據(jù)高安全性。技術(shù)框架層技術(shù)框架層為本系統(tǒng)提供底層的組件集，保證應(yīng)用系統(tǒng)開發(fā)只需專注于業(yè)務(wù)邏輯的實現(xiàn)，而不需要關(guān)心過多技術(shù)底層。技術(shù)框架層所提供的組件集涵蓋應(yīng)用系統(tǒng)的四個層次，包括：用于數(shù)據(jù)庫的數(shù)據(jù)訪問組件、用于中間層的任務(wù)調(diào)度、消息隊列中間件、用于表