[转]Android开发规范（updating）

原文链接：https://github.com/Blankj/AndroidStandardDevelop

安卓开发规范(updating) 摘要 1 前言 2 AS规范 3 命名规范 4 资源文件规范 5 版本统一规范 6 第三方库规范 7 注释规范 8 测试规范 9 RN规范 10 其他的一些规范

1 前言 为了利于项目维护以及规范开发，促进成员之间Code Review的效率，故提出以下开发规范，如有更好建议，欢迎到GitHub提issue，原文地址： 安卓开发规范(updating) 2 AS规范 工欲善其事，必先利其器。 尽量使用最新版的IDE进行开发； 编码格式统一为UTF-8； 编辑完.java , .xml 等文件后一定要格式化（基本格式方面使用 AS 默认模板即可）； 删除多余的import，减少警告出现，可利用AS的Optimize Imports (Settings → Keymap → Optimize Imports)快捷键； AS常用开发插件可以参考这里～**AS常用开发插件**

3 命名规范 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。正确的英文拼写和语法可以让阅读者易于理解,避免歧义。 注意：即使纯拼音命名方式也要避免采用。但alibaba 、taobao 、youku 、hangzhou 等国际通用的名称,可视同英文。

3.1 包名 包名全部小写，连续的单词只是简单地连接起来，不使用下划线。 采用反域名命名规则，全部使用小写字母。一级包名是顶级域名，通常为com ,edu ,gov ,net ,org 等，二级包名为公司名，三级包名根据应用进行命名，四级包名为模块名或层级名。 包名 此包中包含

com.xx.应用名称缩写.activity 用户界面中所有的Activity类

com.xx.应用名称缩写.fragment 界面中所有的Fragment类

com.xx.应用名称缩写.base 基础共享的类

com.xx.应用名称缩写.adapter 页面用到的Adapter类 (适配器的类)

com.xx.应用名称缩写.view 自定义的View类

com.xx.应用名称缩写.util 此包中包含：公共工具方法类（util模块名）

com.xx.应用名称缩写.bean 下面可分：vo、po、dto 此包中包含：JavaBean类

com.xx.应用名称缩写.model 此包中包含：模型类

com.xx.应用名称缩写.db 数据库操作类

com.xx.应用名称缩写.view (或者 com.xx.应用名称缩写.widget ) 自定义的View类等

com.xx.应用名称缩写.service Service服务

com.xx.应用名称缩写.receiver BroadcastReceiver服务

com.xx.应用名称缩写.config 所有的配置相关的类

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

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

Activity 类 Activity为后缀标识 欢迎页面类WelcomeActivity

Adapter类 Adapter 为后缀标识 新闻详情适配器 NewDetailAdapter

解析类 Parser为后缀标识 首页解析类HomePosterParser

工具方法类 Utils或Manager为后缀标识（与系统或第三方的Utils区分）或功能+Utils 线程池管理类：ThreadPoolManager日志工具类：LogUtils（Logger也可）打印工具类：PrinterUtils

数据库类 以DBHelper后缀标识 新闻数据库：NewDBHelper

Service类 以Service为后缀标识 时间服务TimeService

BroadcastReceiver类 以Receiver为后缀标识 推送接收JPushReceiver

ContentProvider类 以Provider为后缀标识 ShareProvider

自定义的共享基础类 以Base开头 BaseActivity,BaseFragment

测试类的命名以它要测试的类的名称开始，以Test结束。例如：HashTest 或HashIntegrationTest 。 接口（interface）：命名规则与类一样采用大驼峰命名法，多以able或ible结尾，如interface Runnable 、interface Accessible 。 注意：如果项目采用MVP，所有Model、View、Presenter的接口都以I为前缀，不加后缀，其他的接口采用上述命名规则。

3.3 方法名 方法名都以lowerCamelCase 风格编写。 方法名通常是动词或动词短语。 方法 说明

initXX() 初始化相关方法,使用init为前缀标识，如初始化布局initView()

isXX() checkXX() 方法返回值为boolean型的请使用is或check为前缀标识

getXX() 返回某个值的方法，使用get为前缀标识

setXX() 设置某个属性值

handleXX()/processXX() 对数据进行处理的方法

displayXX()/showXX() 弹出提示框和提示信息，使用display/show为前缀标识

updateXX() 更新数据

saveXX() 保存数据

resetXX() 重置数据

clearXX() 清除数据

removeXX() 移除数据或者视图等，如removeView();

drawXX() 绘制数据或效果相关的，使用draw前缀标识

3.4 常量名 常量名命名模式为CONSTANT_CASE ，全部字母大写，用下划线分隔单词。那，到底什么算是一个常量？ 每个常量都是一个静态final 字段，但不是所有静态final 字段都是常量。在决定一个字段是否是一个常量时，考虑它是否真的感觉像是一个常量。例如，如果任何一个该实例的观测状态是可变的，则它几乎肯定不会是一个常量。只是永远不打算改变对象一般是不够的，它要真的一直不变才能将它示为常量。 // Constantsstatic final int NUMBER = 5;static final ImmutableListNAMES = ImmutableList.of("Ed", "Ann");static final Joiner COMMA_JOINER = Joiner.on(','); // because Joiner is immutablestatic final SomeMutableType[] EMPTY_ARRAY = {};enum SomeEnum { ENUM_CONSTANT }// Not constantsstatic 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"};

3.5 非常量字段名 非常量字段名以lowerCamelCase 风格的基础上改造为如下风格：基本结构为scopeVariableNameType 。 scope：范围 非公有，非静态字段命名以m开头。 静态字段命名以s开头。 公有非静态字段命名以p开头。 公有静态字段（全局变量）命名以g开头。 例子： public class MyClass { int mPackagePrivate; private int mPrivate; protected int mProtected; private static MyClass sSingleton; public int pField; public static int gField;}

使用1字符前缀来表示作用范围，1个字符的前缀必须小写，前缀后面是由表意性强的一个单词或多个单词组成的名字，而且每个单词的首写字母大写，其它字母小写，这样保证了对变量名能够进行正确的断句。 Type：类型 考虑到Android中使用很多UI控件，为避免控件和普通成员变量混淆以及更好达意，所有用来表示控件的成员变量统一加上控件缩写作为后缀（文末附有缩写表）。 对于普通变量一般不添加类型后缀，如果统一添加类型后缀，请参考文末的缩写表。 用统一的量词通过在结尾处放置一个量词，就可创建更加统一的变量，它们更容易理解，也更容易搜索。 注意：如果项目中使用ButterKnife ，则不添加m前缀，以lowerCamelCase 风格命名。

例如，请使用mCustomerStrFirst 和mCustomerStrLast ，而不要使用mFirstCustomerStr 和mLastCustomerStr 。 量词列表 量词后缀说明

First 一组变量中的第一个

Last 一组变量中的最后一个

Next 一组变量中的下一个变量

Prev 一组变量中的上一个

Cur 一组变量中的当前变量

说明： 集合添加如下后缀：List、Map、Set数组添加如下后缀：Arr 注意：所有的VO（值对象）统一采用标准的lowerCamelCase风格编写，所有的DTO（数据传输对象）就按照接口文档中定义的字段名编写。

3.6 参数名 参数名以lowerCamelCase 风格编写。参数应该避免用单个字符命名。 3.7 局部变量名 局部变量名以lowerCamelCase 风格编写，比起其它类型的名称，局部变量名可以有更为宽松的缩写。 虽然缩写更宽松，但还是要避免用单字符进行命名，除了临时变量和循环变量。 即使局部变量是final和不可改变的，也不应该把它示为常量，自然也不能用常量的规则去命名它。 3.8 临时变量 临时变量通常被取名为i 、j 、k 、m 和n ，它们一般用于整型；c 、d 、e ，它们一般用于字符型。 如：for (int i = 0; i < len ; i++) 。 3.9 类型变量名 类型变量可用以下两种风格之一进行命名： 单个的大写字母，后面可以跟一个数字(如：E , T , X , T2 )。 以类命名方式(参考3.2 类名)，后面加个大写的T (如：RequestT , FooBarT )。

更多还可参考～**阿里巴巴Java开发手册** 4 资源文件规范 4.1 资源布局文件（XML文件（layout布局文件）） 全部小写，采用下划线命名法 4.1.1 contentView命名 必须以全部单词小写，单词间以下划线分割，使用名词或名词词组。 所有Activity或Fragment的contentView必须与其类名对应，对应规则为：将所有字母都转为小写，将类型和功能调换（也就是后缀变前缀）。 例如：activity_main.xml

4.1.2 Dialog命名 规则：dialog_描述.xml

例如：dialog_hint.xml

4.1.3 PopupWindow命名 规则：ppw_描述.xml

例如：ppw_info.xml

4.1.4 列表项命名 规则：item_描述.xml

例如：item_city.xml

4.1.5 包含项命名 规则：模块_(位置)描述.xml

例如：activity_main_head.xml 、activity_main_bottom.xml

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

例如：xxxx_title.xml

4.2 资源文件（图片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，前提是命名要规范。

4.3 动画文件（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 中间缩小

4.4 values中name命名 4.4.1 colors.xml colors 的name 命名使用下划线命名法，在你的colors.xml 文件中应该只是映射颜色的名称一个ARGB值，而没有其它的。不要使用它为不同的按钮来定义ARGB值。 不要这样做 #FFFFFF #2A91BD #5F5F5F #939393 #FFFFFF #FF9D2F ... #323232

使用这种格式，你会非常容易的开始重复定义ARGB值，这使如果需要改变基本色变的很复杂。同时，这些定义是跟一些环境关联起来的，如button 或者comment , 应该放到一个按钮风格中，而不是在color.xml 文件中。 相反，这样做 #FFFFFF #DBDBDB #939393 #5F5F5F #323232 #27D34D #2A91BD #FF9D2F #FF432F

向应用设计者那里要这个调色板，名称不需要跟"green" 、"blue" 等等相同。"brand_primary" 、"brand_secondary" 、"brand_negative" 这样的名字也是完全可以接受的。 像这样规范的颜色很容易修改或重构，会使应用一共使用了多少种不同的颜色变得非常清晰。 通常一个具有审美价值的UI来说，减少使用颜色的种类是非常重要的。 4.4.2 dimens.xml 像对待colors.xml 一样对待dimens.xml 文件 与定义颜色调色板一样，你同时也应该定义一个空隙间隔和字体大小的“调色板”。 一个好的例子，如下所示： 22sp 18sp 15sp 12sp 40dp 24dp 14dp 10dp 4dp 60dp 40dp 32dp

布局时在写margins 和paddings 时，你应该使用spacing_xxxx 尺寸格式来布局，而不是像对待string 字符串一样直接写值。 这样写会非常有感觉，会使组织和改变风格或布局是非常容易。 4.4.3 strings.xml strings 的name 命名使用下划线命名法，采用以下规则：模块名+逻辑名称

名称 说明

main_menu_about 主菜单按键文字

friend_title 好友模块标题栏

friend_dialog_del 好友删除提示

login_check_email 登录验证

dialog_title 弹出框标题

button_ok 确认键

loading 加载文字

4.4.4 styles.xml 几乎每个项目都需要适当的使用style 文件，因为对于一个视图来说有一个重复的外观是很常见的，将所有的外观细节属性（colors 、padding 、font ）放在style 文件中。 在应用中对于大多数文本内容，最起码你应该有一个通用的style文件，例如：

应用到TextView 中:

你或许需要为按钮控件做同样的事情，不要停止在那里。将一组相关的和重复android:**** 的属性放到一个通用的style 中。 将一个大的style 文件分割成多个文件， 你可以有多个styles.xml  文件。Android SDK支持其它文件，styles 这个文件名称并没有作用，起作用的是在文件 里xml的

转载于:https://juejin.im/post/5a33e7f8f265da4325295cf5