Android代码命名规范

Android代码命名规范参考Java标准命名规范，制定本文档，旨在我们的androidapp中规范化我们的代码。1标识符命名法1.1标识符命名法主要有四种：1.驼峰(Camel)命名法又称小驼峰命名法，除首单词外，其余所有单词的第一个字母大写。2.帕斯卡(pascal)命名法又称大驼峰命名法，所有单词的第一个字母大写。3.下划线命名法单词与单词间用下划线做间隔。4.匈牙利命名法广泛应用于微软编程环境中，在以Pascal命名法的变量前附加小写序列说明该变量的类型。量的取名方式为：scope_+prefix_+qualifier范围前缀，类型前缀，限定词。1.2标识符命名原则尽可能的用最少的字符而又能完整的表达标识符的含义。1.3英文缩写原则1.较短的单词可通过去掉“元音”形成缩写2.较长的单词可取单词的头几个字母形成缩写。3.此外还有一些约定成俗的英文单词缩写。1.4常见的缩写尽量少用缩写，除非是约定俗称的。如下：名称缩写iconic（主要用在app的图标）colorcl（主要用于颜色值）dividerdi（主要用于分隔线，不仅包括Listview中的divider，还包括普通布局中的线）selectorsl（主要用于某一view多种状态，不仅包括Listview中的selector，还包括按钮的selector）averageavgbackgroundBg（主要用于布局和子布局的背景）bufferbufcontrolctrldeletedeldocumentdocerrorerrescapeescincrementincinfomationinfoinitialinitimageimgInternationalizationI18Nlengthlenlibrarylibmessagemsgpassword-pwdpositionposserversrvstringstrtemptmpwindowwnd(win)2命名规范1.包（package）采用反域名命名规则，全部使用小写字母。一级包名为com，二级包名为xx（可以是公司或则个人的随便），三级包名根据应用进行命名，四级包名为模块名或层级名。包名此包中包含com.xx.应用名称缩写.activities页面用到的Activity类(activities层级名用户界面层)com.xx.应用名称缩写.base页面中每个Activity类共享的可以写成一个i额BaseActivity类(基础共享的类)com.xx.应用名称缩写.adapter页面用到的Adapter类(适配器的类)com.xx.应用名称缩写.tools此包中包含：公共工具方法类（tools模块名）com.xx.应用名称缩写.bean(或则com.xx.应用名称缩写.unity)此包中包含：元素类com.xx.应用名称缩写.db数据库操作类com.xx.应用名称缩写.view(或则com.xx.应用名称缩写.ui)自定义的View类等com.xx.应用名称缩写.serviceService服务com.xx.应用名称缩写.broadcastBroadcast服务2.类（classes）名词，采用大驼峰命名法。尽量避免缩写，除非该缩写是众所周知的，比如HTML,URL，如果类名称中包含单词缩写，则单词缩写的每个字母均应大写。类描述例如activity类Aty或者Activity为后缀标识欢迎页面类WelcomeAty.或者WelcomeActivityAdapter类Adp或者Adapte为新闻详情适配器NewtDetailAdp或则直后缀标识接NewDetailAdapter解析类Hlr为后缀标识首页解析类HomePosterHlr公共方法类Tools或Manager为后缀标识线程池管理类：ThreadPoolManager日志工具类：LogTools数据库类以DBHelper后缀标识新闻数据库：NewDBHelperService类以Service为后缀标识时间服务TimeServiceBroadcastReceive类以Broadcast为后缀标识时间通知TimeBroadcastContentProvider以Provider为后缀标识直接写的共享基础类以Base开头BaseActivity,BaseFragment3.接口（interface）命名规则与类一样采用大驼峰命名法，多以able或ible结尾，如：interfaceRunnable;interfaceAccessible。4.方法（methods）动词或动名词，采用小驼峰命名法。方法说明initXX()初始化相关方法,使用init为前缀标识，如初始化布局initView()isXX()checkXX()方法返回值为boolean型的请使用is或check为前缀标识getXX()返回某个值的方法，使用get为前缀标识processXX()对数据进行处理的方法，尽量使用process为前缀标识displayXX()弹出提示框和提示信息，使用display为前缀标识saveXX()与保存数据相关的，使用sav为e前缀标识resetXX()对数据重组的，使用reset前缀标识clearXX()清除数据相关的removeXXX()清除数据相关的drawXXX()绘制数据或效果相关的，使用draw前缀标识5.变量（variables）采用小驼峰命名法。类中控件名称必须与xml布局id保持一致。用统一的量词通过在结尾处放置一个量词，就可创建更加统一的变量，它们更容易理解，也更容易搜索。例如，请使用strCustomerFirst和strCustomerLast，而不要使用strFirstCustomer和strLastCustomer。量词列表：量词后缀说明First一组变量中的第一个Last一组变量中的最后一个Next一组变量中的下一个变量Prev一组变量中的上一个Cur一组变量中的当前变量6.常量（Constants）全部大写,采用下划线命名法。例如：MIN_WIDTH。7.资源文件（图片drawable文件夹）全部小写，采用下划线命名法，加前缀区分命名模式：activity名称_逻辑名称/common_逻辑名称如果有多种形态如按钮等除外如btn_xx.xml（selector）名称功能btn_xx按钮图片使用btn_整体效果（selector）btn_xx_normal按钮图片使用btn_正常情况效果btn_xx_press按钮图片使用btn_点击时候效果bg_head背景图片使用bg_功能_说明def_search_cell默认图片使用def_功能_说明icon_more_help图标图片使用icon_功能_说明seg_list_line具有分隔特征的图片使用seg_功能_说明sel_ok选择图标使用sel_功能_说明命名后缀：8.资源布局文件（XML文件）全部小写，采用下划线命名法。1.contentview命名,Activity默认布局，以去掉后缀的Activity类进行命名。不加后缀：功能模块.xml例如：main.xml、more.xml、settings.xml或则：activity_功能模块.xml例如：activity_main.xml、activity_more.xml2.Dialog命名：dialog_描述.xml例如：dlg_hint.xml3.PopupWindow命名：ppw_描述.xml例如：ppw_info.xml4.列表项命名listitem_描述.xml例如：listitem_city.xml5.包含项：include_模块.xml例如：include_head.xml、include_bottom.xml6.adapter的子布局：功能模块_item.xml例如：main_item.xml、7.动画文件（anim文件夹下）全部小写，采用下划线命名法，加前缀区分。前面为动画的类型，后面为方向。动画命名例子规范写法备注fade_in淡入后缀说明unit在使用xml的tilemode来配图片时，element图片使用此后缀nor图片的状态，代表普通状态hl图片的状态，代表高亮状态press图片的状态，代表按下状态select图片的状态，代表其所占的view被选中unselect图片的状态，代表其所占的view没有被选中fade_out淡出push_down_in从下方推入push_down_out从下方推出push_left推像左方slide_in_from_top从头部滑动进入zoom_enter变形进入slide_in滑动进入shrink_to_middle中间缩小8.资源ID（resourcesid）大小写规范与方法名一致，采用小驼峰命名法。命名规范为“资源控件的缩写名”+“变量名”。注意：页面控件名称应该和控件id名保持一致。strings.xml，colors.xml等中的id命名：命名模式：activity名称_功能模块名称_逻辑名称/activity名称_逻辑名称/common_逻辑名称。strings.xml中，使用activity名称注释，将文件内容区分开来。9.layout中的id命名命名模式为：view缩写_模块名称_view的逻辑名称view的缩写详情如下：控件缩写LayoutViewlvRelativeViewrvTextViewtvButtonbtnImageButtonimgBtnImageViewmgView或则ivCheckBoxchkRadioButtonrdoBtnanalogClockanaClk10.activity中的view变量命名命名模式为：逻辑名称+view缩写。建议：如果layout文件很复杂，建议将layout分成多个模块，每个模块定义一个moduleViewHolder，其成员变量包含所属view11.styles.xml将layout中不断重现的style提炼出通用的style通用组件，放到styles.xml中。DigtalClockdgtClkDatePickerdtPkEditTextedtTxtTimePickertmPktoggleButtontglBtnProgressBarproBarSeekBarskBarAutoCompleteTextViewautoTxtZoomControlszmCtlVideoViewvdoViWdbViewwebViRantingBarratBarTabtabSpinnerspnChronometercmtScollViewsclViTextSwitchtxtSwtImageSwitchimgSwtlistViewlVi或则lvExpandableListepdLtMapViewmapVi12.使用layer-list和selector13.其他1.java代码中不出现中文，最多注释中可以出现中文2.局部变量命名、静态成员变量命名只能包含字母，单词首字母除第一个外，都为大写，其他字母都为小写3.常量命名只能包含字母和_，字母全部大写，单词之间用_隔开4.图片尽量分拆成多个可重用的图片5.服务端可以实现的，就不要放在客户端6.引用第三方库要慎重，避免应用大容量的第三方库，导致客户端包非常大7.处理应用全局异常和错误，将错误以邮件的形式发送给服务端8.图片的.9处理9.使用静态变量方式实现界面间共享要慎重10.Log(系统名称模块名称接口名称，详细描述)11.单元测试（逻辑测试、界面测试）12.不要重用父类的handler，对应一个类的handler也不应该让其子类用到，否则会导致message.what冲突13.activity中在一个View.OnClickListener中处理所有的逻辑14.strings.xml中使用%1$s实现字符串的通配15.如果多个Activity中包含共同的UI处理，那么可以提炼一个CommonActivity，把通用部分叫由它来处理，其他activity只要继承它即