Android开发规范.docx
《Android开发规范.docx》由会员分享，可在线阅读，更多相关《Android开发规范.docx（18页珍藏版）》请在冰豆网上搜索。
Android开发规范
编码规范
介绍
1.为什么需要编码规范?
编码规范对于程序员而言尤为重要，有以下几个原因：
●一个软件的生命周期中，80%的花费在于维护
●几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护
●编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码
●如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品
注意：
若项目无特殊要求（比如给客户定制产品或客户有自己的开发规范需要我们遵守），必须严格执行该文档所描述的规范。
命名
2.包命名
命名规则：
一个唯一包名的前缀总是全部小写的ASCII字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org。
包名的后续部分根据不同机构各自内部的命名规范而不尽相同。
这类命名规范可能以特定目录名的组成来区分部门（department），项目（project），机器（machine），或注册名（loginnames）。
例如：
com.anjoyo.project.activities
规约：
若项目无特殊要求，包命名必须以com.anjoyo开始，后面跟有项目名称（或者缩写）,再后面为模块名或层级名称。
如：
com.anjoyo.项目缩写.模块名com.anjoyo.ebook.bookmark
如：
com.anjoyo.项目缩写.层级名com.anjoyo.ebook.activities
3.类和接口命名
命名规则：
类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。
尽量使你的类名简洁而富于描述。
使用完整单词，避免缩写词（除非该缩写词被更广泛使用，像URL，HTML）
接口一般要使用able、ible、er等后缀 例如：
classRaster;classImageSprite;
规约：
类名必须使用驼峰规则，即首字母必须大写，如果为词组，则每个单词的首字母也必须要大写，类名必须使用名词，或名词词组。
要求类名简单，不允许出现无意义的单词（如classXXXActivity）。
如：
classBookMarkAdd正确
如：
classAddBookReadPlanActivity不好！
应为classBookReadPlanAddActivity
4.方法的命名
命名规则：
方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
例如：
publicvoicodetemplatesrun（）;publicStringgetBookName（）;
类中常用方法的命名：
1.类的获取方法（一般具有返回值）一般要求在被访问的字段名前加上get，如
getFirstName（），getLastName（）。
一般来说，get前缀方法返回的是单个值，find前缀的方法返回的是列表值。
2.类的设置方法（一般返回类型为void）：
被访问字段名的前面加上前缀set，如
setFirstName（）,setLastName（）.
3.类的布尔型的判断方法一般要求方法名使用单词is或has做前缀，如isPersistent（），isString（）。
或者使用具有逻辑意义的单词，例如equal或equals。
4.类的普通方法一般采用完整的英文描述说明成员方法功能，第一个单词尽可能采用动词，首字母小写，如openFile（），addCount（）。
5.构造方法应该用递增的方式写。
（参数多的写在后面）。
6.toString（）方法：
一般情况下，每个类都应该定义toString（）,其格式为：
5.变量命名
命名规则：
第一个单词的首字母小写，其后单词的首字母大写。
变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。
变量名应简短且富于描述。
变量名的选用应该易于记忆，即，能够指出其用途。
尽量避免单个字符的变量名，除非是一次性的临时变量。
临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。
例如：
StringbookName;
规约：
变量命名也必须使用驼峰规则，但是首字母必须小写，变量名尽可能的使用名词或名词词组。
同样要求简单易懂，不允许出现无意义的单词。
如：
StringbookName;正确
如：
StringbookNameString;错误！
6.成员变量命名
同变量命名，但不要在私有变量前添加m字样！
7.常量命名
命名规则：
类常量的声明，应该全部大写，单词间用下划线隔开。
例如：
staticfinalintMIN_WIDTH=4;
例如：
staticfinalintMAX_WIDTH=999;
例如：
staticfinalintGET_THE_CPU=1;
8.异常命名
自定义异常的命名必须以Exception为结尾。
已明确标示为一个异常。
9.layout命名
规约：
layoutxml的命名必须以全部单词小写，单词间以下划线分割，并且使用名词或名词词组，即使用模块名_功能名称来命名。
如：
knowledge_gained_main.xml正确
如：
list_book.xml错误！
10.id命名
规约：
layout中所使用的id必须以全部单词小写，单词间以下划线分割，并且使用名词或名词词组，并且要求能够通过id直接理解当前组件要实现的功能。
如：
某TextView@+id/textbookname错误!
应为@+id/book_name_show
或者@+id/tv_nameshow
如：
某EditText@+id/textbookname错误!
应为@+id/book_name_edit
11.资源命名
规约：
layout中所使用的所有资源（如drawable,style等）命名必须以全部单词小写，单词间以下划线分割，并且尽可能的使用名词或名词组，即使用模块名_用途来命名。
如果为公共资源，如分割线等，则直接用用途来命名
如：
menu_icon_navigate.png正确
如：
某分割线：
line.png或separator.png正确
注释
Java程序有两类注释：
实现注释（implementationcomments）和文档注释（documentcomments）。
实现注释是使用/*...*/和//界定的注释。
文档注释（被称为"doccomments"）由/**...*/界定。
文档注释可以通过javadoc工具转换成HTML文件。
12.文件注释
所有的源文件都应该在开头有一个注释，其中列出类名、版本信息、日期和版权声明。
如下：
/*
*文件名
*包含类名列表
*版本信息，版本号
*创建日期。
*版权声明
*/
13.类注释
每一个类都要包含如下格式的注释，以说明当前类的功能等。
/**
*类名
*@author作者
*实现的主要功能。
*创建日期
*修改者，修改日期，修改内容。
*/
14.方法注释
每一个方法都要包含如下格式的注释包括当前方法的用途，当前方法参数的含义，当前方法返回值的内容和抛出异常的列表。
/**
*
*方法的一句话概述
*
方法详述（简单方法可不必详述）
*@params说明参数含义
*@return说明返回值含义
*@throwsIOException说明发生此异常的条件
*@throwsNullPointerException说明发生此异常的条件
*/
15.类成员变量和常量注释
成员变量和常量需要使用javadoc形式的注释，以说明当前变量或常量的含义
/**
*XXXX含义
*/
16.其他注释
方法内部的注释如果需要多行使用/*……*/形式，如果为单行是用//……形式的注释。
不要再方法内部使用javadoc形式的注释“/**……**/”，简单的区分方法是，javadoc形式的注释在eclipse中为蓝色，普通注释为绿色。
17.XML注释
规约：
如果当前layout或资源需要被多处调用，或为公共使用的layout（若list_item），则需要在xml写明注释。
要求注释清晰易懂。
代码风格
18.缩进
规约：
建议使用Tab进行缩进，不推荐用空格进行缩进。
19.空行
空行将逻辑相关的代码段分隔开，以提高可读性。
下列情况应该总是使用空行：
●一个源文件的两个片段（section）之间
●类声明和接口声明之间
●两个方法之间
●方法内的局部变量和方法的第一条语句之间
●一个方法内的两个逻辑段之间，用以提高可读性
规约：
通常在变量声明区域之后要用空行分隔，常量声明区域之后要有空行分隔，方法声明之前要有空行分隔。
20.行宽
无特别规定，因为现在的显示器都比较大，所以推荐使用120进行设置。
规约
21.方法
●一个方法尽量不要超过15行，如果方法太长，说明当前方法业务逻辑已经非常复杂，那么就需要进行方法拆分，保证每个方法只作一件事。
●不要使用trycatch处理业务逻辑（在操作中做trycatch）
22.参数和返回值
●一个方法的参数尽可能的不要超过4个！
●如果一个方法返回的是一个错误码，请使用异常！
！
●尽可能不要使用null，替代为异常或者使用空变量如返回List则可以使用Collections.emptyList（）
23.神秘的数
代码中不允许出现单独的数字，字符！
如果需要使用数字或字符，则将它们按照含义封装为静态常量或添加易懂的注释！
24.控制语句
判断中如有常量，则应将常量置于判断式的右侧。
如：
if（true==isAdmin（））...
尽量不使用三目条件的嵌套。
所有if语句最好用{}包括起来,即便是只有一句：
if（true）{
//dosomething......
}
if（true）
i=0;//不大推荐使用这种
对于循环：
//不推荐方式____________________________________________
while（index//每此都会执行一次getCount（）方法，
//若此方法耗时则会影响执行效率
//而且可能带来同步问题，若有同步需求，请使用同步块或同步方法
}
//推荐方式______________________________________________
//将操作结构保存在临时变量里，减少方法调用次数
finalintcount=products.getCount（）;
while（index}
25.异常的捕捉处理
●通常的思想是只对错误采用异常处理：
逻辑和编程错误，设置错误，被破坏的数据，资源耗尽，等等。
●通常的法则是系统在正常状态下以及无重载和硬件失效状态下，不应产生任何异常。
●最小化从一个给定的抽象类中导出的异常的个数。
对于经常发生的可预计事件不要采用异常。
不要使用异常实现控制结构。
●若有finally子句，则不要在try块中直接返回，亦不要在finally中直接返回。
26.访问控制
若没有足够理由，不要把实例或类变量声明为公有。
通常，实例变量无需显式的设置（set）和获取（gotten），通常这作为方法调用的边缘效应（sideeffect）而产生。
一个具有公有实例变量的恰当例子，是类仅作为数据结构，没有行为。
亦即，若你要使用一个结构（struct）而非一个类（如果java支持结构的话），那么把类的实例变量声明为公有是合适的。
约定俗成
27.变量赋值
避免在一个语句中给多个变量赋相同的值。
它很难读懂。
例如：
fooBar.fChar=barFoo.lchar='c';
不要将赋值运算符用在容易与相等关系运算符混淆的地方。
例如：
if（c++=d++）{//AVOID!
（Javadisallows）
...
}
应该写成
if（（c++=d++）!
=0）{
...
}
不要使用内嵌（embedded）赋值运算符试图提高运行时的效率，这是编译器的工作。
例如：
d=（a=b+c）+r;//AVOID!
应该写成
a=b+c;
d=a+r;
28.圆括号
一般而言，在含有多种运算符的表达式中使用圆括号来避免运算符优先级问题，是个好方法。
即使运算符的优先级对你而言可能很清楚，但对其他人未必如此。
你不能假设别的程序员和你一样清楚运算符的优先级。
if（a==b&&c==d）//AVOID!
if（（a==b）&&（c==d））//RIGHT
29.返回值
设法让你的程序结构符合目的。
例如：
if（booleanExpression）{
returntrue;
}else{
returnfalse;
}
应该代之以如下方法：
returnbooleanExpression
类似地：
if（condition）{
returnx;
}
returny;
应该写做：
return（condition?
x:
y）;
30.条件运算符"?
"前的表达式
如果一个包含二元运算符的表达式出现在三元运算符"?
:
"的"?
"之前，那么应该给表达式添上一对圆括号。
例如：
（x>=0）?
x:
-x
Eclipse注意事项
1.在Workspace中统一编码为:
UTF-8
2.若项目无特殊说明,JDK请使用1.6的版本。
JDKComplianceCompilercompliancelevel选择1.6（目前JDK常用版本为1.6.）
3．关于eclipse的SVN插件请参考：
Android编码规范
一、代码基本规范
1.java代码中不出现中文，最多注释中可以出现中文
2.layout中的id命名
命名模式为：
view缩写_模块名称_view的逻辑名称btn_login_login
view的缩写详情如下
LayoutView：
lv
RelativeView:
rv
TextView:
tv
ImageView:
iv
ImageButton:
im
Button:
btn
3.activity中的view变量命名
命名模式为：
逻辑名称+view缩写
4.strings.xml中的id命名
命名模式：
activity名称_功能模块名称_逻辑名称/activity名称_逻辑名称/common_逻辑名称
strings.xml中，使用activity名称注释，将文件内容区分开来
5.drawable中的图片命名sdcard
命名模式：
activity名称_逻辑名称/common_逻辑名称
styles.xml：
将layout中不断重现的style提炼出通用的style通用组件，放到styles.xml中；
6.使用layer-list和selector
7.图片尽量分拆成多个可重用的图片
8.服务端可以实现的，就不要放在客户端
9.引用第三方库要慎重，避免应用大容量的第三方库，导致客户端包非常大
10.处理应用全局异常和错误，将错误以邮件的形式发送给服务端（针对产品）
11.图片的处理（按比例缩小等）
12.使用静态变量方式实现界面间共享要慎重
13.Log（系统名称模块名称接口名称，详细描述）
14.单元测试（逻辑测试、界面测试）
15.不要重用父类的handler，对应一个类的handler也不应该让其子类用到，否则会导致message.what冲突
16.activity中在一个View.OnClickListener中处理所有的逻辑
17.如果多个Activity中包含共同的UI处理，那么可以提炼一个CommonActivity，把通用部分叫由它来处理，其他activity只要继承它即可
18.使用button+activitgroup实现tab效果时，使用Button.setSelected（true），确保按钮处于选择状态，并使activitygroup的当前activity与该button对应
19.如果所开发的为通用组件，为避免冲突，将drawable/layout/menu/values目录下的文件名增加前缀
20.数据一定要效验，例如
字符型转数字型，如果转换失败一定要有缺省值；
服务端响应数据是否有效判断；
二、Android性能优化
1.http用gzip压缩，设置连接超时时间和响应超时时间
http请求按照业务需求，分为是否可以缓存和不可缓存，那么在无网络的环境中，仍然通过缓存的httpresponse浏览部分数据，实现离线阅读。
2.listview性能优化
1）.复用convertView
在getItemView中，判断convertView是否为空，如果不为空，可复用。
如果couvertview中的view需要添加listerner，代码一定要在if（convertView==null）{}之外。
2）.异步加载图片
item中如果包含有webimage，那么最好异步加载
3）.快速滑动时不显示图片
当快速滑动列表时（SCROLL_STATE_FLING），item中的图片或获取需要消耗资源的view，可以不显示出来；而处于其他两种状态（SCROLL_STATE_IDLE和SCROLL_STATE_TOUCH_SCROLL），则将那些view显示出来
4）.BaseAdapter避免内存溢出
如果BaseAdapter的实体类有属性非常消耗内存，可以将保存到文件；为提高性能，可以进行缓存，并限制缓存大小。
3.使用线程池，分为核心线程池和普通线程池，下载图片等耗时任务放置在普通线程池，避免耗时任务阻塞线程池后，导致所有异步任务都必须等待
4.异步任务，分为核心任务和普通任务，只有核心任务中出现的系统级错误才会报错，异步任务的ui操作需要判断原activity是否处于激活状态
5.尽量避免static成员变量引用资源耗费过多的实例,比如Context
6.使用WeakReference代替强引用，弱引用可以让您保持对对象的引用，同时允许GC在必要时释放对象，回收内存。
对于那些创建便宜但耗费大量内存的对象，即希望保持该对象，又要在应用程序需要时使用，同时希望GC必要时回收时，可以考虑使用弱引用。
7.超级大胖子Bitmap
及时的销毁（Activity的onDestroy时将bitmap回收，在被UI组件使用后马上进行回收会抛RuntimeException:
Canvas:
tryingtousearecycledbitmapandroid.graphics.Bitmap）
设置一定的采样率（有开发者提供的图片无需进行采样，对于有用户上传或第三方的大小不可控图片，可进行采样减少图片所占的内存），从服务端返回图片，建议同时反馈图片的size
巧妙的运用软引用
drawable对应resid的资源，bitmap对应其他资源
任何类型的图片，如果获取不到（例如文件不存在，或者读取文件时跑OutOfMemory异常），应该有对应的默认图片（默认图片放在在apk中，通过resid获取）；
8.保证Cursor占用的内存被及时的释放掉，而不是等待GC来处理。
并且Android明显是倾向于编程者手动的将Cursorclose掉
9.线程也是造成内存泄露的一个重要的源头。
线程产生内存泄露的主要原因在于线程生命周期的不可控
10.如果ImageView的图片是来自网络，进行异步加载
11.应用开发中自定义View的时候，交互部分，千万不要写成线程不断刷新界面显示，而是根据TouchListener事件主动触发界面的更新
12.Drawable
ui组件需要用到的图片是apk包自带的，那么一律用setImageResource或者setBackgroundResource，而不要根据resourceid
注意：
get（getResources（）,R.drawable.btn_achievement_normal）该方法通过resid转换为drawable，需要考虑回收的问题，如果drawable是对象私有对象，在对象销毁前是肯定不会释放内存的。
13.复用、回收Activity对象
临时的activity及时finish
主界面设置为singleTask
一般界面设置为singleTop
14.位置信息
获取用户的地理位置信息时，在需要获取数据的时候打开GPS，之后及时关闭掉
15.在onResume时设置该界面的电源管理，在onPause时取消设置
三、AndroidUI优化
1.layout组件化，尽量使用merge及include复用
2.使用styles，复用样式定义
3.软键盘的弹出控制，不要让其覆盖输入框
4.数字、字母和汉字混排占位问题：
将数字和字母全角化。
由于现在大多数情况下我们的输入都是半角，所以字母和数字的占位无法确定，但是一旦全角化之后，数字、字母的占位就和一个汉字的占位相同了，这样就可以避免由于占位导致的排版问题。
5.英文文档排版：
textview自动换行时要保持单词的完整性，解决方案是计算字符串长度，然后手动设定每一行显示多少个字母并加上‘\n‘
6.复杂布局使用RelativeLayout
7.自适应屏幕，使用dp替代pix，字体建议使用sp.
8.使用android:
layout_weight或者TableLayout制作等分布局
9.使用animation-list制作动画效果
升级会员 