《[計算機軟件及應用]OA消息中心詳細設計》由會員分享，可在線閱讀，更多相關《[計算機軟件及應用]OA消息中心詳細設計（32頁珍藏版）》請在裝配圖網上搜索。

1、 目錄 1. 概述 3 1.1. 背景 3 1.2. 參考資料 3 2. 模塊描述 3 2.1. 在系統(tǒng)中的位置 3 2.2. 功能 3 2.3. 性能 4 3. 標準化設計 4 3.1. 引用模塊說明 4 3.2. 本模塊可能輸出的共享模塊說明 5 4. 模塊設計 6 4.1. 模塊設計準則 6 4.2. 實現(xiàn)原理 6 4.3. 模塊設計的備選方案 6 4.4. 功能劃分 6 4.5. 功能實現(xiàn) 8 4.5.1. 應用管理構件 8 4.5.2. 消息中心構件 12 4.5.3. 應用構件 24 4.5.4. 調度構件 24 5. 數(shù)據(jù)描述 26

2、5.1. 數(shù)據(jù)庫模型 26 5.2. 數(shù)據(jù)字典 27 6. 類設計 27 7. 接口設計 28 7.1. 用戶接口 28 7.2. 硬件接口 28 7.3. 軟件接口 28 7.3.1. 規(guī)范接口 28 7.3.2. 非規(guī)范接口 28 8. 可靠性設計 28 9. 可測試性設計 28 10. 安全性設計 28 11. 關鍵技術說明 28 12. 開發(fā)和運行環(huán)境 28 12.1. 硬件環(huán)境 28 12.2. 軟件環(huán)境 28  1. 概述 1.1. 背景 工具化系統(tǒng)中需要為用戶提供靈活的消息提示機制，用戶可通過各種通訊方式獲取系統(tǒng)發(fā)送的提示信息。用戶能根

3、據(jù)自己所關心的業(yè)務有針對性的獲取系統(tǒng)中提示的消息，可根據(jù)自己的作息時間獲取相關消息。 1.2. 參考資料 《C4消息中心設計方案(12-01).docx》 2. 模塊描述 2.1. 在系統(tǒng)中的位置 消息中心在系統(tǒng)中處于較低的層面，需要為上層的業(yè)務模塊提供消息發(fā)送的統(tǒng)一途徑。 2.2. 功能 l 提供標準消息發(fā)送服務接口，應用構件調用此接口透明發(fā)送消息； l 提供標準消息注冊服務接口，應用管理構件調用此接口透明注冊消息； l 提供消息訂閱功能，用戶可有選擇的通過手機短信、站內信和電子郵件三種方式接收消息；用戶可設定訂閱消息的接收時段； l 支持消息定時發(fā)送； l 支持消

4、息訂閱方式擴展，后期可不斷擴展消息的接收方式； l 與其它構件耦合度最低，確保本構件的獨立性。 2.3. 性能 l 能及時的將系統(tǒng)中應用模塊的消息發(fā)送到用戶 3. 標準化設計 3.1. 引用模塊說明 引用模塊說明 模塊名稱 模塊說明 引用方式 用戶管理 提供用戶帳號及用戶相關信息管理功能 可直接調用相關API獲取用戶信息 郵件發(fā)送 為用戶提供系統(tǒng)中收發(fā)郵件的功能 通過插件，查詢消息中心的消息隊列并調用郵件模塊API發(fā)送郵件 手機短信 提供收發(fā)送短信的功能 通過插件，查詢消息中心的消息隊列并調用手機短信模塊API發(fā)送短信 系統(tǒng)消息 向用戶發(fā)送各種系

5、統(tǒng)提示信息 使用該模塊前臺部分，提供轉換接口將該功能原始數(shù)據(jù)來源變?yōu)橄⒅行南⒈?系統(tǒng)消息是主要方式 3.2. 本模塊可能輸出的共享模塊說明 模塊名稱 模塊內容 消息發(fā)送 向系統(tǒng)提供統(tǒng)一的消息發(fā)送方式 調度管理 為系統(tǒng)提供統(tǒng)一的輪詢調度機制 4. 模塊設計 4.1. 模塊設計準則 4.2. 實現(xiàn)原理 4.3. 模塊設計的備選方案 4.4. 功能劃分 各構建之間的依賴關系如下： 4.5. 功能實現(xiàn) 4.5.1. 應用管理構件 應用管理構件為整個系統(tǒng)提供應用注冊、配置文件解析的功能，并提供一個可在安裝時候進行消息類

6、型交互設置的界面。該構建屬于系統(tǒng)管理類型控件。 4.5.1.1. 注冊應用API 該功能將其它地方傳來的應用相關參數(shù)保存到數(shù)據(jù)庫并返回保存結果，該功能直接對外開發(fā)，開發(fā)人員可調用。 方法原型： /** * 將應用信息注冊到系統(tǒng)中 * * 返回success則成功，返回其他值為失敗原因 * @param string $code * @param string $name * @param string $desc * @return string

7、*/ public function regApp($code, $name, $desc) { // TODO: implement } 4.5.1.2. 應用注冊PAGE 為用戶提供應用注冊的界面，可錄入應用信息。 應用列表 注冊應用 4.5.1.3. 解析配置API 將安裝部署包中的消息注冊配置文件進行解析，獲取其中需要注冊的應用信息及消息類型，并調用相關API將其注冊到系統(tǒng)中。 方法原型： /** * 解析配置文件內容,并注冊配置信息 * @param int $xml

8、 * @return boolean */ public abstract function praseConfig($xml) { // TODO: implement } 輸入：配置文件的內容，格式可參考 輸出：解析以及注冊是否成功 流程：將傳遞進來的xml配置內容進行解析，獲取其中的應用及消息類型信息，然后調用應用/消息注冊API將其注冊到數(shù)據(jù)庫中。 配置文件結構如如下： 4.5.1.4. 獲取已注冊應用API 該功能對外提供一個函數(shù)，可獲取系統(tǒng)中所有已注冊應用對象的列表。 方法原型： /

9、** * 獲取已注冊應用 * @return array */ public abstract function getRegApp() { // TODO: implement } 4.5.2. 消息中心構件 消息中心是消息系統(tǒng)的核心構件，提供與消息有關的核心服務，包括消息注冊、消息訂閱消息管理和消息處理。 4.5.2.1. 應用/消息注冊 該部分只提供數(shù)據(jù)訪問的消息接口，不負責業(yè)務上的功能。 應用注冊： 4.5.2.1.1. 注冊消息API 消息注冊API與應用注冊類似，將其它地方

10、傳來的參數(shù)保存到數(shù)據(jù)庫并返回保存結果。 每個消息類型都屬于一個應用中，因此在這里需要保證消息與應用的主外鍵關系正確。 方法原型： /** * 針對消息類型注冊信息表 * 1.注冊時候需要填寫應用ID、消息編號、消息名稱、備注 * 2.注冊完成后用戶動態(tài)選擇消息可訂閱方式 * * 返回值為該消息類型的編碼，返回success則成功，返回其它則為失敗原因 * @param string $type_code * @param string $code_app * @param

11、 string $name * @param string $desc * @param string $msgType * @return string */ public abstract function regMsgType($type_code, $code_app, $name, $desc, $msgType) { // TODO: implement } 4.5.2.1.2. 獲取已注冊消息API 該功能配合已注冊應用API來使用，同樣提供一個函數(shù)，可

12、獲取某個應用下已注冊的消息類型對象列表。 方法原型： /** * 獲取已注冊消息 * @param string $app_code * @return array */ public abstract function getRegMsgType($app_code) { // TODO: implement } 4.5.2.1.3. 消息類型注冊PAGE 消息類型列表 注冊消息 4.5.2.1.4. 獲取消息發(fā)送許可API 獲取某條消息是否可發(fā)送，通過對消息

13、注冊表進行檢查，獲取消息的消息類型及發(fā)送方式是否在系統(tǒng)中注冊，并返回檢查結果。 方法原型： /** * @param string $appid * @param string $typeid * @return boolean */ public abstract function getPermit($appid, $typeid) { // TODO: implement } 輸入：應用識別號、消息類型識別號 輸出：true通過驗證、false未通過驗證

14、 流程：查詢消息注冊信息，獲取指定應用的消息類型是否注冊，并返回判斷結果 4.5.2.2. 消息訂閱 4.5.2.2.1. 消息訂閱API 消息訂閱API對外提供一個函數(shù)，可將消息訂閱界面?zhèn)鱽淼臄?shù)據(jù)保存到數(shù)據(jù)庫。 方法原型： /** * 添加一條消息訂閱 * @param string $msgplugin * @param string $msgtype * @param string $user * @param int $timesolt * @param

15、 string $condition * @return boolean */ public abstract function subscibe($msgplugin, $msgtype, $user, $timesolt, $condition) { // TODO: implement } 4.5.2.2.2. 消息訂閱PAGE 消息訂閱界面從應用管理模塊加載已注冊應用及消息的列表，在前臺展現(xiàn)成用戶可選擇的界面；再獲取用戶已訂閱的應用及消息，將界面相關選項標識成已選。 界面支持用戶選擇應用及應用關聯(lián)的消

16、息類型。 郵件可配置消息發(fā)送篩選條件，通過標題進行匹配。 短信可配置消息發(fā)送篩選條件、接收時間段，通過標題進行匹配 消息訂閱界面原型 4.5.2.3. 消息管理 4.5.2.3.1. 消息提交API 消息提交API對外提供一個函數(shù)，該函數(shù)將應用發(fā)來的消息以系統(tǒng)消息發(fā)送給用戶，并檢查用戶是否有其它訂閱方式，再以其它訂閱方式發(fā)送給相關消息隊列。 方法原型： /** * 返回成功或失敗原因代碼 * @param string $應用識別號 * @param string $消息識別號 * @param

17、 string $目標用戶ID * @param string $消息標題 * @param string $消息內容 * @param string $鏈接地址 * @param string $有效期 * @return string */ public abstract function sendMsg($應用識別號, $消息識別號, $目標用戶ID, $消息標題, $消息內容, $鏈接地址, $有效期) { // TODO

18、: implement } 消息提交流程 以下是消息中心處理流程 4.5.2.3.2. 系統(tǒng)消息查看 4.5.2.3.2.1. 消息數(shù)量獲取API 該API從系統(tǒng)消息表中獲取當前登錄用戶的未讀消息數(shù)量，并以JSON格式將消息數(shù)量輸出，供前臺AJAX進行渲染。 方法原型： /** * 獲取未讀消息數(shù)量 * @param int $用戶編號 * @return int */ public abstract function getMsgTotal($用戶編號) { // T

19、ODO: implement } 4.5.2.3.2.2. 消息查看PAGE 該頁面根據(jù)傳來的系統(tǒng)消息ID展示系統(tǒng)中某條消息的詳細內容，在第一次顯示消息內容時候，需要將該條消息的狀態(tài)設置為已讀。 4.5.2.3.2.3. 消息列表PAGE 該頁面需要顯示當前用戶在系統(tǒng)中的所有已讀和未讀消息，并可接收一個參數(shù)只顯示已讀內容。 4.5.2.4. 擴展消息處理插件 擴展消息處理插件在系統(tǒng)中承擔某種類型消息的具體發(fā)送者，通過定期循環(huán)檢查自己在系統(tǒng)中所注冊過的消息隊列，將符合條件的消息發(fā)送給用戶，并標記消息狀態(tài)。 擴展插件被調度程序定期調用，從而實現(xiàn)自動化的消息發(fā)送功能。

20、下圖為消息處理插件流程： 4.5.2.4.1. 插件信息管理 該功能用來管理系統(tǒng)消息發(fā)送插件，實現(xiàn)插件信息的注冊、刪除、查看功能。 在插件注冊時候需要向調度程序注冊插件的定時執(zhí)行信息。 4.5.2.4.1.1. 插件信息列表 展示系統(tǒng)中所有已注冊插件信息，通過調用本模塊下API來獲取數(shù)據(jù)。 插件列表 4.5.2.4.1.2. 插件信息注冊功能 插件信息注冊界面完成插件信息的錄入工作，將插件基本信息保存到插件表中，同時將插件信息添加到調度表中，實現(xiàn)插件的定時調用。 插件注冊 4.5.2.4.1.3. 插件信息刪除 可通過插件信息列表刪除插件信息，在刪除插件信息的

21、同時還需要刪除調度表中的相關內容。 輸入：插件ID 輸出：是否刪除成功 流程： 1.刪除插件在操作系統(tǒng)中關聯(lián)的調度任務 2.刪除插件在應用系統(tǒng)中的注冊信息 3.刪除插件信息 4.5.2.4.1.4. 解析插件配置API 將安裝部署包中的插件注冊配置文件進行解析，獲取其中需要注冊的應用信息及消息類型，并調用相關API將其注冊到系統(tǒng)中。 插件配置文件結構如下： 4.5.2.4.1.5. 獲取已注冊插件API 對外提供一個函數(shù)，可獲取系統(tǒng)中已注冊插件信息的列表。 方法原型： /** * 獲取已注冊插件信息列表 * @return

22、 array */ public abstract function getRegPlugin() { // TODO: implement } 輸入：無 輸出：插件信息列表 流程：查詢插件信息及調度信息，組織插件信息表 4.5.2.4.2. 郵件發(fā)送插件 該插件完成郵件消息的發(fā)送功能，首先從郵件隊列表中獲取符合發(fā)送要求的消息，然后調用系統(tǒng)用戶模塊的API獲取用戶接收郵箱，最后調用郵件發(fā)送API將消息發(fā)送給獲取的郵箱并標識消息狀態(tài)。 4.5.2.4.3. 短信發(fā)送插件 該插件完成手機短信發(fā)送功能，從短信網關表中獲取需要發(fā)送

23、的短信內容，并檢查該短信的接收時段，如果正處于消息接收時段，那么獲取用戶手機號碼，調用短信網關接口將消息發(fā)送給短信網關，并標識消息發(fā)送狀態(tài)。 4.5.3. 應用構件 4.5.3.1. 定時消息插件 定時消息插件是系統(tǒng)中業(yè)務模塊需要開發(fā)的插件，該插件被定期調用，獲取系統(tǒng)模塊中需要發(fā)送的消息，然后調用消息中心的消息提交API將消息推送給消息中心。消息發(fā)送時候需要標識消息來源應用及消息類型。 定時消息流程 4.5.4. 調度構件 4.5.4.1. 調度列表 以列表形式展示系統(tǒng)中已經注冊的所有任務信息。 4.5.4.2. 調度注冊 提供一個表單，可填寫調度名稱、周期、調度需要

24、執(zhí)行的程序。首先將調度信息保存到數(shù)據(jù)庫中，然后在操作系統(tǒng)中添加一條調度信息（調度名稱保證唯一）。 4.5.4.3. 調度刪除 從調度列表可觸發(fā)調度刪除鏈接，首先刪除操作系統(tǒng)中相關的定時任務，然后刪除數(shù)據(jù)庫中調度數(shù)據(jù)。 4.5.4.4. 調度修復 查詢已經注冊的調度信息，然后從操作系統(tǒng)中刪除所有與本系統(tǒng)相關的調度信息，最后再按照系統(tǒng)注冊的調度信息向操作系統(tǒng)注冊定時任務。 5. 數(shù)據(jù)描述 5.1. 數(shù)據(jù)庫模型 5.2. 數(shù)據(jù)字典 《消息中心數(shù)據(jù)模型.pdm》 5.2.1. 應用注冊信息表 名稱 代碼 注釋 數(shù)據(jù)類型 主要的 外來鍵 默認值 應用ID ID

25、發(fā)送消息時候根據(jù)模塊編碼進行唯一性確定，由證書ID和應用ID兩部分構成，確保ID唯一 varchar(32) TRUE FALSE 應用名稱 NAME varchar(32) FALSE FALSE 備注 DESC varchar(100) FALSE FALSE 5.2.2. 時段表 名稱 代碼 注釋 數(shù)據(jù)類型 主要的 外來鍵 默認值 接收時段編號 ID 　 int TRUE FALSE 　 名稱 name 　 varchar(32) FALSE FALSE 　 時段1 t1 0:00,23:

26、59 varchar(100) FALSE FALSE 　 時段2 t2 　 varchar(100) FALSE FALSE 　 時段3 t3 　 varchar(100) FALSE FALSE 　 5.2.3. 消息類型注冊信息表 名稱 代碼 注釋 數(shù)據(jù)類型 主要的 外來鍵 默認值 應用ID APP_ID 　 varchar(32) TRUE TRUE 　 消息類型ID id 該類型在編碼中發(fā)送消息使用 varchar(32) TRUE FALSE 　 group/module/msgtype 可選訂

27、閱方式 rcvtyps 多個訂閱方式，中間用逗號分隔，如type,type varchar(200) FALSE FALSE 　 消息類型名稱 name 顯示在界面上的消息名稱 varchar(32) FALSE FALSE 　 備注 desc 　 varchar(100) FALSE FALSE 　 5.2.4. 消息訂閱方式表(插件) 名稱 代碼 注釋 數(shù)據(jù)類型 主要的 外來鍵 默認值 訂閱方式ID id 　 varchar(32) TRUE FALSE 　 訂閱方式名稱 name 　 varchar(128

28、) FALSE FALSE 　 隊列處理SQL sql 插件的名稱 varchar(50) FALSE FALSE 　 備注 desc 　 varchar(100) FALSE FALSE 　 5.2.5. 消息訂閱記錄表 名稱 代碼 注釋 數(shù)據(jù)類型 主要的 外來鍵 默認值 訂閱方式ID MP_ID 　 varchar(32) FALSE TRUE 　 消息類型ID mt_id 該類型在編碼中發(fā)送消息使用 varchar(32) FALSE TRUE 　 group/module/msgtype 接收用戶編號

29、 uid 　 varchar(32) FALSE TRUE 　 接收時段編號 ts_id 　 int FALSE TRUE 　 過濾條件 condition 　 varchar(50) FALSE FALSE 　 5.2.6. 用戶 5.2.7. 用戶消息表 名稱 代碼 注釋 數(shù)據(jù)類型 主要的 外來鍵 默認值 消息流水號 id 　 varchar(32) TRUE FALSE 　 標題 title 　 varchar(200) FALSE FALSE 　 消息內容 content HTM格式，按模板

30、生成 varchar(500) FALSE FALSE 　 消息狀態(tài) state 0 未讀，1-已讀 int FALSE FALSE 　 接收用戶編號 uid 　 varchar(32) FALSE TRUE 　 創(chuàng)建時間 send_time 消息插入的時間 datetime FALSE FALSE 　 接收時間 read_time 打開閱讀時間 datetime FALSE FALSE 　 5.2.8. 調度管理 名稱 代碼 注釋 數(shù)據(jù)類型 主要的 外來鍵 默認值 調度編號 id 　 varchar(

31、32) TRUE FALSE 　 調度名稱 name 　 varchar(128) FALSE FALSE 　 調度時間 round 　 varbinary(256) FALSE FALSE 　 調度執(zhí)行程序 handler 　 varbinary(256) FALSE FALSE 　 5.2.9. 站內信 名稱 代碼 注釋 數(shù)據(jù)類型 主要的 外來鍵 默認值 消息流水號 id 系統(tǒng)自動產生 int TRUE FALSE 　 接收時段編號 ts_id 　 varchar(32) FALSE TRUE

32、　 標題 title 　 varchar(256) FALSE FALSE 　 消息內容 content HTM格式，按模板生成 text FALSE FALSE 　 消息狀態(tài) state 0 待發(fā)， 1-正在發(fā)送，2-已發(fā)， 3-放棄 int FALSE FALSE 　 接收用戶 uid 　 varchar(32) FALSE FALSE 　 創(chuàng)建時間 create_datetime 　 datetime FALSE FALSE 　 預訂發(fā)送時間 send_time 定時發(fā)送時間 datetime FALSE

33、 FALSE 　 發(fā)送時間 sended_time 　 datetime FALSE FALSE 　 失敗重發(fā)次數(shù) resend_times 失敗重發(fā)次數(shù)，每次失敗減1，等于0時放棄 int FALSE FALSE 　 有效期限 void_time 超過此期限不再發(fā)送 datetime FALSE FALSE 　 5.2.10. 郵件消息隊列 名稱 代碼 注釋 數(shù)據(jù)類型 主要的 外來鍵 默認值 消息流水號 id 系統(tǒng)自動產生 int TRUE FALSE 　 接收時段編號 ts_id 　 varbinary(

34、32) FALSE TRUE 　 標題 title 　 varchar(256) FALSE FALSE 　 消息內容 content HTM格式，按模板生成 text FALSE FALSE 　 消息狀態(tài) state 0 待發(fā)， 1-正在發(fā)送，2-已發(fā)， 3-放棄 int FALSE FALSE 　 接收郵箱 rcv_mailaddr 　 varchar(32) FALSE FALSE 　 創(chuàng)建時間 create_datetime 　 datetime FALSE FALSE 　 預訂發(fā)送時間 send_tim

35、e 定時發(fā)送時間 datetime FALSE FALSE 　 發(fā)送時間 sended_time 　 datetime FALSE FALSE 　 失敗重發(fā)次數(shù) resend_times 失敗重發(fā)次數(shù)，每次失敗減1，等于0時放棄 int FALSE FALSE 　 有效期限 void_time 超過此期限不再發(fā)送 datetime FALSE FALSE 　 5.2.11. 手機短信消息隊列 名稱 代碼 注釋 數(shù)據(jù)類型 主要的 外來鍵 默認值 消息流水號 id 系統(tǒng)自動產生 int TRUE FALSE 　

36、 接收時段編號 ts_id 　 varchar(32) FALSE TRUE 　 標題 title 　 varchar(256) FALSE FALSE 　 消息內容 content 　 text FALSE FALSE 　 消息狀態(tài) state 0 待發(fā) 1-在發(fā)，2-已發(fā) 3-放棄 int FALSE FALSE 　 接收號碼 uid 　 varchar(32) FALSE FALSE 　 創(chuàng)建時間 create_datetime 　 datetime FALSE FALSE 　 定時發(fā)送時間 sen

37、d_time 　 datetime FALSE FALSE 　 發(fā)送時間 sended_time 　 datetime FALSE FALSE 　 失敗重發(fā)次數(shù) resend_times 　 int FALSE FALSE 　 有效期限 void_time 　 datetime FALSE FALSE 　 6. 類設計 類名 類型 描述 MessageManagerAction Action 向界面提供數(shù)據(jù)和接收頁面請求，包括消息注冊、消息訂閱、消息查看、消息列表 MessagePluginsAction Actio

38、n 向插件管理界面提供數(shù)據(jù)并響應界面請求，消息發(fā)送插件及可訂閱方式的管理 ScheduleManageAction Action 為調度管理模塊提供頁面數(shù)據(jù)及響應 AppManageAction Action 向應用管理界面提供數(shù)據(jù)并響應頁面請求 MessageManager 業(yè)務類 為上層Action提供消息管理的業(yè)務功能，包括：消息注冊、獲取消息發(fā)送許可、獲取已注冊消息、消息訂閱、系統(tǒng)消息管理等功能 MessagePlugins 業(yè)務類 為上層Action提供插件管理的業(yè)務功能，包括：插件注冊、刪除等功能 MessageSender 業(yè)務類 對所有業(yè)務模塊及

39、Action提供消息發(fā)送API，該類作為消息中心的一個對外接口提供 ScheduleManage 業(yè)務類 調度管理，為上層提供調度注冊、刪除、修復功能 AppManage 業(yè)務類 應用管理，為上層提供應用注冊、修改、刪除及應用相關信息獲取的功能 MailSenderTask.php 調度程序 實現(xiàn)從消息中心的郵件隊列獲取消息并發(fā)送到郵件服務器的功能，該文件將被調度程序定時調用執(zhí)行 SmsSenderTask.php 調度程序 實現(xiàn)從消息中心的手機短信隊列獲取消息并發(fā)送到短信網關的功能，改文件將會被調度程序定期調用 7. 接口設計 7.1. 用戶接口 7.2. 硬件接口 7.3. 軟件接口 7.3.1. 規(guī)范接口 可對其它模塊開放的公用接口 7.3.2. 非規(guī)范接口 模塊內的私有接口 8. 可靠性設計 9. 可測試性設計 10. 安全性設計 11. 關鍵技術說明 12. 開發(fā)和運行環(huán)境 12.1. 硬件環(huán)境 12.2. 軟件環(huán)境