IntelliJ IDEA 使用 lombok 减小冗长代码

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

  1. pom引入依赖
<dependency>
              <groupId>org.projectlombok</groupId>
              <artifactId>lombok</artifactId>
              <optional>true</optional>
         </dependency>复制代码
  1. idea下载插件
![](https://user-gold-cdn.xitu.io/2019/10/14/16dc82e1ef3a57df?w=2054&h=1148&f=png&s=62010)复制代码
  1. lombok 经常使用注解介绍
* `@NonNull` : 使用 @NonNull 注解修饰的字段 经过 set 方法设置时若是为 null, 将抛出 NullPointerException
    * `@Cleanup` : 主要用来修饰 IO 流相关类, 会在 finally 代码块中对该资源进行 close();
    * `@Getter,@Setter` : 为字段生成 getter,setter 方法, 标记到类上代表为全部字段生成
    * `@ToString` : 生成 toString 方法, 默认打印全部非静态字段
    * `@EqualsAndHashCode` : 生成 equals 和 hashCode 方法
    * `@NoArgsConstructor` : 无参构造函数
    * `@RequiredArgsConstructor` : 为未初始化的 final 字段和使用 @NonNull 标注的字段生成构造函数
    * `@AllArgsConstructor` : 为全部字段生成构造函数
    * `@Data` : 至关于同时使@Getter,@Setter,@ToString,@EqualsAndHashCode,@RequiredArgsConstructor
    * `@Value` : 类将使用 final 进行修饰,同时使用@ToString,@EqualsAndHashCode,@AllArgsConstructor,@Getter
    * `@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...使用复制代码
  1. 自定义配置
虽然 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 中将不生效数组

如感受文章对你有所帮助,能够关注微信公众号【五彩的颜色】鼓励一下
相关文章
相关标签/搜索