Android 宝典：代码规范与命名规范

博主声明：

转载请在开头附加本文链接及作者信息，并标记为转载。本文由博主 威威喵 原创，请多支持与指教。

本文首发于此   博主：威威喵  |  博客主页：https://blog.csdn.net/smile_running

• 书写规范

1. 编码方式统一用UTF-8. Android Studio默认已是UTF-8，只要不去改动它就可以了。

2. 缩进统一为4个空格，将Tab size设置为4则可以保证tab键按4个空格缩进。另外，不要勾选上Use tab character，可以保证切换到不同tab长度的环境时还能继续保持统一的4个空格的缩进样式。

3. 花括号不要单独一行，和它前面的代码同一行。而且，花括号与前面的代码之间用一个空格隔开。空方法允许花括号和方法名占同一行。

4. 空格的使用

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

// Good
if (booleanVariable) {
    // TODO while booleanVariable is true
} else {
    // TODO else
}

// Bad
if(booleanVariable) {
    // TODO while booleanVariable is true
}else {
    // TODO else
}

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

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

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

5. 空行的使用

将逻辑相关的代码段用空行隔开，以提高可读性。空行也只空一行，不要空多行。在以下情况需用一个空行：

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

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

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

private String param1; // 参数1
private String param2; // 参数2

8. 行宽设置为100，设置格式化时自动断行到行宽位置。

9. 使用快捷键进行代码自动格式化。

Windows：CTRL+ALT+L 

Mac：OPTION+COMMAND+L

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

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

// 用枚举类定义，Good
public enum CouponType {
    // 现金券
    @SerializedName("1")
    CASH,
    // 抵用券
    @SerializedName("2")
    DEBIT,
    // 折扣券
    @SerializedName("3")
    DISCOUNT
}

// 用整型定义，Bad
public static final int TYPE_CASH = 1; // 现金券
public static final int TYPE_DEBIT = 2; // 抵扣券
public static final int TYPE_DISCOUNT = 3; // 折扣券

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

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

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

• 命名规范

1. 包命名

域名反写+项目名称+模块名称，全部单词用小写字母。例如，机器人项目的Model模块包名如下：

2. 类和接口命名

使用大驼峰规则，用名词或名词词组命名，每个单词的首字母大写。以下为几种常用类的命名：

• activity类，命名以Activity为后缀，如：LoginActivity
• fragment类，命名以Fragment为后缀，如：ShareDialogFragment
• service类，命名以Service为后缀，如：DownloadService
• adapter类，命名以Adapter为后缀，如：CouponListAdapter
• 工具类，命名以Util为后缀，如：EncryptUtil
• 模型类，命名以BO为后缀，如：CouponBO
• 接口实现类，命名以Impl为后缀，如：ApiImpl

3. 方法命名

使用小驼峰规则，用动词或者动名词命名，第一个单词的首字母小写，其他单词的首字母大写。以下为几种常用方法的命名：

• 初始化方法，命名以init开头，例：initView
• 按钮点击方法，命名以to开头，例：toLogin
• 设置方法，命名以set开头，例：setData
• 具有返回值的获取方法，命名以get开头，例：getData
• 通过异步加载数据的方法，命名以load开头，例：loadData
• 布尔型的判断方法，命名以is或has，或具有逻辑意义的单词如equals，例：isEmpty

4. 控件缩写

控件	缩写	控件	缩写
TextView	txt	EditText	edt
Button	btn	ImageButton	imgbtn
ImageView	imgv	ListView	listv
RadioGroup	rgroup	RadioButton	rbtn
ProgressBar	proBar	SeekBar	skBar
CheckBox	chk	Spinner	spn
TableLayout	table	TableRow	row
LinearLayout	llayout	RelativeLayout	rlayout
ScrollView	scroll	SearchView	search
TabHost	host	TabWidget	widget
ZoomControl	zmCtl	VideoView	vdoVi
AutoCompleteTextView	autoTxt	WebView	webv
TimePicker	tmPk	toggleButton	tglBtn
toggleButton	tglBtn	GridView	gv
RecyclerView	recyv

5. 常量命名

全部为大写单词，单词之间用下划线分开。

6. 变量命名

{范围描述+}意义描述+类型描述的组合，用驼峰式，首字母小写。

１．私有成员变量加前缀 m

２．临时变量加前缀 _

３．参数前缀加  p (不强制要求)

7. 控件id命名

控件缩写_{范围_}意义，范围可选，只在有明确定义的范围内才需要加上。

8. layout命名

组件类型_{范围_}功能，范围可选，只在有明确定义的范围内才需要加上。以下为几种常用的组件类型命名：

• activity_{范围_}功能，为Activity的命名格式
• fragment_{范围_}功能，为Fragment的命名格式
• dialog_{范围_}功能，为Dialog的命名格式
• item_list_{范围_}功能，为ListView的item命名格式
• item_recy_{范围_}功能，为RecyclerView的item命名格式
• item_grid_{范围_}功能，为GridView的item命名格式
• header_list_{范围_}功能，为ListView的HeaderView命名格式
• footer_list_{范围_}功能，为ListView的FooterView命名格式

9. strings和 dimens的命名

非共有类型：{模块描述}_{视图类型}_{业务描述}_{后缀}

共有功能类型：{业务功能}_{视图类型}_{业务描述}_{后缀}

后缀:_normal,_pressed,_selected,_selector,_disable……

表示登录页面中的密码输入框的提示文本

请输入密码

表示登录页面中的密码输入框的默认显示密码为123456,

123456

订单列表中的确认收货按钮的文本

确认收货

订单列表中的确认收货按钮被按下时候的文本

确认收货

order 表示视图功能描述，list_item_btn 是视图类型，confirmreceipt 是业务描述

• 页面标题，命名格式为:home_activity_title   
• 按钮文字，命名格式为： login_btn_txt
• 标签文字，命名格式为：order_lable_goods_price
• 选项卡文字，命名格式为：home_tab_mine
• 消息框文字，命名格式为：home_toast_retry_connect
• 编辑框的提示文字，命名格式为：login_et_hint
• 对话框的文字，命名格式为：softupdate_dialog_title
• menu的item文字，命名格式为：home_menu

10. colors的命名

非共有类型：{前缀}_{模块描述}_{视图类型}_{业务描述}_{后缀}

共有功能类型：{业务功能}_{视图类型}_{业务描述}_{后缀}

前缀{_控件}{_范围}{_后缀}，控件、范围、后缀可选，但控件和范围至少要有一个。

    @color/red
    @color/red
    
    @color/red
    
    @color/blue
    
    @color/red
    
    @color/blue

• 区分状态时，默认状态的颜色，添加normal后缀
• 区分状态时，按下时的颜色，添加pressed后缀
• 区分状态时，选中时的颜色，添加selected后缀
• 区分状态时，不可用时的颜色，添加disable后缀

11. drawable的命名

前缀{_控件}{_范围}{_后缀}，控件、范围、后缀可选，但控件和范围至少要有一个。

• 图标类，添加ic前缀
• 背景类，添加bg前缀
• 分隔类，添加div前缀
• 默认类，添加def前缀
• 区分状态时，默认状态，添加normal后缀
• 区分状态时，按下时的状态，添加pressed后缀
• 区分状态时，选中时的状态，添加selected后缀
• 区分状态时，不可用时的状态，添加disable后缀
• 多种状态的，添加selector后缀（一般为ListView的selector或按钮的selector）

名称	功能	例子
btn_xx	按钮图片使用btn_整体效果（selector）	btn_login
btn_xx_normal	按钮图片使用btn_正常情况效果	btn_login_normal
btn_xx_pressed	按钮图片使用btn_点击时候效果	btn_login_pressed
btn_xx_focused	state_focused聚焦效果	et_username_focused
btn_xx_disabled	state_enabled (false)不可用效果	btn_login_disabled
btn_xx_checked	state_checked选中效果	btn_ hobby_checked
btn_xx_selected	state_selected选中效果	btn_hobby_selected
btn_xx_hovered	state_hovered悬停效果	btn_login_hovered
btn_xx_checkable	state_checkable可选效果	btn_ hobby_checkable
btn_xx_activated	state_activated激活的	btn_login.activated
btn_xx_windowfocused	state_window_focused	et_pasword_windowfocused
bg_xx	背景图片使用bg_功能_说明	bg_home

12. 动画文件命名

动画类型_动画方向。

模块名_逻辑名称

逻辑名称

refresh_progress.xml

market_cart_add.xml

market_cart_remove.xml

普通的tween动画采用如下表格中的命名方式

• fade_in，淡入
• fade_out，淡出
• push_down_in，从下方推入
• push_down_out，从下方推出
• slide_in_from_top，从头部滑动进入
• zoom_enter，变形进入
• shrink_to_middle，中间缩小

 

• 注释规范

1. 文件头注释

文件顶部统一添加版权声明，声明的格式如下：

2. 类和接口注释

类和接口统一添加javadoc注释，格式如下：

/**
 * 类或接口的描述信息
 *
 * @author ${USER}
 * @date ${DATE}
 */

3. 方法注释

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

• 接口中定义的所有方法
• 抽象类中自定义的抽象方法
• 抽象父类的自定义公用方法
• 工具类的公用方法

/**
 * 登录
 *
 * @param loginName 登录名
 * @param password  密码
 * @param listener  回调监听器
 */
public void login(String loginName, String password, ActionCallbacListener listener);

4. 变量和常量注释

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

• 接口中定义的所有常量
• 公有类的公有常量
• 枚举类定义的所有枚举常量
• 实体类的所有属性变量

public static final int TYPE_CASH = 1; // 现金券
public static final int TYPE_DEBIT = 2; // 抵扣券
public static final int TYPE_DISCOUNT = 3; // 折扣券

private int id;                // 券id
private String name;           // 券名称
private String introduce;      // 券简介

• 常见缩写表

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