1. 首页
  2. Android
  3. Android 开发规范

Android 开发规范

2019/03/04 22:08:58 发表 2019/03/04 22:12:22 更新 原创 素颜 119 0 0

无规矩不成方圆，定义好规范，才能统一风格，才可提高代码可读性，同时也提高了维护性，还减低了引入 bug 的机会。

要规划好界面层，至少应该遵循几条基本的原则：

  • 保持规范性：定义好开发规范，包括书写规范、命名规范、注释规范等，并按照规范严格执行；

  • 保持单一性：布局就只做布局，内容就只做内容，各自分离好；每个方法、每个类，也只做一件事情；

  • 保持简洁性：保持代码和结构的简洁，每个方法，每个类，每个包，每个文件，都不要塞太多代码或资源，感觉多了就应该拆分。

开发规范并没有统一的标准，这里提出一些个人建议，仅供参考。

一、开发工具常用设置

  1. 设置字体大小：
    Window-Preferences->General->Appearance->Colors and Fonts->Basic->Text Font (Consolas/粗体/小三)(根据个人爱好，自行选择)

  2. 菜单样式：
    eclipse 打开文件，左侧树自动对应文件：选中左右箭头 (根据个人爱好，自行选择)

  3. 禁止Error Checking：
    Window->Preferences->Android->Lint Error Checking，去掉勾选when saving files, check for errors(根据个人爱好，自行选择)

  4. 选择喜欢的 eclipse 主题：
    http://eclipsecolorthemes.org/ (根据个人爱好，自行选择)

  5. 编码格式统一 UTF8

  6. tab 代码缩进 4 个空格：
    Window->Preferences->General->Editors->Text Editors：Displayed tab width = 4

  7. 行宽设置为 100，设置格式化时自动断行到行宽位置。
    设置路径为：【Window】->【Preferences】->【Java】->【Code Style】->【Formatter】，点击“new”新建一个“Profile”。

二、书写规范

  1. 缩进：很多人都习惯用 Tab 缩进，不管是规范4个空格还是2个空格，统一设置好 Tab 缩进的 size 就好了，这样就不用让每个人都去敲空格。

  2. 花括号不要单独一行，和它前面的代码同一行。而且，花括号与前面的代码之间用一个空格隔开。

    1. public void method() { // Good
    2. ...
    3. }
    4. ...
    5. public void method()
    6. { // Bad
    7. }
    8. ...
    9. public void method(){ // Bad
    10. ...
    11. }

  3. 空格的使用：if、else、for、switch、while 等逻辑关键字与后面的语句留一个空格隔开。

    1. // Good
    2. if (booleanVariable) {
    3.  // TODO while booleanVariable is true
    4. } else {
    5.  // TODO else
    6. }
    7. ...
    8. // Bad
    9. if(booleanVariable) {
    10.  // TODO while booleanVariable is true
    11. }else {
    12.  // TODO else
    13. }

  4. 运算符两边各用一个空格隔开。

    1. int result = a + b; // Good, = 和 + 两边各用一个空格隔开
    2. int result=a+b; // Bad,=和+两边没用空格隔开

  5. 方法的每个参数之间用一个空格隔开。

    1. public void method(String param1, String param2); // Good，param1 后面的逗号与 String 之间隔了一个空格
    2. method(param1, param2); // Good，方法调用时，param1 后面的逗号与 param2 之间隔了一个空格
    3. method(param1,param2); // Bad，没有用个空格隔开

  6. 空行的使用：将逻辑相关的代码段用空行隔开，以提高可读性。空行也只空一行，不要空多行。

    在以下情况需用一个空行：

    • 两个方法之间
    • 方法内的两个逻辑段之间
    • 方法内的局部变量和方法的第一条逻辑语句之间
    • 常量和变量之间

  7. 当一个表达式无法容纳在一行内时，可换行显示，另起的新行用 8 个空格缩进。

    1. someMethod(longExpression1, longExpression2, longExpression3,
    2.         longExpression4, longExpression5);

  8. 一行声明一个变量，不要一行声明多个变量，这样有利于写注释。

    1. private String param1; // 参数1
    2. private String param2; // 参数2文字大小的单位统一用 sp，元素大小的单位统一用 dp。

  9. 一个方法最多不要超过 40 行代码。

  10. 范围型的常量用枚举类定义，而不要直接用整型或字符，这样可以减少范围值的有效性检查。

    1. // 用枚举类定义，Good
    2. public enum CouponType {
    3.     // 现金券
    4.     @SerializedName("1")
    5.     CASH,
    7.     // 抵用券
    8.     @SerializedName("2")
    9.     DEBIT,
    11.     // 折扣券
    12.     @SerializedName("3")
    13.     DISCOUNT
    14. }
    15. // 用整型定义，Bad
    16. public static final int TYPE_CASH = 1; // 现金券
    17. public static final int TYPE_DEBIT = 2; // 抵扣券
    18. public static final int TYPE_DISCOUNT = 3; // 折扣券

  11. 文字大小的单位统一用 sp，元素大小的单位统一用 dp。

  12. 应用中的字符串统一在strings.xml中定义，然后在代码和布局文件中引用。

  13. 颜色值统一在colors.xml中定义，然后在代码和布局文件中引用。另外，不要在代码和布局文件中引用系统的颜色，除了透明。

三、命名规范

  1. 包名：按组件类型分包，而不是按照业务模块分包。业务有可能会变，但组件类型是基本不变的。另外，新加入的开发人员，对业务不熟悉，但对组件是很清楚的，理解快，入手也快。

    1. 域名反写 + 项目名称 + 模块名称，全部单词用小写字母。
    2. org.123si.app
    3. 包的单一
    4. activity包：org.123si.app.activity
    5. 适配器包：org.123si.app.adapter
    6. 工具包：org.123si.app.utils
    7. 实体包：org.123si.app.bean
    8. fragment包：org.123si.app.fragment

  2. 类和接口命名

  3. 使用大驼峰规则，用名词或名词词组命名，每个单词的首字母大写。

    以下为几种常用类的命名：

    • activity 类，命名以 Activity 为后缀，如：LoginActivity

    • fragment 类，命名以 Fragment 为后缀，如：ShareDialogFragment

    • service 类，命名以 Service 为后缀，如：DownloadService

    • adapter 类，命名以 Adapter 为后缀，如：CouponListAdapter

    • 工具类，命名以Util为后缀，如：EncryptUtil

    • 模型类，命名以 BO 为后缀，如：CouponBO

    • 接口实现类，命名以 Impl 为后缀，如：ApiImpl

  4. 方法命名：使用小驼峰规则，用动词命名，第一个单词的首字母小写，其他单词的首字母大写。

    以下为几种常用方法的命名：

    • 初始化方法，命名以 init 开头，例：initView

    • 按钮点击方法，命名以 to 开头，例：toLogin

    • 设置方法，命名以 set 开头，例：setData

    • 具有返回值的获取方法，命名以 get 开头，例：getData

    • 通过异步加载数据的方法，命名以 load 开头，例：loadData

    • 布尔型的判断方法，命名以 is 或 has，或具有逻辑意义的单词如 equals，例：isEmpty

  5. 常量命名：全部为大写单词，单词之间用下划线分开，并且能见其名知其意

    1. 比如：MAX_VALUE = 10

  6. 变量命名：{范围描述+}意义描述+类型描述的组合，用驼峰式，首字母小写。命名小写，且具有意义，尽量避免使用单个字符，否则遇到该变量很难理解其用途。对于临时变量，例如记忆循环语句中的循环次数，通常可以命名为i,j,k这样的单字符变量名。变量名应简短其富与描述，以便容易记忆。

    1. 全局变量：
    2. private static final String TAG = "log.MainActivity"
    3. private TextView mTxtTitle
    4. private EditText mEdtUsername
    5. private Button mBtnLogin
    6. private ImageView mImgAvator
    7. private ListView mListGame
    8. private List<Map<String, String>> mGameList
    9. private GameBean mGameBean

  7. 控件 id 命名：控件缩写{范围}意义，范围可选，只在有明确定义的范围内才需要加上。

  8. layout命名：组件类型{范围}功能，范围可选，只在有明确定义的范围内才需要加上。

    以下为几种常用的组件类型命名：

    • activity_{范围_}功能，为 Activity 的命名格式

    • fragment_{范围_}功能，为 Fragment 的命名格式

    • dialog_{范围_}功能，为 Dialog 的命名格式

    • item_list_{范围_}功能，为 ListView 的 item 命名格式

    • item_grid_{范围_}功能，为 GridView 的 item 命名格式

    • header_list_{范围_}功能，为 ListView 的 HeaderView 命名格式

    • footer_list_{范围_}功能，为 ListView 的 FooterView 命名格式

  9. strings的命名：类型{范围}功能，范围可选。

    以下为几种常用的命名：

    • 页面标题，命名格式为：title_页面

    • 按钮文字，命名格式为：btn_按钮事件

    • 标签文字，命名格式为：label_标签文字

    • 选项卡文字，命名格式为：tab_选项卡文字

    • 消息框文字，命名格式为：toast_消息

    • 编辑框的提示文字，命名格式为：hint_提示信息

    • 图片的描述文字，命名格式为：desc_图片文字

    • 对话框的文字，命名格式为：dialog_文字

    • menu 的 item 文字，命名格式为：action_文字

  10. colors 的命名：前缀{控件}{范围}{_后缀}，控件、范围、后缀可选，但控件和范围至少要有一个。

    • 背景颜色，添加 bg 前缀

    • 文本颜色，添加 text 前缀

    • 分割线颜色，添加 div 前缀

    • 区分状态时，默认状态的颜色，添加 normal 后缀

    • 区分状态时，按下时的颜色，添加 pressed 后缀

    • 区分状态时，选中时的颜色，添加 selected 后缀

    • 区分状态时，不可用时的颜色，添加 disable 后缀

  11. drawable 的命名：前缀{控件}{范围}{_后缀}，控件、范围、后缀可选，但控件和范围至少要有一个。

    • 图标类，添加 ic 前缀

    • 背景类，添加 bg 前缀

    • 分隔类，添加 div 前缀

    • 默认类，添加 def 前缀

    • 区分状态时，默认状态，添加 normal 后缀

    • 区分状态时，按下时的状态，添加 pressed 后缀

    • 区分状态时，选中时的状态，添加 selected 后缀

    • 区分状态时，不可用时的状态，添加 disable 后缀

    • 多种状态的，添加 selector 后缀（一般为 ListView 的 selector 或按钮的 selector）

  12. 动画文件命名：动画类型_动画方向。

    • fade_in，淡入

    • fade_out，淡出

    • push_down_in，从下方推入

    • push_down_out，从下方推出

    • slide_in_from_top，从头部滑动进入

    • zoom_enter，变形进入

    • shrink_to_middle，中间缩小

四、注释范围

  1. 类和接口注释

    1. /**
    2. * 类或接口的描述信息
    3. *
    4. * @author ${USER}
    5. * @date ${DATE}
    6. */

  2. 方法注释：下面几种方法，都必须添加 javadoc 注释，说明该方法的用途和参数说明，以及返回值的说明。

    • 接口中定义的所有方法

    • 抽象类中自定义的抽象方法

    • 抽象父类的自定义公用方法

    • 工具类的公用方法

      1. /**
      2. * 登录
      3. *
      4. * @param loginName 登录名
      5. * @param password  密码
      6. * @param listener  回调监听器
      7. */
      8. public void login(String loginName, String password, ActionCallbackListener listener)

  3. 变量和常量注释：下面几种情况下的常量和变量，都要添加注释说明，优先采用右侧//来注释，若注释说明太长则在上方添加注释。

    • 接口中定义的所有常量

    • 公有类的公有常量

    • 枚举类定义的所有枚举常量

    • 实体类的所有属性变量

    1. public static final int TYPE_CASH = 1; // 现金券
    2. public static final int TYPE_DEBIT = 2; // 抵扣券
    3. public static final int TYPE_DISCOUNT = 3; // 折扣券
    4. ...
    5. private int id;                // 券id
    6. private String name;           // 券名称
    7. private String introduce;      // 券简介

(完)