如何配置Jackson fasterxml优先使用@JsonProperty而非@JsonAlias？

背景 #

原本的JSON与Java类映射关系如下：

{ "a": "some-value" }

class Item {
  @JsonProperty("a")
  public String value;
}

现在需要废弃属性a，改用新属性b替代，同时在过渡期内要兼容接收a和b两种属性。一开始用@JsonAlias实现兼容：

class Item {
  @JsonProperty("b")
  @JsonAlias("a")
  public String value;
}

当前正常生效的场景 #

以下几种情况，上述配置都能正常工作：

• 仅存在新属性b：

{ "b": "some-value" }

• 仅存在旧属性a：

{ "a": "some-value" }

• 旧属性a在前，新属性b在后：

{ "a": "this-is-ignored", "b": "uses-this-value" }

遇到的问题 #

Jackson按JSON属性出现的顺序处理赋值，最后出现的属性会覆盖之前的。如果旧属性a出现在新属性b之后，就会错误地使用a的值：

{ "b": "it-should-use-this-value", "a": "but-uses-this-one-instead" }

解决方案 #

要让Jackson始终优先使用主属性b，忽略别名a的覆盖，可以用以下几种方法：

方法1：拆分setter方法（简单直接） #

给主属性和别名分别写setter方法，别名的setter只在主属性未赋值时生效：

class Item {
    private String value;

    @JsonProperty("b")
    public void setValue(String value) {
        // 主属性直接赋值，覆盖任何已有值
        this.value = value;
    }

    @JsonAlias("a")
    public void setValueFromAlias(String value) {
        // 别名仅当value为空时才赋值
        if (this.value == null) {
            this.value = value;
        }
    }

    public String getValue() {
        return value;
    }
}

这种方式不需要额外配置，针对单个属性处理，逻辑清晰。

方法2：自定义反序列化器（精准控制） #

写一个自定义的反序列化器，明确优先读取主属性b，只有当b不存在时才使用a的值：

public class ItemDeserializer extends StdDeserializer<Item> {
    protected ItemDeserializer() {
        super(Item.class);
    }

    @Override
    public Item deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
        JsonNode node = p.getCodec().readTree(p);
        Item item = new Item();
        // 优先读取主属性b
        if (node.has("b")) {
            item.value = node.get("b").asText();
        } else if (node.has("a")) {
            // 主属性不存在时，再读取别名a
            item.value = node.get("a").asText();
        }
        return item;
    }
}

然后在Item类上添加反序列化器注解：

@JsonDeserialize(using = ItemDeserializer.class)
class Item {
    public String value;
}

这种方式完全掌控解析逻辑，适合复杂场景下的精准控制。

方法3：全局配置属性处理优先级（批量处理） #

如果有多个属性需要类似的优先规则，可以自定义PropertyNamingStrategy，全局配置主属性优先：

public class PriorityPropertyNamingStrategy extends PropertyNamingStrategyBase {
    @Override
    public String translate(String propertyName) {
        return propertyName;
    }

    @Override
    public PropertyName nameForSetterMethod(MapperConfig<?> config, AnnotatedMethod method, String defaultName) {
        PropertyName original = super.nameForSetterMethod(config, method, defaultName);
        // 可添加全局逻辑，标记主属性并阻止别名覆盖其值
        return original;
    }
}

配置ObjectMapper时使用这个策略：

ObjectMapper mapper = new ObjectMapper();
mapper.setPropertyNamingStrategy(new PriorityPropertyNamingStrategy());

这种方式适合全局统一处理多个属性的场景。

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