Java中的工具类命名方法

2025-04-28 17:50
文章标签 java 工具 方法 命名

本文主要是介绍Java中的工具类命名方法,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《Java中的工具类命名方法》:本文主要介绍Java中的工具类究竟如何命名,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧...

Java中的工具类究竟如何命名?

先来几个例子

JDK自带工具类

Arrays.asList();
Objects.equals();
Collections.sort();

Spring框架工具类

StringUtils.isEmpty();
CollectionUtils.isEmpty()
FileCopyUtils.copy();

Hutool工具类

StrUtil.isEmpty();
CollectionUtil.isEmpty();
FileUtil.copy();

我们发现各组例子之间的命名方式均不一样,总结一下分为三种:

1、JDK主要以操作对象的复数形式命名
2、Spring框架的工具类以对象或用途 + Util复数方式命名
3、Hutool框架的工具类则以对象或用途 + Util单数方式命名

OK,看完上面的再看下我们项目中的工具类命名方式

 StringUtil.isEmpty();
 StringUtils.isEmpty();
 StringKit.isEmpty();
 StringHelper.isEmpty();
 StringTool.isEmpty();
 StringTools.isEmpty();

可以看到一个简单的String工具类就可以有这么多命名方式,可谓是集百家之长,相当丰富。

几种命名方式的比较

JDK为代表的对象复数形式

优点
简单明了,熟悉的人这么用其实蛮爽的。

缺点
容易与其他以s结尾的单词让人对类的作用产生误解,例如将News、Goods等pojo类跟Objects工具类放一起。是不是第一感觉它们是同一用途,实则不然。

Spring框架为代表的对象Util复数形式

优点
能从类名上对类的用途进行划分,使用者不容易产生误解。

缺点
类命名一般为单数,复数命名形式会显得整体命名方式不一致。

Hutool框架为代表的对象Util单数形式

优点
能从类名上对类的用途进行划分,使用者不容易产生误解http://www.chinasem.cn,且整体命名方式容易与项目其他类保持一致。

缺点
这样就OK了,再较真就没法玩了。

项目中的命名方式

此处不对项目中的Kit、Tool等命名做过多讨论,主要还是对主流的几种命名方式进行分析。

到底如何命名 ?

对于纯粹的工具类来说FfRjbCw,行业中普遍还是以Util或Utils命名方式居多,其他命名方式当然也可以使用,包括上面所列举的项目中的几种命名方式,只是说大家提到Util或Utils第一反应都知道是工具类,其他的命名方式或许需要反应个几秒钟。

但是这里需要说一下Util与Helper的区别,也仅限自己的理解。

软件架构中有个软件重用的概念,分为水平式重用与垂直式重用。

水平式重用:是指可以在不同应用领域中使用的软件元素,简单理解就是业务无关性,可以在任意业务场景中使用

垂直式重用:是指在一类或具有较多公共性的应用领域之间进行软部件重用,简单理解就是可以在特定的业务领域或业务场景中使用

那么Util类就属于上面所说的水平式重用,Util类更多是对JDK提供的类进行封装,或者是某一技术框架自己提供的对框架内部其他类的使用封装,但是这类一般都具有业务、领域的无关性。在任何业务、领域下均可使用。所以既然是工具类一定保证其水平式重用这一特性。

Helpjavascripter翻译过来助手/帮手,从字面意思来看,这样的类是作为辅助类来使用的,那么问题来了,辅助的对象是谁 ?那么当然是对别的类的辅助,这里就有个范围,哪些类可以被辅助,理论上所有类或对象如果需要都可以被辅助,但实际中更多是为了简化某一场景下相关类使用的http://www.chinasem.cn复杂度,而提供了便捷的访问接口,形成Helper类,而这个场景一般具有业务或领域特征,所以更多体现的使用垂直式重用

总结

我个人来说目前习惯使用Util单数形式命名,项目中的其他类均以单数形式命名,如:UserControl编程ler、UserVo这样的,突然出现一个复数形式的类会感觉有点突兀。

没什么特殊要求或个人癖好的情况下,还是以Util或Utils大众最容易理解的方式进行命名,你说我非要用Tool命名咋的了,这么干也没问题,关键在于公司或团队有一套自己的标准就行,我是一个有代码洁癖的人,团队中的规范标准我都会进行严格统一,前期看似需要花费不少时间,但当内部大家认知能够达成一致时,越往后团队中大家工作的默契度越高这样能最大程度减少沟通成本,减小后期的维护成本.

如果能满足以上需求,怎么命名真的都OK

到此这篇关于Java中的工具类究竟如何命名?的文章就介绍到这了,更多相关Java工具类命名内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程China编程(www.chinasem.cn)!

这篇关于Java中的工具类命名方法的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1154414

相关文章

java中long的一些常见用法

《java中long的一些常见用法》在Java中,long是一种基本数据类型,用于表示长整型数值,接下来通过本文给大家介绍java中long的一些常见用法,感兴趣的朋友一起看看吧... 在Java中,long是一种基本数据类型,用于表示长整型数值。它的取值范围比int更大,从-922337203685477

使用jenv工具管理多个JDK版本的方法步骤

《使用jenv工具管理多个JDK版本的方法步骤》jenv是一个开源的Java环境管理工具,旨在帮助开发者在同一台机器上轻松管理和切换多个Java版本,:本文主要介绍使用jenv工具管理多个JD... 目录一、jenv到底是干啥的?二、jenv的核心功能(一)管理多个Java版本(二)支持插件扩展(三)环境隔

java Long 与long之间的转换流程

《javaLong与long之间的转换流程》Long类提供了一些方法,用于在long和其他数据类型(如String)之间进行转换,本文将详细介绍如何在Java中实现Long和long之间的转换,感... 目录概述流程步骤1:将long转换为Long对象步骤2:将Longhttp://www.cppcns.c

SpringBoot集成LiteFlow实现轻量级工作流引擎的详细过程

《SpringBoot集成LiteFlow实现轻量级工作流引擎的详细过程》LiteFlow是一款专注于逻辑驱动流程编排的轻量级框架,它以组件化方式快速构建和执行业务流程,有效解耦复杂业务逻辑,下面给大... 目录一、基础概念1.1 组件(Component)1.2 规则(Rule)1.3 上下文(Conte

SpringBoot服务获取Pod当前IP的两种方案

《SpringBoot服务获取Pod当前IP的两种方案》在Kubernetes集群中,SpringBoot服务获取Pod当前IP的方案主要有两种,通过环境变量注入或通过Java代码动态获取网络接口IP... 目录方案一:通过 Kubernetes Downward API 注入环境变量原理步骤方案二:通过

Springboot整合Redis主从实践

《Springboot整合Redis主从实践》:本文主要介绍Springboot整合Redis主从的实例,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录前言原配置现配置测试LettuceConnectionFactory.setShareNativeConnect

Java中Map.Entry()含义及方法使用代码

《Java中Map.Entry()含义及方法使用代码》:本文主要介绍Java中Map.Entry()含义及方法使用的相关资料,Map.Entry是Java中Map的静态内部接口,用于表示键值对,其... 目录前言 Map.Entry作用核心方法常见使用场景1. 遍历 Map 的所有键值对2. 直接修改 Ma

Mybatis Plus Join使用方法示例详解

《MybatisPlusJoin使用方法示例详解》:本文主要介绍MybatisPlusJoin使用方法示例详解,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,... 目录1、pom文件2、yaml配置文件3、分页插件4、示例代码:5、测试代码6、和PageHelper结合6

Java中实现线程的创建和启动的方法

《Java中实现线程的创建和启动的方法》在Java中,实现线程的创建和启动是两个不同但紧密相关的概念,理解为什么要启动线程(调用start()方法)而非直接调用run()方法,是掌握多线程编程的关键,... 目录1. 线程的生命周期2. start() vs run() 的本质区别3. 为什么必须通过 st

关于跨域无效的问题及解决(java后端方案)

《关于跨域无效的问题及解决(java后端方案)》:本文主要介绍关于跨域无效的问题及解决(java后端方案),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录通用后端跨域方法1、@CrossOrigin 注解2、springboot2.0 实现WebMvcConfig