軟件架構(gòu)設(shè)計(jì)說(shuō)明書(shū)

<XXX>架構(gòu)設(shè)計(jì)說(shuō)明書(shū)的請(qǐng)?jiān)谑褂们膀?yàn)證版本正確性龍杰科技版本說(shuō)明作者審核修訂日期1。0發(fā)布Dick本識(shí)生效日期 本識(shí)生效日期 本識(shí)生效日期[對(duì)于由多個(gè)進(jìn)程構(gòu)成的復(fù)雜系統(tǒng)，系統(tǒng)設(shè)計(jì)階段可以分為：架構(gòu)設(shè)計(jì)(構(gòu)架設(shè)計(jì))、組件高層設(shè)計(jì)、組件詳細(xì)設(shè)計(jì).對(duì)于由單個(gè)進(jìn)程構(gòu)成的簡(jiǎn)單系統(tǒng),系統(tǒng)設(shè)計(jì)階段可以分為:系統(tǒng)概要設(shè)計(jì)、系統(tǒng)詳細(xì)設(shè)計(jì)。本文檔適用于由多個(gè)進(jìn)程構(gòu)成的復(fù)雜系統(tǒng)的構(gòu)架設(shè)計(jì)。][架構(gòu)設(shè)計(jì)說(shuō)明書(shū)是軟件產(chǎn)品設(shè)計(jì)中最高層次的文檔，它描述了系統(tǒng)最高層次上的邏輯結(jié)構(gòu)、物理結(jié)構(gòu)以及各種指南，相關(guān)組件(粒度最粗的子系統(tǒng))的內(nèi)部設(shè)計(jì)由組件高層設(shè)計(jì)提供。][系統(tǒng)：指待開(kāi)發(fā)產(chǎn)品的軟件與硬件整體，其軟件部分由各個(gè)子系統(tǒng)嵌套組成，子系統(tǒng)之間具有粒度最粗的子系統(tǒng)；模塊：指組成組件的各層子系統(tǒng),模塊由下一層模塊或函數(shù)組成；]1)描述產(chǎn)品的邏輯結(jié)構(gòu),定義系統(tǒng)各組件(子系統(tǒng))之間的接口以及每個(gè)組件(子系統(tǒng))應(yīng)該2)定義系統(tǒng)的各個(gè)進(jìn)程以及進(jìn)程之間的通信方式；3)描述系統(tǒng)部署，說(shuō)明用來(lái)部署并運(yùn)行該系統(tǒng)的一種或多種物理網(wǎng)絡(luò)(硬件)配置。對(duì)于每種配置，應(yīng)該指出執(zhí)行該系統(tǒng)的物理節(jié)點(diǎn)(計(jì)算機(jī)、網(wǎng)絡(luò)設(shè)備)配置情況、節(jié)點(diǎn)之間的連接方式、采用何種通信協(xié)議、網(wǎng)絡(luò)帶寬。另外還要包括各進(jìn)程到物理節(jié)點(diǎn)的映射;4)系統(tǒng)的整體性能、安全性、可用性、可擴(kuò)展性、異常與錯(cuò)誤處理等非功能特性設(shè)計(jì)；5)定義該產(chǎn)品的各個(gè)設(shè)計(jì)人員應(yīng)該遵循的設(shè)計(jì)原則以及設(shè)計(jì)指南，各個(gè)編程人員應(yīng)該遵循]與組件設(shè)計(jì)工程師共同完成此文檔。][架構(gòu)設(shè)計(jì)說(shuō)明書(shū)的引言應(yīng)提供整個(gè)文檔的概述.它應(yīng)包括此文檔的目的、范圍、定義、首字母縮eof本識(shí)生效日期1.1目的[簡(jiǎn)要描述體系結(jié)構(gòu)文檔的目的.]1.2范圍[簡(jiǎn)要說(shuō)明此文檔的范圍:它的相關(guān)項(xiàng)目以及受到此文檔影響的任何其它事物]預(yù)期的讀者和閱讀建議[說(shuō)明此文檔的閱讀對(duì)象，簡(jiǎn)要說(shuō)明此文檔中其它章節(jié)包含的內(nèi)容與文檔組織方式，對(duì)于不同讀閱讀方式建議。目標(biāo)讀者是系統(tǒng)最終用戶(hù)、系統(tǒng)分析員、項(xiàng)目經(jīng)理、產(chǎn)品經(jīng)理、市場(chǎng)人員等。本項(xiàng)目的組織架構(gòu)和參與人員如下：參與開(kāi)發(fā)策劃，負(fù)責(zé)批準(zhǔn)項(xiàng)目開(kāi)發(fā)計(jì)劃書(shū)；安排項(xiàng)目組成人員握；確定項(xiàng)目進(jìn)度及檢驗(yàn)標(biāo)準(zhǔn)了解開(kāi)發(fā)中存在問(wèn)題,并及時(shí)制定相應(yīng)對(duì)策.負(fù)責(zé)制訂軟件標(biāo)準(zhǔn).件的維護(hù)。評(píng)估將在其中部署項(xiàng)目最終產(chǎn)品的目標(biāo)組織的情況。協(xié)調(diào)目標(biāo)組織的建模工作。在必要時(shí)對(duì)業(yè)務(wù)工程工作進(jìn)行討論和協(xié)調(diào).本識(shí)生效日期對(duì)目標(biāo)組織中所建議的任何變更進(jìn)行成本效益分析.負(fù)責(zé)獲取用戶(hù)最終需求，概括系統(tǒng)的功能和界定系統(tǒng)來(lái)領(lǐng)導(dǎo)和協(xié)調(diào)需求獲取及用例建模，編寫(xiě)《XXX新版本軟件詳細(xì)設(shè)計(jì)》，制訂命名規(guī)范。軟件構(gòu)架設(shè)計(jì),劃分子模塊并詳細(xì)描述各模塊功能、要求,和測(cè)試要點(diǎn)。對(duì)軟件架構(gòu)中重要的類(lèi)做詳細(xì)說(shuō)明,描述其屬性、方法、和相互之間的關(guān)系。數(shù)據(jù)庫(kù)設(shè)計(jì)，包括定義表、索引、視圖、約束條件、觸發(fā)器、存儲(chǔ)過(guò)程等.嚴(yán)格按照軟件詳細(xì)設(shè)計(jì)說(shuō)明，負(fù)責(zé)自己開(kāi)發(fā)的模塊的資料、軟件的備份及保管工作。在軟件開(kāi)發(fā)中如發(fā)現(xiàn)系統(tǒng)分析設(shè)計(jì)時(shí)漏洞提出異議，提交問(wèn)題報(bào)告至項(xiàng)目負(fù)責(zé)人。對(duì)各自編寫(xiě)的內(nèi)容相互交換作單元測(cè)試。負(fù)責(zé)《用戶(hù)使用手冊(cè)》的編寫(xiě).負(fù)責(zé)編寫(xiě)軟件《詳細(xì)設(shè)計(jì)說(shuō)明書(shū)》、《數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)》、《測(cè)試方案文檔》。負(fù)責(zé)對(duì)各模塊的集成測(cè)試，和軟件的整體評(píng)估測(cè)試，在測(cè)試完后負(fù)責(zé)編寫(xiě)《測(cè)試報(bào)告》.術(shù)語(yǔ)、首字母縮寫(xiě)英英文說(shuō)明AFCClearingCenterAccessControlListAdvancedConfigurationandPowerInterfaceAutomaticFareCollectionAutomaticGateMachineAdministrativeandLogisticsAFC清算管理中心訪問(wèn)控制列表先進(jìn)的配置和電源接口行政和后勤響應(yīng)時(shí)間縮寫(xiě)ACCACLACPIAFCAGMALDT序號(hào)123456本本生效日期序號(hào)縮寫(xiě)英文說(shuō)明序號(hào)縮寫(xiě)DownTime算術(shù)邏輯部件適應(yīng)的安全算法ArithmeticLogicUnit算術(shù)邏輯部件適應(yīng)的安全算法ArithmeticLogicUnit789ALUASAAVMAddValueMachineBinaryCode進(jìn)制數(shù)編碼表示的方法微機(jī)的基本輸入輸出系統(tǒng)市政交通一卡通半自動(dòng)售票機(jī)進(jìn)制數(shù)編碼表示的方法微機(jī)的基本輸入輸出系統(tǒng)市政交通一卡通半自動(dòng)售票機(jī)循環(huán)冗余校驗(yàn)數(shù)字音頻磁帶數(shù)據(jù)庫(kù)數(shù)據(jù)庫(kù)管理員數(shù)據(jù)定義語(yǔ)言數(shù)字?jǐn)?shù)據(jù)存儲(chǔ)數(shù)據(jù)加密標(biāo)準(zhǔn)默認(rèn)網(wǎng)關(guān)非軍事區(qū)拒絕服務(wù)動(dòng)態(tài)路由協(xié)議MunicipleAdministration＆CommunicationCardCo。PURCPURCGatewayCentralProcessingUnitCyclicRedundancyCheckDigitalAudioTapeDatabaseDatabaseAdministratorDataDefinitionLanguageDigitalDataStorageDataEncryptionStandardDefaultGatewayDenialofServiceDynamicRoutingProtocolDifferentiatedServicesCode區(qū)分服務(wù)代碼本本生效日期序號(hào)縮序號(hào)縮寫(xiě)車(chē)票編碼分揀機(jī)緊急按鈕錯(cuò)誤檢查校正設(shè)備的主要控制單元Encoder/SorterMachineEmergencyButtonErrorCheckingandCorrectingEquipmentControlUnitElectricallyErasableEEPROM電可擦除只讀內(nèi)存ProgrammableRead-EEPROM電可擦除只讀內(nèi)存Memory進(jìn)站自動(dòng)檢票機(jī)出進(jìn)站自動(dòng)檢票機(jī)出站自動(dòng)檢票機(jī)光纖通道仲裁環(huán)光纖通道交換機(jī)戶(hù)接口硬件高可用性硬盤(pán)硬盤(pán)驅(qū)動(dòng)器熱備份單元輸入/輸出E工業(yè)標(biāo)準(zhǔn)結(jié)構(gòu)總線I0123EntryGateExitGateFailOverFibreChannelArbitratedLoopFiberChannelSwitchFloppyDiskGraphicalUserInterfaceHardwareHighAvailabilityHardDiskHardDiskDriveHotStandby4HotStandby4Unit5678IdentificationIntegratedDriveElectronicsIndustryStandardArchitecture名稱(chēng)標(biāo)識(shí)版本生效日期序號(hào)縮寫(xiě)英文說(shuō)明中文說(shuō)明49KbpsKilo(thousand)bitspersecond千比特/秒(速率)50KMSKeyManagementSystem密鑰管理系統(tǒng)51LANLocalAreaNetwork局域網(wǎng)52LCDLiquidCrystalDisplay液晶顯示器53LCLineCenter線路中央計(jì)算機(jī)系統(tǒng)54LCSLineComputerSystem線路計(jì)算機(jī)系統(tǒng)55LEDLowEmittingDiode發(fā)光二極管56LTOLinearTapeOpen線性磁帶開(kāi)放協(xié)議57MACMessageAuthenticationCode消息認(rèn)證碼58MAKMemoryAccessKey內(nèi)存存取密鑰59MbpsMega(Million)bitspersecond兆比特/秒(速率)60MCBFMean—CyclesBetweenFailure平均無(wú)故障時(shí)間61MCUMainControlUnit主控單元62MHzMegaHertz兆赫茲(頻率)63MTBFMean—TimeBetweenFailure平均無(wú)故障時(shí)間64MTTRMeanTimeToRepair平均故障恢復(fù)維修時(shí)間65N/WNetwork網(wǎng)絡(luò)66NICNetworkInterfaceCard網(wǎng)絡(luò)接口卡67NMSNetworkManagementSystem網(wǎng)絡(luò)管理系統(tǒng)68NTPNetworkTimeProtocol網(wǎng)絡(luò)時(shí)間協(xié)議69OAOfficeAutomation辦公自動(dòng)化70OTTotalOperatingTime總運(yùn)營(yíng)時(shí)間71PCIProtocolControlInformation一種局部總線72PCI—XPeripheralComponent擴(kuò)展的PCI本本端質(zhì)量保證磁盤(pán)陣列數(shù)據(jù)庫(kù)管理系統(tǒng)射頻遠(yuǎn)程監(jiān)控路由交換引擎車(chē)站現(xiàn)場(chǎng)設(shè)備安全存取模塊存儲(chǔ)網(wǎng)絡(luò)簡(jiǎn)單網(wǎng)絡(luò)管理協(xié)議車(chē)站計(jì)算機(jī)系統(tǒng)小型計(jì)算機(jī)接口總待機(jī)時(shí)間傳輸控制協(xié)議/網(wǎng)際協(xié)議薄膜晶體管液晶顯示器每分鐘內(nèi)系統(tǒng)處理的交易個(gè)數(shù)RandomArrayofInexpensiveDatabaseManagementSystemRadioFrequencyRemoteMonitoringRoutingSwitchingEngineSoftwareStationLevelEquipmentSecureAccessModulestorageareanetworkSimpleNetworkManagementocolStationComputersystemSmallComputerSystemInterfaceTotalStandbyTimeTicketCheckingMachineTransmissionControlProtocol/InternetProtocolThinFilmTransistor-LiquidCrystalTransactionsPerMinuteTicketVendingMachine生效日期序號(hào)縮寫(xiě)英文說(shuō)明序號(hào)縮寫(xiě)InterconnectExtended73Peer74QA75RAIDRDBMS77RFRMON79RSE80S/W1SLE82SAM83SAN84SNMP85SC86SCSI87ST88TCM89TCP/IP90TFT-LCD91Tom92TVM本本生效日期序號(hào)縮寫(xiě)93序號(hào)縮寫(xiě)93UPS94USB95VLAN96VRRPBase-FX98UsecaseviewImplementation99view100Activityview101ClassviewUML不間斷電源通用串行總線虛擬局域網(wǎng)虛擬路由器冗余協(xié)議Un—interruptiblePowerSupplyUniversalSerialBusVirtualLocalAreaNetworkVirtualRouterRedundancyProtocol(IETF)10/100Base－FX標(biāo)準(zhǔn)110/100Base－FX標(biāo)準(zhǔn)UsecaseviewImplementationviewActivityviewClassviewUnifiedModelingLanguage.5參考資料此軟件架構(gòu)文檔引用文件如下：BB《計(jì)算機(jī)軟件質(zhì)量保證計(jì)劃規(guī)范》《計(jì)算機(jī)軟件配置管理計(jì)劃規(guī)范》《計(jì)算機(jī)軟件測(cè)試文件編制規(guī)范》本識(shí)生效日期邏輯結(jié)構(gòu)[本章描述系統(tǒng)的總體邏輯結(jié)構(gòu)，包括組件(子系統(tǒng))的劃分與依賴(lài)關(guān)系定義、組件之間的接口定義、系統(tǒng)功能在組件之間的實(shí)現(xiàn)流程、組件功能定義]2.1總體結(jié)構(gòu)[本節(jié)定義系統(tǒng)的總體邏輯結(jié)構(gòu)，定義組件劃分以及組件之間的依賴(lài)關(guān)系。為了能夠使系統(tǒng)具有較好的可重用性以及能夠控制對(duì)第三方系統(tǒng)的依賴(lài)性(如第三方系統(tǒng)軟件、中間件等),在結(jié)構(gòu)設(shè)計(jì)時(shí)可以采用分層方法。系統(tǒng)可以分為專(zhuān)用應(yīng)用層、通用應(yīng)用層、中間件層、為了統(tǒng)一與便于理解,當(dāng)用圖形化表示組件(子系統(tǒng))、組件之間的依賴(lài)關(guān)系時(shí),要求采用UML的符號(hào)與表示方法.]2.2系統(tǒng)功能實(shí)現(xiàn)[針對(duì)《產(chǎn)品需求說(shuō)明書(shū)》中定義的功能特性，在此描述它們?cè)谙嚓P(guān)組件(子系統(tǒng))之間是如何實(shí)現(xiàn)的,系統(tǒng)功能實(shí)現(xiàn)描述是定義組件之間的接口以及組件功能的基礎(chǔ)，選擇若干代表性的用例來(lái)說(shuō)明。在此要求用兩種方式來(lái)描述功能實(shí)現(xiàn)：1)UML的順序圖;2)對(duì)順序圖的文字解釋需要注意的是UML順序圖中的生命線代表組件(子系統(tǒng))。《產(chǎn)品需求說(shuō)明書(shū)》中各個(gè)功能特性的數(shù)據(jù)流圖或順序圖描述是此處設(shè)計(jì)的基礎(chǔ).]2.3組件接口[本節(jié)明確定義：各個(gè)組件之間的接口(系統(tǒng)內(nèi)部接口)。如果組件之間采用通信協(xié)議作為接口，則需要詳細(xì)定義應(yīng)用層協(xié)議以及低層通信方式。如果采用API作為接口，則需要詳細(xì)定義API接口函數(shù)(包括參數(shù)定義)。]本識(shí)生效日期[系統(tǒng)的所有對(duì)外接口在《產(chǎn)品需求說(shuō)明書(shū)》中明確定義。]2.4組件功能[本節(jié)明確定義各個(gè)組件的軟件功能，其依據(jù)是《產(chǎn)品需求說(shuō)明書(shū)》以及系統(tǒng)功能實(shí)現(xiàn)描述。本節(jié)通常按照組件進(jìn)行組織.]2.5數(shù)據(jù)庫(kù)關(guān)系模型[本節(jié)在邏輯層面上定義系統(tǒng)所包含的主體數(shù)據(jù)庫(kù)模型，以及主要的實(shí)體關(guān)系，通常以E-R圖形式來(lái)表現(xiàn)。]tx_update_recvstatpw_card_specialpw_card_speciallist_batchpw_card_speciallistcardidvarchar(9)<pk>cardidphysicalvarchartx_update_recvstatpw_card_specialpw_card_speciallist_batchpw_card_speciallistcardidvarchar(9)<pk>cardidphysicalvarchar(16)cardtypevarchar(2)tradedatetimestampdealtypevarchar(1)registtypevarchar(2)pw_card_speciallist_datepw_fare_basicppw_card_storecardidvarchar(9)<pk>cardidfacevarchar(9)cardidphysicalvarchar(16)cardtypevarchar(2)cardsnintegersolddatetimestampforegiftintegerchargeintegerstartdatetimestampenddatetimestampcurrentvalueintegerpointintegerautoflagvarchar(2)cardstatusvarchar(2)updatedatetimestampcardidinouttypesystemlistprocessrulerelationlistfarerulenovarchar(9)<pk>varchar(1)<pk>varchar(800)<pk>varchar(2)varchar(2000)varchar(4)cardidstartcardidendtradedatedealtyperegisttypeoperatorvarchar(9)<pk>varchar(9)timestampvarchar(1)varchar(2)varchar(6)listdatecardidcardidphysicaldealtypetimestampvarchar(9)varchar(16)varchar(1)<pk><pk><pk><pk><pk>basicplannostationno1stationno2farebasicvarchar(4)varchar(10)varchar(10)integerbasicplabasicplabasicrulestartpriceunitpriceunitsdividenotd_clearflagcardidtradetypetradedatereceivedatestartflagstartdatestartaddressstartterminalvarchar(9)varchar(2)timestamptimestampintegertimestampvarchar(10)varchar(9)td_commoncardidvarchar(9)<pk>cardtypevarchar(2)tradetypevarchar(2)tradeaddressvarchar(10)tradedatetimestamp<pk>terminalidvarchar(9)<pk>operatorvarchar(6)trademoneyintegertradevalueintegercurrentvalueintegerforegiftintegerchargeintegercardsninteger<pk>terminalsnintegerterminalsumintegertacvarchar(8)receivedatetimestamptradesnintegerreceivesnintegerstartdatetimestampstartaddressvarchar(10)startterminalvarchar(9)dataresourcevarchar(1)td_customervarchar(9)varchar(2)timestamptimestampvarchar(16)varchar(1)varchar(20)varchar(2)varchar(16)varchar(100)cardidcardtypetradedatereceivedatecustomernamesexcustomerididtypepinaddressphonetd_exchangetradetypetradeaddresstradedateterminalidoperatorreceivedateterminalsnorgcurrencyorgamtexchangeratecurcurrencycuramtvarchar(2)varchar(10)timestampvarchar(9)varchar(6)timestampintegervarchar(3)integervarchar(8)varchar(3)integertd_fareendcardidtradetypetradedatereceivedatefarebasicstartdatestartaddressstartterminalvarchar(9)varchar(2)timestamptimestampintegertimestampvarchar(10)varchar(9)td_common_printvarchar(9)varchar(2)timestamp<pk>varchar(2000)cardidtradetypetradedatePrintMemotd_common_bakcardidcardtypetradetypetradedateterminalidoperatortrademoneycardsnstatereceivedatevarchar(9)varchar(2)varchar(2)timestampvarchar(9)varchar(6)integerintegervarchar(6)timestamp<pk><pk><pk><pk>carditradetradereceicustosexidtypcustopin本識(shí)生效日期txtx_db_recvstatustdtd_logvarchar(9)varchar(2)timestampvarchar(3)varchar(4000)varchar(9)varchar(6)cardidtradetypetradedatecommandidtradecontentterminalidoperator<pk><pk>tx_send_bakrow_idrow_id0command_idborn_timesend_timeresend_timevalid_timeaspectadd_addrdest_addrstatuscontentnumeric(10)numeric(10)varchar(3)timestamptimestampintegerintegervarchar(1)varchar(16)varchar(16)varchar(1)varchar(4000)tx_send_bak0row_idrow_id0command_idborn_timesend_timeresend_timevalid_timeaspectadd_addrdest_addrstatuscontentif_reprocessnumeric(10)numeric(10)varchar(3)timestamptimestampintegerintegervarchar(1)varchar(16)varchar(16)varchar(1)varchar(4000)varchar(1)tx_send_temprow_idrow_id0command_idborn_timesend_timeresend_timevalid_timeaspectadd_addrdest_addrstatuscontentnumeric(10)numeric(10)varchar(3)timestamptimestampintegerintegervarchar(1)varchar(16)varchar(16)varchar(1)varchar(4000)tz_account_list_detailsystemidseqnosubseqnooperatortypeclass1class2statusclass3differnumtradenumremainsumdiffermoneytrademoneyremainmoneyoperatorrelationerco_systemidoperatordatesendupflagvarchar(9)varchar(10)varchar(2)varchar(2)varchar(2)varchar(20)varchar(1)varchar(20)integerintegerintegerintegerintegerintegervarchar(6)varchar(6)varchar(9)timestampvarchar(1)<pk><pk><pk>tz_account_stocksystemidclass1class2statusdiffernumtradenumremainsumdiffermoneytrademoneyremainmoneyoperatoroperatordatevarchar(9)varchar(2)varchar(20)varchar(1)integerintegerintegerintegerintegerintegervarchar(6)timestamp<pk><pk><pk><pk>wh_coding_contentcodingcodecontentclass1class2class3varchar(100)<pk>varchar(255)<pk>varchar(2000)v