简单整理的Android开发规范

一、包命名

1、包名全部采用小写，不用下划线区分单词，多个单词用驼峰命名法。例：com.packer.tablet、com.packer.tablet.otherView
2、包名按功能模块划分，该模块相关类都放置同一个包下面。例：网络请求相关类放在net或http包下面，数据库相关类放在db包下面，数据pojo类放在bean包下面，activity和相关的adapter都放在同一个包下面等。

二、代码

1、变量、方法命名主要采用大/小驼峰命名法，首字母小写，后面的每个单词首字母大写。例：getPackerInfo()
2、静态常量使用public final static修饰（Java）、const val（Kotlin），并且命名为大写，例：INTENT_RESULT_DATA = "data"
3、类名、接口名、枚举名等首字母大写，若由多个单词组成，则其后每个单词首字母大写，例：class ConfigManager{}
4、继承自安卓组件的类，采用父类名作为后缀，例：class LoginActivity extends Activity{}
5、变量、方法的命名以有意义的英文单词命名，例：getLoginInfo()、loginUrl
6、成员变量尽量以m开头命名，推荐，例：mContext
7、控件命名尽量以控件名简写作为开头或结尾，驼峰式命名法。例：TextView控件：tvAdd、addTv Button控件：btnLogin、loginBtn
8、id命名尽量以控件名简写作为开头或结尾，全部小写，单词之间用下划线隔开。例：TextView控件：tv_add、add_tv Button控件：btn_login、login_btn
9、编码格式统一为 UTF-8

三、资源

1、资源命名全部采用小写，各单词间以下划线区分。例：icon_booking_order.png
2、selector文件以selector_开头、shape文件以shape开头。例：selector_clear_btn_bg.xml、shape_et_gray_bg.xml
3、布局文件命名以类型+模块名命名。例：activity_login.xml、dialog_change_price.xml、fragment_order_layout.xml、list_order_item.xml、recycle_food_item.xml、include_login_title_bar_layout.xml

四、常用开发库

1、网络请求库：Retrofit、OKHttp
2、数据解析库：Gson、fastjson
3、软件更新、异常上报：bugly
4、图片加载库：Glide
5、数据库存储：Room
6、数据通讯：EventBus
7、扫码功能：zxing相关库
8、日志打印：LogCook、LogToFile
9、内存泄漏检测工具：LeakCanary
10、轻量级数据存储：DataStore、MMKV

五、开发

1、新项目优先使用Kotlin语言与Java混合开发、原有Java旧项目仍用Java开发。
2、大型复杂优先使用MVVM架构开发，简单的小项目可不用。
3、使用Log打印日志而不是System.out.println()。
4、定义基本数据类型变量非必要情况不用装箱类。
5、一个方法不能超过80行，多了就分开。
6、版本号为3位数，例：versionName "1.0.0"，小修小改bug修复最后一位加1，小新功能添加修改中间位加1，大功能添加修改第一位加1，每更新一次版本，versionCode加1
7、使用视图绑定viewBinding或者DataBinding替代findViewById