一、概述
Lombok项目是一个Java库,它会自动插入编辑器和构建工具中,Lombok提供了一组有用的注释,用来消除Java类中的大量样板代码。仅五个字符(@Data)就可以替换数百行代码从而产生干净,简洁且易于维护的Java类。
二、常用注解:
@Data: 注解在类,生成setter/getter、equals、canEqual、hashCode、toString方法,如为final属性,则不会为该属性生成setter方法。
@Setter :注解在类或字段,注解在类时为所有字段生成setter方法,注解在字段上时只为该字段生成setter方法。
@Getter :使用方法同上,区别在于生成的是getter方法。
@ToString :注解在类,添加toString方法。
@ToString(exclude={“column1”,“column2”}):排除多个column列所对应的元素
@ToString(of={“column1”,“column2”}):只生成包含多个column列所对应的元素
@EqualsAndHashCode: 注解在类,生成hashCode和equals方法。
@Slf4j: 注解在类,生成log变量,严格意义来说是常量。
@Log4j:在需要打印日志的类中使用,项目中使用log4j日志框架
@Synchronized:注解自动添加到同步机制,生成的代码并不是直接锁方法,而是锁代码块, 作用范围是方法上
@Accessors(chain = true):链式风格,在调用set方法时,返回这个类的实例对象
@NonNull: 可以帮助我们避免空指针。
示例:
使用@NonNull
public NonNullExample(@NonNull Person person) {
super(“Hello”);
this.name = person.getName();
}
不使用@NonNull
public NonNullExample(Person person) {
super(“Hello”);
if (person == null) {
throw new NullPointerException(“person”);
}
this.name = person.getName();
}
@Cleanup: 自动调用close()方法。
示例:@Cleanup InputStream in = new FileInputStream(args[0]);
@NoArgsConstructor:在JavaBean中使用,注解会生成对应的无参构造方法
@AllArgsConstructor:在JavaBean中使用,注解会生成对应的有参构造方法
@RequiredArgsConstructor :生成private构造方法,使用staticName选项生成指定名称的static方法。
@RequiredArgsContructor(staticName = “of”):生成一个静态方法,用于构建本类对象,与@NonNull联用,指定那些属性是本方法参数
@Builder:构建者模式
@Delegate:代理模式
三、依赖
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.10</version>
</dependency>