标签：冗余 not boot throws 方法参数 cep 不同 构建 put
一、Lombok简介
（1）Lombok官网（https://projectlombok.org/）对lombok的介绍
（2）GitHub项目地址：https://github.com/rzwitserloot/lombok
虽然是生硬的翻译，大家也大致可以看到Lombok存在的价值和意义，Lombok主要是可以提高开发效率，让我们这些小码农们工作时可以偷懒，让我们不再编写很多臃肿而定式的代码，虽然现在我们使用IDE工具可以生成很多，但是频繁的生成也会让我们的实体类看起来非常的臃肿。Lombok正是我们这些处于水深火热中的小码农的福音。
二、Lombok存在的意义：
（1）简化冗余的JavaBean代码，使得实体文件很简洁；
（2）便捷的生成比较复杂的代码，例如一个POJO要转化成构建器模式的形式，只需要一个注解。
三、Lombok有哪些注解，他们的作用分别是什么？
a）Lombok的注解概览
b）下面对每个注解进行一一总结，如下：
1、@NotNull
①详细介绍：这个注解可以用在成员方法或者构造方法的参数前面，会自动产生一个关于此参数的非空检查，如果参数为空，则抛出一个空指针异常。
②栗子：
编译前：
//成员方法参数加上@NonNull注解
public String getName(@NonNull Person p) {
return p.getName();
}
编译后：
public String getName(@NonNull Person p) {
if (p == null) {
throw new NullPointerException("person");
}
return p.getName();
}
2、@Cleanup
①、详细介绍：这个注解用在变量前面，可以保证此变量代表的资源会被自动关闭，默认是调用资源的close()方法，如果该资源有其它关闭方法，可使用@Cleanup("methodName")来指定要调用的方法。
②、栗子：
编译前：
public static void main(String[] args) throws IOException {
@Cleanup InputStream in = new FileInputStream(args[0]);
@Cleanup OutputStream out = new FileOutputStream(args[1]);
byte[] b = new byte[1024];
while (true) {
int r = in.read(b);
if (r == -1) break;
out.write(b, 0, r);
}
}
编译后：
public static void main(String[] args) throws IOException {
InputStream in = new FileInputStream(args[0]);
try {
OutputStream out = new FileOutputStream(args[1]);
try {
byte[] b = new byte[10000];
while (true) {
int r = in.read(b);
if (r == -1) break;
out.write(b, 0, r);
}
} finally {
if (out != null) {
out.close();
}
}
} finally {
if (in != null) {
in.close();
}
}
}
3、@Getter/@Setter
①、详细介绍：这一对注解从名字上就很好理解，用在成员变量前面，相当于为成员变量生成对应的get和set方法，同时还可以为生成的方法指定访问修饰符，当然，默认为public。也可以用在类上，表示为该类所有的属性，生成对应的get和set方法。
②、栗子：
编译前：
public class Programmer {
@Getter
@Setter
private String name;
@Setter(AccessLevel.PROTECTED)
private int age;
@Getter(AccessLevel.PUBLIC)
private String language;
}
编译后：
public class Programmer {
private String name;
private int age;
private String language;
public void setName(String name) {
this.name = name;
}
public String getName() {
return name;
}
protected void setAge(int age) {
this.age = age;
}
public String getLanguage() {
return language;
}
}
4、@Getter（lazy=true）
①详细介绍：如果Bean的一个字段的初始化是代价比较高的操作，比如加载大量的数据；同时这个字段并不是必定使用的。那么使用懒加载机制，可以保证节省资源。懒加载机制，是对象初始化时，该字段并不会真正的初始化，而是第一次访问该字段时才进行初始化字段的操作。
5、@ToString/@EqualsAndHashCode
①详细介绍：这两个注解也比较好理解，就是生成toString，equals和hashcode方法，同时后者还会生成一个canEqual方法，用于判断某个对象是否是当前类的实例，生成方法时只会使用类中的非静态和非transient成员变量，这些都比较好理解，就不举例子了。
当然，这两个注解也可以添加限制条件，例如用@ToString(exclude={"param1","param2"})来排除param1和param2两个成员变量，或者用@ToString(of={"param1","param2"})来指定使用param1和param2两个成员变量，@EqualsAndHashCode注解也有同样的用法。
6、@NoArgsConstructor/@RequiredArgsConstructor /@AllArgsConstructor
①、详细介绍：这三个注解都是用在类上的，第一个和第三个都很好理解，就是为该类产生无参的构造方法和包含所有参数的构造方法，第二个注解则使用类中所有带有@NonNull注解的或者带有final修饰的成员变量生成对应的构造方法。当然，和前面几个注解一样，成员变量都是非静态的，另外，如果类中含有final修饰的成员变量，是无法使用@NoArgsConstructor注解的。
三个注解都可以指定生成的构造方法的访问权限，同时，第二个注解还可以用@RequiredArgsConstructor(staticName="methodName")的形式生成一个指定名称的静态方法，返回一个调用相应的构造方法产生的对象。
②、栗子：
编译前：
@RequiredArgsConstructor(staticName = "sunsfan")
@AllArgsConstructor(access = AccessLevel.PROTECTED)
@NoArgsConstructor
public class Shape {
private int x;
@NonNull
private double y;
@NonNull
private String name;
}
编译后：
public class Shape {
private int x;
private double y;
private String name;
public Shape() {
}
protected Shape(int x, double y, String name) {
this.x = x;
this.y = y;
this.name = name;
}
public Shape(double y, String name) {
this.y = y;
this.name = name;
}
public static Shape sunsfan(double y, String name) {
return new Shape(y, name);
}
}
7、@Data/@Value
①、详细介绍：@Data注解综合了@Getter/@Setter，@ToString，@EqualsAndHashCode和@RequiredArgsConstructor注解，其中@RequiredArgsConstructor使用了类中的带有@NonNull注解的或者final修饰的成员变量，它可以使用@Data(staticConstructor="methodName")来生成一个静态方法，返回一个调用相应的构造方法产生的对象。
@Value注解和@Data类似，区别在于它会把所有成员变量默认定义为private final修饰，并且不会生成set方法。
8、@SneakyThrows
①、详细介绍：这个注解用在方法上，可以将方法中的代码用try-catch语句包裹起来，捕获异常并在catch中用Lombok.sneakyThrow(e)把异常抛出，可以使用@SneakyThrows(Exception.class)的形式指定抛出哪种异常。
②、栗子：
编译前：
public class SneakyThrows implements Runnable {
@SneakyThrows(UnsupportedEncodingException.class)
public String utf8ToString(byte[] bytes) {
return new String(bytes, "UTF-8");
}
@SneakyThrows
public void run() {
throw new Throwable();
}
}
编译后：
public class SneakyThrows implements Runnable {
@SneakyThrows(UnsupportedEncodingException.class)
public String utf8ToString(byte[] bytes) {
try {
return new String(bytes, "UTF-8");
} catch(UnsupportedEncodingException uee) {
throw Lombok.sneakyThrow(uee);
}
}
@SneakyThrows
public void run() {
try {
throw new Throwable();
} catch(Throwable t) {
throw Lombok.sneakyThrow(t);
}
}
}
9、@Synchronized
①、详细介绍：这个注解用在类方法或者实例方法上，效果和synchronized关键字相同，区别在于锁对象不同，对于类方法和实例方法，synchronized关键字的锁对象分别是类的class对象和this对象，而@Synchronized的锁对象分别是私有静态final对象LOCK和私有final对象lock，当然，也可以自己指定锁对象。
②、栗子：
编译前：
public class Synchronized {
private final Object readLock = new Object();
@Synchronized
public static void hello() {
System.out.println("world");
}
@Synchronized
public int answerToLife() {
return 42;
}
@Synchronized("readLock")
public void foo() {
System.out.println("bar");
}
}
编译后：
public class Synchronized {
private static final Object $LOCK = new Object[0];
private final Object $lock = new Object[0];
private final Object readLock = new Object();
public static void hello() {
synchronized($LOCK) {
System.out.println("world");
}
}
public int answerToLife() {
synchronized($lock) {
return 42;
}
}
public void foo() {
synchronized(readLock) {
System.out.println("bar");
}
}
}
10、@Log
①、详细介绍：这个注解用在类上，可以省去从日志工厂生成日志对象这一步，直接进行日志记录，具体注解根据日志工具的不同而不同，同时，可以在注解中使用topic来指定生成log对象时的类名。
②日志总结，注解对应的日志代码：
@CommonsLog ==> private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class); @JBossLog ==> private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class); @Log ==> private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName()); @Log4j ==> private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class); @Log4j2 ==> private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class); @Slf4j ==> private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class); @XSlf4j ==> private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);
四、Lombok的实际应用：
a)添加Lombok的maven依赖：
maven依赖：
<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.2</version>
<scope>provided</scope>
</dependency>
b）只需要引入依赖后，就可以直接在开发时使用啦
使用Lombok开发：
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
private String id;
private String username;
private String password;
private Integer age;
private String description;
}
不使用Lombok开发：
package com.shuwen.demo.entity;
public class User {
private String id;
private String username;
private String password;
private Integer age;
private String description;
public User(){}
public User(String id, String username, String password, Integer age, String description) {
this.id = id;
this.username = username;
this.password = password;
this.age = age;
this.description = description;
}
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
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;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
@Override
public String toString() {
return "User{" +
"id=‘" + id + ‘\‘‘ +
", username=‘" + username + ‘\‘‘ +
", password=‘" + password + ‘\‘‘ +
", age=" + age +
", description=‘" + description + ‘\‘‘ +
‘}‘;
}
}
经过这一对比，是不是很心动了呢，但是Lombok自身也有一定的缺陷，也需要注意哦~
五、Lombok的缺陷/易导致的错误
通过官方文档，可以得知，当使用@Data注解时，则有了@EqualsAndHashCode注解，那么就会在此类中存在equals(Object other) 和 hashCode()方法，且不会使用父类的属性，这就导致了可能的问题。
问题：比如，有多个类有相同的部分属性，把它们定义到父类中，恰好id（数据库主键）也在父类中，那么就会存在部分对象在比较时，它们并不相等，却因为lombok自动生成的equals(Object other) 和 hashCode()方法判定为相等，从而导致出错。
六、Lombok的缺陷解决方案
解决方案：
（1）使用@Getter @Setter @ToString代替@Data并且自定义equals(Object other) 和 hashCode()方法，比如有些类只需要判断主键id是否相等即足矣。
（2）或者使用在使用@Data时同时加上@EqualsAndHashCode(callSuper=true)注解
时光匆匆飞逝，望你我皆有所收获。
标签：冗余 not boot throws 方法参数 cep 不同 构建 put
原文地址：https://www.cnblogs.com/l3306/p/10768864.html
