先来几个例子

  • 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单数形式

优点

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

缺点

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

项目中的命名方式

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

到底如何命名 ?

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

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

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

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

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

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

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

总结

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

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

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

Java中的工具类究竟如何命名?的更多相关文章

  1. Java中的工具类和新特性

    1:Collections集合框架工具类: /* 集合框架的工具类. Collections:集合框架的工具类.里面定义的都是静态方法. Collections和Collection有什么差别? Co ...

  2. 在Java中Arrays工具类实现功能的六种方法

    使用Arrays工具类,要先导入包即:import.java.util.Arrays 以下是实现六种功能的方法: 1.比较两个数组值是否相等: 结果为true.false.(布尔型不能比较) int ...

  3. 巧用Java中Calendar工具类

    Java的JDK中提供了一系列好用的util工具类.Calendar就是java.util中用于处理日期的工具类.且该工具类易学易用实用. 工具类Calendar是抽象类. PS:为什么把Calend ...

  4. java高并发系列 - 第22天:java中底层工具类Unsafe,高手必须要了解

    这是java高并发系列第22篇文章,文章基于jdk1.8环境. 本文主要内容 基本介绍. 通过反射获取Unsafe实例 Unsafe中的CAS操作 Unsafe中原子操作相关方法介绍 Unsafe中线 ...

  5. Java中Arrays工具类

    以下是实现六种功能的方法: 1.比较两个数组值是否相等: 结果为true.false.(布尔型不能比较) int []a={10,20,30}; int []b={10,20,30}; int []c ...

  6. java中常用工具类

    目录 一. org.apache.commons.io.IOUtils 二. org.apache.commons.io.FileUtils 三. org.apache.commons.lang.St ...

  7. HttpTool.java(在java tool util工具类中已存在) 暂保留

    HttpTool.java 该类为java源生态的http 请求工具,不依赖第三方jar包 ,即插即用. package kingtool; import java.io.BufferedReader ...

  8. 简单了解Spring中常用工具类_java - JAVA

    文章来源:嗨学网 敏而好学论坛www.piaodoo.com 欢迎大家相互学习 文件资源操作 Spring 定义了一个 org.springframework.core.io.Resource 接口, ...

  9. java中的File类

    File类 java中的File类其实和文件并没有多大关系,它更像一个对文件路径描述的类.它即可以代表某个路径下的特定文件,也可以用来表示该路径的下的所有文件,所以我们不要被它的表象所迷惑.对文件的真 ...

随机推荐

  1. Distinct 实现自定义去重

    using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.T ...

  2. 08 python学习笔记-随机生成大乐透号码(八)

    1 #产生大乐透号码 2 #前区 1-32,5 后区 1-12,2 3 #1.前区从1-32中级取5个,后区再从1-12里面取2个 4 #01 02 03 04 5 def dlt(): #生成随机大 ...

  3. Process类调用exe,返回值以及参数空格问题

    (方法一)返回值为int fileName为调用的exe路径,入口参数为para,其中多个参数用空格分开,当D:/DD.exe返回值为int类型时. Process p = new Process() ...

  4. Spring Cloud gateway 网关服务 一

    之前我们介绍了 zuul网关服务,今天聊聊spring cloud gateway 作为spring cloud的亲儿子网关服务.很多的想法都是参照zuul,为了考虑zuul 迁移到gateway 提 ...

  5. spring cloud 调用接口间歇性返回http 500 - Internal Server Error的错误

    查找了各种资料都没找到解决办法,token失效,网络问题,接口服务问题,基础服务问题,都考虑过,但是没能解决,偶尔发现服务器网络配置中存在一个virbr0虚拟网卡,问了下了网管,删除这个对服务并没有影 ...

  6. Python的深浅拷贝

    Python的深浅拷贝 深浅拷贝 1. 赋值,对于list, set, dict来说, 直接赋值. 其实是把内存地址交给变量并不是复制一份内容 list1 = [']] list2 = list1 p ...

  7. li列表循环滚动的简单方法,无需插件,简单方法搞定

    <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8&quo ...

  8. 适用于Windows桌面应用程序的.NET Core 3

    介绍 9月,微软发布了新版.NET Core,用于构建Windows桌面应用程序,包括WPF和Windows Forms.从那时起开发人员可以将传统的nfx桌面应用程序(和控件库)迁移到.NET Co ...

  9. 一位年轻而优秀的.NET开发者的成长点滴

    一,社区的小圈子 今年3月的一次技术交流活动上,那是我们.NET技术社区第一次组织线下活动,由于没什么经验,所以活动组织得比较仓促,内容也比较一般,效果还是有点欠缺.当然,活动本身是必要的,这次活动上 ...

  10. TypeError: expected string or bytes-like object

    在写Python代码的时候,遇到了"TypeError: a bytes-like object is required, not 'str'"错误,此处实验机器的Python环境 ...