Android 开发规范
来源:互联网 发布:网络电视包月怎么取消 编辑:程序博客网 时间:2024/06/06 18:09
Android 开发规范(updating)
安卓开发规范(updating)
摘要
- 前言
- AS规范
- 命名规范
- 资源文件规范
- 版本统一规范
- 第三方库规范
- 注释规范
- 测试规范
- RN规范
- 其他的一些规范
前言
为了利于项目维护以及规范开发,促进成员之间Code Review的效率,故提出以下开发规范,如有更好建议,欢迎到GitHub提issue,原文地址: 安卓开发规范(updating)
AS规范
工欲善其事,必先利其器。
- 尽量使用最新版的IDE进行开发;
- 编码格式统一为UTF-8;
- 编辑完.java、.xml等文件后一定要格式化(缩进对齐与AS默认一致即可);
- 删除多余的import,减少警告出现,可利用AS的
Optimize Imports
快捷键; - AS常用开发插件可以参考这里~AS常用开发插件
命名规范
1. 包名
包名全部小写,连续的单词只是简单地连接起来,不使用下划线。
采用反域名命名规则,全部使用小写字母。一级包名是顶级域名,通常为com, edu, gov, net, org等,二级包名为公司名,三级包名根据应用进行命名,四级包名为模块名或层级名。
注意:如果项目采用MVP,所有M、V、P抽取出来的接口都放置在相应模块的i包下,所有的实现都放置在相应模块的impl下
2. 类名
类名都以UpperCamelCase
风格编写。
类名通常是名词或名词短语,接口名称有时可能是形容词或形容词短语。现在还没有特定的规则或行之有效的约定来命名注解类型。
名词,采用大驼峰命名法,尽量避免缩写,除非该缩写是众所周知的, 比如HTML,URL,如果类名称中包含单词缩写,则单词缩写的每个字母均应大写。
测试类的命名以它要测试的类的名称开始,以Test结束。例如:HashTest 或 HashIntegrationTest。
接口(interface):命名规则与类一样采用大驼峰命名法,多以able或ible结尾,如
interface Runnable , interface Accessible。
注意:如果项目采用MVP,所有Model、View、Presenter的接口都以I为前缀,不加后缀,其他的接口采用上述命名规则。
3. 方法名
方法名都以lowerCamelCase
风格编写。
方法名通常是动词或动词短语。
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"};
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。
说明:
集合添加如下后缀:List、Map、Set
数组添加如下后缀:Arr
注意:所有的VO(值对象)统一采用标准的lowerCamelCase风格编写,所有的DTO(数据传输对象)就按照接口文档中定义的字段名编写。
6. 参数名
参数名以lowerCamelCase
风格编写。
参数应该避免用单个字符命名。
7. 局部变量名
局部变量名以lowerCamelCase
风格编写,比起其它类型的名称,局部变量名可以有更为宽松的缩写。
虽然缩写更宽松,但还是要避免用单字符进行命名,除了临时变量和循环变量。
即使局部变量是final和不可改变的,也不应该把它示为常量,自然也不能用常量的规则去命名它。
8. 临时变量
临时变量通常被取名为i,j,k,m和n,它们一般用于整型;c,d,e,它们一般用于字符型。 如: for (int i = 0; i < len ; i++)。
9. 类型变量名
类型变量可用以下两种风格之一进行命名:
单个的大写字母,后面可以跟一个数字(如:E, T, X, T2)。
以类命名方式(参考2. 类名),后面加个大写的T(如:RequestT, FooBarT)。
更多还可参考~阿里巴巴Java开发手册
资源文件规范
1. 资源布局文件(XML文件(layout布局文件))
全部小写,采用下划线命名法
1) contentview 命名
必须以全部单词小写,单词间以下划线分割,使用名词或名词词组。
所有Activity或Fragment的contentView必须与其类名对应,对应规则为:
将所有字母都转为小写,将类型和功能调换(也就是后缀变前缀)。
例如:activity_main.xml
2) Dialog命名:dialog_描述.xml
例如:dialog_hint.xml
3) PopupWindow命名:ppw_描述.xml
例如:ppw_info.xml
4) 列表项命名:item_描述.xml
例如:item_city.xml
5) 包含项命名:模块_(位置)描述.xml
例如:activity_main_head.xml
、activity_main_bottom.xml
注意:通用的包含项命名采用:项目名称缩写_描述.xml
例如:xxxx_title.xml
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,前提是命名要规范。
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. values中name命名
1) colors.xml
colors的name命名使用下划线命名法,在你的colors.xml
文件中应该只是映射颜色的名称一个ARGB值,而没有其它的。不要使用它为不同的按钮来定义ARGB值。
不要这样做
<resources> <color name="button_foreground">#FFFFFF</color> <color name="button_background">#2A91BD</color> <color name="comment_background_inactive">#5F5F5F</color> <color name="comment_background_active">#939393</color> <color name="comment_foreground">#FFFFFF</color> <color name="comment_foreground_important">#FF9D2F</color> ... <color name="comment_shadow">#323232</color>
使用这种格式,你会非常容易的开始重复定义RGBA值,这使如果需要改变基本色变的很复杂。同时,这些定义是跟一些环境关联起来的,如button
或者comment
, 应该放到一个按钮风格中,而不是在color.xml
文件中。
相反,这样做:
<resources> <!-- grayscale --> <color name="white" >#FFFFFF</color> <color name="gray_light">#DBDBDB</color> <color name="gray" >#939393</color> <color name="gray_dark" >#5F5F5F</color> <color name="black" >#323232</color> <!-- basic colors --> <color name="green">#27D34D</color> <color name="blue">#2A91BD</color> <color name="orange">#FF9D2F</color> <color name="red">#FF432F</color> </resources>
向应用设计者那里要这个调色板,名称不需要跟"green", "blue", 等等相同。 "brand_primary", "brand_secondary", "brand_negative" 这样的名字也是完全可以接受的。 像这样规范的颜色很容易修改或重构,会使应用一共使用了多少种不同的颜色变得非常清晰。 通常一个具有审美价值的UI来说,减少使用颜色的种类是非常重要的。
2) dimens.xml
像对待colors.xml一样对待dimens.xml文件 与定义颜色调色板一样,你同时也应该定义一个空隙间隔和字体大小的“调色板”。 一个好的例子,如下所示:
<resources> <!-- font sizes --> <dimen name="font_larger">22sp</dimen> <dimen name="font_large">18sp</dimen> <dimen name="font_normal">15sp</dimen> <dimen name="font_small">12sp</dimen> <!-- typical spacing between two views --> <dimen name="spacing_huge">40dp</dimen> <dimen name="spacing_large">24dp</dimen> <dimen name="spacing_normal">14dp</dimen> <dimen name="spacing_small">10dp</dimen> <dimen name="spacing_tiny">4dp</dimen> <!-- typical sizes of views --> <dimen name="button_height_tall">60dp</dimen> <dimen name="button_height_normal">40dp</dimen> <dimen name="button_height_short">32dp</dimen></resources>
布局时在写 margins 和 paddings 时,你应该使用spacing_xxxx尺寸格式来布局,而不是像对待String字符串一样直接写值。 这样写会非常有感觉,会使组织和改变风格或布局是非常容易。
3) strings.xml
strings的name命名使用下划线命名法,采用以下规则:模块名+逻辑名称
例如:
main_menu_about
主菜单按键文字friend_title
好友模块标题栏friend_dialog_del
好友删除提示login_check_email
登录验证dialog_title
弹出框标题button_ok
确认键loading
加载文字
4) styles.xml
几乎每个项目都需要适当的使用style文件,因为对于一个视图来说有一个重复的外观是很常见的,将所有的外观细节属性(colors, padding, font)放在style文件中。 在应用中对于大多数文本内容,最起码你应该有一个通用的style文件,例如:
<style name="ContentText"> <item name="android:textSize">@dimen/font_normal</item> <item name="android:textColor">@color/basic_black</item></style>
应用到TextView 中:
<TextView android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="@string/price" style="@style/ContentText" />
你或许需要为按钮控件做同样的事情,不要停止在那里。将一组相关的和重复android:****
的属性放到一个通用的style中。
将一个大的style文件分割成多个文件, 你可以有多个styles.xml
文件。Android SDK支持其它文件,styles
这个文件名称并没有作用,起作用的是在文件 里xml的<style>
标签。因此你可以有多个style文件styles.xml
,style_home.xml
,style_item_details.xml
,styles_forms.xml
。 不同于资源文件路径需要为系统构建起的有意义,在res/values
目录下的文件可以任意命名。
5. layout中的id命名
命名模式为:view缩写_模块名_逻辑名
,比如btn_main_search
使用 AndroidStudio 的插件 ButterKnife Zelezny,生成注解非常方便,或者也可以使用Android Code Generator插件。
如果想对资源文件进行分包可以参考我这篇文章~Android Studio下对资源进行分包
版本统一规范
Android开发存在着众多版本的不同,比如compileSdkVersion、minSdkVersion、targetSdkVersion以及项目中依赖第三方库的版本,不同的module及不同的开发人员都有不同的版本,所以需要一个统一版本规范的文件。
具体可以参考我写的这篇博文~Android开发之版本统一规范
第三方库规范
别再闭门造车了,用用最新最火的技术吧,安利一波~Android 流行框架查速表,顺便带上自己的干货~Android开发人员不得不收集的代码
希望team能用时下较新的技术,不建议自己造轮子或者使用停止维护的轮子,否则出了问题也提不了issue。
个人推荐team使用Retrofit, RxAndroid, OkHttp, Glide/Fresco, Gson/Fastjson, EventBus/AndroidEventBus, GreenDao,(Dagger2, Tinker)。
注释规范
为了让他人可以容易看懂你的代码,请在关键地方做好注释。
1. 类注释
每个类完成后应该有作者姓名和联系方式的注释,对自己的代码负责。
/** * <pre> * author : Blankj * e-mail : xxx@xx * time : 2017/03/07 * desc : xxxx描述 * version: 1.0 * </pre> */
具体可以在AS中自己配制,Setting → Editor → File and Code Templates → Includes → File Header,输入
/** * <pre> * author : ${USER} * e-mail : xxx@xx * time : ${YEAR}/${MONTH}/${DAY} * desc : xxxx描述 * version: 1.0 * </pre> */public class WelcomeActivity { ...}
这样便可在每次新建类的时候自动加上该注释。
2. 方法注释
每一个成员方法(包括自定义成员方法、覆盖方法、属性方法)的方法头都必须做方法头注释,在方法前一行输入/**回车,AS便会帮你生成模板,我们只需要补全参数即可,如下所示。
/** * bitmap转byteArr * * @param bitmap bitmap对象 * @param format 格式 * @return 字节数组 */public static byte[] bitmap2Bytes(Bitmap bitmap, CompressFormat format) { if (bitmap == null) return null; ByteArrayOutputStream baos = new ByteArrayOutputStream(); bitmap.compress(format, 100, baos); return baos.toByteArray();}
3. 块注释
块注释与其周围的代码在同一缩进级别。它们可以是/* ... */
风格,也可以是// ...
风格(// 后最好带一个空格)。对于多行的/* ... */
注释,后续行必须从*
开始, 并且与前一行的*
对齐。以下示例注释都是OK的。
/* * This is // And so /* Or you can * okay. // is this. * even do this. */ */
注释不要封闭在由星号或其它字符绘制的框架里。
Tip:在写多行注释时,如果你希望在必要时能重新换行(即注释像段落风格一样),那么使用/* ... */。
测试规范
业务开发完成之后,开发人员做单元测试,单元测试完成之后,保证单元测试全部通过同时单元测试代码覆盖率达到一定程度(这个需要开发和测试约定,理论上越高越好),开发提测。
// TODO...
RN规范
// TODO...
其他的一些规范
- 合理布局,有效运用
<merge>
,<ViewStub>
,<include>
标签 - 相关联的方法尽量放在一起
- 不要忘了内存泄漏的检测
附录
表1 UI控件缩写表
表2 常见的英文单词缩写:
程序中使用单词缩写原则:不要用缩写,除非该缩写是约定俗成的。
- [Android] Android开发规范
- Android开发规范
- Android开发规范
- Android开发规范
- Android开发规范
- android开发规范
- Android开发规范
- Android开发规范
- Android开发规范
- Android开发规范
- Android开发命名规范
- Android开发规范
- Android开发规范
- Android 开发规范
- Android开发规范
- 客户端开发规范-Android
- Android 开发编码规范
- Android开发规范
- 用递归函数求N阶勒让德多项式的值,递归公式为:
- CONTROLFILE AUTOBACKUP ON 间接导致数据库hang
- C语言,进制转换之十进制转二进制,完整代码
- HDU 6137 Engineering of the Clones(快速幂+NTT)
- c0201时遇到的问题
- Android 开发规范
- vmware 合并块和迁移
- Cordova详解2
- 初识JavaScript,Ajax,jQuery,并比较三者关系
- `html语言基础笔记
- bzoj1095: [ZJOI2007]Hide 捉迷藏(动态点分治+树上ST表)
- 搞了好几天,终于搞好了hadoop环境安装!
- [Java] 组合与继承的区别
- win10家庭版关闭windows defender