}
public interface Comparable{
//…
}
public interface CompletionService{
//…
}
public interface Iterable{
//…
}
public interface EventListener{
//…
}
在Spring Framework标准库中,通常采用名词+动词/形容词的组合方式来命名接口,下列是Spring Framework中一些接口命名示例:
public interface AfterAdvice{
//…
}
public interface TargetClassAware{
//…
}
public interface ApplicationContextAware{
//…
}
public interface MessageSourceResolvable{
//…
}
2.2 抽象类命名规范
抽象类(Abstract Class)是一种特殊的类,其命名与普通类的命名规范相当。一般地,为了将抽象类与普通类和接口做出区别,提高抽象类的可读性,在命名抽象类时,会以“Abstract”/“Base”作为类命的前缀。下面是编程中一些常规的命名示例:
public abstract class AbstractRepository{
//…
}
public abstract class AbstractController{
//…
}
public abstract class BaseDao<T,ID>{
//…
}
public abstract class AbstractCommonService{
//…
}
以下是Spring Framework中常见的抽象类示例:
public abstract class AbstractAspectJAdvice{
//…
}
public abstract class AbstractSingletonProxyFactoryBean{
//…
}
public abstract class AbstractBeanFactoryPointcutAdvisor{
//…
}
public abstract class AbstractCachingConfiguration{
//…
}
public abstract class AbstractContextLoaderInitializer{
//…
}
2.3 异常类命名规范
异常类(Exception Class)也是类的一种,但与普通类命名不同的是,异常类在命名时需要使用“Exception”作为其后缀。下面是常见的异常类命名示例:
public class FileNotFoundException{
//…
}
public class UserAlreadyExistException{
//…
}
public class TransactionException{
//…
}
public class ClassNotFoundException{
//…
}
public class IllegalArgumentException{
//…
}
public class IndexOutOfBoundsException{
//…
}
另外,在Java中还有另外一类异常类,它们属于系统异常,这一类异常类的命名使用“Error”作为其后缀,以区分Exception(编码,环境,操作等异常)。下面是系统异常(非检查异常)的命名示例:
public abstract class VirtualMachineError{
//…
}
public class StackOverflowError{
//…
}
public class OutOfMemoryError{
//…
}
public class IllegalAccessError{
//…
}
public class NoClassDefFoundError{
//…
}
public class NoSuchFieldError{
//…
}
public class NoSuchMethodError{
//…
}
3.方法命名规范
方法(Method)命名时,其首字母应该小写,如果方法签名由多个单词组成,则从第二个单词起,使用驼峰命名法进行书写。一般地,在对方法进行命名时,通常采用动词/动词+名词的组合,下面是方法命名的一些常见示例。
3.1 表述获取
如果一个方法用于获取某个值,通常使用“get”作为其前缀,例如:
public String getUserName(){
//…
}
public List getUserIds(){
//…
}
public User getOne(){
//…
}
3.2 表述查询
如果方法需要通过查询或筛选的方式获取某个数据,通常使用“find”/“query”作为其前缀,例如:
public List findOne(Integer id){
//…
}
public List findAll(){
//…
}
public List queryOrders(){
//…
}
3.3 表述条件
如果一个方法需要一些条件参数,则可以使用“by”/“with”等字符作为方法名中条件的连接符,例如:
public User findByUsername(String username){
//…
}
public List getUserIdsWithState(boolean state){
//…
}
public List findAllByUsernameOrderByIdDesc(String username){
//…
}
3.4 表述设置
如果一个方法是要设置,插入,修改,删除等操作,应该将对应的动词(set,insert,update,delete)作为其名词的前缀,例如:
public void setName(String name){
//…
}
public User insert(User user){
//…
}
public void update(User user){
//…
}
public void clearAll(){
//…
}
3.5 其他规范
如果一个方法用于获取某组数据的长度或数量,则该方法应该使用length或size命名;如果方法的返回值为布尔类型(Boolean),则该方法应该使用“is”或”has”作为前缀;如果方法用于将一种类型的数据转换为另一种数据数类型,则可以使用“to”作为前缀。下面是综合示例:
public long length(){
//…
}
public int size(){
//…
}
public boolean isOpen(){
//…
}
public boolean isNotEmpty(){
//…
}
public boolean hasLength(){
//…
}
public Set mapToSet(Map map){
//…
}
public UserDto convertTo(User user){
//…
}
public String toString(Object obj){
//…
}
4. 变量命名规范
变量(Variable)命名包括参数名称,成员变量和局部变量。变量命名通常以小写字母开头,如果变量名由多个单词构成,则从第二个单词起首字母需要大写,在变量命名过程中,不建议使用“_”作为前缀或者单词之间的分割符号。下面是一些常见的变量命名示例:
private String nickName;
private String mobileNumber;
private Long id;
private String username;
private Long orderId;
private Long orderItemId;
5. 常量命名规范
一般地,常量名称采用全部大写的英文单词书写,如果常量名称由多个单词组成,则单词之间统一使用“_”进行分割,下面是常量命名示例:
public static final String LOGIN_USER_SESSION_KEY = “current_login_user”;
public static final int MAX_AGE_VALUE = 120;
public static final int DEFAULT_PAGE_NO = 1;
public static final long MAX_PAGE_SIZE = 1000;
public static final boolean HAS_LICENSE = false;
public static final boolean IS_CHECKED = false;
6. 枚举命名规范
枚举(Enum)类是一种特殊的类,其命名规范遵循普通类的命名约束条件,首字母大写,采用驼峰命名法;枚举类中定义的值的名称遵循常量的命名规范,且枚举值的名称需要与类名有一定的关联性,下面是枚举的一些示例:
public enum Color{
RED,YELLOW,BLUE,GREEN,WHITE;
}
public enum PhysicalSize{
TINY,SMALL,MEDIUM,LARGE,HUGE,GIGANTIC;
}
小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数初中级Java工程师,想要提升技能,往往是自己摸索成长,但自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年最新Java开发全套学习资料》送给大家,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频
如果你觉得这些内容对你有帮助,可以添加下面V无偿领取!(备注Java)
lic enum PhysicalSize{
TINY,SMALL,MEDIUM,LARGE,HUGE,GIGANTIC;
}
小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数初中级Java工程师,想要提升技能,往往是自己摸索成长,但自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年最新Java开发全套学习资料》送给大家,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
[外链图片转存中…(img-HSz5D1R7-1710876733413)]
[外链图片转存中…(img-Doz8Z2dJ-1710876733414)]
[外链图片转存中…(img-xcoQBpnC-1710876733414)]
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频
如果你觉得这些内容对你有帮助,可以添加下面V无偿领取!(备注Java)
[外链图片转存中…(img-XJIdzfJX-1710876733415)]