Android编程规范不完全指南

命名规则

1). 类名,接口名:

以大写开头,如果一个类的类名由多个单词组成,所有单词的首字母必须大写,单词尽量写全称,不要简写,除非约定俗成的名字,例如:URL,RTMP,RTSP 这些广泛使用的专有名词,可以全部大写,也可以首字母大写。

例如 HttpRequest,CourseActivity

2). 局部变量,类的成员变量,类的成员函数,函数参数:

以小写字母开头其他的单词首字母大写,变量名不建议使用下划线分隔单词,建议使用驼峰命名法,Android的系统类都采用此方法。

例如 toString()  onCreateView(Bundle savedInstanceState)

3). 静态常量:全部大写,单词之间使用下划线分开,常量单词全部大写,所以单词之间使用下划线分隔。

例如 WHAT_EMPTY_CONTENT

4). 控件变量的命名,控件的ID命名:

建议:xml布局文件中的控件的id的命名与*.java的代码文件中的控件对象的命名一致。

class  MyActivity extends Activity{
	TextView  txtUserName  ;
	…
	protected void onCreate(Bundle savedInstanceState) {
		txtUserName =  (TextView) findViewById(R.id.txtUserName);
	}
}

5). 常用控件以及类对象命名的规范说明(红色部分为建议的前缀或者后缀):

类名 变量名 类名 变量名
TextView txtDescription ProgressBar progressDescription
Button btnDescription SeekBar seekBarDescription
ImageButton imgBtnDescription VideoView vvDescription
ImageView imgDescription Spinner spinDescription
RadioButton rbDescription WebView webViewDescription
EditText editDescription ListView listViewDescription
ScrollView scrollDescription GridView gridDescription
Handler descriptionHandler RatingBar ratingBarDescription
PullToRefreshListView pullRefreshViewDescription Adapter descriptionAdapter
Fragment descriptionFragment Activity descriptionActivity
List<T> descriptionList Map<> mapDescription
SlidingMenu slidMenuDescription ViewPager viewPagerDescription
CheckBox chBoxDescription View viewDescription
RadioGroup rgDescription ExpandableListView expDescription
FrameLayout frameLayDescription SharedPreferences spDescription
LinearLayout lineLayDescription RelativeLayout relativeLayDescription
startActivityForResult(requestCode) REQUEST_CODE_DESCRIPTION msg.what WHAT_DESCRIPTION

6). 资源命名:

layout资源文件的命名(全部小写,下划线分隔):
activity的资源文件:activity_description1_description2.xml
fragment的资源文件:fragment_description1_description2.xml
listview列表项的资源文件:list_item_description1_description2.xml
可复用(被include)的组件资源文件: control_description1_description2.xml
drawable资源: controlName_description1_description2_selector.xml
controlName表示该资源要用在什么类型的控件上面,例如如果是按钮的图片切换则
应该这么定义 button_bg_sendmessage_selector.xml
selector表示该资源的形式,例如还有shape等
图片资源的名字:同上
颜色值的命名:  color_description  以color为前缀,全部小写,下划线分隔。description既可以是该颜色值使用的功能描述,也可以是该颜色值的英文描述,也可以是具体的颜色值,例如:

<color name="color_white">#ffffff</color>
<color name="color_grey_ccc">#cccccc</color>
<color name="color_grey_ddd">#dddddd</color>

因为grey可能有很多等级,有时候需要不同等级的灰色,没有那么多英文名可以区分,所以名字中可以直接使用颜色值
<color name=”color_button_pressed”>#4c4c4c</color> 根据功能定义description,表示该颜色用于按钮被按下

注:不允许出现毫无意义的命名,例如textview1,textview2

关于字面常量

代码中不允许出现直接硬编码的字面常量,如果是控件上面显示的文本,必须放在strings.xml资源文件中。 如果是代码中用到常量字符串,必须定义成 public static final String类型的常量值,在代码中使用该定义的常量值。这样做的好处是以后需要修改该常量值,只需要修改一个地方。如果是硬编码在代码中则要修改所有使用它的地方,而且拷贝容易出错。在Activity之间传递参数的时候,intent.putExtra 的key值也要命名规范,并且统一定义为静态常量,不能直接硬编码在代码中,否则想要修改的时候很麻烦。某一个Activity在被启动的时候需要接受参数,那么这些参数的key定义就应该放在该Activity中。

JSON解析

Android中调用服务端的接口一般返回的是json数据,在解析json的时候,无论是使用原始的手工解析方式,还是使用javabean的解析方式,解析出来的结果在使用的时候必须都进行判空处理。不允许因为服务端的json出问题,导致app在解析json的时候出现崩溃。

类成员初始化

所有类的成员变量一定要赋初始值,不允许只定义,不赋值。

Int类型常量

函数返回的时候,如果返回的int类型的数据并不是真实的实用的数据值(例如表示高度,宽度,大小等值),仅仅表示函数执行成功、失败、异常的状态值,并且这些值是有限的几个值,必须要将这些值使用静态常量描述,或者使用枚举,例如:

int  GetJsonString()

该函数返回-1表示获取解析json数据异常,返回0表示成功,返回1表示网络连接异常,返回2表示json内容中的数据部分为空。那么在函数内部的代码里不要直接使用这些字面值,这些字面值对于程序员来说是毫无意义的,代码可阅读性很差,建议做成下面的模式:

public static final int RESULT_PARSE_JSON_EXCEPTION = -1;
public static final int RESULT_SUCCESS = 0;
public static final int RESULT_NETWORK_EXCEPTION = 1;
public static final int RESULT_NO_DATA = 2;

使用这些符号常量值代替字面值的好处是,符号常量值是由大写的英文单词组成,是有意义的,可以帮助程序员更好的理解函数返回值的意义,而且符号常量值对应的具体的赋值在后期是很方便修改的。

Activity接受参数与模块化

如果一个Activity可能在多个地方被打开,或者一个Fragment可能在多个地方被用到。那么在设计该Activity和Fragment的时候一定要考虑低耦合,对外提供统一的参数接口,启动Activity的过程封装在该Activity类的静态成员方法里面,类似如下:

class MyActivity extends Activity{
	...
	public static void startActivity(Context context,Params param){
		Intent intent = new Intent(context, MyActivity.class);
		intent.putExtra("param", param);
		startActivity(intent);
	}

	public static void startActivityForResult(Context context,Params param){
		Intent intent = new Intent(context, MyActivity.class);
		intent.putExtra("param", param);
		startActivityForResult(intent,REQUEST_CODE);
	}
}

参数的传递最好是封装在一个Model实体类中,避免使用Map这种方式进行参数传递。建议该实体类实现为对应的Activity的静态可序列化的内部类。

AndroidStudio工程目录组织

AndroidStudio中的项目的包结构应该根据工程各个部分的功能来组织。

Handler的封装

每一个Activity里面几乎都会定义一个Handler内部类,但是很多Activity里面的Handler都使用了重复的消息类型,这里面是有冗余代码的,所以应该把这些Activity都使用到的Handler类的消息部分,提取成一个公用的Handler类。然后在各个Activity里面使用继承的方式,来提供该Activity特有的Handler消息类型的Handler类实现。

另外Handler发送消息应该使用Handler类的成员函数,不应该直接使用handler.obtainMessage(xxx).sendToTarget();这种原始的发送消息的方式,这样不利于降低耦合,这种细节应该隐藏在Handler内的里面。Handler的消息类型应该定义为Handler类里面的静态常量,而该常量不应是public的,对外部不可见。也就是说使用handler对象发送消息的细节不应该暴露给外部。

List的数据更新

封装ListView的数据更新,在handlerMessage中更新数据,避免出现 java.lang.IllegalStateException 问题

Activity与Fragment之间传递参数

Activity与Fragment的数据传递采用interface的方式,这样可以降低耦合,有利于Fragment的复用:

网络请求数据模块化

一般在Activity中我们通过网络请求服务端的接口获得数据,这个过程一般是在一个线程中做的,获取到数据之后,再通过Activity中的handler发送消息来通知Activity更新数据。该负责获取数据的线程类,我们一般都实现为一个Activity的内部类,该类可以直接访问Activity的成员变量,例如handler,数据列表对象等。但是这样不利于该数据获取线程的复用。如果另一个Activity里面也需要获取相同的数据,那么这个功能是不能复用的,所以这个负责数据请求的线程类,不应该与具体的Handler和Activity联系过于紧密。应该定义为一个静态类,handler应该作为参数传递进来,而不是直接访问外部类的成员变量。

封装Log功能

Log功能应该封装成为自动将当前所在类的类名变成log输出的TAG参数,发布的app最好是能循环写日志文件到系统存储中,并且日志文件应该使用反复覆盖的方式重复利用。下面仅仅是一个不完善的例子:

public class MyLog {
  public static final String TAG = "myapp ";
  public static void v(Object o,String message)
  {
      Log.v(TAG+o.getClass().getSimpleName(),message);
  }
}

使用

MyLog.v(this,"hello log");

打印结果

V/myapp MainActivity﹕ hello log

版本控制

使用自动化版本管理,自动生成版本号,使应用程序的版本与版本库上保持一致。使用hg替换工程目录下的app目录下的build.gradle文件即可,如果manifest里面也有版本号的设置,AndroidStudio还是以build.gradle为准。不应该在每次发布的时候,在AndroidStudio的工程设置里面手工修改版本号。

为程序添加全局异常捕获

应该为app添加全局异常捕获,app中总会有一些我们未捕获的异常,一旦用户使用过程中遇到这样的异常,程序就会崩溃,我们应该检测该类未捕获的异常信息,程序崩溃的时候通过写文件日志,或者发送邮件的方式获得异常信息,以便解决bug。

时间: 2024-10-22 11:55:30

Android编程规范不完全指南的相关文章

Android编程规范V1.0

转载请注明出处:http://blog.csdn.net/zhaokaiqiang1992 本文章是根据众多公司的编程规范整理而成,如果错误,还请指出. Android编程规范 编写人 赵凯强 日期 2014-8-5 审核人   日期   批准人   日期     修改记录(REVISION CHART) 版本 作者 修改描述 修改日期 1.0 赵凯强 初稿 2014-8-5     1.概述 1.1目的与概述 本文提供一整套编写高效可靠的android代码的标准.约定和指南.它们以安全可靠的软

Android编程规范与常用技巧

一.Android编码规范 1.java代码中不出现中文,最多注释中可以出现中文 2.局部变量命名.静态成员变量命名只能包含字母,单词首字母出第一个外,都为大写,其他字母都为小写. 3.常量命名只能包含字母和_,字母全部大写,单词之间用_隔开. 4.layout中的id命名命名模式为: view缩写_模块名称_view的逻辑名称 view的缩写详情如下: LayoutView:lv RelativeView:rv TextView:tv ImageView:iv ImageButton:im B

Android 编程规范指南

一.目录规范 1.系统目录规范 Requirement:需求文档: Design:设计文档: Planning&Log:计划.日志.会议: Test:集成测试.系统测试.测试报告: Study:学习资料.demo等: Deployment:发布.部署等: Source:源代码以及单元测试: Help:相关帮助文档: 2.源码目录规范 目录即包(package):目录下所有类都属于这个命名空间,一主类一文件: 目录层次递归:一般系统命名空间目录最好不要超过3层: 二.代码编码规范 1.常见的命名规

我总结的Android编程规范

命名规则 1). 类名,接口名:以大写开头,如果一个类的类名由多个单词组成,所有单词的首字母必须大写,单词尽量写全称,不要简写,除非约定俗成的名字,例如:URL,RTMP,RTSP 这些广泛使用的专有名词,可以全部大写,也可以首字母大写.例如 HttpRequest,CourseActivity 2). 局部变量,类的成员变量,类的成员函数,函数参数:以小写字母开头其他的单词首字母大写,变量名不建议使用下划线分隔单词,建议使用驼峰命名法,Android的系统类都采用此方法.例如 toString

Android编程规范及优化

一.编码规则 1.      函数的规模尽量限制在 200 行以内. 2.      一个方法仅完成一件功能.如果一个方法实现多个功能,可以考虑分拆成多个方法,每个方法实现一个功能. 3.      如果多段代码重复做同一件事情,那么可考虑提供一个公用的方法实现这个功能,供其它方法调用. 4.      检查函数所有参数输入的有效性.例如参数传入 ArrayList 对象为空,如果直接使用会导致程序异常. 5.      对方法的异常中应有全面的处理,不要想当然在 try 块中实现的功能中只可

最全面的 Android 编码规范指南

最全面的 Android 编码规范指南 本文word文档下载地址:http://pan.baidu.com/s/1bXT75O 1. 前言 这份文档参考了 Google Java 编程风格规范和 Google 官方 Android 编码风格规范.该文档仅供参考,只要形成一个统一的风格,见量知其意就可. 1.1 术语说明 在本文档中,除非另有说明: 术语 class 可表示一个普通类,枚举类,接口或是annotation类型(@interface) 术语 comment 只用来指代实现的注释(im

《Android编程权威指南》-读书笔记(三)Git初探

<Android编程权威指南>-读书笔记(三)Git初探 版本控制-Git 为什么要使用版本控制 什么是版本控制?我为什么要关心它呢?版本控制是一种记录一个或若干文件内容变化,以便将来查阅特定版本修订情况的系统.在本书所展示的例子中,我们仅对保存着软件源代码的文本文件作版本控制管理,但实际上,你可以对任何类型的文件进行版本控制. 如果你是位图形或网页设计师,可能会需要保存某一幅图片或页面布局文件的所有修订版本(这或许是你非常渴望拥有的功能).采用版本控制系统(VCS)是个明智的选择.有了它你就

Android编程权威指南

Code download: www.bignerdranch.com/solutions/AndroidProgramming.zip Android编程权威指南,布布扣,bubuko.com

Android编程开发规范

 Android编程开发规范         原文地址 http://www.jianshu.com/p/9b8aeca9b281 一.约定 Activity.onCreate(),Fragment.onActivityCreated(),作为程序入口,不用写入太多代码,尽量保持只调用initXXX()方法,简单明了展示调用过程.如:initData(),initView(). 单个方法体不要过长 代码任何地方不要拼错单词 杜绝整个类代码格式化 调用方法保持"临近原则",被调用的方法,