Android代码书写规范

公司文档

---

版本	日期	作者	更新内容
1.0	2015-4-25	王恒	初稿

1. Java代码

1.1 命名规范

1.1.1 类名

类名遵循驼峰命名法，首字母大写,类名只允许英文单词，绝对不可以出现如中文、数字、下划线、全大写字母、全小写字母等

• 错误的示例

// 数字
public class Part9{
}
// 拼音
public class PartJiu(){
}
// 数字和下划线
public class Part_9{
}

• 正确的示例

public class PartNine{
}

1.1.2 常量

• 必须定义在类的最开始处,以static final修饰
• 必须全部由大写字母组成，并以下划线_分隔单词
• 绝对不能出现数字、拼音等内容

特别注意

代码里面绝对不要出现魔术字，防止产生歧义和Bug

// 错误的使用魔术字
getIntent().getIntExtra(KEY_ID,-1);
// 正确的方式是定义一个常量来表示非法状态
private static final int INVALID_ID = -1;
getIntent().getIntExtra(KEY_ID,INVALID_ID);

1.1.3 静态变量

• 静态变量声明在常量之后，以s开头(如sInstance等)
• 使用驼峰命名法
• 绝对不允许出现拼音
• 尽量不要出现数字，如果需要使用数字的表示多个类似的变量，考虑使用集合代替

1.1.3 普通变量

• 非public的、非static的字段名称以m开头。
• 其它字段以小写字母开头。
• 使用驼峰命名法
• 绝对不要出现拼音
• 尽量不要出现数字，如果需要使用数字的表示多个类似的变量，考虑使用集合代替

特别注意

• 如果是普通的POJO（普通Java对象）一般对变量提供setter、getter方法和toString()方法
• 需要Serialization的变量，一定要实现Serialization接口，并添加序列化id ,如private static final long serialVersionUID = - 792307888317213554L;
• 如果字段存放在Fragment或者Activity中，则要考虑内存回收的问题，在onSaveInstanceState和onCreate或onCreateView方法中保存和恢复变量

1.1.4 方法

• 遵循驼峰命名法，并且首字母小写
• 绝对不可以出现拼音
• 方法的名字和参数一定能表达出方法的意义和参数的意义
• 绝对不可以出现数字
• 方法名字不可以有歧义

1.1.5 注释

• 对所有的类、方法、字段必须添加注释(使用我们的注释模板)
• XML文件中尽量也添加注释

1.1.6 分包

• 我们根据模块&公共包的方式进行分包
• 我们后面添加的模块如果功能比较多，涉及网络请求的必须封装成MVP
• 前期尚未封装成MVP的代码，后面也会逐步封装成MVP

1.2 格式化

• 一定要导入我们的格式化模板
• 快捷键CTRL + SHIFT + F可以快速格式化代码
• 使用鼠标右键Source --> Format也可以格式化代码
• CTRL + SHIFT + O 可以整理我们的import语句

1.2.1 {}

• 绝对不能出现下面这种看似简洁的代码：

// 错误的写法
if(condition) doByCondition();
// 正确的写法
if(condition){
    doByCondition();
}

• 绝对不可以在第一个{之前进行换行：

// 错误的写法
if(condition)
{
    doByCondition();
}
// 正确的写法
if(condition) {
    doByCondition();
}

1.2.2 运算符前后的空白

• 运算符左边和右边一定要加上一个空格:

// 错误的写法
if(a>b){
    max=a;
}
// 正确的写法
if(a > b){
    max = a;
}

2.XML代码

• 使用下划线分隔英文单词的方式进行命名
• 绝对不可以出现拼音

• 布局文件命名

  • 如果是activity的布局，则使用activity_Activity名称的方式命名，如MainActivity的布局文件activity_main.xml
  • 如果是fragment的布局，则使用fragment_fragment名称的方式命名，如EventFragment的布局文件fragment_event.xml
  • 如果是列表的空View，如果只针对具体界面则使用empty_界面名称，如MainActivity，empty_main_activity.xml；如果是通用的，则使用emptyView的功能来命名，如没有网络的命名方式empty_no_network.xml
  • 如果是FooterView或者HeaderView则使用'footer_xxx'或者header_xxx的方式来命名文件
  • 如果是ListView的布局，则使用item_(activity,framgent,或者模块名)来命名
  • 如果是要被包含到其他布局中的布局，则以include_功能或内容的含义.xml的方式命名
  • 如果布局文件仅仅是为了某些特定的组件，则以layout_组件类型_组件功能.xml的方式命名，如layout_dialog_exit.xml
  • 其他布局文件需要以layout_功能.xml的方式书写

• 其他资源放入到指定类型的文件中

• view的id命名以view名缩写 + 模块名 + 功能的方式书写，如EventFragment的Topbar是一个FrameLayout，则它的id是flEventFragmentTopbar

• 字符串资源以模块_字符串的含义来命名，如EventFragment的Topbar的标题的命名方式event_topbar_title
• 有需要在布局文件中使用自定义的styleable的，需要在根布局中引入自动命名空间xmlns:custom="http://schemas.android.com/apk/res-auto"

3、其他需要注意的点

3.1、防止内存泄漏问题

• 除了我封装的Application的Context对象，其他任何地方绝对不可以有static的Context(包括Activity,Contxt,Service,Fragment)的引用
• 除了我封装的Application的Context对象(最好也不要让Thread引用)，在新开启的线程中绝对不可以有Context的引用
• 不要忘记关闭cursor：

// 错误的代码，查询三次都使用了同一个引用，导致上一次查询的cursor没有关闭
Cursor cursor = query();
cursor = query();
cursor = query();
// 正确的 处理
Cursor cursor = query();
cursor.close();
cursor = null;
cursor = query();
cursor.close();
cursor = null;
cursor = query();
cursor.close();
cursor = null;

• 对于Stream也要和cursor类似的处理
• 在代码中register的Receiver一定要unregister
• 尽量少使用static的变量
• 需要加载图片的地方优先考虑使用Picasso进行加载，尽量少的去直接操作Bitmap
• 在Fragment被Detach或者Destory之后绝对不要执行Fragment的事务
• 提交Fragment事务的时候，尽量使用commitAllowingStateLoss()方法替换commit()方法
• 能不是用Timer的地方就尽量不要使用Timer
• 尽量使用static的Handler内部类而不是普通类
• 尽量不要使用非静态的内部类

3.2 减少资源浪费

• 如果代码手动持有一个WakeLock一定不要忘了释放