Java命名规范
包(Package)
1、使用小写英文字母进行命名
2、多层包之间用点进行分隔
3、一般采用域名倒写的方式进行
package com.xing.controller
package com.xing.pojo
package com.xing.service
类(Class)
1、通常是见名知意的名词
2、首字母大写
3、多个单词时,采用驼峰命名法
4、不建议使用中文缩写来命名
public class User{}
public class UserController{}
接口(Interface)
符合类名的命名规范即可
public interface UserService{}
public interface UserMapper{}
抽象类(Abstract Class)
1、符合类名的命名规范即可
2、为了和接口做出区别,一般以“Abstract”或者“Base”作为前缀
public abstract class AbstractController{}
public abstract class BaseDao{}
异常类(Exception Class)
1、符合类名的命名规范即可
2、为了和普通类做出区别,一般以“Exception”作为后缀
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;
常量(final)
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、枚举类中的值遵循常量的命名规范
3、枚举值名称需要和类有关联性
public enum Color{
RED,
BLUE,
GREEN,
YELLOW
}
public enum ElementType{
TYPE,
FIELD,
METHOD,
PARAMETER,
CONSTRUCTOR,
LOCAL_VARIABLE,
ANNOTATION_TYPE,
PACKAGE,
TYPE_PARAMETER,
TYPE_USE;
}
泛型
1、E表示Element,通常用在集合中。
2、T表示Type(类型),通常指类。
3、K表示Key(键),通常用于Map中。
4、V表示Value(值),通常用于Map中,与K成对出现。
5、N表示Number,通常表示数值类型。
6、?表示不确定的Java类型。
7、X表示异常。
8、U,S表示任意类型。
本文作者:笔兴洽谈室 哔哩哔哩:笔兴洽谈室 GitHub:StarJava1024 Gitee:StarJava1024
本文链接:https://www.cnblogs.com/CrayonXiaoxing/articles/17527723.html
原创文章仅用于学习,不得修改原作品,不得再创作。若本文侵犯某版权,请私信联系删除!如需转载,请私信!