当前位置：首页 > news >正文

Lombok @Builder 注解的进阶玩法：自定义 Getter/Setter 方法全攻略

news 来源：原创 2025/4/29 6:44:50

大家好呀！👋 今天我们来聊聊 Java 开发中超级实用的 Lombok 库，特别是它的 @Builder 注解。很多小伙伴都用过 @Builder 来简化对象的创建，但你们知道吗？当我们需要自定义 getter/setter 方法时，@Builder 也能玩出花样来！🤹‍♀️

一、Lombok @Builder 快速回顾 🏃‍♂️

首先，让我们快速回顾一下 @Builder 的基本用法：

@Builder
public class User {private String name;private int age;private String email;
}

这样就能用链式调用来创建对象啦：

User user = User.builder().name("张三").age(25).email("zhangsan@example.com").build();

超方便的有没有！😍 但有时候，我们需要对字段进行一些特殊处理，这时候就需要自定义 getter/setter 了。

二、为什么需要自定义 Getter/Setter？🤔

想象一下这些场景：

你想在设置年龄时检查是否合法（比如不能为负数）
你想在获取邮箱时自动转为小写
你想对某些字段进行加密/解密处理

这时候，默认的 getter/setter 就不够用了，我们需要自己动手！🛠️

三、自定义 Getter/Setter 的正确姿势 🧘‍♀️

1. 基本方法：手动添加 getter/setter

最简单的方法就是自己写：

@Builder
public class User {private String name;private int age;private String email;// 自定义 getterpublic String getEmail() {return email != null ? email.toLowerCase() : null;}// 自定义 setterpublic void setAge(int age) {if (age < 0) {throw new IllegalArgumentException("年龄不能为负数！");}this.age = age;}
}

但是！这样直接添加 getter/setter 会导致 @Builder 生成的 builder 类忽略你的自定义方法。😱

2. 正确方法：使用 @Getter 和 @Setter

Lombok 提供了更优雅的解决方案：

@Builder
@Getter
@Setter
public class User {private String name;private int age;@Getter(AccessLevel.NONE)  // 不自动生成 getter@Setter(AccessLevel.NONE)  // 不自动生成 setterprivate String email;// 自定义 getterpublic String getEmail() {return email != null ? email.toLowerCase() : null;}// 自定义 setterpublic void setAge(int age) {if (age < 0) {throw new IllegalArgumentException("年龄不能为负数！");}this.age = age;}
}

这样，@Builder 就会使用你自定义的方法啦！🎉

四、更高级的玩法：Builder 自定义方法 🚀

有时候，我们想在 builder 阶段就进行验证或处理：

1. 自定义 builder 方法

@Builder
public class User {private String name;private int age;private String email;// 自定义 builder 类public static class UserBuilder {private int age;public UserBuilder age(int age) {if (age < 0) {throw new IllegalArgumentException("年龄不能为负数！");}this.age = age;return this;}}
}

这样，在 builder 阶段就会进行验证：

// 这会抛出异常
User user = User.builder().name("张三").age(-5)  // 这里会抛异常.email("zhangsan@example.com").build();

2. 使用 @Builder.Default 设置默认值

@Builder
public class User {private String name;@Builder.Defaultprivate int age = 18;  // 默认值private String email;
}

五、实战案例：完整的自定义处理 📝

让我们看一个完整的例子：

@Builder
@Getter
public class SecureUser {private String username;@Setter(AccessLevel.NONE)private String password;// 自定义密码设置方法public void setPassword(String password) {if (password.length() < 8) {throw new IllegalArgumentException("密码至少需要8位！");}this.password = encrypt(password);  // 假设有加密方法}// 自定义 builder 方法public static class SecureUserBuilder {private String password;public SecureUserBuilder password(String password) {if (password.length() < 8) {throw new IllegalArgumentException("密码至少需要8位！");}this.password = encrypt(password);return this;}}// 模拟加密方法private static String encrypt(String input) {return "加密后的:" + input;  // 实际项目中请使用真正的加密算法}
}

使用示例：

// 正确用法
SecureUser user = SecureUser.builder().username("admin").password("12345678")  // 满足长度要求.build();// 错误用法会抛异常
SecureUser invalidUser = SecureUser.builder().username("admin").password("123")  // 这里会抛异常.build();

六、常见问题解答 ❓

Q: 为什么我的自定义 getter/setter 不生效？
A: 可能是因为 Lombok 自动生成了默认方法覆盖了你的自定义方法。记得用 @Getter(AccessLevel.NONE) 和 @Setter(AccessLevel.NONE) 来禁用自动生成。

Q: 可以在 builder 中使用自定义方法吗？
A: 当然可以！就像上面的例子，你可以自定义 builder 类中的方法。

Q: @Builder 和 @Data 一起用会怎样？
A: @Data 包含了 @Getter、@Setter 等功能，可以和 @Builder 一起用，但要注意方法覆盖的问题。

七、总结 🎯

今天我们一起探索了 Lombok @Builder 注解与自定义 getter/setter 方法的完美配合：

使用 @Getter/@Setter 配合 AccessLevel.NONE 来控制自动生成
直接在类中定义自定义 getter/setter 方法
通过自定义 builder 类方法来增强 builder 的功能
使用 @Builder.Default 设置默认值

记住，虽然 Lombok 能帮我们减少样板代码，但遇到特殊需求时，我们完全可以"夺回控制权"！💪

希望这篇文章对你有帮助！如果有任何问题，欢迎在评论区留言讨论~ 😊

Happy coding! 🚀