一、实验性功能说明
@UtilityClass
是在lombok v1.16.2
中作为实验性功能引入的。
实验因为:
- 关于其是否常见到足以算作模板的问题,存在一些争议。
当前状态:积极-目前我们认为该功能可能很快脱离实验状态,不会有任何或微小的变化。
二、简介
一个实用工具类是一个只是函数命名空间的类。它的实例不可能存在,而且它的所有成员都是静态的。例如,java.lang.Math
和java.util.Collections
是著名的实用工具类。这个注解会自动将被注解的类变成一个这样的类。
一个实用工具类不能被实例化。通过用@UtilityClass
标记你的类,lombok
会自动生成一个抛出异常的私有构造函数,将你添加的任何显式构造函数标记为错误,并将该类标记为final
。如果该类是一个内部类,该类也被标记为static
。
实用工具类的所有成员都被自动标记为静态。甚至是字段和内部类。
三、示例比较
1. Lombok 写法
import lombok.experimental.UtilityClass;
@UtilityClass
public class UtilityClassExample {
private final int CONSTANT = 5;
public int addSomething(int in) {
return in + CONSTANT;
}
}
2. Java 标准写法
public final class UtilityClassExample {
private static final int CONSTANT = 5;
private UtilityClassExample() {
throw new java.lang.UnsupportedOperationException("This is a utility class and cannot be instantiated");
}
public static int addSomething(int in) {
return in + CONSTANT;
}
}
四、支持的配置项
lombok.utilityClass.flagUsage
= [warning
| error
] (默认: not set
)
Lombok
将@UtilityClass
的任何使用标记为警告或错误(如果已配置)。
五、附属说明
目前还没有任何方法来创建非静态成员,或者定义你自己的构造函数。如果你想实例化实用工具类,即使只是作为一个内部实现,也不能使用@UtilityClass
。
由于javac
处理静态导入的方式很特别,试图对@UtilityClass
的任何成员进行非星形静态导入都不会成功。要么使用星形静态导入:import static TypeMarkedWithUtilityClass.*;
或者不要静态导入任何成员。
参考文献
【1】@UtilityClass | Utility, metility, wetility! Utility classes for the masses.
Java 面试宝典是大明哥全力打造的 Java 精品面试题,它是一份靠谱、强大、详细、经典的 Java 后端面试宝典。它不仅仅只是一道道面试题,而是一套完整的 Java 知识体系,一套你 Java 知识点的扫盲贴。
它的内容包括:
- 大厂真题:Java 面试宝典里面的题目都是最近几年的高频的大厂面试真题。
- 原创内容:Java 面试宝典内容全部都是大明哥原创,内容全面且通俗易懂,回答部分可以直接作为面试回答内容。
- 持续更新:一次购买,永久有效。大明哥会持续更新 3+ 年,累计更新 1000+,宝典会不断迭代更新,保证最新、最全面。
- 覆盖全面:本宝典累计更新 1000+,从 Java 入门到 Java 架构的高频面试题,实现 360° 全覆盖。
- 不止面试:内容包含面试题解析、内容详解、知识扩展,它不仅仅只是一份面试题,更是一套完整的 Java 知识体系。
- 宝典详情:https://www.yuque.com/chenssy/sike-java/xvlo920axlp7sf4k
- 宝典总览:https://www.yuque.com/chenssy/sike-java/yogsehzntzgp4ly1
- 宝典进展:https://www.yuque.com/chenssy/sike-java/en9ned7loo47z5aw
目前 Java 面试宝典累计更新 400+ 道,总字数 42w+。大明哥还在持续更新中,下图是大明哥在 2024-12 月份的更新情况:
想了解详情的小伙伴,扫描下面二维码加大明哥微信【daming091】咨询
同时,大明哥也整理一套目前市面最常见的热点面试题。微信搜[大明哥聊 Java]或扫描下方二维码关注大明哥的原创公众号[大明哥聊 Java] ,回复【面试题】 即可免费领取。