Java开发相关命名规范

JAVA文件命名规范

1.类命名

抽象类以ABstract或者Base开头。
异常类以Exception结尾。
枚举类以Enum作为后缀。
形容能力的接口使用able作为后缀。
实现类与接口用后缀Impl区别。
数据类:表名+DO。
传输类:领域相关名+DTO。
展示类:页面名称+VO。

2.service/dao层方法命名

获取单个对象用get做前缀。
获取多个对象用list做前缀
获取统计值用count做前缀。
插入用save做前缀。
删除用remove做前缀。
修改用update做前缀。

数据库命名规范

库:应用名表:业务名称_表的作用(单数形式
主键索引:pk_字段名
唯一索引:uk_字段名
普通索引:idx_字段名
表示是否字段:is_xxxx unsigned tinyint(1.表示是,0表示否)

JUnit单元测试命名规范

1.测试类的命名定义规范

类的命名规则是:被测试的业务+Test、被测试的接口+Test、被测试的类+Test
类的名字必须由大写字母开头而其他字母均为小写;如果类名称由多个单词组成,则每个单词的首字母均应为大写,如MobileBindTest。如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExample。

2.测试用例的命名定义规范

test+用例操作_状态 或者 test+用例方法名称_具体测试方法
单词的约定与测试类命名同。如:testSetMobileBind_NoSkyid
比如要测试的用例是“数据库用户信息不存在时,获取Mobile绑定消息”,那么它的测试用例名称就是testSetMobileBind_NoSkyid
?比如要测试的方法是findParam,采用的是边界值方法,那么它的测试用例名称可以是testFindParam_Boundaries

3.测试程序的包名定义规范

被测试类的包名前加上“test.” 。被测试类的包名是com.wistrons.util,那么测试类的包名就是test.com.wistrons.util。
测试程序包的命名规则是:test.com.skymobi.项目名;测试公共类包的命名规则是:test.com.skymobi.common

4.变量的命名规范

第一个单词的首字母小写,其后单词的首字母大写
例如:maxValue
变量名不应以下划线或美元符号开头,尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆,即,能够指出其用途。尽量避免单个字符的变量名,除非是一次性的临时变量。

5.常量的命名规范

常量名应该都使用大写字母,下划线分割单词。例如:
MAX_VALUE

版本控制工具提交信息命名规范

第1行:提交修改内容的摘要(少于25个汉字,不用句号,使用祈使句,大写字母开始)
第2行:空行
第3行以后:修改的理由(大概36个汉字换行,正文解释是什么和为什么,而不是如何做)

时间: 2024-10-13 15:38:53

Java开发相关命名规范的相关文章

【Java】变量命名规范

Java是一种区分字母的大小写的语言,所以我们在定义变量名的时候应该注意区分大小写的使用和一些规范,接下来我们简单的来讲讲Java语言中包.类.变量等的命名规范. (一)Package(包)的命名 Package的名字应该都是由一个小写单词组成,例如com.xuetang9.company等. (二)Class(类)的命名 Class的名字首字母大写,通常由多个单词合成一个类名,要求每个单词的首字母也要大写,例如:XueTang或ProNine. (三)变量的命名 变量的名字可大小写混用,但首字

Java开发相关名词解释 Java开发学习

随着技术的发展,市场的需要,很多盆友想转行Java开发,但又苦恼于不懂Java中一些名词的意义,那我们就一起来通俗的解释下Java开发中的一些名词,方便大家理解. Servlet:java初级框架,所有框架的基础,struts2,springMVC的控制层都是在servlet的基础上封装的. Hibernate:java持久层框架,主要作用就是提供与数据库的交互.现在已经被mybatis逐渐替代了. Mybatis:java持久层框架,功能与hibernate近似,但是相比hibernate更灵

阿里巴巴Java开发手册-命名规约

1. [强制] 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束.反例: _name / __name / $Object / name_ / name$ / Object$2. [强制] 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式.说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义.注意,即使纯拼音命名方式也要避免采用.反例:  DaZhePromotion [ 打折 ] /  getPingfenByName() [ 评分 ] /  in

java中的命名规范,项目开发步骤

1. 项目名:没有要求,别中文 2. 包:公司域名倒写:com.igeek 3. 持久层:dao,persist,mepper 4. 实体类:entity,model,bean,javabean,pojo 5. 业务逻辑:service 6. 控制器:controller,servlet,action,web 7. 过滤器:filter 8. 异常:exception 9. 监听器:listener 10. 注释: 类和方法上使用文档注释:/**   */ 方法里使用/*   */  或者  /

[java开发篇][代码规范]

http://www.hawstein.com/posts/google-java-style.html Google Java编程风格指南 January 20, 2014 作者:Hawstein出处:http://hawstein.com/posts/google-java-style.html声明:本文采用以下协议进行授权: 自由转载-非商用-非衍生-保持署名|Creative Commons BY-NC-ND 3.0 ,转载请注明作者及出处. 目录 前言 源文件基础 源文件结构 格式 命

Java基础之命名规范

一 命名规则 1)包: 命名应该都是名词或名词性词组,全部小写,单词之间用“.”分开,一般使用本公司网站域名的逆序后跟具体的软件内部模块名 包命名举例: package com.sun.java: package com.baidu.java: 2)类: 名词或名词性词组,每个单词首字母大写:一般不使用缩写,除非其缩写更通用和便于理解,大驼峰命名法,每一个单字的首字母都采用大写字母,如HTML:当要区别接口和实现类的时候,可以在类的后面加上"Impl",例如:interface Con

Java包的命名规范

indi : 个体项目,指个人发起,但非自己独自完成的项目,可公开或私有项目,版权主要属于发起者. 包名为indi.发起者名.项目名.模块名*.*.* pers : 个人项目,指个人发起,独自完成,可分享的项目,版权主要属于个人. 包名为pers.个人名.项目名.模块名*.*.* priv : 私有项目,指个人发起,独自完成,非公开的私人使用的项目,版权属于个人. 包名为priv.个人名.项目名.模块名*.*.* team : 团队项目指由团队发起,并由该团队开发的项目,版权属于该团队所有. 包

Java开发相关官方存档下载地址

前言 一般很多人下载软件的习惯都是百度随便一搜,然后开始慢慢寻找:我个人观点是: 不要百度随便搜着下,不要下载来历不明的软件 不需要去CSDN下 去官网下,官网一般都会有一个所有版本下载存档 jdk Java SE - 下载 | Oracle 技术网 | Oracle: http://www.oracle.com/technetwork/cn/java/javase/downloads/index.html 存档地址: http://www.oracle.com/technetwork/cn/j

Java开发相关安装包网盘下载链接分享

虚拟机VMWare10软件 网盘链接: 链接:https://pan.baidu.com/s/1dff3m0EBzMegtgRaJFEadQ 提取码:8caf CentOS-6.6-x86_64-bin-DVD1.iso 网盘链接: 链接:https://pan.baidu.com/s/13wIXuoJkza95U-rBs0AUpQ 提取码:r0xd nginx-1.15.2 网盘链接: 链接:https://pan.baidu.com/s/1RdMe3oikPJSrRpg3lEvwaQ 提取码