Android 命名规范（提高代码可以读性）

2021-12-07 14:03 Android开发

刚接触android的时候，命名都是按照拼音来，所以有的时候想看懂命名的那个控件什么是什么用的，就要读一遍甚至好几遍才知道，这样的话，在代码的审查和修改过程中就会浪费不少不必要的时间。如果就是我一个人开发，一个人维护的话还好，可是如果一个项目是团队分工合作，这样让你的同事去看你的代码就更加吃力了，因为大家之间的编程方式不一样，所以，在开发过程中，命名规范统一尤为重要，最好是团队中统一好大家命名方法，这样对于日后的工作会轻松很多。 在面试的时候，审核一个程序员的编程水平的时候，命名规范也是一大标准，所以，下面我就总结下我从网上别人的经验和自己的感悟中收集总结的android命名规范，希望对大家有所帮助。 提醒：在命名规范的统一下，在加上注释，这样日后维护会高效快捷好多。先初略介绍下当前主要的标识符命名法和英文缩写规则：（这段别人那边借鉴的） 在讲解命名规范前，先初略介绍下当前主要的标识符命名法和英文缩写规则。 标识符命名法 标识符命名法最要有四种: 1 驼峰(Camel)命名法:又称小驼峰命名法，除首单词外，其余所有单词的第一个字母大写。 2 帕斯卡(pascal)命名法:又称大驼峰命名法，所有单词的第一个字母大写 3 下划线命名法:单词与单词间用下划线做间隔。 4 匈牙利命名法:广泛应用于微软编程环境中，在以Pascal命名法的变量前附加小写序列说明该变量的类型。量的取名方式为：<scope_>+<prefix_>+<qualifier>范围前缀，类型前缀，限定词。 个人觉得标识符命名原则:尽可能的用最少的字符而又能完整的表达标识符的含义。 英文缩写原则： 1 较短的单词可通过去掉"元音"形成缩写 2 较长的单词可取单词的头几个字母形成缩写 3 此外还有一些约定成俗的英文单词缩写. 下面为常见的英文单词缩写:<table border="1" width="493"><tbody><tr class="firstRow"><td >名称</td><td >缩写</td></tr><tr><td>icon </td><td>ic（主要用在app的图标）</td></tr><tr><td>color </td><td>cl（主要用于颜色值）</td></tr><tr><td>divider</td><td>di（主要用于分隔线，不仅包括Listview中的divider，还包括普通布局中的线）</td></tr><tr><td>selector</td><td>sl（主要用于某一view多种状态，不仅包括Listview中的selector，还包括按钮的selector）</td></tr><tr><td>average</td><td>avg</td></tr><tr><td>background</td><td>Bg（主要用于布局和子布局的背景）</td></tr><tr><td>buffer</td><td>buf</td></tr><tr><td>control</td><td>ctrl</td></tr><tr><td>delete</td><td>del</td></tr><tr><td>document</td><td>doc</td></tr><tr><td>error</td><td>err</td></tr><tr><td>escape</td><td>esc</td></tr><tr><td>increment</td><td>inc</td></tr><tr><td>infomation</td><td>info</td></tr><tr><td>initial</td><td>init</td></tr><tr><td>image</td><td>img</td></tr><tr><td>Internationalization</td><td>I18N</td></tr><tr><td>length</td><td>len</td></tr><tr><td>library</td><td>lib</td></tr><tr><td>message</td><td>msg</td></tr><tr><td>password-</td><td>pwd</td></tr><tr><td>position</td><td>pos</td></tr><tr><td>server</td><td>srv</td></tr><tr><td>string</td><td>str</td></tr><tr><td>temp</td><td>tmp</td></tr><tr><td>window</td><td>wnd(win)</td></tr></tbody></table> 程序中使用单词缩写原则：不要用缩写，除非该缩写是约定俗成的。 命名规范： 1 包（packages）:采用反域名命名规则，全部使用小写字母。一级包名为com，二级包名为xx（可以是公司或则个人的随便），三级包名根据应用进行命名，四级包名为模块名或层级名 <table border="1" width="493"><tbody><tr class="firstRow"><td >包名</td><td >此包中包含</td></tr><tr><td>com.xx.应用名称缩写.activities</td><td>页面用到的Activity类(activities层级名用户界面层)</td></tr><tr><td>com.xx.应用名称缩写.base</td><td>页面中每个Activity类共享的可以写成一个i额BaseActivity类(基础共享的类)</td></tr><tr><td>com.xx.应用名称缩写.adapter </td><td>页面用到的Adapter类(适配器的类)</td></tr><tr><td>com.xx.应用名称缩写.tools</td><td>此包中包含：公共工具方法类（tools模块名）</td></tr><tr><td>com.xx.应用名称缩写.bean(或则com.xx.应用名称缩写.unity)</td><td>此包中包含：元素类</td></tr><tr><td>com.xx.应用名称缩写.db</td><td>数据库操作类</td></tr><tr><td>com.xx.应用名称缩写.view(或则com.xx.应用名称缩写.ui)</td><td>自定义的View类等</td></tr><tr><td>com.xx.应用名称缩写.service </td><td>Service服务</td></tr><tr><td>com.xx.应用名称缩写.broadcast </td><td>Broadcast服务</td></tr></tbody></table> 2 类（classes）：名词，采用大驼峰命名法，尽量避免缩写，除非该缩写是众所周知的，比如HTML,URL，如果类名称中包含单词缩写，则单词缩写的每个字母均应大写。 <table border="1" width="553"><tbody><tr class="firstRow"><td >类</td><td >描述</td><td >例如</td></tr><tr><td>activity类</td><td>Aty或者Activity为后缀标识</td><td>欢迎页面类WelcomeAty.或者WelcomeActivity</td></tr><tr><td>Adapter类</td><td>Adp或者Adapte为后缀标识</td><td>新闻详情适配器NewtDetailAdp或则直接 NewDetailAdapter</td></tr><tr><td>解析类</td><td>Hlr为后缀标识</td><td>首页解析类HomePosterHlr</td></tr><tr><td>公共方法类</td><td>Tools或Manager为后缀标识</td><td>线程池管理类：ThreadPoolManager 日志工具类：LogTools</td></tr><tr><td>数据库类</td><td>以DBHelper后缀标识</td><td>新闻数据库：NewDBHelper</td></tr><tr><td>Service类</td><td>以Service为后缀标识</td><td>时间服务TimeService</td></tr><tr><td>BroadcastReceive类</td><td> 以Broadcast为后缀标识</td><td>时间通知TimeBroadcast</td></tr><tr><td>ContentProvider</td><td>以Provider为后缀标识</td><td></td></tr><tr><td>直接写的共享基础类</td><td>以Base开头</td><td>BaseActivity,BaseFragment</td></tr></tbody></table> 3 接口（interface）：命名规则与类一样采用大驼峰命名法，多以able或ible结尾，如interface Runnable; interface Accessible。 4 方法（methods）：动词或动名词，采用小驼峰命名法例如:onCreate(),run() <table border="1" width="616"><tbody><tr class="firstRow"><td >方法</td><td >说明</td></tr><tr><td>initXX()</td><td>初始化相关方法,使用init为前缀标识，如初始化布局initView()</td></tr><tr><td>isXX()</td><td>checkXX()方法返回值为boolean型的请使用is或check为前缀标识</td></tr><tr><td>getXX()</td><td>返回某个值的方法，使用get为前缀标识</td></tr><tr><td>processXX()</td><td>对数据进行处理的方法，尽量使用process为前缀标识</td></tr><tr><td>displayXX()</td><td>弹出提示框和提示信息，使用display为前缀标识</td></tr><tr><td>saveXX()</td><td>与保存数据相关的，使用sav为e前缀标识</td></tr><tr><td>resetXX()</td><td>对数据重组的，使用reset前缀标识</td></tr><tr><td>clearXX()</td><td>清除数据相关的</td></tr><tr><td>removeXXX()</td><td>清除数据相关的</td></tr><tr><td>drawXXX()</td><td>绘制数据或效果相关的，使用draw前缀标识</td></tr></tbody></table> 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） <table border="1" width="493"><tbody><tr class="firstRow"><td >名称</td><td >功能</td></tr><tr><td>btn_xx</td><td>按钮图片使用btn_整体效果（selector）</td></tr><tr><td>btn_xx_normal</td><td>按钮图片使用btn_正常情况效果</td></tr><tr><td>btn_xx_press</td><td>按钮图片使用btn_点击时候效果</td></tr><tr><td>bg_head</td><td>背景图片使用bg_功能_说明</td></tr><tr><td>def_search_cell</td><td>默认图片使用def_功能_说明</td></tr><tr><td>icon_more_help</td><td>图标图片使用icon_功能_说明</td></tr><tr><td>seg_list_line</td><td>具有分隔特征的图片使用seg_功能_说明</td></tr><tr><td>sel_ok</td><td>选择图标使用sel_功能_说明</td></tr></tbody></table>命名后缀：<table border="1" align="left" width="604"><tbody><tr class="firstRow"><td >后缀</td><td >说明</td></tr><tr><td>unit</td><td>在使用xml的tilemode来配图片时，element图片使用此后缀</td></tr><tr><td>nor</td><td>图片的状态，代表普通状态</td></tr><tr><td>hl</td><td>图片的状态，代表高亮状态</td></tr><tr><td>press</td><td>图片的状态，代表按下状态</td></tr><tr><td>select</td><td>图片的状态，代表其所占的view被选中</td></tr><tr><td>unselect</td><td>图片的状态，代表其所占的view没有被选中</td></tr></tbody></table>8资源布局文件（XML文件（layout布局文件））：全部小写，采用下划线命名法1)．contentview命名,Activity默认布局，以去掉后缀的Activity类进行命名。不加后缀： 功能模块.xml 例如：main.xml、more.xml、settings.xml 或则：activity_功能模块.xml 例如：activity_main.xml、activity_more.xml2)．Dialog命名：dialog_描述.xml例如：dlg_hint.xml2)．PopupWindow命名：ppw_描述.xml例如：ppw _info.xml3).列表项命名listitem_描述.xml例如：listitem_city.xml4)．包含项：include_模块.xml例如：include_head.xml、include_bottom.xml5)．adapter的子布局：功能模块_item.xml例如：main_item.xml、 9动画文件（anim文件夹下）：全部小写，采用下划线命名法，加前缀区分。//前面为动画的类型，后面为方向<table border="1" width="481"><tbody><tr class="firstRow"><td >动画命名例子</td><td >规范写法</td><td >备注</td></tr><tr><td>fade_in</td><td>淡入</td><td></td></tr><tr><td>fade_out</td><td>淡出</td><td></td></tr><tr><td>push_down_in</td><td>从下方推入</td><td></td></tr><tr><td>push_down_out</td><td>从下方推出</td><td></td></tr><tr><td>push_left</td><td>推像左方</td><td></td></tr><tr><td>slide_in_from_top</td><td>从头部滑动进入</td><td></td></tr><tr><td>zoom_enter</td><td>变形进入</td><td></td></tr><tr><td>slide_in</td><td>滑动进入</td><td></td></tr><tr><td>shrink_to_middle</td><td>中间缩小</td><td></td></tr></tbody></table>10资源ID（resourcesid）：大小写规范与方法名一致，采用小驼峰命名法。命名规范为"资源控件的缩写名"+"变量名"。注意：页面控件名称应该和控件id名保持一致strings.xml，colors.xml等中的id命名：命名模式：activity名称_功能模块名称_逻辑名称/activity名称_逻辑名称/common_逻辑名称strings.xml中，使用activity名称注释，将文件内容区分开来 11 layout中的id命名命名模式为：view缩写_模块名称_view的逻辑名称view的缩写详情如下： <table border="1" align="left" width="493"><tbody><tr class="firstRow"><td >控件</td><td >缩写</td></tr><tr><td>LayoutView</td><td>lv</td></tr><tr><td>RelativeView</td><td>rv</td></tr><tr><td>TextView</td><td>tv</td></tr><tr><td>Button</td><td>btn</td></tr><tr><td>ImageButton</td><td>imgBtn</td></tr><tr><td>ImageView</td><td>mgView或则 iv</td></tr><tr><td>CheckBox</td><td>chk</td></tr><tr><td>RadioButton</td><td>rdoBtn</td></tr><tr><td>analogClock</td><td>anaClk</td></tr><tr><td>DigtalClock</td><td>dgtClk</td></tr><tr><td>DatePicker</td><td>dtPk</td></tr><tr><td>EditText </td><td>edtTxt</td></tr><tr><td>TimePicker </td><td>tmPk</td></tr><tr><td>toggleButton </td><td>tglBtn</td></tr><tr><td>ProgressBar</td><td>proBar</td></tr><tr><td>SeekBar</td><td>skBar</td></tr><tr><td>AutoCompleteTextView</td><td>autoTxt</td></tr><tr><td>ZoomControls</td><td>zmCtl</td></tr><tr><td>VideoView</td><td>vdoVi</td></tr><tr><td>WdbView</td><td>webVi</td></tr><tr><td>RantingBar</td><td>ratBar</td></tr><tr><td>Tab</td><td>tab</td></tr><tr><td>Spinner</td><td>spn</td></tr><tr><td>Chronometer</td><td>cmt</td></tr><tr><td>ScollView</td><td>sclVi</td></tr><tr><td>TextSwitch</td><td>txtSwt</td></tr><tr><td>ImageSwitch</td><td>imgSwt</td></tr><tr><td>listView</td><td>lVi或则lv</td></tr><tr><td>ExpandableList</td><td>epdLt</td></tr><tr><td>MapView</td><td>mapVi</td></tr></tbody></table> 12.activity中的view变量命名命名模式为：逻辑名称+view缩写建议：如果layout文件很复杂，建议将layout分成多个模块，每个模块定义一个moduleViewHolder，其成员变量包含所属view13.styles.xml：将layout中不断重现的style提炼出通用的style通用组件，放到styles.xml中；14.使用layer-list和selector Android编码规范建议（别人弄的觉得蛮有道理）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只要继承它即可16.使用button+activitgroup实现tab效果时，使用Button.setSelected(true)，确保按钮处于选择状态，并使activitygroup的当前activity与该button对应17.如果所开发的为通用组件，为避免冲突，将drawable/layout/menu/values目录下的文件名增加前缀18.数据一定要效验，例如字符型转数字型，如果转换失败一定要有缺省值；服务端响应数据是否有效判断

Android 命名规范 （提高代码可以读性）

Android 命名规范（提高代码可以读性）