Android專案程式碼規範
阿新 • • 發佈:2020-08-18
專案程式碼規範
- Android Studio的程式碼Style檢查和inspect Code功能已經很強大,規範只負責程式碼結構和檔案結構
- 帶
?
的內容為可選或團隊內協商內容
核心目標
- 提高可維護性: MVVM
- 降低開發成本: JAVA -> Kotlin
- 降低溝通成本: 命名規範+程式碼結構
語言-Kotlin
- 版本:1.3及以上
- 質量:
CodeSytleLint
Android Studio -> Code -> Inspect Code
模式-MVVM
- M職責:資料持久化 + 模型轉換Builder
- V職責:UI + UI互動響應
- VM職責: 網路請求響應 + 其他響應
注意:ViewModel
絕不能引用檢視、Lifecycle或可能儲存對Activity上下文的引用的任何類
命名規範:
- 資料夾:小寫activity,fragment,viewholder,viewmodel,model,net,extension
- 類名:首字母大寫+駝峰+身份結尾(xxxActivity,xxxModel,xxxExtension)
程式碼結構:
單檔案順序
- 1、常量
- 2、列舉類
- 3、類
- 4、類的extension(?)
View(Activity、Fragment)內部順序
- 1、常量
- 2、Public屬性、Private屬性、建構函式
- 3、生命週期方法(onCreate、onResume)
- 4、UI方法(initView, resetView)
- 5、UI事件(onXXX)
- 6、網路請求
- 7、網路響應回撥
- 8、通知響應回撥
ViewModel內部順序
- 1、Public LiveData - 外部監聽
- 2、Private MutableLiveData - 內部持有
- 2、網路事件方法(?)
- 3、其他事件方法(?)
Model編寫規範
- 1、註解@Parceblize + data class + : Parceble
- 2、或data class: Serializable (因使用的是反射,執行效率不如第一種)
- 3、XXXModelBuilder(通過構造模式將介面Json模型轉換為頁面需要的UI模型,反之亦然)