SpringBoot整合Lombok及常见问题解决

目录

• Lombok
• 2. Lombok注解失效原因
• 整合过程
• 1. 引入Lombok依赖：
• 2. 安装Lombok插件
• 优点与缺点（可能出现的问题即解决方法）

Lombok

Lombok能以简单的注解形式来简化java代码，从而提高开发人员的开发效率。其本身是一个优秀的Java代码库，它采用了一种投机取巧的语法糖，简化了Java的编码，为Java代码的精简提供了一种方式，但Lombok并非一个标准的Java库。

在web开发过程中经常需要写的Java类，都需要花时间去添加相应的getter/setter、构造器和equals等方法。当属性多时会出现大量的getter/setter方法，这些显得很冗长也没有太多技术含量，一旦修改属性，容易出现忘记修改对应方法的情况。

官方网站：Project Lombok

1. Lombok常用注解

注解	作用
@Data	注解在类上；提供类所有属性的 getting 和 setting 方法，还提供了equals、canEqual、hashCode、toString 方法
@Setter	注解在属性上；为属性提供 setting 方法
@Setter	注解在属性上；为属性提供 getting 方法
@Log4j	注解在类上；为类提供一个 属性名为log 的 log4j 日志对象
@NoArgsConstructor	注解在类上；为类提供一个无参的构造方法
@AllArgsConstructor	注解在类上；为类提供一个全参的构造方法
@Cleanup :	关闭流
@Builder	被注解的类增加构造者模式
@Synchronized	同步锁
@SneakyThrows	捕获异常，类似try/catch 捕获异常
@NonNull	给参数加个这个注解，当参数为null会抛出空指针异常
@Value	注解和@Data类似，默认定义所有成员变量为private final修饰，不生成set方法

2. Lombok注解失效原因

在pom.xml引入Lombok依赖后，还需要安装Lombok插件，重启IDEA才能生效。

整合过程

1. 引入Lombok依赖：

复制如下代码并插入pom.xml当中，等待maven仓库自动下载安装依赖，没有设置自动导包点击手动导入。

        
            org.projectlombok
            lombok
            
            1.18.12
            provided
        

2. 安装Lombok插件

在IDEA中点击File-》Setting-》Plugins-》搜索Lombok安装插件后，重启IDEA;

3. 利用Lombok为属性生成getter/setter等方法程序代码示例

a.未使用Lombok编写实体类（程序肥胖、不好看）

使用IDE自带的快捷键能自动生成getter/setter这些方法：

package com.dvms.entity;

/*
 *文件名: Anglerecord
 *创建者: CJW
 *创建时间:2020/6/6 14:40
 *描述: 记录
 */
public class Record {

    private String time;
    private String device;
    private String state;

    public Record(String time, String device, String state) {
        this.time = time;
        this.device = device;
        this.state = state;
    }

    public Record() {
    }

    public String getTime() {
        return this.time;
    }

    public String getDevice() {
        return this.device;
    }

    public String getState() {
        return this.state;
    }

    public Record setTime(String time) {
        this.time = time;
        return this;
    }

    public Record setDevice(String device) {
        this.device = device;
        return this;
    }

    public Record setState(String state) {
        this.state = state;
        return this;
    }

    public boolean equals(final Object o) {
        if (o == this) return true;
        if (!(o instanceof Record)) return false;
        final Record other = (Record) o;
        if (!other.canEqual((Object) this)) return false;
        final Object this$time = this.getTime();
        final Object other$time = other.getTime();
        if (this$time == null ? other$time != null : !this$time.equals(other$time)) return false;
        final Object this$device = this.getDevice();
        final Object other$device = other.getDevice();
        if (this$device == null ? other$device != null : !this$device.equals(other$device)) return false;
        final Object this$state = this.getState();
        final Object other$state = other.getState();
        if (this$state == null ? other$state != null : !this$state.equals(other$state)) return false;
        return true;
    }

    protected boolean canEqual(final Object other) {
        return other instanceof Record;
    }

    public int hashCode() {
        final int PRIME = 59;
        int result = 1;
        final Object $time = this.getTime();
        result = result * PRIME + ($time == null ? 43 : $time.hashCode());
        final Object $device = this.getDevice();
        result = result * PRIME + ($device == null ? 43 : $device.hashCode());
        final Object $state = this.getState();
        result = result * PRIME + ($state == null ? 43 : $state.hashCode());
        return result;
    }

    public String toString() {
        return "Record(time=" + this.getTime() + ", device=" + this.getDevice() + ", state=" + this.getState() + ")";
    }
}

b.引入Lombok生成方法（程序苗条、看着很舒服）

可自己根据需求手动增添注解，也可以通过右键-》Refactor-》Lomok-》

package com.dvms.entity;

/*
 *文件名: Anglerecord
 *创建者: CJW
 *创建时间:2020/6/6 14:40
 *描述: 记录
 */

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;
import lombok.experimental.Accessors;

@Data
@ToString
@AllArgsConstructor
@NoArgsConstructor
@Accessors(chain = true) //链式调用
public class Record {

    private String time;
    private String device;
    private String state;
}

优点与缺点（可能出现的问题即解决方法）

优点：
Lombok能通过注解的方式，在编译时自动为属性生成getter/setter、equals和toString等方法，省去了手动重建这些代码的麻烦，使程序实体类（entity/pojo）代码看起来更‘苗条’、更有逼格。

缺点（可能出现的问题）：
如果是个人开发，可能出现如下问题：

1.Lombok目前支持JDK1.8，升级JDK版本后可能失效，解决方法：
a.通过IDE自带的快捷键Alt+Insert生成getter/setter，equals，hashCode，toString以及构造器等方法；

b.使用DeLombok工具生成上述这些方法，在最新版本中已包含DeLombok。右键选择Refactored->DeLombok：

或者使用一个命令：

java -jar lombok.jar delombok src -d src-delomboked

把 Lombok 注解实现的类文件转换为不使用 Lombok 的 Java 源文件。

2.Lombok隐藏了JavaBean封装的细节，程序看着简洁但是可读性差。此外尽量不要使用使用这个注解@AllArgsConstructor，该注解提供一个巨型构造器，使外界有机会在初始化对象时修改类中所有的属性是非常不安全的，毕竟Java类中对象的某些属性不应被修改。同时，如果某个Java类中有好多个属性，那么Lombok会注入好多个参数的构造器到Java类中，而构造器参数的顺序完全由Lombok所控制。

3.使用Lombok来编写Javabean代码后，其余依赖此javabean的其他代码都需要引入Lombok依赖，代码耦合度上升。同时，还需要在IDE中安装Lombok的插件。

4.如果是协同开发，则需要注意如下问题：
当我们的程序代码中引入了Lombok插件，其他人也必须去下载、引入Lombok插件，否则Java代码可能无法正常运行。

到此这篇关于SpringBoot整合Lombok及常见问题解决的文章就介绍到这了,更多相关SpringBoot整合Lombok内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！