Lombok 实战教程 - @Builder | 提供 Builder 形式轻松实现对象创建

Lombok 的 @Builder 注解可以帮助我们轻松实现 Builder 模式，从而使对象创建更加灵活和可读。Builder 模式是一种设计模式，通过使用一个辅助对象（即 Builder 对象）一步步构建一个复杂的对象。

@Builder 的基本使用

自动生成 Builder 类

示例：

import lombok.Builder;
import lombok.ToString;

@Builder
@ToString
public class Person {
    private String name;
    private int age;
    private String address;
}

在这个例子中，Lombok 会自动生成 Person 类的一个静态内部类 PersonBuilder，以及一个静态方法 builder()，用于创建 PersonBuilder 实例。

使用 @Builder 后，我们可以使用链式调用的方式来创建 Person 对象：

public class Main {
    public static void main(String[] args) {
        Person person = Person.builder()
                              .name("John Doe")
                              .age(30)
                              .address("123 Main St")
                              .build();
        System.out.println(person);
    }
}

输出结果：

Person(name=John Doe, age=30, address=123 Main St)

@Builder 注解的详细特性

1. 链式调用：生成的 Builder 类允许我们使用链式调用的方式设置各个字段的值。
2. 可选参数：通过 Builder 模式，我们可以选择性地设置某些字段，而不是必须在构造函数中传递所有参数。
3. 可读性：代码更加可读，尤其是在创建复杂对象时。

自定义 Builder

我们可以通过 Lombok 的 @Builder 注解来自定义生成的 Builder 类和方法。

自定义示例

示例：

import lombok.Builder;
import lombok.ToString;

@Builder(builderMethodName = "newBuilder", buildMethodName = "create")
@ToString
public class User {
    private String username;
    private String email;
    private String password;
}

在这个例子中：

• builderMethodName 参数自定义了生成的静态方法的名称为 newBuilder。
• buildMethodName 参数自定义了生成的 Builder 类中的构建方法的名称为 create。

使用自定义 Builder 方法：

public class Main {
    public static void main(String[] args) {
        User user = User.newBuilder()
                        .username("johndoe")
                        .email("john.doe@example.com")
                        .password("securepassword")
                        .create();
        System.out.println(user);
    }
}

与其他 Lombok 注解结合使用

Lombok 的 @Builder 注解可以与其他 Lombok 注解结合使用，例如 @Data、@Value 等。

示例：

import lombok.Builder;
import lombok.Value;

@Value
@Builder
public class Product {
    private String name;
    private double price;
    private String category;
}

在这个例子中，@Value 注解使 Product 类不可变，同时 @Builder 注解生成了 Builder 模式相关的方法。

安装和配置 Lombok

1. 添加 Lombok 依赖：在你的项目中添加 Lombok 依赖（例如使用 Maven 或 Gradle）。

   Maven：

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

   Gradle：

   dependencies {
       compileOnly 'org.projectlombok:lombok:1.18.20'
       annotationProcessor 'org.projectlombok:lombok:1.18.20'
   }
   

2. 在 IDE 中启用 Lombok 支持：

   • IntelliJ IDEA：安装 Lombok 插件，并在设置中启用注解处理。
   • Eclipse：安装 Lombok 插件，并在设置中启用注解处理。

结合实际案例

假设我们有一个订单类，需要使用 Builder 模式来创建对象。

示例：

import lombok.Builder;
import lombok.ToString;

@Builder
@ToString
public class Order {
    private String orderId;
    private String product;
    private int quantity;
    private double price;
}

使用 Builder 模式创建 Order 对象：

public class Main {
    public static void main(String[] args) {
        Order order = Order.builder()
                           .orderId("12345")
                           .product("Laptop")
                           .quantity(2)
                           .price(1500.00)
                           .build();
        System.out.println(order);
    }
}

输出结果：

Order(orderId=12345, product=Laptop, quantity=2, price=1500.0)

通过使用 Lombok 的 @Builder 注解，我们可以大大简化对象创建过程，使代码更加简洁和可读。结合自定义参数和其他 Lombok 注解，可以满足各种复杂的需求。