java 语法的命名规范
文章目录
项目名 命名规范
全部小写
如：yijiebuyi , helloworld
package 包名命名规范
强烈推荐使用公司或机构的顶级域名为包名的前缀;
包名的前几个为固定名称, 如果是网站的话，采用网站的域名的反写;
package 包名全部为小写字母,以符号(. )来分隔, 但是不能包含*号，具有实际的区分意义.
如:
com.yijiebuyi.blog //博客系统
com.yijiebuyi.wechat //微信H5服务站
要求
- 有意义的名词
- 传达其用途
- 结合模块名来命名
使用范例
应用系统中经常应用分层，Dao层（数据库访问）、Service层（业务处理）、Web层（页面控制action类）
假如我们现在要定义blog下的内容( content) 模块
Dao层操作：定义为 com.yijiebuyi.blog.content.dao
Service层操作：定义为 com.yijiebuyi.blog.content.service
web层操作：定义为 com.yijiebuyi.blog.content.web
class 类名的命名规范
类名必须使用名词，如果一个类名内含多个单词，那么各个单词第一个字母大写，后续字母小写，起伏呈驼峰状，人称驼峰式命名;
给类名命名时，必须保证准确、简洁且容易理解;
尽量使用完整单词，避免使用缩写词（除了大家公认的）.
要求
- 类名中出现的单词要有意义,能传达该类的用途
- 首字母必须大写,如果多个词组成,每个词的第一个字母必须大写,如 友情链接: FriendLink
- 接口类和实现类要有区别,类的后面加上“Impl” ,接口类：FriendLinkInterface.java 接口实现类：FriendLinkInterfaceImp.java
- 实体类没有后缀名
使用范例
在系统开发中一样会定义 Dao层（数据库访问）、Service层（业务处理）、Web层（页面控制action类）
Dao
- 接口类：采用 业务名称+Interface+Dao 的形式来定义,即，实体对象+Interface+Dao.
如：内容对象接口类： ContentInterfaceDao - 实现类：采用 业务名称+Interface+Impl+Dao的形式来定义,即，实体对象+Interface+Impl+Dao.
如：内容对象实现类：UserInterfaceImplDao
Service
- 接口类：采用 业务名称+Interface+Service的形式来定义,
如：内容管理接口类：ContentInterfaceServiec - 实现类：采用 业务名称+Interface+Impl+Service的形式来定义,
如：内容管理实现类：ContentInterfaceImplServiec
action
- 实现类：采用 业务名称+Operator+Action的形式来定义,
如: 内容模块action ,Content+删除操作 Delete+Action = ContentDeleteAction
变量的命名规范
要求
- 有意义的名字，能快速地传达该变量的用途
- 首字母以小写开头，每个单词首字母大写（第一个单词除外）
- 开头加上类型标识 (使用3字符前缀)
byte-> bye
char-> chr
float-> flt
boolean-> bln
Integer/int-> int
short-> sht
Long/long-> lng
Double/double-> dbl
string-> str
约定
- 同一函数中不使用同一个变量表示前后意义不同的两个数值
- 除非是在循环中，否则一般不推荐使用单个字母作为变量名，i、j、k等只作为小型循环的循环索引变量
- 避免用Flag来命名状态变量
- 如果需要对变量名进行缩写时，一定要注意整个代码中缩写规则的一致性 (变量名中尽量不要出现缩写)
静态变量
- 选择有意义的名字，能快速地传达该变量的用途
- 采用全部大写的形式来书写，对于采用多词合成的变量采用“_”来连接各单词.如：BLOG_CATEGORY
方法的命名规范
要求
- 选择有意义的名字，能快速地传达该方法的用途
- 首字母以小写开头，每个单词首字母大写 (第一个单词除外)
约定
- 方法表示一种行为，即一种动作，最好是一个动词或者动词词组或者第一个单词为一个动词
- 属性方法：以get/set开头，其后跟字段名称，字段名称首字母大写。如：getBlogTitle()
- 数据层方法：只能以insert（插入）,delete（删除）,update（更新）,select（查找）,count（统计）开头，其他层方法避免以这个5个单词开头，以免造成误解
- 服务层方法，根据方法的行为命名，只描述方法的意义，而不采用方法的目的命名.比如系统的添加新用户，用户可以前台注册，也可以管理员后台添加，方法会被重用，所以最好不要用使用register，采用add会更好些,避免使用与web层相关的方法.
- Web层方法最好是贴近web的语言，如register，login，logout等方法.
出自:java 语法的命名规范