第三方工具系列--Lombok常用注解
原创作品,可以转载,但是请标注出处地址:https://www.cnblogs.com/V1haoge/p/9329798.html
Lombok注解解析:
@NonNull
使用在方法的参数或者构造器的参数上,用于生成null验证。
Lombok可以识别任何第三方工具的字段上标注的@NonNull名称的注解,并在使用@Data、@AllArgsContruct进行生成方法和构造器时进行null判断。
而Lombok的@NonNull注解使用在参数之上,仅仅作用到你自定义的方法和构造器之上。
null判断会采用:
if (param == null)
throw new NullPointerException("param is marked @NonNull but is null");
的形式插入,并且会在你方法的开头和构造器的this,super之类的调用之后插入。
@Cleanup
使用在资源之前,用于表示资源可以被完美自动释放(在代码的执行路径超出资源范围之前)。
将该注解标注在表示资源的变量之上,比如:@Cleanup InputStream in = new FileInputStream("some/file");
这样一来,在资源范围结束的位置会自动调用in.close()方法进行资源释放。这个调用会在try...finally...块中调用,来保证调用必定会执行。
当然,你也可以在注解内部定义释放资源的方法名称,来指定释放资源的具体方法,这适用于没有close()方法的情况下,必须保证这些方法是无参的。
@Getter and @Setter
标注在字段之上,用于自动生成get、set方法。Boolean类型为is开头。
生成的get、set方法默认情况之下都是public的,但也可以手动指定范围value=AccessLevel.PUBLIC、AccessLevel.PROTECTED、AccessLevel.PRIVATE、AccessLevel.PRIVATE四种。
也能标注在类上,表示针对该类中所有的非静态字段进行get、set方法自动生成。
如果指定某个字段的AccessLevel=AccessLevel.NONE,则可以使该生成动作失效,此时可以手动实现get、set方法,这应用于在这些方法中有一些自定义逻辑的情况下。
@ToString
标注于类之上,用于生成toString()方法。
includeFieldNames,默认为true,表示在toString输出时输出字段名称。
callSuper,默认为false,表示生成toString时不输出超类中的字段内容,若要输出超类中的内容,需要设置为true
doNotUseGetters,默认为false,表示获取字段值时通过get方法获取,设置为true表示直接通过字段获取
onlyExplicitlyIncluded,默认为false,表示输出所有非静态字段内容,如果设置为true,则只输出标注有@ToString.Include的字段和方法
@ToString.Include
标注于字段、方法之上,表示生成toString方法时包含该注解标注的字段和方法,需要与onlyExplicitlyIncluded一起使用。
rank,默认为0,表示级别,数字越大级别越高,高级别将会优先输出,同级别按照代码顺序输出。
name,可以为标注的成员(字段或者方法)另起一个名字。
@ToString.Exclude
标注于字段之上,表示生成toString方法时不包含被该注解标注的字段。那么生成toString方法时会跳过这些字段,
@EqualsAndHashCode
标注于类之上用于生成hashCode方法和equals方法。
callSuper,同上
doNotUseGetters,同上
onlyExplicitlyIncluded,同上,需要配合@EqualsAndHashCode.Include使用。
@EqualsAndHashCode.Include
标注于字段或者方法之上,需要与onlyExplicitlyIncluded配合使用,表示将该注解标注的内容添加到实现hashCode和equals方法的内容中去。
@EqualsAndHashCode.Exclude
标注于字段之上,用于排除不需要参与生成hashCode和equals方法的字段。可单独使用。
@NoArgsConstructor
用于生成无参构造器,如果类中存在final字段,则会报编译错误。一般结合其他几个构造器注解一起使用提供一个无参构造器,并且不会检查@NonNull标注的字段
force,默认为false,表示是否针对final字段进行特殊处理,如果将其设置为true,则上面的编译错误将会消失,内部处理为,将final字段初始化为0\false\null
access,默认为lombok.AccessLevel.PUBLIC,表示public范围的构造器
staticName,一旦设置该值,则会生成一个静态的“构造器”工厂,其内部包裹着一个私有的构造器,对外提供创建对象的功能,这是明显的工厂模式。
@RequiredArgsConstructor
用于按照要求生成构造器,所谓的要求就是包含final字段和类似于@NonNull约束标注的字段,会对@NonNull字段进行明确的null检查
access,同上
staticName,同上
@AllArgsConstructor
用于生成包含所有字段的构造器。@NonNull字段会进行null判断检查。
access,同上
staticName,同上
@Data
标注于类之上,是@ToString,@EqualsAndHashCode、@Getter、@Setter、@RequiredArgsConstructor的综合体
staticConstructor,同staticName
@Value
可以看成是@Data的变体,表示生成一个不可变类(final类)。没有set方法,只有get方法,字段全部为final private的,类也是final的
等效于@Getter @FieldDefaults(makeFinal=true, level=AccessLevel.PRIVATE) @AllArgsConstructor @ToString @EqualsAndHashCode
staticConstructor,同上。
如果手工实现了任何一个注解的功能,那么该注解将失效,为了使注解起效,你可以在手共实现的方法上添加注解@lombok.experimental.Tolerate,用于将手共实现对lombok隐藏。
我们可以使用下面两种方式来重写默认为final和private的行为,一是直接在字段上添加accessLevel,二是使用@NonFinal或者@PackagePrivate注解。
@Builder
标注于类之上,用于生成复杂的builder API,创建构建者模式。
还可用于标注于构造器和方法之上。
@SneakyThrows
标注于方法之上用于隐藏异常抛出语句,该注解存在争议,暂不使用
@Log
@CommonsLog
@Flogger
@JBossLog
@Log
@Log4j
@Log4j2
@Slf4j
@XSlf4j
@Synchronized
标注于方法(只能用于静态方法和实例方法)之上,用于表示同步方法,锁可以使用默认的也可以使用自定义的锁(private final )。
第三方工具系列--Lombok常用注解的更多相关文章
- 20190905 Lombok常用注解
Lombok常用注解 val 用于声明类型,将从初始化表达式推断出类型,仅适用于局部变量和foreach循环,而不适用于字段.声明的局部变量为final变量. Java自带类型推断随着JDK版本提升越 ...
- Lombok 常用注解
Lombok Lombok 能以简单的注解形式来简化 java 代码,提高开发人员的开发效率.例如开发中经常需要写的 javaBean,都需要花时间去添加相应的 getter/setter,也许还要去 ...
- lombok常用注解@Data@AllArgsConstructor@NoArgsConstructor@Builder@Accessors
原贴:https://blog.csdn.net/ChenXvYuan_001/article/details/84961992 https://blog.csdn.net/weixin_382293 ...
- lombok常用注解
简介: Lombok能以简单的注解形式来简化java代码,提高开发人员的开发效率.例如开发中经常需要写的javabean,都需要花时间去添加相应的getter/setter,也许还要去写构造器.equ ...
- [Java 开发利器Lombok] 常用注解演示
在以往的对象模型编码时,我们需要写一大堆的get/set以及不同的构造函数等.Lombok为我们提供了一个非常好的插件形式. 在大多数的项目中,只需要使用到以下集中Annotation就足够了,如果需 ...
- Lombok 常用注解总结
本文转载自知乎专栏 极乐科技.有所整理. 主要注解 @Data @Setter @Getter @Log4j @AllArgsConstructor @NoArgsConstructor @Equal ...
- lombok --- 常用注解解析
@Data@Getter @Setter @ToString@Cleanup@NonNull@Builder@EqualsAndHashCode
- Lombok - 使用注解让你的JavaBean变得更加简洁
Lombok - 工具简介: Lombok是一个编译时注释预处理器,有助于在编译时注入一些代码.Lombok提供了一组在开发时处理的注释,以将代码注入到Java应用程序中,注入的代码在开发环境中立即可 ...
- Spring注解 系列之Spring常用注解总结
参考:Spring系列之Spring常用注解总结 (1) Resource 默认是byName的方式进行bean配置,@AutoWired默认是按照byType的方式进行装配bean的:(2)Comp ...
随机推荐
- 周报数据采集之生存图片(execl方法)
https://blog.csdn.net/Luzaofa/article/details/81675364 Python之Excel chart另存为图片大家好,好久没有更新博客了,这一段时间有点忙 ...
- ubuntu设置ssh登录
1.为ubuntu添加root用户(其实Ubuntu中的root帐号默认是被禁用了的,所以登陆的时候没有这个账号),打开初始账号,输入命令:sudo passwd root,设置root的密码 2.切 ...
- Maven4-仓库
坐标和构建是一个构件在Maven世界中的逻辑表示方式,而其物理表示方式是文件.Maven通过仓库来统一管理这些文件 什么是Maven仓库? 在Maven世界中,任何一个依赖,插件或者项目构建的输出,都 ...
- chat.php
<!DOCTYPE html><html> <meta charset="UTF-8"> <title>web chat</t ...
- .net反混淆脱壳工具de4dot的使用
de4dot是一个开源的.net反混淆脱壳工具,是用C#编写的,介绍一下它的使用方法 首先 pushd 到de4dot.exe所在文件夹,然后调用 de4dot.exe 路径+dll名称 如果显示: ...
- 为什么需要提前撰写Spec文档
Joel on Software(中文名叫<Joel软件随想录>)算得上是一本旧书了,但里面的建议和讨论,真的是历久弥新.特别是,Joel是个有趣.牛逼的家伙:前微软Excel的职员.St ...
- BATJ等公司必问的8道Java经典面试题,你都会了吗?
1.谈谈你对 Java 平台的理解?“Java 是解释执行”,这句话正确吗? 考点分析: 对于这类笼统的问题,你需要尽量表现出自己的思维深入并系统化,Java 知识理解得也比较全面,一定要避免让面试官 ...
- Android JNI 学习(七):Accessing Fields Api
一.GetFieldID jfieldIDGetFieldID(JNIEnv *env, jclass clazz, const char *name, const char *sig); 返回类的实 ...
- Android 9.0/P 版本推荐使用 HttpURLConnection
早在几年前,谷歌就推荐在Android2.3版本以上使用HttpURLConnection,而在即将正式发布的 Android P 版本中,谷歌彻底取消了对Apache HTTPClient的支持,针 ...
- 解决Django项目数据库无法迁移问题
找到自己的虚拟环境,以下是我自己的环境路径 D:\xunihuanjing\venv\Lib\site-packages\django\contrib\admin\migrations 然后删除里面的 ...