軟件需求說明書（SRS）文檔編號：SR-2023-XX-001版本號：V1.2編制日期：2023年10月20日編制單位：XX科技有限公司編制人：張三（產(chǎn)品經(jīng)理）、李四（技術(shù)負(fù)責(zé)人）審批人：王五（項目經(jīng)理）1.引言1.1項目背景隨著在線教育行業(yè)的快速發(fā)展，傳統(tǒng)線下課程模式已無法滿足用戶對靈活學(xué)習(xí)的需求。為解決這一問題，XX科技有限公司計劃開發(fā)一款在線教育平臺，旨在為用戶提供課程發(fā)布、學(xué)習(xí)、考核及互動等功能，連接講師與學(xué)習(xí)者，實現(xiàn)教育資源的高效傳播。本項目的目標(biāo)是打造一個“易用、可靠、安全”的在線教育生態(tài)，支持1000+并發(fā)用戶，覆蓋K12、職業(yè)教育、興趣愛好等多個領(lǐng)域，滿足不同用戶的學(xué)習(xí)需求。1.2文檔目的本軟件需求說明書（SRS）是項目開發(fā)的核心文檔，旨在：明確系統(tǒng)的功能范圍、非功能要求及約束條件；為開發(fā)人員提供詳細(xì)的需求依據(jù)，指導(dǎo)系統(tǒng)設(shè)計與實現(xiàn)；為測試人員提供驗收標(biāo)準(zhǔn)，確保系統(tǒng)符合用戶需求；作為客戶與開發(fā)團(tuán)隊之間的溝通橋梁，避免需求歧義。1.3讀者對象讀者類型角色職責(zé)關(guān)注重點產(chǎn)品經(jīng)理需求管理與驗收功能范圍、用戶體驗開發(fā)工程師系統(tǒng)設(shè)計與實現(xiàn)功能需求、接口定義、技術(shù)約束測試工程師測試用例設(shè)計與執(zhí)行驗收標(biāo)準(zhǔn)、功能/非功能需求客戶代表需求確認(rèn)與驗收功能匹配度、業(yè)務(wù)價值運維工程師系統(tǒng)部署與維護(hù)可靠性、可維護(hù)性、環(huán)境約束1.4術(shù)語定義術(shù)語定義講師擁有課程發(fā)布權(quán)限的用戶，負(fù)責(zé)上傳課程內(nèi)容并與學(xué)習(xí)者互動學(xué)習(xí)者使用平臺學(xué)習(xí)課程的用戶，可觀看視頻、完成作業(yè)、參與討論Token用戶登錄后的身份憑證，有效期24小時，用于接口認(rèn)證課程審核管理員對講師發(fā)布的課程進(jìn)行內(nèi)容審查，確保符合平臺規(guī)范OSS阿里云對象存儲服務(wù)，用于存儲課程封面、視頻等大文件1.5參考資料1.《IEEE____軟件需求說明書標(biāo)準(zhǔn)》；2.《在線教育平臺項目可行性研究報告》（文檔編號：FR-2023-XX-001）；3.《用戶需求調(diào)研問卷》（2023年9月）；4.《阿里云OSS開發(fā)文檔》；5.《SpringBoot2.7.x官方文檔》。2.系統(tǒng)概述2.1整體描述本系統(tǒng)是一款B/S架構(gòu)的在線教育平臺，支持Web端與移動端訪問（移動端通過H5實現(xiàn)）。核心功能包括：用戶管理（注冊、登錄、角色權(quán)限）；課程管理（發(fā)布、審核、編輯、刪除）；學(xué)習(xí)管理（視頻觀看、作業(yè)提交、進(jìn)度跟蹤）；互動管理（評論、回復(fù)、點贊）；考核管理（考試、評分、證書頒發(fā)）。系統(tǒng)的核心價值是“連接講師與學(xué)習(xí)者”，通過標(biāo)準(zhǔn)化的課程流程（發(fā)布-審核-學(xué)習(xí)-考核），降低教育資源傳播成本，提升學(xué)習(xí)效率。2.2系統(tǒng)架構(gòu)系統(tǒng)采用分層架構(gòu)設(shè)計，分為4層，各層職責(zé)明確：1.表現(xiàn)層：負(fù)責(zé)與用戶交互，采用Vue.js3.x框架開發(fā)，支持響應(yīng)式布局，適配PC、手機等終端；2.業(yè)務(wù)邏輯層：負(fù)責(zé)處理核心業(yè)務(wù)邏輯（如課程審核、作業(yè)評分），采用SpringBoot2.7.x框架，實現(xiàn)模塊化開發(fā)；3.數(shù)據(jù)層：負(fù)責(zé)數(shù)據(jù)存儲與訪問，采用MySQL8.0（關(guān)系型數(shù)據(jù)）+Redis6.x（緩存）+阿里云OSS（文件存儲）；4.第三方服務(wù)層：對接外部服務(wù)，如支付寶/微信支付（支付功能）、阿里云短信（驗證碼）、騰訊云視頻（視頻轉(zhuǎn)碼）。2.3功能模塊劃分系統(tǒng)功能模塊分為6大類，具體如下：模塊名稱子模塊描述用戶管理注冊、登錄、權(quán)限管理支持用戶注冊/登錄，分配講師、學(xué)習(xí)者、管理員角色課程管理發(fā)布、審核、編輯、刪除講師發(fā)布課程，管理員審核，支持課程信息修改與刪除學(xué)習(xí)管理視頻觀看、作業(yè)提交、進(jìn)度跟蹤學(xué)習(xí)者觀看課程視頻，提交作業(yè)，系統(tǒng)跟蹤學(xué)習(xí)進(jìn)度互動管理評論、回復(fù)、點贊學(xué)習(xí)者可對課程發(fā)表評論，講師/其他學(xué)習(xí)者回復(fù)，支持點贊功能考核管理考試、評分、證書頒發(fā)講師設(shè)置考試題目，學(xué)習(xí)者參與考試，系統(tǒng)自動評分并頒發(fā)電子證書系統(tǒng)管理日志管理、配置管理管理員查看系統(tǒng)日志，配置平臺參數(shù)（如課程審核開關(guān)、支付方式）3.功能需求3.1用戶管理模塊3.1.1用戶注冊功能功能描述：學(xué)習(xí)者/講師通過填寫基本信息創(chuàng)建平臺賬號，支持郵箱驗證。前置條件：用戶未注冊過平臺賬號；郵箱未被占用。后置條件：數(shù)據(jù)庫新增用戶記錄，狀態(tài)為“正常”；用戶收到激活郵件（若開啟郵箱驗證）；返回登錄Token。輸入：參數(shù)名類型約束描述username字符串1-50位，唯一用戶名password字符串6-20位，包含字母、數(shù)字、特殊字符登錄密碼email字符串符合郵箱格式，唯一聯(lián)系郵箱role字符串可選值：learner（學(xué)習(xí)者）、teacher（講師）用戶角色參數(shù)名類型描述code整數(shù)0（成功）、1（失敗）message字符串提示信息（如“注冊成功”）data對象包含user_id（用戶ID）、token（登錄憑證）輸出：處理流程：1.用戶進(jìn)入注冊頁面，選擇角色（學(xué)習(xí)者/講師）；2.填寫用戶名、密碼、郵箱；3.點擊“注冊”按鈕，系統(tǒng)驗證輸入合法性（用戶名未重復(fù)、密碼符合要求、郵箱格式正確）；4.驗證通過，生成用戶ID，密碼采用BCrypt哈希加密存儲；6.生成登錄Token（有效期24小時），返回注冊成功信息。3.1.2用戶登錄功能功能描述：用戶通過用戶名/郵箱和密碼登錄平臺，支持記住密碼（7天有效期）。前置條件：用戶已注冊且賬號狀態(tài)正常。后置條件：返回登錄Token；記錄登錄日志（IP、時間）。輸入：參數(shù)名類型約束描述account字符串非空用戶名或郵箱password字符串非空登錄密碼remember布爾可選，默認(rèn)false是否記住密碼參數(shù)名類型描述code整數(shù)0（成功）、1（失?。﹎essage字符串提示信息（如“登錄成功”）data對象包含user_id、token、role輸出：處理流程：1.用戶進(jìn)入登錄頁面，輸入賬號（用戶名/郵箱）和密碼；2.點擊“登錄”按鈕，系統(tǒng)驗證賬號存在且密碼正確；3.驗證通過，生成登錄Token；4.若選擇“記住密碼”，將Token存儲在本地Cookie（有效期7天）；5.記錄登錄日志（IP、時間、角色），返回登錄成功信息。3.2課程管理模塊3.2.1課程發(fā)布功能功能描述：講師填寫課程信息（名稱、描述、分類、封面、視頻），提交后進(jìn)入審核流程。前置條件：用戶已登錄且角色為講師；管理員已開啟課程審核功能。后置條件：數(shù)據(jù)庫新增課程記錄，狀態(tài)為“待審核”；管理員收到審核通知（系統(tǒng)消息+短信）。輸入：參數(shù)名類型約束描述course_name字符串1-50位，非空課程名稱description字符串1-500位，非空課程描述cover_file文件格式：JPG/PNG，大小≤2MB課程封面video_file文件格式：MP4/AVI，大小≤1GB課程視頻參數(shù)名類型描述code整數(shù)0（成功）、1（失?。﹎essage字符串提示信息（如“課程發(fā)布成功，等待審核”）data對象包含course_id（課程ID）輸出：處理流程：1.講師進(jìn)入課程發(fā)布頁面，填寫課程名稱、描述，選擇分類；2.上傳課程封面（JPG/PNG，≤2MB）和視頻（MP4/AVI，≤1GB）；3.點擊“發(fā)布”按鈕，系統(tǒng)驗證輸入合法性（名稱非空、描述非空、文件格式/大小符合要求）；4.驗證通過，將課程信息保存到數(shù)據(jù)庫（狀態(tài)：待審核）；5.向管理員發(fā)送審核通知（系統(tǒng)消息+短信）；6.返回課程發(fā)布成功信息及課程ID。3.2.2課程審核功能（管理員）功能描述：管理員查看待審核課程，審核通過/拒絕，并填寫審核意見。前置條件：用戶已登錄且角色為管理員；存在待審核課程。后置條件：課程狀態(tài)更新為“已通過”或“已拒絕”；講師收到審核結(jié)果通知（系統(tǒng)消息+郵件）。輸入：參數(shù)名類型約束描述course_id字符串非空課程IDaudit_result字符串可選值：approved（通過）、rejected（拒絕）審核結(jié)果audit_opinion字符串1-200位，非空（當(dāng)結(jié)果為拒絕時）審核意見參數(shù)名類型描述code整數(shù)0（成功）、1（失敗）message字符串提示信息（如“審核完成”）輸出：處理流程：1.管理員進(jìn)入課程審核頁面，查看待審核課程列表（包含課程名稱、講師、發(fā)布時間）；2.點擊“查看詳情”，查看課程封面、視頻、描述等信息；3.選擇審核結(jié)果（通過/拒絕），填寫審核意見（拒絕時必填）；4.點擊“提交”按鈕，系統(tǒng)更新課程狀態(tài)；5.向講師發(fā)送審核結(jié)果通知（系統(tǒng)消息+郵件）；6.返回審核完成信息。4.非功能需求4.1性能需求響應(yīng)時間：核心功能（登錄、課程加載）響應(yīng)時間≤2秒；并發(fā)能力：支持1000+并發(fā)用戶，系統(tǒng)無崩潰或明顯延遲；吞吐量：課程視頻上傳吞吐量≥10MB/s（單用戶）；數(shù)據(jù)庫性能：復(fù)雜查詢（如按分類統(tǒng)計課程數(shù)量）響應(yīng)時間≤5秒。4.2可用性需求系統(tǒng)可用性：全年可用性≥99.9%（即每年downtime≤8.76小時）；故障恢復(fù)：系統(tǒng)發(fā)生故障后，30分鐘內(nèi)恢復(fù)服務(wù)（數(shù)據(jù)無丟失）；用戶體驗：新用戶能在5分鐘內(nèi)學(xué)會基本操作（注冊、登錄、找課程）；界面設(shè)計：符合MaterialDesign規(guī)范，顏色搭配簡潔，操作流程直觀。4.3可靠性需求數(shù)據(jù)可靠性：數(shù)據(jù)庫采用主從復(fù)制，數(shù)據(jù)丟失率≤0.01%；系統(tǒng)穩(wěn)定性：連續(xù)運行72小時無內(nèi)存泄漏、死鎖等問題；錯誤處理：系統(tǒng)出現(xiàn)錯誤時，返回明確的錯誤信息（如“用戶名已存在”），而非模糊提示（如“操作失敗”）。4.4安全性需求身份認(rèn)證：用戶密碼采用BCrypt哈希加密（加鹽，鹽值長度16位）；權(quán)限控制：采用RBAC（角色-權(quán)限-資源）模型，不同角色擁有不同操作權(quán)限（如講師無法刪除課程）；數(shù)據(jù)傳輸：敏感數(shù)據(jù)（如密碼、身份證號）傳輸采用SSL/TLS1.3協(xié)議加密；安全掃描：每月進(jìn)行一次安全掃描（使用Nessus工具），及時修復(fù)高危漏洞；日志審計：記錄所有用戶操作日志（如登錄、課程發(fā)布），保留時間≥6個月。4.5可維護(hù)性需求模塊化設(shè)計：系統(tǒng)采用微服務(wù)架構(gòu)（如用戶服務(wù)、課程服務(wù)、學(xué)習(xí)服務(wù)），修改一個模塊不影響其他模塊；文檔完整性：提供詳細(xì)的開發(fā)文檔（如接口文檔、數(shù)據(jù)庫設(shè)計文檔）、用戶手冊、運維手冊；版本管理：采用Git進(jìn)行代碼版本管理，每兩周發(fā)布一個迭代版本（如V1.0、V1.1）。4.6兼容性需求瀏覽器兼容：支持Chrome（≥100版本）、Firefox（≥95版本）、Edge（≥100版本）、Safari（≥15版本）；移動端兼容：支持iOS（≥14版本）、Android（≥10版本）的手機瀏覽器；數(shù)據(jù)庫兼容：支持MySQL8.0及以上版本，可遷移至PostgreSQL（若后續(xù)需要）。5.數(shù)據(jù)需求5.1數(shù)據(jù)類型系統(tǒng)數(shù)據(jù)分為3類：1.用戶數(shù)據(jù)：用戶名、密碼哈希、郵箱、角色、創(chuàng)建時間等；2.課程數(shù)據(jù)：課程名稱、描述、分類、封面URL、視頻URL、講師ID、狀態(tài)等；3.學(xué)習(xí)數(shù)據(jù)：學(xué)習(xí)進(jìn)度、作業(yè)提交記錄、考試成績、評論等。5.2數(shù)據(jù)結(jié)構(gòu)用戶表（user）字段名類型約束描述user_id字符串主鍵、唯一用戶IDusername字符串唯一、非空用戶名password字符串非空密碼哈希email字符串唯一、非空聯(lián)系郵箱role字符串非空角色（learner/teacher/admin）create_timedatetime非空創(chuàng)建時間課程表（course）字段名類型約束描述course_id字符串主鍵、唯一課程IDcourse_name字符串非空課程名稱description字符串非空課程描述category字符串非空課程分類cover_url字符串非空封面URLvideo_url字符串非空視頻URLteacher_id字符串外鍵（user.user_id）講師IDstatus字符串非空狀態(tài)（pending/approved/rejected）create_timedatetime非空創(chuàng)建時間學(xué)習(xí)進(jìn)度表（learning_progress）字段名類型約束描述progress_id字符串主鍵、唯一進(jìn)度IDuser_id字符串外鍵（user.user_id）用戶IDcourse_id字符串外鍵（course.course_id）課程IDprogress整數(shù)非空（0-100）學(xué)習(xí)進(jìn)度（%）last_learn_timedatetime非空最后學(xué)習(xí)時間5.3數(shù)據(jù)存儲關(guān)系型數(shù)據(jù)：采用MySQL8.0存儲，使用InnoDB存儲引擎（支持事務(wù)、行級鎖）；緩存數(shù)據(jù)：采用Redis6.x存儲，用于存儲登錄Token（有效期24小時）、熱門課程列表（有效期1小時）；文件存儲：采用阿里云OSS存儲，用于存儲課程封面（路徑：/course/cover/）、課程視頻（路徑：/course/video/），支持CDN加速（提高視頻加載速度）。5.4數(shù)據(jù)流程以“課程發(fā)布”為例，數(shù)據(jù)流程如下：1.講師在Web端上傳課程封面和視頻；2.表現(xiàn)層將文件上傳至阿里云OSS，獲取封面URL和視頻URL；3.表現(xiàn)層將課程信息（名稱、描述、分類、封面URL、視頻URL）發(fā)送至業(yè)務(wù)邏輯層；4.業(yè)務(wù)邏輯層驗證信息合法性（如名稱非空、文件格式正確）；5.驗證通過，業(yè)務(wù)邏輯層將課程信息插入課程表（狀態(tài)：待審核）；6.業(yè)務(wù)邏輯層向管理員發(fā)送審核通知（系統(tǒng)消息+短信）；7.表現(xiàn)層返回課程發(fā)布成功信息。6.接口需求6.1內(nèi)部接口內(nèi)部接口指系統(tǒng)各模塊之間的接口，采用RESTful風(fēng)格，示例如下：6.1.1用戶服務(wù)與課程服務(wù)接口（獲取講師信息）接口名稱：獲取講師信息接口URL：/api/user/teacher/{teacher_id}請求方法：GET請求參數(shù)：teacher_id（講師ID，字符串）響應(yīng)參數(shù)：參數(shù)名類型描述code整數(shù)0（成功）、1（失敗）message字符串提示信息data對象包含teacher_id（講師ID）、username（用戶名）、email（郵箱）6.2外部接口外部接口指系統(tǒng)與第三方服務(wù)的接口，示例如下：6.2.1支付寶支付接口（下單）接口名稱：支付寶下單請求方法：POST請求參數(shù)（部分）：參數(shù)名類型描述out_trade_no字符串平臺訂單號total_amount字符串訂單金額（單位：元）subject字符串訂單標(biāo)題（如“課程《Java入門》購買”）參數(shù)名類型描述trade_no字符串支付寶交易號status字符串訂單狀態(tài)（SUCCESS：成功，WAIT_BUYER_PAY：等待支付）響應(yīng)參數(shù)（部分）：6.3用戶接口（UI/UX）用戶接口指系統(tǒng)與用戶交互的界面，示例如下：6.3.1登錄界面元素：賬號輸入框：placeholder=“請輸入用戶名或郵箱”；密碼輸入框：placeholder=“請輸入密碼”，支持顯示/隱藏密碼；“登錄”按鈕：藍(lán)色背景，白色文字，點擊后觸發(fā)登錄請求；交互：輸入錯誤時，輸入框邊框變紅，顯示錯誤提示（如“用戶名或密碼錯誤”）；7.約束條件7.1技術(shù)約束后端必須采用Java語言開發(fā)，使用SpringBoot2.7.x框架；前端必須采用Vue.js3.x框架，使用ElementPlus組件庫；數(shù)據(jù)庫必須采用MySQL8.0，存儲引擎為InnoDB；緩存必須采用Redis6.x，用于存儲登錄Token和熱門課程數(shù)據(jù)；文件存儲必須采用阿里云OSS，支持CDN加速。7.2環(huán)境約束服務(wù)器環(huán)境：Linux（CentOS7.x或Ubuntu20.04），CPU≥4核，內(nèi)存≥8GB，硬盤≥100GB；網(wǎng)絡(luò)環(huán)境：服務(wù)器帶寬≥100Mbps（保證視頻加載速度）。7.3政策約束符合《中華人民共和國網(wǎng)絡(luò)安全法》，確保用戶數(shù)據(jù)安全；符合《中華人民共和國個人信息保護(hù)法》，用戶信息收集需明確告知并獲得同意；符合《互聯(lián)網(wǎng)信息服務(wù)管理辦法》，課程內(nèi)容需審核，禁止發(fā)布違法信息。8.驗收標(biāo)準(zhǔn)8.1功能驗收功能驗收采用“測試用例+手動驗證+自動化測試”方式，示例如下：8.1.1用戶注冊功能驗收驗收項驗收條件驗收結(jié)果輸入合法性驗證用戶名重復(fù)時，提示“用戶名已存在”；密碼不符合要求時，提示“密碼需包含字母、數(shù)字、特殊字符”通過/未通過注冊成功后數(shù)據(jù)存儲數(shù)據(jù)庫中新增用戶記錄，密碼為BCrypt哈希值；發(fā)送激活郵件（若開啟）通過/未通過登錄驗證使用注冊的用戶名和密碼能成功登錄，返回Token通過/未通過8.1.2課程審核功能驗收驗收項驗收條件驗收結(jié)果審核結(jié)果更新管理員審核通過后，課程狀態(tài)變?yōu)椤耙淹ㄟ^”；審核拒絕后，狀態(tài)變?yōu)椤耙丫芙^”通過/未通過通知功能講師收到審核結(jié)果通知（系統(tǒng)消息+郵件）通過/未通過課程顯示審核通過的課程顯示在課程列表中；審核拒絕的課程不顯示通過/未通過8.2非功能驗收8.2.1性能驗收響應(yīng)時間：使用JMeter工具模擬1000并發(fā)用戶，登錄功能響應(yīng)時間≤2秒；并發(fā)能力：使用LoadRunner工具模擬1000并發(fā)用戶，系統(tǒng)無崩潰，吞吐量≥100請求/秒；視頻加載：使用Chrome瀏覽器訪問課程視頻，加載時間≤3秒（帶寬100Mbps）。8.2.2