Java命名规范

项目(Object)
全小写

包(Package)
小写名词,上下级以.隔开,每个分隔单元为一个单词,一般地,包命名常采用顶级域名作为前缀,例如com,net,org,edu,gov,cn,io等,随后紧跟公司/组织/个人名称以及功能模块名称

类(Class)
大驼峰命名法,通常用名词

接口(interface)
大驼峰命名法,通常用形容词或动词

抽象类(Abstract Class)
一般会以“Abstract”/“Base”做前缀

异常类(Exception Class)
一般异常使用“Exception”作为其后缀
系统异常使用“Error”作为其后缀

方法(Method)
小驼峰命名法,一般使用动词或动词+名词的命名方式

表述查询
通常使用“find”/“query”作为其前缀

表述条件
可以使用“by”/“with”等字符作为方法名中条件的连接符

表述设置
如果一个方法是要设置,插入,修改,删除等操作,应该将对应的动词(set,insert,update,delete)作为其名词的前缀

其他规范
如果一个方法用于获取某组数据的长度或数量,则该方法应该使用length或size命名;如果方法的返回值为布尔类型(Boolean),则该方法应该使用“is”或”has”作为前缀;如果方法用于将一种类型的数据转换为另一种数据数类型,则可以使用“to”作为前缀。

变量命名规范
小驼峰命名法

常量命名规范
全大写蛇形命名法

枚举(Enum)
方法用大驼峰,枚举值全大写

泛型类
E表示Element,通常用在集合中;
ID用于表示对象的唯一标识符类型
T表示Type(类型),通常指代类;
K表示Key(键),通常用于Map中;
V表示Value(值),通常用于Map中,与K结对出现;
N表示Number,通常用于表示数值类型;
?表示不确定的Java类型;
X用于表示异常;
U,S表示任意的类型。

接口实现类
为了便于阅读,在通常情况下,建议接口实现类使用“Impl作为后缀”,不建议使用大写的“I”作为接口前缀

测试类和测试方法
在项目中,测试类采用被测试业务模块名/被测试接口/被测试类+“Test”的方法进行书写,测试类中的测试函数采用“test”+用例操作_状态的组合方式进行书写

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值