Lombok 简介

Lombok项目是一个Java库，它会自动插入编辑器和构建工具中，Lombok提供了一组有用的注释，用来消除Java类中的大量样板代码。仅五个字符(@Data)就可以替换数百行代码从而产生干净，简洁且易于维护的Java类。

Lombok也存在一定风险，在一些开发工具商店中没有Project Lombok支持选择。 IDE和JDK升级存在破裂的风险，并且围绕项目的目标和实施存在争议。

常用注解

@Setter ：注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。

@Getter ：使用方法同上，区别在于生成的是getter方法。

@ToString ：注解在类，添加toString方法。

@EqualsAndHashCode：注解在类，生成hashCode和equals方法。

@NoArgsConstructor：注解在类，生成无参的构造方法。

@RequiredArgsConstructor：注解在类，为类中需要特殊处理的字段生成构造方法，比如final和被@NonNull注解的字段。

@AllArgsConstructor：注解在类，生成包含类中所有字段的构造方法。

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

@Slf4j：注解在类，生成log变量，严格意义来说是常量。

Maven 依赖

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>${lombok.version}</version>
    <scope>provided</scope>
</dependency>

添加 IDE 工具对 Lombok 的支持

首先下载 Lombok 插件

开启编译时注解，使 Lombok 在编译时生效

Lombok 基本使用方法

@NonNull: 可以帮助我们避免空指针

import lombok.NonNull;

// 使用lombok：
public class NonNullExample extends Something {
    private String name;  
    public NonNullExample(@NonNull Person person) {
        super("Hello");
        this.name = person.getName();
    }
}

// 不使用lombok：
public class NonNullExample extends Something {
	private String name;  
	public NonNullExample(@NonNull Person person) {
		super("Hello");
		if (person == null) {
			throw new NullPointerException("person");
		}
		this.name = person.getName();
	}
}

@Cleanup: 自动帮我们调用 close() 方法

import lombok.Cleanup;
import java.io.*;

// 使用lombok：
public class CleanupExample {
    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[10000];
        while (true) {
            int r = in.read(b);
            if (r == -1) break;
            out.write(b, 0, r);
        }
    }
}

// 不使用lombok：
public class CleanupExample {
    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();
            }
        }
    }
}

@Getter / @Setter: 自动生成 Getter/Setter 方法

import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;

// 使用lombok：
public class GetterSetterExample {
    @Getter
    @Setter
    private int age = 10;
    
    @Setter(AccessLevel.PROTECTED)
    private String name;
}

// 不使用lombok：
public class GetterSetterExample {
    private int age = 10;
    private String name;
    
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
    protected void setName(String name) {
        this.name = name;
    }
}