转载

IntelliJ IDEA 使用 lombok 减少冗长代码

对于 POJO, 我们需要为其中的每个字段生成 getter,setter 方法, 虽然能够使用 IDE 快速为我们生成. 但如果需要修改字段名称及字段类型, 那么就需要删除在重新进行生成, 终究还是有一些不方便. 如果使用 lombok, 可以通过一些简单的注解直接生成我们所需要的代码, 能极大的提高开发体验.

pom引入依赖

<dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <optional>true</optional>
 </dependency>

idea下载插件

lombok 常用注解介绍

@NonNull
@Cleanup
@Getter,@Setter
@ToString
@EqualsAndHashCode
@NoArgsConstructor
@RequiredArgsConstructor
@AllArgsConstructor
@Data
@Value
@Builder

如 User 对象中存在 name,age 字段, User user=User.builder().name("姓名").age(20).build()

* `@SneakyThrows` ： 对标注的方法进行 try catch 后抛出异常, 可在 value 输入需要 catch 的异常数组, 默认 catch Throwable
* `@Synchronized` ： 在标注的方法内 使用 synchronized(/$lock) {} 对代码进行包裹 ,$lock 为 new Object[0]
* `@Log,@CommonsLog,@JBossLog,@Log,@Log4j,@Log4j2,@Slf4j,@XSlf4j` ： 生成一个当前类的日志对象, 可以使用 topic 指定要获取的日志名称,使用log...使用

自定义配置

虽然 lombok 能为我们快速生成代码, 但是有一些生成的代码依然无法满足我们的需求. 此时可配置 lombok.config 来解决问题

以下列出一些常用的配置

lombok.getter.noIsPrefix=true(默认: false)  #lombok 默认对 boolean 类型字段生成的 get 方法使用 is 前缀, 通过此配置则使用 get 前缀
 lombok.accessors.chain=true(默认: false) #默认的 set 方法返回 void 设置为 true 返回调用对象本身
 lombok.accessors.fluent=true(默认: false) #如果设置为 true. get,set 方法将不带 get,set 前缀, 直接以字段名为方法名
 lombok.log.fieldName=logger(默认: log) #设置 log 类注解返回的字段名称

注 : 在 IDEA 中,lombok.config 文件请放置于 srcmainjava 目录下, 在 srcmainresources 中将不生效

如感觉文章对你有所帮助，可以关注微信公众号【五彩的颜色】鼓励一下

IntelliJ IDEA 使用 lombok 减少冗长代码