Java 命名规范(非常全面,可以收藏)

本文详细介绍了Java编程中接口、抽象类、异常类、方法、变量、常量、枚举等的命名规范,并推荐了全面的Java开发学习资料,涵盖基础知识到并发编程,旨在帮助开发者提升技能和准备面试。
摘要由CSDN通过智能技术生成

}

public interface ImageObserver{

}

public class ArrayIndexOutOfBoundsException{

}

public class enum Thread.State{

}

2.1 接口命名规范

首先,接口(Interface)是一种表述某一类型对象动作的特殊类;简单来说,接口也是类(不太严谨),所以,接口的名称的书写也应该符合类名书写规范,首字母应该大写,与普通类名不同的是,接口命名时通常采用形容词或动词来描述接口的动作行为。下列是Oracle Java中一些标准库的接口使用形容词命名示例:

public interface Closeable{

}

public interface Cloneable{

}

public interface Runnable{

}

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;

}

下面是Oracle Java标准库中的一个示例:

public enum ElementType{

TYPE,

FIELD,

METHOD,

PARAMETER,

CONSTRUCTOR,

LOCAL_VARIABLE,

ANNOTATION_TYPE,

PACKAGE,

TYPE_PARAMETER,

TYPE_USE;

}

7. 其他命名规范


7.1 数组

在定义数组时,为了便于阅读,尽量保持以下的书写规范:

int[] array = new int[10];

int[] idArray ={1,2,3,4,5};

String[] nameArray = {“First”,“Yellow”,“Big”}

public List getNameById(Integer[] ids){

}

public List getNameById(Integer…ids){

}

7.2 表述复数或者集合

如果一个变量用于描述多个数据时,尽量使用单词的复数形式进行书写,例如:

Collection orders;

int[] values;

List items;

另外,如果表述的是一个Map数据,则应使用“map”作为其后缀,例如:

Map<String,User> userMap;

Map<String,List> listMap;

7.3 泛型类

在书写泛型类时,通常做以下的约定:

  • E表示Element,通常用在集合中;

  • ID用于表示对象的唯一标识符类型

  • T表示Type(类型),通常指代类;

  • K表示Key(键),通常用于Map中;

  • V表示Value(值),通常用于Map中,与K结对出现;

  • N表示Number,通常用于表示数值类型;

  • ?表示不确定的Java类型;

  • X用于表示异常;

  • U,S表示任意的类型。

下面时泛型类的书写示例:

public class HashSet extends AbstractSet{

}

public class HashMap<K,V> extends AbstractMap<K,V>{

}

public class ThreadLocal{

}

自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。

深知大多数Java工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《2024年Java开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。img

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,真正体系化!

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注Java获取)

img

最后

很多程序员,整天沉浸在业务代码的 CRUD 中,业务中没有大量数据做并发,缺少实战经验,对并发仅仅停留在了解,做不到精通,所以总是与大厂擦肩而过。

我把私藏的这套并发体系的笔记和思维脑图分享出来,理论知识与项目实战的结合,我觉得只要你肯花时间用心学完这些,一定可以快速掌握并发编程。

不管是查缺补漏还是深度学习都能有非常不错的成效,需要的话记得帮忙点个赞支持一下

整理不易,觉得有帮助的朋友可以帮忙点赞分享支持一下小编~
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!
-1713393343852)]

[外链图片转存中…(img-uWUb62mn-1713393343852)]

[外链图片转存中…(img-J2rLzQto-1713393343853)]

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,真正体系化!

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注Java获取)

img

最后

很多程序员,整天沉浸在业务代码的 CRUD 中,业务中没有大量数据做并发,缺少实战经验,对并发仅仅停留在了解,做不到精通,所以总是与大厂擦肩而过。

我把私藏的这套并发体系的笔记和思维脑图分享出来,理论知识与项目实战的结合,我觉得只要你肯花时间用心学完这些,一定可以快速掌握并发编程。

不管是查缺补漏还是深度学习都能有非常不错的成效,需要的话记得帮忙点个赞支持一下

整理不易,觉得有帮助的朋友可以帮忙点赞分享支持一下小编~
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!

  • 21
    点赞
  • 30
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值