Android编码规范

2017-09-07 01:39:25

标签： 转载 Android 编码规范

# Android-Code-Style

## 1. 约定

* **Activity.onCreate()，Fragment.onActivityCreated()，紧跟成员变量后，方法内部保持简单，尽量只调用initXXX()方法，如：initData()，initView()。**
* 调用方法保持**“临近原则”**，被调用的方法，放在调用方法下方
* **单个方法体不要过长**
* **代码任何地方不要拼错单词**
* 统一调整IDE的Tab缩进为4个空格
* **杜绝整个类代码格式化**
	
## 2. 命名

### 2.1. 布局文件中的id命名

**规则：使用驼峰命名，前缀+逻辑名称，类变量名和布局文件id名称保持一致，不需要下划线分割**

* 如：TextView @+id/textTitle
* 如：EditView @+id/textName
* 如：Button @+id/btnSearch

### 2.2. 布局文件命名

**规则：** 使用**前缀_逻辑名称**命名，单词全部小写，单词间以 下划线 分割。

### 2.3. 资源文件命名

**规则：** 使用 **前缀_用途** 命名，单词全部小写，单词间以 下划线 分割。

* 第三方资源文件，不管在value、drawable
	
必须携带第三方资源前缀|
------------ |
umeng_socialize_style.xml |
pull_refresh_attrs.xml |

### 2.4. 类和接口命名

**规则：** 使用驼峰规则，首字母必须大写，使用名词或名词词组。要求简单易懂，富于描述，不允许出现无意义或错误单词。

### 2.5. 方法的命名

**规则：** 使用驼峰规则，首字母必须小写，使用动词。要求简单易懂，富于描述，不允许出现无意义或错误单词。

方法	| 说明
---	| ---			
initXX()	| 初始化相关方法，使用init为前缀标识，如初始化布局initView()
httpXX()	| http业务请求方法，以http为前缀标识
getXX()		| 返回某个值的方法，使用get为前缀标识
saveXX()	| 与保存数据相关的，使用save为前缀标识
deleteXX()	| 删除操作
resetXX()	| 对数据重组的，使用reset前缀标识
clearXX()	| 清除数据相关的
isXX()		| 方法返回值为boolean型的请使用is或check为前缀标识
processXX()	| 对数据进行处理的方法，尽量使用process为前缀标识
displayXX()	| 弹出提示框和提示信息，使用display为前缀标识
drawXXX()	| 绘制数据或效果相关的，使用draw前缀标识

### 2.6. 变量命名

**规则：** 使用驼峰规则，首字母必须小写，使用名词或名词词组。要求简单易懂，富于描述，不允许出现无意义或错误单词。

* 成员变量命名，自定义变量前添加m前缀，布局控件变量不用添加m前缀
* 常量命名，全部大写，单词间用下划线隔开

## 3. 其他规范
* Activity继承BaseFragmentActivity或SwipeBackActivity，可以使用ButterKnife注解代替findViewById
* 方法
	* 拆分臃肿方法，每个方法只作一件事
	* 做同一个逻辑的方法，尽量靠近放到一块，方便查看
	* 不要使用 try catch 处理业务逻辑
	* 使用JSON工具类，不要手动解析和拼装数据
* 控制语句
	* 减少条件嵌套，不要超过3层
	* if判断使用“卫语句”，减少层级	
	`
	if(obj != null) {
		doSomething();
	}	
	`	
	修改为：	
	`
	if(obj == null) {
		return;
	}
	doSomething();	`
	* if语句必须用{}包括起来,即便是只有一句
* 处理“魔数”等看不懂的神秘数字
	* 代码中不要出现数字，特别是一些标识不同类型的数字。
	* 所有意义数字全部抽取到Constant公共类中，避免散布在各位类中。
* 空行：空行将逻辑相关代码段隔开，简洁清楚，提高可读性
	* 成员变量之间，根据业务形成分组加空行
	* 方法之间加空行
* 用好TODO标记
	* 记录想法，记录功能点，开发过程中可以利用TODO记录一下临时想法或为了不打扰思路留下待完善的说明
	* 删除无用TODO，开发工具自动生成的TODO，或则已经完善的TODO，一定要删除。

## 4. IDE

* Android Studio (越早使用越好)
* Android SDK API 20（根据项目约定）
* JDK 1.8（根据项目约定）

## 5. Libraries

** Base **

* fastjson-android-1.2.4.jar
* okhttp-2.2.0.jar
* okio-1.2.0.jar
* picasso-2.5.0.jar
* butterknife:7.0.1
* ormlite-android:4.48

** UI **

* PullToRefresh
* QuickAdapter
* PagerSlidingTabStrip
* SystemBarTint		状态栏以及导航栏设置背景颜色
* SwipeBackLayout 	左滑返回
* PullToZoomView	可以下拉缩放HeaderView
* AutoLoopViewPager 轮播图
* PhotoView
* ViewPageIndicator

## View project on GitHub

* [https://github.com/tianshaojie/android-code-style](https://github.com/tianshaojie/android-code-style)

上一篇：Android Studio2.0 教程MAC版 - 提高篇（二）下一篇：APP开发必须知道的API集合

分享到：QQ空间新浪微博腾讯微博人人网微信

登录