游客您好
第三方账号登陆
  • 点击联系客服

    在线时间:8:00-16:00

    客服电话

    020-85534346

    电子邮件

    81058337@qq.com
  • 码云社APP

    随时掌握码云社动态

  • 扫描二维码

    关注砺锋微信公众号

java中超好用的简化代码工具:Lombok使用

发布时期:2019-4-3 11:57
阅读:824 回复:12

Lombok使用介绍你是否也被java的各种模板化代码困扰,各种getter、setter、toString等等在项目中使用Lombok可以减少很多这种重复代码的书写。IDEA中的安装打开IDEA的Setting–>选择Plugins选项–>选择Browsereposito ...

Lombok使用

介绍

你是否也被java的各种模板化代码困扰,各种getter、setter、toString等等

在项目中使用Lombok可以减少很多这种重复代码的书写。

IDEA中的安装

打开IDEA的Setting –> 选择Plugins选项 –> 选择Browse repositories –> 搜索lombok –> 点击安装 –> 安装完成重启IDEA –> 安装成功


java中超好用的简化代码工具:Lombok使用


引入依赖

在项目中添加Lombok依赖jar,在pom文件中添加如下部分。(不清楚版本可以在Maven仓库中搜索)

org.projectlombok

lombok

1.16.18

provided

使用

在对应的类或者方法上使用对应注解即可。

Lombok有哪些注解

  • @Setter
  • @Getter
  • @Data
  • @Log(这是一个泛型注解,具体有很多种形式)
  • @AllArgsConstructor
  • @NoArgsConstructor
  • @EqualsAndHashCode
  • @NonNull
  • @Cleanup
  • @ToString
  • @RequiredArgsConstructor
  • @Value
  • @SneakyThrows
  • @Synchronized

注解详情

log

注解在 上。有如下可选择可用:

//@CommonsLog

privatestaticfinal org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);

//@JBossLog

privatestaticfinal org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class);

//@Log

privatestaticfinal java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());

//@Log4j

privatestaticfinal org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);

//@Log4j2

privatestaticfinal org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);

//@Slf4j

privatestaticfinal org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);

//@XSlf4j

privatestaticfinal org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

默认情况下,记录器的主题(或名称)将是使用注释进行@Log注释的类的类名称。这可以通过指定topic参数来定制。例如:@XSlf4j(topic="reporting")。

该类型注解可以满足不同的日志系统的日志使用,Lombok提供了一些自定义配置项可以参看官方说明文档。

Log官方介绍

@Getter和@Setter

该注解使用在类或者属性上,该注解可以使用在类上也可以使用在属性上。生成的getter遵循布尔属性的约定。例如:boolean类型的sex,getter方法为isSex而不是getSex

在使用该注解时,会默认生成一个无参构造。和对应的getterhe setter方法


java中超好用的简化代码工具:Lombok使用


该注解也可以使用在单个属性上,会默认生成一个无参构造:


java中超好用的简化代码工具:Lombok使用


@NonNull

该注解使用在属性上,该注解用于属的非空检查,当放在setter方法的字段上,将生成一个空检查,如果为空,则抛出NullPointerException。

该注解会默认是生成一个无参构造。


java中超好用的简化代码工具:Lombok使用


@toString

该注解使用在上,该注解默认生成任何非讲台字段以名称-值的形式输出。

1、如果需要可以通过注释参数includeFieldNames来控制输出中是否包含的属性名称。

2、可以通过exclude参数中包含字段名称,可以从生成的方法中排除特定字段。

3、可以通过callSuper参数控制父类的输出。

  • includeFieldNames是否包含属性名称:


java中超好用的简化代码工具:Lombok使用


  • exclude 排除指定字段


java中超好用的简化代码工具:Lombok使用


  • callSuper输出父类属性
java中超好用的简化代码工具:Lombok使用



注意:父类也要有toString方法,不然打印的是对象内存地址

@EqualsAndHashCode

该注解使用在上,该注解在类级别注释会同时生成equals和hashCode。

注意继承关系的时候该注解的使用。详细介绍参照官方介绍


java中超好用的简化代码工具:Lombok使用


存在继承关系需要设置callSuper参数为true。

@Data

该注解使用在上,该注解是最常用的注解,它结合了@ToString,@EqualsAndHashCode, @Getter和@Setter。本质上使用@Data注解,类默认@ToString和@EqualsAndHashCode以及每个字段都有@Setter和@getter。该注解也会生成一个公共构造函数,可以将任何@NonNull和final字段作为参数。

虽然@Data注解非常有用,但是它没有与其他注解相同的控制粒度。@Data提供了一个可以生成静态工厂的单一参数,将staticConstructor参数设置为所需要的名称,Lombok自动生成的构造函数设置为私有,并提供公开的给定名称的静态工厂方法。

java中超好用的简化代码工具:Lombok使用



@AllArgsConstructor

该注解使用在上,该注解提供一个全参数的构造方法,默认不提供无参构造。


java中超好用的简化代码工具:Lombok使用


@NoArgsConstructor

该注解使用在上,该注解提供一个无参构造


java中超好用的简化代码工具:Lombok使用


@RequiredArgsConstructor

该注解使用在上,使用类中所有带有 @NonNull 注解的或者带有 final 修饰的成员变量生成对应的构造方法。


java中超好用的简化代码工具:Lombok使用


@Value

这个注解用在 类 上,会生成含所有参数的构造方法,get 方法,此外还提供了equals、hashCode、toString 方法。

注意:没有setter


java中超好用的简化代码工具:Lombok使用


@Cleanup

该注解使用在属性前,该注解是用来保证分配的资源被释放。在本地变量上使用该注解,任何后续代码都将封装在try/finally中,确保当前作用于中的资源被释放。默认@Cleanup清理的方法为close,可以使用value指定不同的方法名称。


java中超好用的简化代码工具:Lombok使用


@Synchronized

该注解使用在类或者实例方法上,Synchronized在一个方法上,使用关键字可能会导致结果和想要的结果不同,因为多线程情况下会出现异常情况。Synchronized

关键字将在this示例方法情况下锁定当前对象,或者class讲台方法的对象上多锁定。这可能会导致死锁现象。一般情况下建议锁定一个专门用于此目的的独立锁,而不是允许公共对象进行锁定。该注解也是为了达到该目的。


java中超好用的简化代码工具:Lombok使用


@SneakyThrows

该注解使用在方法上,这个注解用在 方法 上,可以将方法中的代码用 try-catch 语句包裹起来,捕获异常并在 catch 中用 Lombok.sneakyThrow(e) 把异常抛出,可以使用 @SneakyThrows(Exception.class) 的形式指定抛出哪种异常。该注解需要谨慎使用。详情参看官方介绍


java中超好用的简化代码工具:Lombok使用


结语

Lombok的目的是减少代码的重复编写,并提供比较好的解决方案。当然也存在一些争议性的注解,可以根据实际场景进项使用。Lombok有一些实验注解可以在官网查看。

lggb1258(未知职业)-本文作者
这个人很懒,什么也没有留下。
824 12 2019-4-3 11:57
该文章已有12人参与评论

请发表评论

全部评论

查看全部评论>>

扫一扫关注官方微信号

一手信息资讯权掌握尽在码云社

滚动新闻
CODESEEDING(码云社)一家致力于程序员成长、以内容为核心、以提问为引导的多元化成长社区。我们在线上为技术爱好者提供了一个优质的交流氛围环境,在线下同样和众多高校联合开办了技术沙龙品牌。
020-85534346
关注我们
  • 访问移动H5版
  • 官方微信公众号

码云社 - CODESEEDING 2.0© 2018-2019 码云社. TOOBUG ( 粤ICP备16114193号-3 )