SpringBoot结合Lombok整合对象

我们之前介绍MyBatis Plus，AOP实现日志接口以及Swagger-UI等文章中都是使用了Lombok，可能有些人不是很了解Lombok，下面我们来介绍一下Java中的Lombok库。

Lombok介绍

Lombok是一个用于简化Java开发的，他的作用是自动插入编辑器和构建工具。通过注解方式，实现getter、setter、eques以及tostring()等方法。

在Lombok中添加Maven依赖

    
            org.projectlombok
            lombok
            true

IDEA安装Lombok插件

在IDEA中使用，还需要安装Lombok插件，安装如图所示：

在编译时可能出错，如图解决

Lombok常用注解介绍

@Data：提供了java中get、set、equals、hashCode、toString和canEqual方法。
@Setter:在类上生成所有字段的setter方法，如若在字段上进行注解就只生成选定字段的setter。
@Getter：在类上生成所有字段的getter方法，如若在字段上进行注解就只生成选定字段的getter。
@ToString:为类添加上toString方法。
@EqualsAndHashCode:为类生成hashCode和equals方法。
@AllArgsConstructor:为类添加一个构造函数，该构造函数含有所有已声明字段属性参数。可以和final结合等同于@Autowired

@Service
public class MesAdminServiceImpl {
    @Autowired
    private JwtTokenUtil jwtTokenUtil;
    @Autowired
    private PasswordEncoder passwordEncoder;
    @Autowired
    private MesAdminLoginLogMapper loginLogMapper;
    @Autowired
    private MesAdminCacheService adminCacheService;
    @Autowired
    private MesAdminRoleRelationService adminRoleRelationService;
    @Autowired
    private MesRoleMapper roleMapper;
    @Autowired
    private MesResourceMapper resourceMapper;
    }

等同于：

@Service

@AllArgsConstructor
public class MesAdminServiceImpl {
    @Autowired
    private  final  JwtTokenUtil jwtTokenUtil;
    @Autowired
    private final  PasswordEncoder passwordEncoder;
    @Autowired
    private final  MesAdminLoginLogMapper loginLogMapper;
    @Autowired
    private final  MesAdminCacheService adminCacheService;
    @Autowired
    private final  MesAdminRoleRelationService adminRoleRelationService;
    @Autowired
    private final  MesRoleMapper roleMapper;
    @Autowired
    private final  MesResourceMapper resourceMapper;
    }

@NoArgsConstructor：生成无参的构造方法
@Builder：Builder 使用创建者模式又叫建造者模式。简单来说，就是一步步创建一个对象，它对用户屏蔽了里面构建的细节，但却可以精细地控制对象的构造过程。例如：

/**
 * Swagger自定义配置
 * 
 */
@Data
@EqualsAndHashCode(callSuper = false)
@Builder
public class MesSwaggerProperties {
    /**
     * API文档生成基础路径
     */
    private String apiBasePackage;
    /**
     * 是否要启用登录认证
     */
    private boolean enableSecurity;
    /**
     * 文档标题
     */
    private String title;
    /**
     * 文档描述
     */
    private String description;
    /**
     * 文档版本
     */
    private String version;
    /**
     * 文档联系人姓名
     */
    private String contactName;
    /**
     * 文档联系人网址
     */
    private String contactUrl;
    /**
     * 文档联系人邮箱
     */
    private String contactEmail;
}

builder基础使用：

MesSwaggerProperties.builder()

一般示例查看使用Lombok和不使用的区别

使用Lombok：

/**
 * 用户登录参数
 *
 */
@Data
@EqualsAndHashCode(callSuper = false)
public class MyMesAdminLoginParam {
    @NotEmpty
    @ApiModelProperty(value = "用户名",required = true)
    private String username;
    @NotEmpty
    @ApiModelProperty(value = "密码",required = true)
    private String password;
}

不使用Lombok：


/**
 * 用户登录参数
 *
 */

public class MyMesAdminLoginParam {
    @NotEmpty
    @ApiModelProperty(value = "用户名",required = true)
    private String username;
    @NotEmpty
    @ApiModelProperty(value = "密码",required = true)
    private String password;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        MyMesAdminLoginParam that = (MyMesAdminLoginParam) o;
        return username.equals(that.username) &&
                password.equals(that.password);
    }

    @Override
    public int hashCode() {
        return Objects.hash(username, password);
    }

    public MyMesAdminLoginParam(@NotEmpty String username, @NotEmpty String password) {
        this.username = username;
        this.password = password;
    }
}

注:编译源文件，然后反编译class文件,会发现@Data注解在类上，会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，但是final属性，不会为该属性生成setter方法。

Lombok的优缺点

优点:

1.可以通过注解方式，自动生成一些代码，开发效率提高
2.代码整洁度提高，减少一些简单方法
3.便于属性修改

缺点：

1.不支持多种构造函数
2.降低了代码的可读性

总结:

今天主要讲解了我们在Swagger-UI,AOP实现接口日志、MyBatis Plus自动生成代码以及Reids实现缓存等模块中使用到的Lombok。

Github地址：

github地址:https://github.com/bangbangzhou/greemes/tree/master

Lombok在SpringBoot项目的中使用