Java命名规范【全】

最新推荐文章于 2024-05-10 17:48:36 发布

写BUG的ySir

最新推荐文章于 2024-05-10 17:48:36 发布

阅读量1.1w

点赞数 28

分类专栏： Java 文章标签： java 开发语言

本文链接：https://blog.csdn.net/yanzer/article/details/124641438

版权

Java 专栏收录该内容

8 篇文章 1 订阅

订阅专栏

前言

本文根据本人日常的学习等，总结出来的Java中的命名规范。

基本上概括所有。

喜欢的话记得点个赞，收藏哟~~

包（Package）-命名规范

1. 使用小写英文字母进行命名。

2. 多层包之间用点进行分隔。

3. 一般采用域名倒写的方式进行命名。

package com.zer.controller
package com.zer.pojo
package com.zer.service

类（Class）-命名规范

1. 通常是见名知意的名词。

2. 首字母大写。

3. 多个单词时，采用驼峰命名法。

4. 不建议使用中文缩写来命名。

public class User{}
public class UserController{}

接口（Interface）-命名规范

符合类名的命名规范即可。

public interface Animal{}
public interface UserMapper{}

抽象类（Abstract Class）-命名规范

1. 符合类名的命名规范即可。

2. 为了和接口做出区别，一般以“Abstract”或“Base”作为前缀。

public abstract class AbstractController{}
public abstract class BaseDao{}

异常类（Exception Class）-命名规范

1. 符合类名的命名规范即可。

2. 为了和普通类做出区别，一般以“Exceptiont”作为后缀。

public class FileNotFoundException{}

接口实现类-命名规范

1. 符合类名的命名规范即可。

2. 为了和普通类做出区别，一般以“Impl”作为后缀。

public interface UserService{}
public class UserMapperImpl implements UserService{}

测试类-命名规范

1. 符合类名的命名规范即可。

2. 为了和普通类做出区别，一般以“Test”作为后缀。

public class UserServiceTest{}

方法（Method）-命名规范

1. 通常是见名知意的名词。

2. 首字母小写。

3. 多个单词时，采用驼峰命名法。

4. 不建议使用中文缩写来命名。

5. 不建议使用下划线作为连接。

6. 有返回值的方法一般加“get”前缀。

7. 设置的方法一般加对应的动词作为前缀（如：set、insert、update、delete）。

8. 查询的方法一般加“select”或“find”或“query”作为前缀。

9. 带有条件的方法一般在命名中使用“by”或“with”等字符。

10. 判断的方法一般以“is”作为前缀。

11. 测试方法一般以“test”作为前缀。

public void show() {}
public String getName() {}
public void setName() {}
public int insertUser() {}
public int updateUser() {}
public int deleteUser() {}
public List<User> findUser() {}
public User queryUser()
public User selectUserById(int id) {}
public boolean isHas() {}
public void testUserServiceImpl() {}

变量-命名规范

1. 通常是见名知意的名词。

2. 首字母小写。

3. 多个单词时，采用驼峰命名法。

4. 不建议使用中文缩写来命名。

5. 不建议使用下划线作为连接。

private Integer userId;
private String userName;
private String password;

常量-命名规范

1. 通常是见名知意的名词。

2. 全部大写字母。

3. 多个单词之间使用“_”进行分隔。

4. 不建议使用中文缩写来命名。

public static final int MAX_AGE = 120;
public static final String USER_TYPE_VIP = "会员用户";
public static final long MAX_NUMBER = 10000;

枚举类（Enum）-命名规范

1.枚举类遵循普通类的命名规范。

2. 枚举类中的值遵循常量的命名规范。

2. 枚举值名称需要和类有关联性。

public enum Color{
    RED,
    BLUE,
    GREEN,
    YELLOW
}
public enum ElementType{
    TYPE,
    FIELD,
    METHOD,
    PARAMETER,
    CONSTRUCTOR,
    LOCAL_VARIABLE,
    ANNOTATION_TYPE,
    PACKAGE,
    TYPE_PARAMETER,
    TYPE_USE;
}