Android 命名规范 (提高代码可以读性)

本贴最后更新于 2925 天前,其中的信息可能已经时移世改

刚接触 Android 的时候,命名都是按照拼音来,所以有的时候想看懂命名的那个控件什么是什么用的,就要读一遍甚至好几遍才知道,这样的话,在代码的审查和修改过程中就会浪费不少不必要的时间。如果就是我一个人开发,一个人维护的话还好,可是如果一个项目是团队分工合作,这样让你的同事去看你的代码就更加吃力了,因为大家之间的编程方式不一样,所以,在开发过程中,命名规范统一尤为重要,最好是团队中统一好大家命名方法,这样对于日后的工作会轻松很多。

在面试的时候,审核一个程序员的编程水平的时候,命名规范也是一大标准,所以,下面我就总结下我从网上别人的经验和自己的感悟中收集总结的android命名规范,希望对大家有所帮助。 提醒:在命名规范的统一下,在加上注释,这样日后维护会高效快捷好多。

先初略介绍下当前主要的标识符命名法和英文缩写规则:(这段别人那边借鉴的)

在讲解命名规范前,先初略介绍下当前主要的标识符命名法和英文缩写规则。
**
**标识符命名法
标识符命名法最要有四种:

1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外,其余所有单词的第一个字母大写。

2 帕斯卡(pascal)命名法:又称大驼峰命名法,所有单词的第一个字母大写

3 下划线命名法:单词与单词间用下划线做间隔。

4 匈牙利命名法:广泛应用于微软编程环境中,在以 Pascal 命名法的变量前附加小写序列说明该变量的类型。 量的取名方式为: + + 范围前缀,类型前缀,限定词。

个人觉得标识符命名原则:尽可能的用最少的字符而又能完整的表达标识符的含义。

英文缩写原则:
1 较短的单词可通过去掉“元音”形成缩写
2 较长的单词可取单词的头几个字母形成缩写
3 此外还有一些约定成俗的英文单词缩写.

下面为常见的英文单词缩写:

|

名称

|

缩写

|
|

icon

|

ic (主要用在 app 的图标)

|
|

color

|

cl(主要用于颜色值)

|
|

divider

|

di(主要用于分隔线,不仅包括 Listview 中的 divider,还包括普通布局中的线)

|
|

selector

|

sl(主要用于某一 view 多种状态,不仅包括 Listview 中的 selector,还包括按钮的 selector)

|
|

average

|

avg

|
|

background

|

Bg(主要用于布局和子布局的背景)

|
|

buffer

|

buf

|
|

control

|

ctrl

|
|

delete

|

del

|
|

document

|

doc

|
|

error

|

err

|
|

escape

|

esc

|
|

increment

|

inc

|
|

infomation

|

info

|
|

initial

|

init

|
|

image

|

img

|
|

Internationalization

|

I18N

|
|

length

|

len

|
|

library

|

lib

|
|

message

|

msg

|
|

password-

|

pwd

|
|

position

|

pos

|
|

server

|

srv

|
|

string

|

str

|
|

temp

|

tmp

|
|

window

|

wnd(win)

|

程序中使用单词缩写原则:不要用缩写,除非该缩写是约定俗成的。

命名规范:

1 包(packages): 采用反域名命名规则,全部使用小写字母。一级包名为 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.应用名称缩写.service

|

Service 服务

|
|

com.xx.应用名称缩写.broadcast

|

Broadcast 服务

|

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

|

|

描述

|

例如

|
|

activity 类

|

Aty 或者 Activity 为后缀标识

|

欢迎页面类 WelcomeAty.或者 WelcomeActivity

|
|

Adapter 类

|

Adp 或者 Adapte 为后缀标识

|

新闻详情适配器 NewtDetailAdp 或则直接 NewDetailAdapter

|
|

解析类

|

Hlr 为后缀标识

|

首页解析类 HomePosterHlr

|
|

公共方法类

|

Tools 或 Manager 为后缀标识

|

线程池管理类:ThreadPoolManager
日志工具类:LogTools

|
|

数据库类

|

以 DBHelper 后缀标识

|

新闻数据库:NewDBHelper

|
|

Service 类

|

以 Service 为后缀标识

|

时间服务 TimeService

|
|

BroadcastReceive 类

|

以 Broadcast 为后缀标识

|

时间通知 TimeBroadcast

|
|

ContentProvider

|

以 Provider 为后缀标识

| |
|

直接写的共享基础类

|

以 Base 开头

|

BaseActivity,BaseFragment

|

3 接口(interface):命名规则与类一样采用大驼峰命名法,多以 able 或 ible 结尾,如 interface Runna ble ;
interface Accessible 。

4 方法(methods):动词或动名词,采用小驼峰命名法例如:onCreate(),run()

|

方法

|

说明

|
|

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_功能_说明

|

命名后缀:

|

后缀

|

说明

|
|

unit

|

在使用 xml 的 tilemode 来配图片时,element 图片使用此后缀

|
|

nor

|

图片的状态,代表普通状态

|
|

hl

|

图片的状态,代表高亮状态

|
|

press

|

图片的状态,代表按下状态

|
|

select

|

图片的状态,代表其所占的 view 被选中

|
|

unselect

|

图片的状态,代表其所占的 view 没有被选中

|


8 资源布局文件(XML 文件(layout 布局文件)):

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

1).contentview 命名, Activity 默认布局,以去掉后缀的 Activity 类进行命名。不加后缀:

** 功能模块.xml
**

例如:main.xml、more.xml、settings.xml 或则:activity_功能模块.xml 例如:**activity_main.xml、activity_more.xml**

2).Dialog 命名:dialog_描述.xml

例如:**dlg_hint.xml**

2).PopupWindow 命名:ppw_描述.xml

例如:**ppw _info.xml**

3). 列表项命名 listitem_描述.xml

例如:**listitem_city.xml**

4).包含项:include_模块.xml

例如:**include_head.xml、include_bottom.xml**

5).adapter 的子布局:功能模块_item.xml

例如:**main_item.xml、**

9 动画文件(anim 文件夹下):全部小写,采用下划线命名法,加前缀区分。

//前面为动画的类型,后面为方向

|

动画命名例子

|

规范写法

|

备注

|
|

fade_in

|

淡入

|

|
|

fade_out

|

淡出

|

|
|

push_down_in

|

从下方推入

|

|
|

push_down_out

|

从下方推出

|

|
|

push_left

|

推像左方

|

|
|

slide_in_from_top

|

从头部滑动进入

|

|
|

zoom_enter

|

变形进入

|

|
|

slide_in

|

滑动进入

| |
|

shrink_to_middle

|

中间缩小

| |

10 资源 ID(resourcesid):大小写规范与方法名一致,采用小驼峰命名法。命名规范为“资源控件的缩写 名”+“变量名”。注意:页面控件名称应该和控件 id 名保持一致

** strings.xml,colors.xml 等中的 id 命名:**

命名模式:activity 名称_功能模块名称_逻辑名称/activity 名称_逻辑名称/common_逻辑名称

strings.xml 中,使用 activity 名称注释,将文件内容区分开来

11 layout 中的 id 命名

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

view 的缩写详情如下:

|

控件

|

缩写

|
|

LayoutView

|

lv

|
|

RelativeView

|

rv

|
|

TextView

|

tv

|
|

Button

|

btn

|
|

ImageButton

|

imgBtn

|
|

ImageView

|

mgView 或则 iv

|
|

CheckBox

|

chk

|
|

RadioButton

|

rdoBtn

|
|

analogClock

|

anaClk

|
|

DigtalClock

|

dgtClk

|
|

DatePicker

|

dtPk

|
|

EditText

|

edtTxt

|
|

TimePicker

|

tmPk

|
|

toggleButton

|

tglBtn

|
|

ProgressBar

|

proBar

|
|

SeekBar

|

skBar

|
|

AutoCompleteTextView

|

autoTxt

|
|

ZoomControls

|

zmCtl

|
|

VideoView

|

vdoVi

|
|

WdbView

|

webVi

|
|

RantingBar

|

ratBar

|
|

Tab

|

tab

|
|

Spinner

|

spn

|
|

Chronometer

|

cmt

|
|

ScollView

|

sclVi

|
|

TextSwitch

|

txtSwt

|
|

ImageSwitch

|

imgSwt

|
|

listView

|

lVi 或则 lv

|
|

ExpandableList

|

epdLt

|
|

MapView

|

mapVi

|

12.activity 中的 view 变量命名

命名模式为:逻辑名称 +view 缩写

建议:如果 layout 文件很复杂,建议将 layout 分成多个模块,每个模块定义一个 moduleViewHolder,其成员变量包含所属 view

13.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 是一种以 Linux 为基础的开放源码操作系统,主要使用于便携设备。2005 年由 Google 收购注资,并拉拢多家制造商组成开放手机联盟开发改良,逐渐扩展到到平板电脑及其他领域上。

    335 引用 • 324 回帖 • 1 关注

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...

推荐标签 标签

  • API

    应用程序编程接口(Application Programming Interface)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。

    79 引用 • 431 回帖 • 2 关注
  • 禅道

    禅道是一款国产的开源项目管理软件,她的核心管理思想基于敏捷方法 scrum,内置了产品管理和项目管理,同时又根据国内研发现状补充了测试管理、计划管理、发布管理、文档管理、事务管理等功能,在一个软件中就可以将软件研发中的需求、任务、bug、用例、计划、发布等要素有序的跟踪管理起来,完整地覆盖了项目管理的核心流程。

    6 引用 • 15 回帖 • 34 关注
  • 微软

    微软是一家美国跨国科技公司,也是世界 PC 软件开发的先导,由比尔·盖茨与保罗·艾伦创办于 1975 年,公司总部设立在华盛顿州的雷德蒙德(Redmond,邻近西雅图)。以研发、制造、授权和提供广泛的电脑软件服务业务为主。

    8 引用 • 44 回帖
  • Netty

    Netty 是一个基于 NIO 的客户端-服务器编程框架,使用 Netty 可以让你快速、简单地开发出一个可维护、高性能的网络应用,例如实现了某种协议的客户、服务端应用。

    49 引用 • 33 回帖 • 35 关注
  • SMTP

    SMTP(Simple Mail Transfer Protocol)即简单邮件传输协议,它是一组用于由源地址到目的地址传送邮件的规则,由它来控制信件的中转方式。SMTP 协议属于 TCP/IP 协议簇,它帮助每台计算机在发送或中转信件时找到下一个目的地。

    4 引用 • 18 回帖 • 639 关注
  • 友情链接

    确认过眼神后的灵魂连接,站在链在!

    24 引用 • 373 回帖
  • GraphQL

    GraphQL 是一个用于 API 的查询语言,是一个使用基于类型系统来执行查询的服务端运行时(类型系统由你的数据定义)。GraphQL 并没有和任何特定数据库或者存储引擎绑定,而是依靠你现有的代码和数据支撑。

    4 引用 • 3 回帖 • 6 关注
  • SendCloud

    SendCloud 由搜狐武汉研发中心孵化的项目,是致力于为开发者提供高质量的触发邮件服务的云端邮件发送平台,为开发者提供便利的 API 接口来调用服务,让邮件准确迅速到达用户收件箱并获得强大的追踪数据。

    2 引用 • 8 回帖 • 491 关注
  • FlowUs

    FlowUs.息流 个人及团队的新一代生产力工具。

    让复杂的信息管理更轻松、自由、充满创意。

    1 引用
  • 支付宝

    支付宝是全球领先的独立第三方支付平台,致力于为广大用户提供安全快速的电子支付/网上支付/安全支付/手机支付体验,及转账收款/水电煤缴费/信用卡还款/AA 收款等生活服务应用。

    29 引用 • 347 回帖
  • WordPress

    WordPress 是一个使用 PHP 语言开发的博客平台,用户可以在支持 PHP 和 MySQL 数据库的服务器上架设自己的博客。也可以把 WordPress 当作一个内容管理系统(CMS)来使用。WordPress 是一个免费的开源项目,在 GNU 通用公共许可证(GPLv2)下授权发布。

    66 引用 • 114 回帖 • 197 关注
  • 程序员

    程序员是从事程序开发、程序维护的专业人员。

    586 引用 • 3538 回帖
  • CongSec

    本标签主要用于分享网络空间安全专业的学习笔记

    1 引用 • 1 回帖 • 25 关注
  • Sphinx

    Sphinx 是一个基于 SQL 的全文检索引擎,可以结合 MySQL、PostgreSQL 做全文搜索,它可以提供比数据库本身更专业的搜索功能,使得应用程序更容易实现专业化的全文检索。

    1 引用 • 216 关注
  • CSDN

    CSDN (Chinese Software Developer Network) 创立于 1999 年,是中国的 IT 社区和服务平台,为中国的软件开发者和 IT 从业者提供知识传播、职业发展、软件开发等全生命周期服务,满足他们在职业发展中学习及共享知识和信息、建立职业发展社交圈、通过软件开发实现技术商业化等刚性需求。

    14 引用 • 155 回帖
  • Vim

    Vim 是类 UNIX 系统文本编辑器 Vi 的加强版本,加入了更多特性来帮助编辑源代码。Vim 的部分增强功能包括文件比较(vimdiff)、语法高亮、全面的帮助系统、本地脚本(Vimscript)和便于选择的可视化模式。

    29 引用 • 66 回帖
  • 服务器

    服务器,也称伺服器,是提供计算服务的设备。由于服务器需要响应服务请求,并进行处理,因此一般来说服务器应具备承担服务并且保障服务的能力。

    125 引用 • 585 回帖 • 1 关注
  • 自由行
    2 关注
  • Visio
    1 引用 • 2 回帖
  • Oracle

    Oracle(甲骨文)公司,全称甲骨文股份有限公司(甲骨文软件系统有限公司),是全球最大的企业级软件公司,总部位于美国加利福尼亚州的红木滩。1989 年正式进入中国市场。2013 年,甲骨文已超越 IBM,成为继 Microsoft 后全球第二大软件公司。

    107 引用 • 127 回帖 • 355 关注
  • ZooKeeper

    ZooKeeper 是一个分布式的,开放源码的分布式应用程序协调服务,是 Google 的 Chubby 一个开源的实现,是 Hadoop 和 HBase 的重要组件。它是一个为分布式应用提供一致性服务的软件,提供的功能包括:配置维护、域名服务、分布式同步、组服务等。

    59 引用 • 29 回帖 • 5 关注
  • 分享

    有什么新发现就分享给大家吧!

    247 引用 • 1794 回帖 • 3 关注
  • 锤子科技

    锤子科技(Smartisan)成立于 2012 年 5 月,是一家制造移动互联网终端设备的公司,公司的使命是用完美主义的工匠精神,打造用户体验一流的数码消费类产品(智能手机为主),改善人们的生活质量。

    4 引用 • 31 回帖 • 3 关注
  • Mac

    Mac 是苹果公司自 1984 年起以“Macintosh”开始开发的个人消费型计算机,如:iMac、Mac mini、Macbook Air、Macbook Pro、Macbook、Mac Pro 等计算机。

    168 引用 • 595 回帖
  • Vditor

    Vditor 是一款浏览器端的 Markdown 编辑器,支持所见即所得、即时渲染(类似 Typora)和分屏预览模式。它使用 TypeScript 实现,支持原生 JavaScript、Vue、React 和 Angular。

    366 引用 • 1842 回帖 • 2 关注
  • RESTful

    一种软件架构设计风格而不是标准,提供了一组设计原则和约束条件,主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。

    30 引用 • 114 回帖 • 6 关注
  • FreeMarker

    FreeMarker 是一款好用且功能强大的 Java 模版引擎。

    23 引用 • 20 回帖 • 458 关注