
java record 的 lombok `@with` 注解默认只生成单字段 with 方法,但可通过链式调用组合多个单字段方法实现多字段更新;无需生成冗余的复合方法,既保持 api 简洁性,又兼顾灵活性与可维护性。
Lombok 的 @With 注解为 record(或普通类)自动生成不可变的 withXxx() 方法,每个方法返回一个新实例并仅修改对应字段。例如:
@Builder
@With
public record DepotRecord(Long id, String x, String y, String z, String a) {}将生成如下方法:
public DepotRecord withId(Long id) { ... }
public DepotRecord withX(String x) { ... }
public DepotRecord withY(String y) { ... }
// 其他字段同理✅ 推荐做法:链式调用(Composition over Generation)
当需要同时更新多个字段(如 id、x、y)时,直接组合已有方法即可:
DepotRecord original = new DepotRecord(1L, "old-x", "old-y", "z", "a");
DepotRecord updated = original.withId(2L).withX("new-x").withY("new-y");该方式语义清晰、类型安全、零额外开销,且天然支持任意字段组合——无需为每种组合(withIdX, withXY, withIdYZ…)生成专属方法,避免代码膨胀与维护负担。
? 如需封装复用,可添加自定义便捷方法
若某组字段更新在业务中高频出现,可手动添加语义化方法(不依赖 Lombok 生成):
public record DepotRecord(Long id, String x, String y, String z, String a) {
// 自定义多字段更新方法(保持不可变性)
public DepotRecord withIdXY(Long id, String x, String y) {
return this.withId(id).withX(x).withY(y);
}
// 或更通用的 builder 风格入口(可选)
public static WithIdStep with() {
return new WithIdStep(null, null, null, null, null);
}
public static class WithIdStep {
private final Long id; private final String x; private final String y; private final String z; private final String a;
WithIdStep(Long id, String x, String y, String z, String a) {
this.id = id; this.x = x; this.y = y; this.z = z; this.a = a;
}
public WithXStep id(Long id) { return new WithXStep(id, null, null, null, null); }
}
// …(略去完整 builder 实现,按需选用)
}⚠️ 注意事项
立即学习“Java免费学习笔记(深入)”;
- @With 生成的方法使用 == 比较原始值(对 Long/String 等包装类型可能误判),如需严格值比较(如 Objects.equals(this.id, id)),应手动重写对应方法;
- 所有 withXxx() 方法均返回新实例,符合函数式编程原则,但需注意频繁调用可能产生临时对象——在性能敏感场景可结合 @Builder(toBuilder = true) 或手动优化;
- 若字段间存在约束(如 x 与 y 必须同时更新),应在自定义方法中加入校验逻辑,而非依赖链式调用。
? 总结
与其追求“生成所有可能的多字段 with 方法”,不如信任开发者组合能力——Lombok 提供的原子化 with 方法正是为组合而生。这体现了“组合优于继承”与“小工具优于大方案”的设计哲学:简洁、正交、可扩展。真正需要的不是更多生成代码,而是更清晰的意图表达与可控的扩展点。










