Android 命名规范整理

Android 命名规范整理

类结构

区块划分：

1. 常量声明区
2. UI控件成员变量声明区
3. 普通成员变量声明区
4. 内部接口声明区
5. 初始化相关方法区
6. 事件响应方法区
7. 普通逻辑方法区
8. 重载的逻辑方法区
9. 发起异步任务方法区
10. 异步任务回调方法区
11. 生命周期回调方法区（出去onCreate()方法
12. 内部类声明区

类成员排列通用规则：

1. 按照发生的先后顺序排列
2. 常量按照使用先后排列
3. UI控件成员变量按照layout文件中的先后顺序排列
4. 普通成员变量按照使用的先后顺序排列
5. 方法基本上都按照调用的先后顺序在各自区块中排列
6. 相关功能作为小区块放在一起（或者封装掉）

代码规范格式

1.重载方法放在一起
规范:
按照参数从少到多，从易到难排列

行规范

1.大括号与if, else, for, do, while语句一起使用，即使只有一条语句(或是空)，也应该把大括号写上
左大括号前不换行
左大括号后换行
右大括号前换行
如果右大括号是一个语句、函数体或类的终止，则右大括号后换行; 否则不换行。
一个空的块状结构里什么也不包含，大括号可以简洁地写成{}，不需要换行

2.一个项目可以选择一行80个字符或100个字符的列限制
除外的：不可能满足列限制的行(例如，Javadoc中的一个长URL，或是一个长的JSNI方法参考)
package和import语句
注释中那些可能被剪切并粘贴到shell中的命令行

3.自动换行
自动换行的基本准则是：更倾向于在更高的语法级别处断开。
（+ 类运算符 .）在该符号前换行
（=）在该符号后换行
方法名或构造函数名与左括号留在同一行。逗号(,)与其前面的内容留在同一行。

4.以下情况需要使用一个空行：
类内连续的成员之间：字段，构造函数，方法，嵌套类，静态初始化块，实例初始化块。
在函数体内，语句的逻辑分组间使用空行。
import语句可分为以下几组,组间需要换行
所有的静态导入独立成组
com.google imports(仅当这个源文件是在com.google包下)
第三方的包。每个顶级包为一组，字典序。例如：android, com, junit, org, sun
java imports5.javax imports组内不空行，按字典序排列。

列规范

1.以下请款需要空格
分隔任何保留字与紧随其后的左括号(()(如if, for catch等)。
分隔任何保留字与其前面的右大括号(})(如else, catch)。
在任何左大括号前({) 。两个例外： @SomeAnnotation({a, b})(不使用空格). String[][] x = foo;(大括号间没有空格，见下面的Note)。
在任何二元或三元运算符的两侧
在, : ;及右括号())后

关键字排序

头部关键字出现顺序：
1. public
2. protected
3. private
4. abstract
5. static
6. final
7. transient
8. volatile
9. synchronized
10. native
11. strictfp

import规范

import不要使用通配符(如：import java.util.*)

变量的申明

1.不要使用组合声明，比如int a, b;。
2.需要时才声明变量，并尽快进行初始化,不要在一个代码块的开头把局部变量一次性都声明了(这是c语言的做法)。
3.数组风格（3种）：
String[] args ( 非 String args[])
new int[] {
0, 1, 2, 3
}
new int[] {
0,
1,
2,
3
}
4.switch规范
1.在程序要跳转出去的地方加注释说明
2.每个switch语句都包含一个default语句组，即使它什么代码也不包含。

switch (input) {
    case 1:
    case 2:
        prepareOneOrTwo(); // fall through
    case 3:
        handleOneTwoOrThree();
        break;
    default:
        handleLargeNumber(input);
    }

编程细节规范

1.@Override：能用则用, 只要是合法的,就把 @Override注解给用上。
2.异常处理 如果它被认为是不可能的：往外继续抛出 如果它确实是不需要在catch块中做任何响应：需要做注释加以说明

try {
        int i = Integer.parseInt(response);
        return handleNumericResponse();
    } catch (NumberFormatException ok) {
        // it's not numeric; that's fine, just continue
    }

在测试中，如果一个捕获的异常被命名为expected，则它可以被不加注释地忽略。用以确保所测试的方法会抛出一个期望中的异常，因此在这里就没有必要加注释。
4.不要使用finalize。如果你非要使用它，请先仔细阅读和理解Effective Java第7条款：”Avoid Finalizers”，然后不要使用它。

包名

包名全部小写，连续的单词只是简单地连接起来，不使用下划线。
采用反域名命名规则，全部使用小写字母。一级包名为com，二级包名为xx（可以是公司或则个人的随便），三级包名根据应用进行命名，四级包名为模块名或层级名。
例如：
com.bitmain.connect.ui

包名	包含模块
com.xx.activity	页面用到的Activity类(activitie层级名用户界面层)
com.xx.base	基础共享的类
com.xx.util	公共工具方法类(util模块名)
com.xx.bean	包含通用的JavaBean类
com.xx.model	模型类
com.xx.db	数据库相关操作类
com.xx.view(或者com.xx.widget)	自定义的View类等
com.xx.service	Service服务
com.xx.receiver	BroadcastReceiver服务

注意：
如果项目采用MVP，所有M、V、P抽取出来的接口都放置在相应模块的i包下，所有的实现都放置在相应模块的impl下

类名

类名都以UpperCamelCase风格编写。
类名通常是名词或名词短语，接口名称有时可能是形容词或形容词短语。现在还没有特定的规则或行之有效的约定来命名注解类型。
名词，采用大驼峰命名法，尽量避免缩写，除非该缩写是众所周知的， 比如HTML,URL，如果类名称中包含单词缩写，则单词缩写的每个字母均应大写。

类	描述	例如
Activity	Activity为后缀标识	欢迎页面类 WelcomeActivity
Adapter	Adapter 为后缀标识	联系人详情适配器 ContactsAdapter
解析类	Parser为后缀标识	命令解析类 CommandParse
工具方法类	功能+Utils	日志打印工具类 LogUtils
数据库类	DBHelper后缀标识	好友数据库 ContactsDbHelper
Service	Service为后缀标识	Http后台服务 HttpsService
Receiver	Receiver为后缀标识	网络切换广播 NetChangeReciver
ContentProvider	Provider为后缀标识	好友数据表 PersonProvider
自定义的共享基础类	Base开头	Activity基类 BaseActivity
测试类	测试的类的名称开始，以Test结束	注册测试 LoginActivityTest
接口	与类一样采用大驼峰命名法，多以able或ible结尾	Runnable,Accessible

注意：
如果项目采用MVP，所有Model、View、Presenter的接口都以I为前缀，不加后缀，其他的接口采用上述命名规则。

方法名

方法名都以 LowerCamelCase 风格编写。
方法名通常是动词或动词短语。

方法	说明
initXX()	初始化相关方法,使用init为前缀标识，如初始化布局initView()
isXX() checkXX()	方法返回值为boolean型的请使用is或check为前缀标识
getXX()	返回某个值的方法，使用get为前缀标识
handleXX()	对数据进行处理的方法，尽量使用handle为前缀标识
displayXX()/showXX()	弹出提示框和提示信息，使用display/show为前缀标识
saveXX()	与保存数据相关的，使用save为前缀标识
resetXX()	对数据重组的，使用reset前缀标识
clearXX()	清除数据相关的
removeXXX()	清除数据相关的
drawXXX()	绘制数据或效果相关的，使用draw前缀标识

下划线可能出现在JUnit测试方法名称中用以分隔名称的逻辑组件。一个典型的模式是：test_，例如testPop_emptyStack。
并不存在唯一正确的方式来命名测试方法。

常量名

常量名命名模式为CONSTANT_CASE，全部字母大写，用下划线分隔单词。那，到底什么算是一个常量？
每个常量都是一个静态final字段，但不是所有静态final字段都是常量。在决定一个字段是否是一个常量时，考虑它是否真的感觉像是一个常量。
例如，如果任何一个该实例的观测状态是可变的，则它几乎肯定不会是一个常量。只是永远不打算改变对象一般是不够的，它要真的一直不变才能将它示为常量。

// Constants
static final int NUMBER = 5;
static final ImmutableListNAMES = ImmutableList.of("Ed", "Ann");
static final Joiner COMMA_JOINER = Joiner.on(','); // because Joiner is immutable
static final SomeMutableType[] EMPTY_ARRAY = {};
enum SomeEnum { ENUM_CONSTANT }
// Not constants
static String nonFinal = "non-final";
final String nonStatic = "non-static";
static final SetmutableCollection = new HashSet();
static final ImmutableSetmutableElements = ImmutableSet.of(mutable);
static final Logger logger = Logger.getLogger(MyClass.getName());
static final String[] nonEmptyArray = {"these", "can", "change"};

这些名字通常是名词或名词短语。

非常量字段名

非常量字段名以LowerCamelCase风格的基础上改造为如下风格：
基本结构为scopeVariableNameType

scope：范围

非公有，非静态字段命名以m开头。
静态字段命名以s开头。
公有非静态字段命名以p开头。
公有静态字段（全局变量）命名以g开头。
public static final 字段(常量) 全部大写，并用下划线连起来。
例如:

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

使用1字符前缀来表示作用范围，1个字符的前缀必须小写，前缀后面是由表意性强的一个单词或多个单词组成的名字，而且每个单词的首写字母大写，其它字母小写，这样保证了对变量名能够进行正确的断句。

Type：类型

考虑到Android中使用很多UI控件，为避免控件和普通成员变量混淆以及更好达意，所有用来表示控件的成员变量统一加上控件缩写作为后缀（文末附有缩写表）。
对于普通变量一般不添加类型后缀，如果统一添加类型后缀，请参考文末的缩写表。
用统一的量词通过在结尾处放置一个量词，就可创建更加统一的变量，它们更容易理解，也更容易搜索。

注意：如果项目中使用ButterKnife，则不添加m前缀，以LowerCamelCase风格命名。

例如，请使用 mCustomerStrFirst 和 mCustomerStrLast，而不要使用mFirstCustomerStr和mLastCustomerStr。
量词列表：量词后缀说明
First 一组变量中的第一个
Last 一组变量中的最后一个
Next 一组变量中的下一个变量
Prev 一组变量中的上一个
Cur 一组变量中的当前变量。

说明：
集合添加如下后缀：List、Map、Set
数组添加如下后缀：Arr

注意：所有的VO（值对象）统一采用标准的lowerCamelCase风格编写，所有的DTO（数据传输对象）就按照接口文档中定义的字段名编写。

参数名

参数名以LowerCamelCase风格编写

局部变量名

局部变量名以LowerCamelCase风格编写，比起其它类型的名称，局部变量名可以有更为宽松的缩写。
虽然缩写更宽松，但还是要避免用单字符进行命名，除了临时变量和循环变量。
即使局部变量是final和不可改变的，也不应该把它示为常量，自然也不能用常量的规则去命名它。

临时变量

临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。 如： for (int i = 0; i < len ; i++)，并且它和第一个单词间没有空格。

类型变量名

类型变量可用以下两种风格之一进行命名：
1. 单个的大写字母，后面可以跟一个数字(如：E,T,X,T2)。
2. 以类命名方式(5.2.2节)，后面加个大写的T(如：RequestT,FooBarT)。

资源文件命名

资源布局文件(XML文件（layout布局文件))

全部小写，采用下划线命名法

contentview 命名

必须以全部单词小写，单词间以下划线分割，使用名词或名词词组。
所有Activity或Fragment的contentView必须与其类名对应，对应规则为：
将所有字母都转为小写，将类型和功能调换（也就是后缀变前缀）。
例如：
activity_main.xml

Dialog命名

dialog_描述.xml
例如:
dialog_hint.xml

PopupWindow命名

ppw_描述.xml
例如:
ppw_info.xml

列表项命名

item_描述.xml
例如：
item_city.xml

包含项命名

模块_(位置)描述.xml
例如：
activity_main_head.xml、activity_main_bottom.xml

注意：
通用的包含项命名采用：项目名称缩写_描述.xml
例如：xxxx_title.xml

资源文件（图片drawable文件夹下）

全部小写，采用下划线命名法，加前缀区分
命名模式：可加后缀 _small 表示小图, _big 表示大图，逻辑名称可由多个单词加下划线组成，采用以下规则：

用途_模块名_逻辑名称
用途_模块名_颜色
用途_逻辑名称
用途_颜色

说明：用途也指控件类型（具体见UI控件缩写表）
例如:

btn_main_home.png按键
divider_maket_white.png 分割线
ic_edit.png 图标
bg_main.png 背景
btn_red.png 红色按键
btn_red_big.png 红色大按键
ic_head_small.png 小头像
bg_input.png输入框背景
divider_white.png白色分割线

如果有多种形态如按钮等除外如 btn_xx.xml（selector）

名称	功能
btn_xx	按钮图片使用btn_整体效果（selector）
btn_xx_normal	按钮图片使用btn_正常情况效果
btn_xx_pressed	按钮图片使用btn_点击时候效果
btn_xx_focused	state_focused聚焦效果
btn_xx_disabled	state_enabled (false)不可用效果
btn_xx_checked	state_checked选中效果
btn_xx_selected	state_selected选中效果
btn_xx_hovered	state_hovered悬停效果
btn_xx_checkable	state_checkable可选效果
btn_xx_activated	state_activated激活的
btn_xx_windowfocused	state_window_focused
bg_head	背景图片使用bg_功能_说明
def_search_cell	默认图片使用def_功能_说明
ic_more_help	图标图片使用ic_功能_说明
seg_list_line	具有分隔特征的图片使用seg_功能_说明
sel_ok	选择图标使用sel_功能_说明

使用AndroidStudio的插件SelectorChapek可以快速生成selector，前提是命名要规范。

动画文件（anim文件夹下）：

全部小写，采用下划线命名法，加前缀区分。
具体动画采用以下规则：

模块名_逻辑名称

逻辑名称

refresh_progress.xml
market_cart_add.xml
market_cart_remove.xml

普通的tween动画采用如下表格中的命名方式
前面为动画的类型，后面为方向

动画命名例子	规范写法
fade_in	淡入
fade_out	淡出
push_down_in	从下方推入
push_down_out	从下方推出
push_left	推向左方
slide_in_from_top	从头部滑动进入
zoom_enter	变形进入
slide_in	滑动进入
shrink_to_middle	中间缩小

values中name命名

strings的name命名使用下划线命名法
模块名+逻辑名称

main_menu_about 主菜单按键文字
friend_title好友模块标题栏
friend_dialog_del好友删除提示
login_check_email登录验证
dialog_title 弹出框标题
button_ok确认键 loading加载文字|

colors的name命名使用下划线命名法，采用以下规则：
模块名+逻辑名称 颜色

friend_info_bgfriend_bg transparent gray

styles的name命名使用Camel命名法，采用以下规则：
模块名+逻辑名称

main_tabBottom

layout中的id命名

命名模式为：
view缩写_view的逻辑名称

使用 AndroidStudio 的插件 ButterKnife Zelezny，生成注解非常方便。
如果不使用 ButterKnife Zelezny，则建议使用 view 缩写做后缀，如：username_tv（展示用户名的TextView）

附录
UI控件缩写表

控件	缩写	例子
LinearLayout	ll	llFriend或者mFriendLL
RelativeLayout	rl	rlMessage或mMessageRL
FrameLayout	fl	flCart或mCartFL
TableLayout	tl	tlTab或mTabTL
Button	btn	btnHome或mHomeBtn
ImageButton	ibtn	btnPlay或mPlayIBtn
TextView	tv	tvName或mNameTV
EditText	et	etName或mNameET
ListView	lv	lvCart或mCartLV
ImageView	iv	ivHead或mHeadIV
GridView	gv	gvPhoto或mPhotoGV

常见的英文单词缩写

名称	缩写
icon	ic （主要用在app的图标）
color	cl（主要用于颜色值）
divider	di（主要用于分隔线，不仅包括Listview中的divider，还包括普通布局中的线）
selector	sl（主要用于某一view多种状态，不仅包括Listview中的selector，还包括按钮的selector）
average	avg
background	bg（主要用于布局和子布局的背景）
buffer	buf
control	ctrl
delete	del
document	doc
error	err
escape	esc
increment	inc
infomation	info
initial	init
image	img
Internationalization	I18N
length	len
library	lib
message	msg
password	pwd
position	pos
server	srv
string	str
temp	tmp
window	wnd(win)