Lombok介绍和配置

发布时间：2022-12-25 文章分类：编程知识 投稿人：王小丽 字号： 默认 | 大 | 超大 打印

什么是Lombok

Lombok是一个Java库，能自动插入编辑器并构建工具，简化Java开发。

官网: https://www.projectlombok.org/

Lombok的作用

通过 添加注解 的方式，Lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率。

例如开发中经常需要写的javabean，都需要花时间去添加相应的getter/setter，也许还要去写构造器、equals等方法，而且需要维护，当属性多时会出现大量的getter/setter方法，这些显得很冗长也没有太多技术含量，一旦修改属性，就容易出现忘记修改对应方法的失误,使代码看起来更简洁些。

Lombok的配置

使用Lombok 有两个工作要做：

  1. 安装idea的插件

  2. 在项目里面添加 lombok的依赖。

添加maven依赖


<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
	<version>1.18.8</version>
	<scope>provided</scope>
</dependency>

安装插件

使用Lombok还需要插件的配合，使用开发工具为idea. 打开idea的设置，点击Plugins，点击Browse repositories，在弹出的窗口中搜索lombok，然后安装即可

Lombok介绍和配置

解决编译时出错问题

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

Lombok介绍和配置

总结

  1. Lombok: 就是一个工具, 简化java代码开发

  2. Lombok环境

    • 添加坐标

    • 添加插件

Lombok的常用注解

@Data：@Data注解在类上，会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。


@Data
public class User implements Serializable{
	private Integer id;
	private String username;
	private String password;
	private String address;
	private String nickname;
	private String gender;
	private String email;
	private String status;
}

@Getter/@Setter：如果觉得@Data太过残暴不够精细，可以使用@Getter/@Setter注解，此注解在属性上，可以为相应的属性自动生成Getter/Setter方法.


public class User implements Serializable{
	@Setter
	@Getter
	private Integer id;
	private String username;
	private String password;
	private String address;
	private String nickname;
	private String gender;
	private String email;
	private String status;
}

@ToString：类使用@ToString注解，Lombok会生成一个toString()方法，默认情况下，会输出类名、所有属性（会按照属性定义顺序），用逗号来分割。 通过exclude属性指定忽略字段不输出,


@ToString(exclude = {"id"})
public class User implements Serializable{
	private Integer id;
	private String username;
	private String password;
	private String address;
	private String nickname;
	private String gender;
	private String email;
	private String status;
}

@xxxConstructor

@NoArgsConstructor: 无参构造器


@NoArgsConstructor
public class User implements Serializable{
	private Integer id;
	private String username;
	private String password;
	private String address;
	private String nickname;
	private String gender;
	private String email;
	private String status;
}

@AllArgsConstructor: 全参构造器


@AllArgsConstructor
public class User implements Serializable{
	private Integer id;
	private String username;
	private String password;
	private String address;
	private String nickname;
	private String gender;
	private String email;
	private String status;
}

**总结**

优点：

缺点：

标签 , ,