如何让Immutables生成自定义create和of方法以保持向后兼容？

要在Immutables中保留旧版of()/create()方法同时新增适配新字段的版本，可通过以下几种方案实现：

方案一：给新字段设默认值 + 手动维护旧工厂方法 #

如果新字段允许使用默认值，这是最简洁的兼容方式：

1. 用@Value.Default给新增字段提供默认实现，让旧方法无需传递该参数
2. 在抽象类中手动编写旧版of()和create()方法，内部调用框架生成的全参数方法

@Value.Immutable
public abstract class MyClass {
    // 原有字段
    public abstract String getName();
    public abstract int getAge();

    // 新增字段：设置默认值
    @Value.Default
    public String getNewField() {
        return "default_compatible_value";
    }

    // 旧版of方法：兼容原有调用签名
    public static ImmutableMyClass of(String name, int age) {
        // 调用框架生成的全参数of方法，传入默认值
        return ImmutableMyClass.of(name, age, getNewField());
    }

    // 旧版create方法：兼容原有调用签名
    public static ModifiableMyClass create(String name, int age) {
        ModifiableMyClass instance = ModifiableMyClass.create();
        instance.setName(name);
        instance.setAge(age);
        instance.setNewField(getNewField());
        return instance;
    }
}

框架会自动生成包含所有字段的新版of(String name, int age, String newField)方法，同时旧版方法也会被保留供现有用户使用。

方案二：自定义自动生成方法名，避免签名冲突 #

如果新字段是必填项，无法使用默认值，可通过@Value.Style修改框架自动生成的方法名，再手动保留旧方法：

@Value.Immutable
@Value.Style(
    of = "ofWithAll",    // 将全参数of方法改名
    create = "createEmpty" // 将无参create方法改名
)
public abstract class MyClass {
    // 原有字段
    public abstract String getName();
    public abstract int getAge();

    // 新增必填字段
    public abstract String getNewField();

    // 旧版of方法：保留原有签名，给新字段设兼容值
    public static ImmutableMyClass of(String name, int age) {
        return ImmutableMyClass.ofWithAll(name, age, "legacy_compatible_value");
    }

    // 旧版create方法：保留原有签名
    public static ModifiableMyClass create(String name, int age) {
        ModifiableMyClass instance = ModifiableMyClass.createEmpty();
        instance.setName(name);
        instance.setAge(age);
        instance.setNewField("legacy_compatible_value");
        return instance;
    }
}

这种方式下，用户既可以用旧版方法兼容原有逻辑，也可以用改名后的新版方法ofWithAll()/createEmpty()处理包含新字段的场景。

方案三：利用构建器模式兼容可选字段 #

如果新字段是可选的，可结合Optional和构建器实现兼容：

@Value.Immutable
public abstract class MyClass {
    public abstract String getName();
    public abstract int getAge();
    public abstract Optional<String> getNewField();

    // 旧版of方法：兼容原有调用
    public static ImmutableMyClass of(String name, int age) {
        return ImmutableMyClass.builder()
                .name(name)
                .age(age)
                .newField(Optional.empty()) // 或设默认值
                .build();
    }
}

框架会自动生成包含新字段的构建器和全参数方法，旧版方法则通过构建器完成实例创建。

注意事项 #

• 手动添加的静态方法需放在抽象类中，调用生成类时注意前缀（Immutable/Modifiable+抽象类名）
• 若新字段为必填项，旧方法中必须给它设置符合旧业务逻辑的固定值，不能遗漏
• 使用@Value.Default时，默认方法必须是public无参的，框架会自动用该值填充未指定的字段

内容的提问来源于stack exchange，提问作者mcvkr