項目Alpha衝刺——代碼規範、任務及計劃

班級：軟件工程1916|W
做業：項目Alpha衝刺（團隊）
團隊名稱：Echo
做業目標：規定代碼規範，明確衝刺任務與計劃

目錄

• 團隊博客彙總
• 代碼規範
• alpha衝刺任務
• alpha衝刺計劃

團隊博客彙總

隊員學號	隊員姓名	我的博客地址	備註
221600418	黃少勇	http://www.cnblogs.com/huangshaoyong
221600420	黃種鑫	http://www.cnblogs.com/huangzhongxin	隊長
221600421	孔偉民	http://www.cnblogs.com/kwm42
221600422	李東權	http://www.cnblogs.com/Ldqblogs
221600425	林弘傑	http://www.cnblogs.com/lhj20190212

代碼規範

前端

1、文件組織形式

• 全部項目源代碼請放在項目根目錄 src 目錄下，項目所需最基本的文件包括 入口文件 以及 頁面文件

  入口文件爲 app.js ，頁面文件建議放置在 src/pages 目錄下

• Taro 中普通 JS/TS 文件以小寫字母命名，多個單詞如下劃線鏈接，例如 util.js、util_helper.js

• Taro 組件文件命名遵循 Pascal 命名法

• Taro 中普通 JS/TS 文件以 .js 或者 .ts 做爲文件後綴

• Taro 組件則以 .jsx 或者 .tsx 做爲文件後綴，固然這不是強制約束，只是做爲一個實踐的建議，組件文件依然能夠以 .js或者 .ts 做爲文件後綴

2、JavaScript 書寫規範

• 使用兩個空格進行縮進
• 字符串統一使用單引號
• 關鍵字後面加空格，函數聲明時括號與函數名間加空格
• 屬性前面不要加空格
• 遇到分號時空格要後留前不留，逗號後面加空格，始終將逗號置於行末
• 鍵值對當中冒號與值之間要留空格
• 對於變量和函數名統一使用駝峯命名法
• 不重複聲明變量，不定義未使用變量
• 對象定義存值器，必定要對於的定義取值器
• 對象屬性轉行時注意統一代碼風格
• 不定義冗餘的函數參數，避免多餘的函數上下文綁定，嵌套代碼塊中禁止再次定義函數
• 類名以大寫字母開頭，子類構造器必定要調用super，使用this以前確保super已調用
• 同一模塊有多個導入時一次性寫完，return、throw、continue和break後再也不跟代碼
• 使用===代替==，if/else關鍵字要與花括號保存在同一行
• 避免使用常量做爲條件表達式條件（循環語句除外）

3、組件及JSX書寫規範

• 組件以類的形式進行建立，而且當個文件中只能存在當個組件
• 使用兩個空格進行縮進，不要混合使用空格與製表符做爲縮進
• JSX 屬性均使用單引號
• 多個屬性，多行書寫，每一個屬性佔用一行，標籤結束另起一行
• 終始在自閉合標籤前面添加一個空格
• 屬性名稱始終使用駝峯命名法
• 用括號包裹多行 JSX 標籤
• 當標籤沒有子元素時，始終使用自閉合標籤
• 事件綁定均以on開頭，子組件傳入函數時屬性名須要以on開頭

後端

1、命名規則

• 類名統一使用UpperCamelCase風格，如XmlService
• 方法名，參數名，成員變量，局部變量統一使用lowerCamelCase風格，如inputUserId
• 常量命名所有大寫，單詞間用下劃線隔開，如MAX_STOCK_COUNT
• 抽象類命名使用 Abstract 或 Base 開頭；異常類命名使用 Exception 結尾；測試類
  命名以它要測試的類的名稱開始，以 Test 結尾
• 類型與中括號緊挨相連來表示數組
• 包名統一使用小寫，點分隔符之間有且僅有一個天然語義的英語單詞。包名統一使用
  單數形式
• Service/DAO 層方法命名規約
  1） 獲取單個對象的方法用 get 作前綴。
  2） 獲取多個對象的方法用 list 作前綴，複數形式結尾如：listObjects。
  3） 獲取統計值的方法用 count 作前綴。
  4） 插入的方法用 save/insert 作前綴。
  5） 刪除的方法用 remove/delete 作前綴。
  6） 修改的方法用 update 作前綴。

2、代碼風格

• 採用 4 個空格縮進，禁止使用 tab 字符
• if/for/while/switch/do 等保留字與括號之間都必須加空格
• 註釋的雙斜線與註釋內容之間有且僅有一個空格
• 方法參數在定義和傳入時，多個參數逗號後邊必須加空格
• 全部的覆寫方法，必須加@Override 註解
• 全部的相同類型的包裝類對象之間值的比較，所有使用 equals 方法比較
• finally 塊必須對資源對象、流對象進行關閉，有異常也要作 try-catch

3、應用分層

圖中默認上層依賴於下層，箭頭關係表示可直接依賴，如：開放接口層能夠依賴於
Web 層，也能夠直接依賴於 Service 層，依此類推：

• 開放接口層：可直接封裝 Service 方法暴露成 RPC 接口；經過 Web 封裝成 http 接口；進行
  網關安全控制、流量控制等。
• 終端顯示層：各個端的模板渲染並執行顯示的層。當前主要是 velocity 渲染，JS 渲染，
  JSP 渲染，移動端展現等。
• Web 層：主要是對訪問控制進行轉發，各種基本參數校驗，或者不復用的業務簡單處理等。
• Service 層：相對具體的業務邏輯服務層。
• DAO 層：數據訪問層，與底層 MySQL、Oracle、Hbase 等進行數據交互。

alpha衝刺任務

一、物業端衝刺任務：

• 宿舍信息管理。（添加住戶信息，刪除住戶信息，修改住戶信息，查詢
  住戶信息）
• 員工信息管理。（添加員工信息，刪除員工信息，修改員工信息，查詢
  員工信息）
• 水電信息管理。（水電費查詢，水電費生成，發送水電提醒）
• 維修信息管理。（查看維修申請，發佈維修公告）
• 信息公告管理。（發佈公告信息，查詢公告信息，修改公告信息，刪除
  公告信息）
• 問卷調查。（問卷生成及發佈，查看問卷列表，刪除問卷信息，修改問
  卷信息）

小程序alpha衝刺任務：

• 登陸/綁定學號
• 社區公告
• 便民電話
• 報修申請
• 個人帳單
• 個人消息
• 個人工單（報修，投訴記錄）

alpha衝刺計劃

小程序

• 完成總體框架搭建
• 完成登陸及綁定模塊
• 完成公告模塊（含最新公告、小區公告、個人消息）
• 完成帳單模塊（查詢、繳費）
• 完成報修、投訴模塊（含提交、查詢）
• 完成問卷調查模塊（查詢，提交）

Web端

• 完成總體框架搭建

• 完成登陸模塊

• 完成宿舍信息管理模塊（增刪改查）

• 完成員工信息管理模塊（增刪改查）

• 完成繳費信息管理模塊（增長、查詢）

• 完成維修、投訴管理模塊（查詢、修改）

• 完成信息公告模塊（查詢、發佈）

• 完成問卷調查模塊（生成，發佈，查詢）