Java插件Lombok的简介以及Lombok的使用

最新推荐文章于 2024-06-04 22:31:35 发布

唐_方

最新推荐文章于 2024-06-04 22:31:35 发布

阅读量594

点赞数

分类专栏： Java插件学习笔记文章标签： Java插件

本文链接：https://blog.csdn.net/qq_39031310/article/details/103183902

版权

Java插件学习笔记专栏收录该内容

1 篇文章 0 订阅

订阅专栏

前言

本文主要介绍的是Java插件Lombok。

Lombok简介

Lombok项目是一个Java库，它会自动插入您的编辑器和构建工具中，为您的Java增光添彩。

Lombok是一款Java开发插件，使得Java开发者通过其定义的一些注解来消除业务工程中冗长和繁琐的代码，尤其对于简单的Java模型对象（POJO）。在开发环境中使用Lombok插件后，Java开发人员可以节省出重复构建，诸如hashCode和equals这样的方法以及各种业务对象模型的accessor和ToString等方法的大量时间。对于这些方法，它能够在编译源代码期间自动帮我们生成这些方法，并没有如反射那样降低程序的性能。官网链接

简而言之：Lombok能以简单的注解形式来简化Java代码，提高开发人员的开发效率。

Lombok使用

使用Lombok需要的开发环境Java+Maven+IDEA或者Eclipse(安装Lombok Plugin)

添加maven依赖

<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.8</version>
    <scope>provided</scope>
</dependency>

安装插件

使用Lombok还需要插件的配合，下面展示的是如何在IDEA中安装Lombok插件

打开idea的设置，点击Plugins，点击Browse repositories，在弹出的窗口中搜索lombok，然后安装即可。

解决编译时出错问题

编译时出错，可能是没有enable注解处理器。Annotation Processors > Enable annotation processing。设置完成之后程序正常运行。

示例

下面举两个例子，看看使用lombok和不适用的区别

创建一个Role类

不使用lombok

public class Role {
    private Integer roleId;
    private String roleName;

    public Integer getRoleId() {
        return roleId;
    }

    public String getRoleName() {
        return roleName;
    }

    public void setRoleId(Integer roleId) {
        this.roleId = roleId;
    }

    public void setRoleName(String roleName) {
        this.roleName = roleName;
    }

    @Override
    public String toString() {
        return "Role{" +
                "roleId=" + roleId +
                ", roleName='" + roleName + '\'' +
                '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        Role role = (Role) o;
        return Objects.equals(roleId, role.roleId) &&
                Objects.equals(roleName, role.roleName);
    }

    @Override
    public int hashCode() {
        return Objects.hash(roleId, roleName);
    }
}

使用Lombok

@Data
public class Role implements Serializable {

    private static final long serialVersionUID = -8054600833969507380L;
    private Integer roleId;
    private String roleName;
}

编译源文件，然后反编译class文件，如下图。说明说明@Data注解在类上，会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。

public class Role
        implements Serializable {

    private static final long serialVersionUID = -8054600833969507380L;
    private Integer roleId;
    private String roleName;

    public void setRoleId(Integer roleId) {
        this.roleId = roleId;
    }

    public void setRoleName(String roleName) {
        this.roleName = roleName;
    }

    public boolean equals(Object o) {
        if (o == this) {
            return true;
        }
        if (!(o instanceof Role)) {
            return false;
        }
        Role other = (Role) o;
        if (!other.canEqual(this)) {
            return false;
        }
        Object this$roleId = getRoleId(), other$roleId = other.getRoleId();
        if ((this$roleId == null) ? (other$roleId != null) : !this$roleId.equals(other$roleId)) {
            return false;
        }
        Object this$roleName = getRoleName(), other$roleName = other.getRoleName();
        return !((this$roleName == null) ? (other$roleName != null)
                : !this$roleName.equals(other$roleName));
    }

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

    public int hashCode() {
        int PRIME = 59;
        result = 1;
        Object $roleId = getRoleId();
        result = result * 59 + (($roleId == null) ? 43 : $roleId.hashCode());
        Object $roleName = getRoleName();
        return result * 59 + (($roleName == null) ? 43 : $roleName.hashCode());
    }

    public String toString() {
        return "Role(roleId=" + getRoleId() + ", roleName=" + getRoleName() + ")";
    }


    public Integer getRoleId() {
        return this.roleId;
    }

    public String getRoleName() {
        return this.roleName;
    }

自动化日志变量

@Slf4j
@RestController
@RequestMapping("/user")
  @GetMapping("/findAllOfPage")
    public Object findAllOfPage(
            @RequestParam(name = "pageNum", required = false, defaultValue = "1") int pageNum,
            @RequestParam(name = "pageSize", required = false, defaultValue = "10") int pageSize) {
        if (log.isInfoEnabled()) {
            log.debug("查询失败");
        }

        return userService.findAll(pageNum, pageSize);
    }

通过反编译可以看到@Slf4h注解生成了log日志变量，无需去声明一个log就可以在类中使用log记录日志。

@RestController
@RequestMapping({"/user"})
public class UserController
{
  private static final Logger log = LoggerFactory.getLogger(UserController.class);

  @GetMapping({"/findAllOfPage"})
  public Object findAllOfPage(@RequestParam(name = "pageNum", required = false, defaultValue = "1") int pageNum, @RequestParam(name = "pageSize", required = false, defaultValue = "10") int pageSize) {
    if (log.isInfoEnabled()) {
      log.debug("��������");
    }
    
    return this.userService.findAll(pageNum, pageSize);
  }

Lombok常用注解

@Setter 注解在类或者字段上，注解在类时为所用字段生成setter方法，注解在字段上时只为该字段生成setter方法。
@Getter 使用方法类同@Setter，区别在于生成的是getter方法。
@ToString 注解在类，添加toString方法
@EqualsAndHashCode 注解在类，生成hashCode和equals方法
@NoArgsConstructor 注解在类，生成无参的构造方法
@RequiredArgsConstructor 注解在类，为类中需要特殊处理的字段生成构造方法，比如final和被@NonNull注解的字段。
@AllArgsConstructor 注解在类，生成包含所有字段的构造方法
@Data 注解在类，生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。
@Slf4 注解在类，生成log变量，严格意义来说是常量。private static final Logger log = LoggerFactory.getLogger(UserController.class)
Val 可以将变量申明是final类型
@Log 可以生成不同类型的log日志对象，实例名都是log方便用于打印日志
@Builder 可以用在类、构造器、方法上，注解提供了一种比较推崇的构建值对象的方式。
@Synchronized 注解类似Java中的Synchronized 关键字，但是可以隐藏同步锁。
@NonNull 注解能够为方法或构造函数的参数提供非空检查
@Cleanup 注解能够自动释放资源

Lombok的自定义注解原理

Lombok这款插件依靠可插件化的Java自定义注解处理API（ JSR 269: Pluggable Annotation Processing API ）来实现在Javac编译阶段你用"Annotation Processor"对自定义的注解进行预处理后生成真正在JVM上面执行的clss文件。原理图如下：

从上面的原理图可以看出Annotation Processing是编译器在解析Java源代码和生成Class文件之间的一个步骤。其中Lombok插件具体的执行流程如下：

从上面的Lombok执行的流程图中可以看出，在JavaC解析成AST抽象语法树之后，Lombok根据自己编写的注解处理器，动态地修改AST，增加新的节点（即Lombok自定义注解所需要生成的代码），最终通过分析生成JVM可执行的字节码Class文件。使用Annotation Processing自定义注解是在编译阶段进行修改，而JDK的反射技术是在运行时动态修改，两者相比，反射虽然更加灵活一些但是带来的性能损耗更加大。

Lombok本质上就是实现了“JSP 269 API”的程序。在使用javac的过程中，它产生作用的具体流程如下：

javac对源代码进行分析，生成了一棵抽象语法树（AST）
运行过程中调用实现了“JSR 269 API”的Lombok程序
Lombok就对第一步骤得到的AST进行处理，找到@Data注解所在类对应的语法树（AST），然后修改该语法树（AST），增加getter和setter方法定义的相应树节点
使用修改后的抽象语法树（AST）生成字节码文件，即给class增加新的节点（代码块）

Lombok的优缺点

优点：

能通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法，提高了一定的开发效率
让代码变得简洁，不用过多的去关注相应的方法
属性做修改时，也简化了维护为这些属性所生成的getter/setter方法等

缺点：

不支持多种参数构造重载
虽然省去了手动创建getter/setter方法的麻烦，但大大降低了源代码的可读性和完整性，降低了阅读源代码的舒适度

唐_方

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
Java插件Lombok的简介以及Lombok的使用

前言本文主要介绍的是Java插件Lombok。Lombok简介Lombok项目是一个Java库，它会自动插入您的编辑器和构建工具中，为您的Java增光添彩。Lombok是一款Java开发插件，使得Java开发者通过其定义的一些注解来消除业务工程中冗长和繁琐的代码，尤其对于简单的Java模型对象（POJO）。在开发环境中使用Lombok插件后，Java开发人员可以节省出重复构建，诸如hashCode和equals这样的方法以及各种业务对象模型的accessor和ToString等方法的大量时间。
复制链接

扫一扫

专栏目录