Android 开发规范总结

来源:互联网 发布:网络犯罪特搜班土豆 编辑:程序博客网 时间:2024/06/08 02:35
Android 开发规范     
一.基本命名规范    :                                                                              
1. 包:包名一律小写, 少用缩写和长名;采用以下规则:[com].[组织名].[项目名] 后面再跟后面为模块名或层级名称。比如:com.neolink.phone.activitys   
2. 类:类或接口名是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词,避免用缩写词(除非该缩写词被更广泛使用,像URL,HTML)interface OnResultListener  class Result   命名采用单词组合取名,单词首字母为大写,单词之间可采用“_”下划线进行区分,也可不采用 根据定义类型首字母加以区分:
3. Interface:命名首字母加大写的“I”;
4. Abstract class:命名首字母加大写“A”;
5. Class:无需加                          
(1)  方法:方法名是动词[名词]结构,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写;取值类可使用get前缀,设值类可使用set前缀,判断类可使用is(has)前缀。
(2) 变量
只在代码块的开始处声明变量;
采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写;
变量名不应以下划线或美元符号开头;尽量避免单个字符的变量名;组件或部件变量使用类型名或类型名缩写作其后缀。集合类型变量,例如数组和矢量,应采用复数命名或使用表示该集合的名词做后缀。String bookName
(3) 成员变量: 成员变量使用m开头,其它和变量的规则一致,如:boolean mSuccessful
(4) 临时变量:临时变量, 临时变量通常被取名为i,j,k,m和n,它们一般用于整型;c,d,e,它们一般用于字符型。如: for (int i=0;i<iLen;i++)

(5) 常量: 常量 全部采用大写,单词间用下划线隔开Static final  String MSG_GATEWAY_NOT_RESPONSE;













(2) Android 注释规范
 Ⅰ文件注释

所有的源文件都应该在开头有一个注释,其中列出文件的版权声明、文件名、功能描述以及创建、修改记录:
/*
 * Copyright (C) 2009-2014 ROUTEMAP Inc.All Rights Reserved.
 *
 * FileName:KQQMIDlet.java
 *
 * Description:简要描述本文件的内容
 *
 * History:
* 版本号 作者 日期       简要介绍相关操作

*  1.0   Iron 2009-01-21  Create

 *  1.1   Iron 2009-01-30  Add Logo Screen
**/

Ⅱ类或接口注释

采用JavaDoc文档注释,在类、接口定义之前应当对其进行注释,包括类、接口的描述、最新修改者、版本号、参考链接等:
/**

 * 描述

 * @author 作者(最新修改者)

 * @version 版本号(最新版本号)

 * @see 参考的JavaDoc

 */

class Window extends BaseWindow

{

   ...

}

注:JavaDoc文档注释:描述Java的类、接口、构造方法、方法、以及字段。每个文档注释都会被置于注释定界符/**...*/之中,一个注释对应一个类、接口或成员。该注释应位于声明之前。文档注释的第一行(/**)不需缩进,随后的文档注释每行都缩进1格(使星号纵向对齐)。
Ⅱ方法注释
采用JavaDoc文档注释,在方法定义之前当对其进行注释,包括方法的描述、输入、输出及返回值说明、抛出异常说明、参考链接等:
  /**

     * 描述

     * @param 参数说明:每个参数一行,注明其取值范围等

     * @return 返回值:注释出失败、错误、异常时的返回情况

     * @exception 异常:注释出什么条件下会引发什么样的异常

     * @see 参考的JavaDoc

     */

public char charAt(int index)

{
       ...

    }
Ⅲ其它注释(非JavaDoc文档注释)
1单行代码注释一律使用注释界定符"//",例如:
// explain what this means
if(bar > 1)

{

……

}
int isShow = 0;// 是否显示
2.多行注释使用注释界定符"/*...*/",例如:

/*

     * Here is a block comment with

     * multiple lines for text comments.
     */
这些命名规范和注释,看似是微不足道一小步,却是我们通往专业程序员的一大步。

(三)开发注意的问题

1. 图片尽量分拆成多个可重用的图片
2. 1. 为Activity声明系统配置变更事件
3. 系统配置变更事件是指转屏,区域语言发生变化,屏幕尺寸发生变化等等,如果Activity没有声明处理这些事件,发生事件时,系统会把Activity杀掉然后重启,并尝试恢复状态,Activity有机会通过onSaveInstanceState()保存一些基本数据到Bundle中,然后此Bundle会在Activity的onCreate()中传递过去。虽然这貌似正常,但是这会引发问题,因为很多其他的东西比如Dialog等是要依赖于具体Activity实例的。所以这种系统默认行为通常都不是我们想要的。为了避免这些系统默认行为,就需要为Activity声明这些配置,如下二个是每个Activity必须声明的:<activity android:configChanges="orientation|keyboardHidden">几乎所有的Activity都要声明如上,为什么Android不把它们变成Default的呢?
2. 尽量使用Android的API,这好像是废话,在Android上面开发不用Android API用什么?因为Android几乎支持Java SE所有的API,所以有很多地方Android API与Java SE的API会有重复的地方,比如说对于文件的操作最好使用Android里面Context封装的API,而不要直接使用File对象:
Context.openFileOutput(String); // no File file = new File(String)
原因就是API里面会考虑到Android平台本身的特性;再如,少用Thread,而多使用AsyncTask等。
3. 要考虑到Activity和进程被杀掉的情况,如了通常情况退出Activity外,还有Activity因其他原因被杀的情况,比如系统内存过低,系统配置变更,有异常等等,要考虑和测试这种情况,特别是Activity处理重要的数据时,做好的数据的保存。
4. 小心多语言,有些语言真的很啰嗦,中文或英文很简短就能表达的事情到了其他语言就变的死长死长的,所以如果是wrap_content就可能把其他控制挤出可视范围; 如果是指定长度就可能显示不全。也要注意特殊语言比如那些从右向左读的语言。
5. 不要用四大组件去实现接口,一是组件的对象都比较大,实现接口比较浪费,而且让代码更不易读和理解; 另外更重要的是导致多方引用,可能会引发内存泄露。
6. 用getApplication()来取Context当参数
对于需要使用Context对象作为参数的函数,要使用getApplication()获取Context对象当参数,而不要使用this,除非你需要特定的组件实例!getApplication()返回的Context是属于Application的,它会在整个应用的生命周期内存在,远大于某个组件的生命周期,所以即使某个引用长期持有Context对象也不会引发内存泄露。
7. 主线程只做UI控制和Frameworks回调相关的事。附属线程只做费时的后台操作。交互只通过Handler。这样就可以避免大量的线程问题。
8. Frameworks的回调不要做太多事情仅做必要的初始化,其他不是很重要的事情可以放到其他线程中去做,或者用Handler Schedule到稍后再做。
9. 要考虑多分辨率
至少为hdpi, mdpi, ldpi准备图片和布局。元素的单位也尽可能的使用dip而不要用px。
10. 利用Android手机的硬键
几乎所有的Android手机都有BACK和MENU,它们的作用是返回和弹出菜单,所以就不要再在UI中设计返回按扭和菜单按扭。很多优秀的应用如随手记和微信都有返回键,他们之所以有是因为他们都是从iOS上移植过来的,为了保存体验的一致,所以也有了返回和菜单。但这不够Android化,一个纯正的Android是没有必须重复硬键的功能的。
11.服务端可以实现的,就不要放在客户端
12.引用第三方库要慎重,避免应用大容量的第三方库,导致客户端包非常大
13.处理应用全局异常和错误,将错误以邮件的形式发送给服务端
14.图片的.9处理
15.使用静态变量方式实现界面间共享要慎重
16.Log(系统名称 模块名称 接口名称,详细描述)
17.单元测试(逻辑测试、界面测试)
18.不要重用父类的handler,对应一个类的handler也不应该让其子类用到,否则会导致message.what冲突
19.activity中在一个View.OnClickListener中处理所有的逻辑

20.strings.xml中使用%1$s实现字符串的通配
21.如果多个Activity中包含共同的UI处理,那么可以提炼一个CommonActivity,把通用部分叫由它来处理,其他activity只要继承它即可
22.使用button+activitgroup实现tab效果时,使用Button.setSelected(true),确保按钮处于选择状态,并使activitygroup的当前activity与该button对应
23.如果所开发的为通用组件,为避免冲突,将drawable/layout/menu/values目录下的文件名增加前缀
24.数据一定要效验,例如
字符型转数字型,如果转换失败一定要有缺省值;
服务端响应数据是否有效判断;
25.同一个客户端如果要放在不同的市场,而且要统计各个市场下载及使用数据时
针对不同的客户端打不同的包,唯一的区别是versionName,apk文件名为versionName.apk
在升级时,要将自己的versionCode和versionName一并传给服务端,如果需要升级,则下载versionName相对应的apk
关于是否要强制升级:
1).不管何种情况都强制升级
2).判断用户的版本和当前最新版本,如果兼容则强制升级,否则可选;
26.有的按钮要避免重复点击
二、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).list中异步加载的图片,当不在可视范围内,按照一定的算法及时回收(如在当前可视范围的上下10条item以外的图片进行回收,或者将图片进行缓存,设置一个大小,按照最近最少使用原则超过部分进行回收)
5).BaseAdapter避免内存溢出
如果BaseAdapter的实体类有属性非常消耗内存,可以将保存到文件;为提高性能,可以进行缓存,并限制缓存大小。
3.使用线程池,分为核心线程池和普通线程池,下载图片等耗时任务放置在普通线程池,避免耗时任务阻塞线程池后,导致所有异步任务都必须等待
4.异步任务,分为核心任务和普通任务,只有核心任务中出现的系统级错误才会报错,异步任务的ui操作需要判断原activity是否处于激活状态
1).主线程不要进行网络处理;
2).主线程不要进行数据库处理;
3).主线程不要进行文件处理;
5.尽量避免static成员变量引用资源耗费过多的实例,比如Context
6.使用WeakReference代替强引用,弱引用可以让您保持对对象的引用,同时允许GC在必要时释放对象,回收内存。对于那些创建便宜但耗费大量内存的对象,即希望保持该对象,又要在应用程序需要时使用,同时希望GC必要时回收时,可以考虑使用弱引用。
7.超级大胖子Bitmap
及时的销毁(Activity的onDestroy时将bitmap回收,在被UI组件使用后马上进行回收会抛RuntimeException: Canvas: trying to use a recycled bitmap android.graphics.Bitmap)
设置一定的采样率(有开发者提供的图片无需进行采样,对于有用户上传或第三方的大小不可控图片,可进行采样减少图片所占的内存),从服务端返回图片,建议同时反馈图片的size
巧妙的运用软引用
drawable对应resid的资源,bitmap对应其他资源
任何类型的图片,如果获取不到(例如文件不存在,或者读取文件时跑OutOfMemory异常),应该有对应的默认图片(默认图片放在在apk中,通过resid获取);
8.保证Cursor 占用的内存被及时的释放掉,而不是等待GC来处理。并且 Android明显是倾向于编 程者手动的将Cursor close掉
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
8.使用android:layout_weight或者TableLayout制作等分布局
9.使用animation-list制作动画效果



0 0