Android编码规范
一、命名规则
1). 类名,接口名:
以大写开头,如果一个类的类名由多个单词组成,所有单词的首字母必须大写,单词尽量写全称,不要简写,除非约定俗成的名字,例如:URL,RTMP,RTSP 这些广泛使用的专有名词,可以全部大写,也可以首字母大写。
例如 HttpRequest,CourseActivity
2). 局部变量,类的成员变量,类的成员函数,函数参数:
以小写字母开头其他的单词首字母大写,变量名不建议使用下划线分隔单词,建议使用驼峰命名法,Android的系统类都采用此方法。
例如 toString() onCreateView(Bundle savedInstanceState)
3). 静态常量:全部大写,单词之间使用下划线分开,常量单词全部大写,所以单词之间使用下划线分隔。
例如 WHAT_EMPTY_CONTENT
4). 控件变量的命名,控件的ID命名:
建议:xml布局文件中的控件的id的命名与*.java的代码文件中的控件对象的命名一致。
类名 | 变量名 | 类名 | 变量名 |
TextView | txt_description | ProgressBar | progress_description |
Button | btn_description | SeekBar | seekBar_description |
ImageButton | imgBtn_description | VideoView | vv_description |
ImageView | img_description | Spinner | spin_description |
RadioButton | rb_description | WebView | webView_description |
EditText | edit_description | ListView | listView_description |
ScrollView | scroll_description | GridView | grid_description |
Handler | description_handler | RatingBar | ratingBar_description |
PullToRefreshListView | pullRefreshView_description | Adapter | descriptionAdapter |
Fragment | descriptionFragment | Activity | descriptionActivity |
List<T> | descriptionList | Map<> | mapDescription |
slidMenu_description | ViewPager | viewPager_description | |
CheckBox | chBox_description | View | view_description |
RadioGroup | rg_description | ExpandableListView | exp_description |
FrameLayout | frameLay_description | SharedPreferences | sp_description |
LinearLayout | lineLay_description | RelativeLayout | relativeLay_description |
startActivityForResult(requestCode) | REQUEST_CODE_DESCRIPTION | msg.what | WHAT_DESCRIPTION |
class MyActivity extends Activity{
TextView txtUserName ;
…
protected void onCreate(Bundle savedInstanceState) {
txtUserName = (TextView) findViewById(R.id.txtUserName);
}
}
5). 常用控件以及类对象命名的规范说明(红色部分为建议的前缀或者后缀):
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;
使用这些符号常量值代替字面值的好处是,符号常量值是由大写的英文单词组成,是有意义的,可以帮助程序员更好的理解函数返回值的意义,而且符号常量值对应的具体的赋值在后期是很方便修改的。