Android 开发参考规范

Android学习笔记

目录

  1. 参考来源
  2. 目标
  3. 总结
    1. Java
    2. C/C++

参考来源

建议仔细阅读以下文档:

  1. Google Java Style Guide
  2. Google C++ Style Guide
  3. Android Source Style Guide

目标

简单，统一，高效

总结

Java

1. 类名大小写敏感，首字母小写，后缀名.java

2. 源代码UTF-8编码

3. 缩进使用空格(0x20)，除去空格的其余所有空白字符使用转义(\t等)

4. 转义字符优先使用(\b, \t, \n, \f, \r, \", \'和\\)，其次使用八进制或十六进制表示；在布局文件xml中的特殊字符Android Studio会给出对应转义提示

5. 不使用通配符(*)进行导入import

6. 类的重载方法应该按顺序在一起，构造方法同理

7. 即使if等语句只有一行语句时，也需要使用花括号({})，花括号遵循K&R Style

8. 一行一条语句，长度最大100

9. 水平空白和垂直空白根据逻辑和美观进行添加

10. 运算符优先级使用小括号指定

11. switch都包含default语句，即使什么代码也没有

12. 注释块遵循如下格式 

1
2
3
4
/*
 * This is          // And so           /* Or you can
 * okay.            // is this.          * even do this. */
 */

13. Modifiers出现顺序

public protected private abstract static final transient volatile synchronized native strictfp

14. long 后缀使用 L，十六进制和八进制前缀使用0x和o

15. 命名约定：

  • 标识符只使用ASCII和数字

  • 包名全部小写，中间无下划线

  • 类名使用UpperCamelCase风格

  • 方法名使用lowerCamelCase风格

  • 常量使用static fianl，大写字母并以下划线分割

  • CamelCase：每个单词首字母大写，其余小写

16. 编程习惯：

  • 使用Java提供的注解(@Override, @Deprecated 和 @SuppressWarnings)

  • 异常捕获最好指定类型，并给出异常时的解决方案

  • 静态成员和静态方法使用类变量进行调用

  • 类成员的习惯命名格式(注意前面的m)

1
2
3
4
5
6
7
8
public class MyClass {
    public static final int SOME_CONSTANT = 42;
    public int publicField;
    private static MyClass sSingleton;
    int mPackagePrivate;
    private int mPrivate;
    protected int mProtected;
}

  • 特有名词当成普通单词，例如 IOS->Ios

  • 使用TODO进行未完成的注释

  • 日志使用Log，使用tag分类，注意各种级别：

级别 适用场景
ERROR 致命错误导致的运行时异常(crash)
WARNING 不会导致崩溃，但需要进一步去改进
INFORMATION 报告一些对于大多数人感兴趣的信息
DEBUG 调试时产生异常的信息
VERBOSE 普通提示信息，用于观察程序运行

  • Java访问权限最小化，包括:

    • 变量优先使用局部变量 > 成员变量 > 静态变量
    • 方法优先使用private > protected > default > public
    • 定义优先模块 > 全局

  • 使用Annotations和常量代替枚举

  • 资源文件命名要使用类型前缀，资源id要使用资源文件名作为前缀

  • 优先使用res进行资源定义，避免代码写死

  • 多使用Android提供的特定API

C/C++

暂时没有使用NDK开发，待续。。。