教育教學(xué)管理系統(tǒng)規(guī)范建設(shè)思考

前言：想要寫出一篇引人入勝的文章？我們特意為您整理了教育教學(xué)管理系統(tǒng)規(guī)范建設(shè)思考范文，希望能給你帶來靈感和參考，敬請閱讀。

一、教育教學(xué)管理系統(tǒng)構(gòu)建

根據(jù)目前學(xué)院ISO9000的運行情況，在構(gòu)建教育教學(xué)質(zhì)量管理系統(tǒng)時，主要考慮了以下幾個方面:第一，如何保證信息系統(tǒng)的隨需應(yīng)變能力，隨時適應(yīng)管理機制的變化。第二，如果某一個業(yè)務(wù)點產(chǎn)生變化或者調(diào)整，是否面要重新編譯整個程序，還是進行局部構(gòu)建。第三，在系統(tǒng)開發(fā)過程中，產(chǎn)生的一些公用組件，在學(xué)院新建的或現(xiàn)有的業(yè)務(wù)系統(tǒng)中使用，是否還需要重新來進行開發(fā)，如何使用現(xiàn)有的成熟的組件，如何向項目中引用或使用。第四，是否能夠形成一個基礎(chǔ)平臺，在進行新的業(yè)務(wù)系統(tǒng)開發(fā)時，直接在基礎(chǔ)平臺上建設(shè)即可?；谝陨纤狞c來考慮教育教學(xué)質(zhì)量管理系統(tǒng)的構(gòu)建方式。對整個系統(tǒng)的標(biāo)準(zhǔn)規(guī)范作了如下定義，以確保系統(tǒng)的建設(shè)，能夠滿足以上的要求。

(一)具體環(huán)境規(guī)范。

應(yīng)用程序的運行環(huán)境采用兩臺應(yīng)用服務(wù)器和兩臺數(shù)據(jù)服務(wù)器，進行負載均衡的高可用web集群運行環(huán)境配置，保證應(yīng)用程序運行的穩(wěn)定性和運行效率，數(shù)據(jù)庫采用主從備份的方面，用以保證數(shù)據(jù)的安全性。

(二)總體規(guī)范。

1．統(tǒng)一縮寫或名詞約定。在項目中，對于同一概念如果需要使用縮寫，統(tǒng)一使用如下定義:info－信息;doc－文檔;src－源碼;demo－項目的靜態(tài)頁面原型;fea－功能點;req－需求點;query－查詢;add－增加;update－編輯;input－輸入;delete－刪除;list－結(jié)果列表使用的英文名稱;impor－導(dǎo)入;export－導(dǎo)出;rtn－返回;success－成功;fault－失敗;error－錯誤;業(yè)務(wù)字典－與業(yè)務(wù)相關(guān)的代碼及對代碼的描述，系統(tǒng)提供了對業(yè)務(wù)字典的管理，通過系統(tǒng)業(yè)務(wù)字典功能，為系統(tǒng)實現(xiàn)提供的大量組件，方便開發(fā)。

2．需求/功能編號定義。需求編號規(guī)范:“req”+“－”+一級模塊編號+“－”+二級模塊編號+“－”+功能點編號。功能點代碼編號規(guī)范:“fea”+“－”+一級模塊編號+“－”+二級模塊編號+“－”+功能點編號。在此，“fea”表示功能，“req”表示需求一級模塊對應(yīng)一個包，二級模塊對應(yīng)構(gòu)件包下的構(gòu)件，功能點為構(gòu)件下的具體功能。

3．子系統(tǒng)及程序包規(guī)劃。一級模塊與包命名最后一段一致:小寫英文單詞組成的業(yè)務(wù)描述。如:權(quán)限管理(auth)，功能矩陣樣式如下:子系統(tǒng):um，包中文名:權(quán)限管理與控制，包名稱:auth，功能中文名稱對應(yīng)的功能名稱依次是:認證管理－auth，應(yīng)用功能管理－function，菜單管理－menu，角色管理－role，操作員管理－operator，數(shù)據(jù)權(quán)限管理－dataright;包中文名:組織機構(gòu)管理，包名稱:organization，功能中文名稱對應(yīng)的功能名稱依次是:機構(gòu)管理－organization，崗位管理－position，人員管理－person，職務(wù)管理－duty，工作組管理－workgroup，業(yè)務(wù)機構(gòu)管理－busiorg;包中文名:應(yīng)用基礎(chǔ)服務(wù)，包名稱:common，功能中文名稱對應(yīng)的功能名稱依次是:單點登錄———sso，業(yè)務(wù)字典———busidict，業(yè)務(wù)日志———busilog，元數(shù)據(jù)管理———metada-ta，基礎(chǔ)構(gòu)件———comm;包中文名:應(yīng)用基礎(chǔ)工具，包名稱:Utili-ty，功能中文名稱對應(yīng)的功能名稱依次是:文件上傳———fileup-load，通用數(shù)據(jù)選擇———datachoose。在進行構(gòu)建時，包名全部使用英文小寫，包名稱建議采用長命名空間的方式。

4．應(yīng)用架構(gòu)構(gòu)建。Maven除了以程序構(gòu)建能力為特色之外，還提供高級項目管理工具。由于Maven的缺省構(gòu)建規(guī)則有較高的可重用性，所以常常用兩三行Maven構(gòu)建腳本就可以構(gòu)建簡單的項目。由于Maven面向項目的方法，許多ApacheJa-karta項目時使用Maven，而且公司項目采用Maven的比例在持續(xù)增長。本應(yīng)用采用JAVAEE架構(gòu)，應(yīng)用系統(tǒng)的功能開發(fā)，將通過Maven的方式對項目進行構(gòu)建。以Maven的方式進行構(gòu)造，依賴的版本定義在公共模塊或子系統(tǒng)中，子(模塊)pom設(shè)置＜parent＞，繼承父(項目)pom，設(shè)置一個虛擬的總項目，多個實際項目作為總項目的模塊。在編碼過程中，要求盡量使用公用模塊，以減少系統(tǒng)編碼、維護工作量，使程序具有良好的結(jié)構(gòu)性。一般定義，超過三個地方使用的相同邏輯的代碼主要抽象為公用模塊。

(三)配置規(guī)范。

1．配置工具。項目的配置工具內(nèi)部采用SVN作為配置管理工具，MavenRepository作為Maven倉庫的定義。2．配置目錄結(jié)構(gòu)。配置目錄結(jié)構(gòu)如圖2所示。

(四)文檔規(guī)范。

1．文檔命名規(guī)范。文檔名稱=系統(tǒng)名稱+“_”+中文文檔名［+“_”+作者姓名］。修改者必須在文檔中注明修改時間、版本和大致內(nèi)容。

2．文檔編寫規(guī)范。對于項目的成果性文檔，要求在編寫前提供統(tǒng)一的模板，編寫和修正過程中，要記錄變更歷史。在Word中的插圖盡可能使用JPG或GIF以及PNG格式，以降低Word文檔的大小。所有文檔中涉及的圖形，要求提供原始文件，并保存到配置庫中。文檔一旦初步定稿之后，評審者采用修正模式修改文檔。如果文檔參考了其他資料，需要提供參考資料的出處，如某個文檔、網(wǎng)站、書籍。

(五)結(jié)構(gòu)設(shè)計開發(fā)規(guī)范。系統(tǒng)中以包為復(fù)用的基本對象，構(gòu)件包中包含數(shù)據(jù)訪問層、業(yè)務(wù)層、控制層、頁面資源、配置信息等概念。一個項目中可包含多個子項目，按Maven的體系結(jié)構(gòu)，項目按照功能模塊進行劃分，力求便于維護和管理。其中“model”為整個系統(tǒng)的顯示層，即所有的界面操作及界面邏輯都在些項目中進行構(gòu)建common項目為系統(tǒng)的公用項目，所有公用部分的代碼在項目中進行構(gòu)建。model－caculate為系統(tǒng)中模型算法部分，所有算法在此項目中進行構(gòu)建其它核心功能模塊和輔助功能模塊按照規(guī)則進行創(chuàng)建，即“項目名稱———功能模塊名稱”。

1．總體規(guī)范。(1)項目路徑規(guī)劃。com．sinocarbon．model．(2)對于應(yīng)用中的變量命名，要求遵循如下規(guī)范。在數(shù)據(jù)訪問層中，變量名稱遵循Java變量命名規(guī)則;業(yè)務(wù)層中，變量命名和數(shù)據(jù)訪問層的命名規(guī)則一致;控制層中，變量名和業(yè)務(wù)層的命名規(guī)則一致。為保證程序邏輯或代碼的可追溯性，要求每個文件都保留正確合適的開發(fā)人員信息。(3)針對創(chuàng)建者和部門，按照如下要求進行設(shè)置。作者:輸入開發(fā)環(huán)境使用者正式姓名的中文。開發(fā)人員的英文名或者系統(tǒng)缺省的用戶名。部門:輸入開發(fā)環(huán)境使用者所在公司的名稱，例如“信息中心”等。

2．包命名規(guī)范。包是項目中基礎(chǔ)的業(yè)務(wù)實現(xiàn)和業(yè)務(wù)部署單元，其中包含了數(shù)據(jù)訪問、業(yè)務(wù)邏輯、控制以及一些額外需要的資源，包采用以下方式進行命名:包名稱全部使用英文小寫;包名稱采用長命名空間的方式;包名=系統(tǒng)命名空間+”．”+業(yè)務(wù)描述的英文單詞;包命名在設(shè)計期由設(shè)計人員確定，不允許開發(fā)期確定;顯示名稱描述為中文信息;包屬于一個抽象概念。

3．?dāng)?shù)據(jù)訪問層命名規(guī)范。數(shù)據(jù)訪問層是進行數(shù)據(jù)庫操作的邏輯層。數(shù)據(jù)訪問層按以下所描述的方式進行命名。包名定義為com．sinocarbon．model．um．dao。實現(xiàn)接口規(guī)則com．sinocar-bon．model．+子項目名稱+模塊名稱Dao，類規(guī)則為com．sino-carbon．model．+子項目名稱+模塊名稱DaoImpl如用戶管理模塊的包命名規(guī)則為在包com．sinocarbon．model．um，在該包下創(chuàng)建接口和類名稱為UserDao．java和UserDaoImpl．java，首字母大寫，與java類命名一致。接口和類直接建在以構(gòu)件包為名稱的包下，原則上不增加新的包的定義。名稱不使用前綴或后綴。接口和類包含一個單一實體管理功能的操作集合，即增、刪、改、查等。

4．業(yè)務(wù)層命名規(guī)范。業(yè)務(wù)層為進行業(yè)務(wù)邏輯操作的邏輯層。業(yè)務(wù)層按下面方式進行命名:包名定義為com．sinocarbon．model．um．service。實現(xiàn)接口規(guī)則com．sinocarbon．model．+子項目名稱+模塊名稱Service，類規(guī)則為com．sinocarbon．model．+子項目名稱+模塊名稱ServiceImpl如用戶管理模塊的包命名規(guī)則為在包com．sinocarbon．model．um，在該包下創(chuàng)建接口和類名稱為UserService．java和UserServiceImpl．java，首字母大寫，與java類命名一致。接口和類直接建在以構(gòu)件包為名稱的包下，原則上不增加新的包的定義。名稱不使用前綴或后綴。接口和類包含一個單一實體管理功能的操作集合，即增、刪、改、查等。

5．頁面資源命名規(guī)范。一是在web項目中創(chuàng)建一個文件夾，與模塊名稱一致文件夾下創(chuàng)建與該模塊相關(guān)的頁面資源，例如user，在頁面資源下創(chuàng)建user目錄;二是如果涉及較多的不同頁面資源，可以在同名的文件夾下再創(chuàng)建js和image，并將相應(yīng)資源放置在目錄下;三是頁面資源文件一律使用小寫字母，命名一般采用主謂格式，各個單詞之間使用下劃線“_”連接。

6．web目錄規(guī)范。WEB目錄是針對整個項目的WEB配置目錄，允許放置對整個應(yīng)用有效的資源文件，包括公共的js、圖片、頁面、以及WEB－INF的配置等。

二、結(jié)語

本文描述了教育教學(xué)質(zhì)量管理系統(tǒng)中，項目標(biāo)準(zhǔn)規(guī)范的定義。標(biāo)準(zhǔn)規(guī)范的制定，為項目的設(shè)計提供了依據(jù)，為項目的順利實施提供了保障，為使用基礎(chǔ)平臺或相關(guān)組件的開發(fā)人員提供了依據(jù)，為后續(xù)系統(tǒng)的擴展和在基礎(chǔ)平臺基礎(chǔ)上進行業(yè)務(wù)系統(tǒng)開發(fā)的用戶進行了規(guī)則的限定，是整個系統(tǒng)順定實施的基礎(chǔ)。

作者：張海建 孫丹 單位：北京信息職業(yè)技術(shù)學(xué)院