【Android】代码规范参考指南

代码规范对于一个软件项目来说非常重要，当然Android项目也不例外，一个优秀的Android项目不仅需要严谨的业务逻辑和架构设计，更需要一套统一优雅的代码规范标准，才可以让整个项目团队更加高效。

包命名规范

包（packages）：采用反域名命名规则，全部使用小写字母。一级包名为com，二级包名为xxx（可以是公司域名或者个人命名），三级包名根据应用进行命名，四级包名为模块名或层级名。

包名说明com.xxx.应用名称缩写.activities页面用到的Activity类（activities层级用户界面）com.xxx.应用名称缩写.fragment页面用到的Fragment类com.xxx.应用名称缩写.base页面中每个Activity类共享的可以写成一个BaseActivity类（基础共享的类）com.xxx.应用名称缩写.adapter页面用到的Adapter类（适配器的类）com.xxx.应用名称缩写.utils此包中包含：公共工具方法类（包含日期、网络、存储、日志等工具类）com.xxx.应用名称缩写.bean（model/domain均可，个人喜好）实体类com.xxx.应用名称缩写.db数据库操作com.xxx.应用名称缩写.view（或者.ui）自定义的View类等com.xxx.应用名称缩写.serviceService服务com.xxx.应用名称缩写.broadcastBroadcast服务

类命名规范

类（classes）：名词，采用大驼峰命名法，尽量避免缩写，除非该缩写是众所周知的，比如HTML，URL,如果类名称包含单词缩写，则单词缩写的每个字母均应大写。

类描述例如Application类Application为后缀标识XXXApplicationActivity类Activity为后缀标识闪屏页面类SplashActivity解析类Handler为后缀标识

公共方法类Utils或Manager为后缀标识线程池管理类：ThreadPoolManager,日志工具类：LogUtils数据库类以DBHelper后缀标识MySQLiteDBHelperService类以Service为后缀标识播放服务：PlayServiceBroadcastReceiver类以Broadcast为后缀标识时间通知：TimeBroadcastContentProvider类以Provider为后缀标识单词内容提供者：DictProvider直接写的共享基础类以Base为前缀BaseActivity,BaseFragment

变量命名规范

变量（variables）采用小驼峰命名法。类中控件名称必须与xml布局id保持一致。

公开的常量：定义为静态final，名称全部大写；

eg: public staticfinal String ACTION_MAIN=”android.intent.action.MAIN”;

静态变量：名称以s开头 eg：private static long sInstanceCount = 0;

非静态的私有变量、protected的变量：以m开头，eg：private Intent mItent;

接口命名规范

接口（interface）：命名规则与类一样采用大驼峰命名法，多以able或ible结尾，eg：interface Runable; interface Accessible;

方法命名规范

方法（methods）：动词或动名词，采用小驼峰命名法，eg：onCreate(),run();

方法说明initXX()初始化相关方法，使用init为前缀标识，如初始化布局initView()isXX() checkXX()方法返回值为boolean型的请使用is或check为前缀标识getXX()返回某个值的方法，使用get为前缀标识processXX()对数据进行处理的方法，尽量使用process为前缀标识displayXX()弹出提示框和提示信息，使用display为前缀标识saveXX()与保存数据相关的，使用save为前缀标识resetXX()对数据重组的，使用reset前缀标识clearXX()清除数据相关的removeXX()清除数据相关的drawXXX()绘制数据或效果相关的，使用draw前缀标识

布局文件命名规范

全部小写，采用下划线命名法

contentview

contentview命名, Activity默认布局，以去掉后缀的Activity类进行命名。不加后缀：
功能模块.xml
eg：main.xml、more.xml、settings.xml

或者：activity_功能模块.xml
eg：activity_main.xml、activity_more.xml

Dialog

Dialog命名：dialog_描述.xml
eg：dlg_hint.xml

PopupWindow

PopupWindow命名：ppw_描述.xml
eg：ppw_info.xml

列表项

列表项命名listitem_描述.xml
eg：listitem_city.xml

包含项

包含项：include_模块.xml
eg：include_head.xml、include_bottom.xml

adapter的子布局

adapter的子布局：功能模块_item.xml
eg：main_item.xml、

资源id命名规范

命名模式为：view缩写_模块名称_view的逻辑名称

view的缩写详情如下：

控件缩写LayoutViewlvRelativeViewrvTextViewtvButtonbtnImageButtonimgBtnImageViewivCheckBoxcbRadioButtonrbanalogClockanaClkDigtalClockdgtClkDatePickerdtPkEditTextedtTxtTimePickertmPktoggleButtontglBtnProgressBarproBarSeekBarskBarAutoCompleteTextViewautoTxtZoomControlszmCtlVideoViewvdoViWdbViewwebViRantingBarratBarTabtabSpinnerspnChronometercmtScollViewsclViTextSwitchtxtSwtImageSwitchimgSwtlistViewlVi 或则lvExpandableListepdLtMapViewmapVi

动画文件命名

动画文件（anim文件夹下）：全部小写，采用下划线命名法，加前缀区分。

前面为动画的类型，后面为方向

动画命名例子规范写法fade_in淡入fade_out淡出push_down_in从下方推入push_down_out从下方推出push_left推像左方slide_in_from_top从头部滑动进入zoom_enter变形进入slide_in滑动进入shrink_to_middle中间缩小

图片资源文件命名

命名说明bg_xxx这种图片一般那些比较大的图片，比如作为某个Activity的背景等btn_xxx按钮，一般用于按钮，而且这种按钮没有其他状态ic_xxx图标，一般用于单个图标，比如启动图片ic_launcherbg描述状态1[_状态2]用于控件上的不同状态btn描述状态1[_状态2]用于按钮上的不同状态chx描述状态1[_状态2]选择框，一般有2态和4态

一些常见的单词缩写

名称缩写iconic （主要用在app的图标）colorcl（主要用于颜色值）dividerdi（主要用于分隔线，不仅包括Listview中的divider，还包括普通布局中的线）selectorsl（主要用于某一view多种状态，不仅包括Listview中的selector，还包括按钮的selector）averageavgbackgroundBg（主要用于布局和子布局的背景）bufferbufcontrolctrldeletedeldocumentdocerrorerrescapeescincrementincinfomationinfoinitialinitimageimgInternationalizationI18Nlengthlenlibrarylibmessagemsgpasswordpwdpositionposserversrvstringstrtemptmpwindowwnd(win)