@JsonProperty和@JSONField注解的區(qū)別解析(最新)

更新時間：2024年04月01日 11:15:17 作者：四問四不知

Jackson是一款優(yōu)秀的JSON解析庫,添加了依賴之后就可以使用對應的注解,讓我們能夠自由的將Java對象和JSON做轉換,這篇文章主要介紹了@JsonProperty和@JSONField注解的區(qū)別,需要的朋友可以參考下

JSON（JavaScript Object Notation）

json是一種常見的數據交換的輕量級數據格式。HTTP協(xié)議傳輸數據可以有多種數據格式，比如下面幾種常見數據傳輸格式，除此之外還有其他的數據交換格式。

數據傳輸類型	編碼類型	示例
表單格式	application/x-www-form-urlencoded	`username=zk&password=123`
JSON（JavaScript Object Notation）	application/json	`{"username": "zk","password": "123"}`
XML（eXtensible Markup Language）	application/xml	`<user><username>zk</username><password>123</password></user>`

Jackson

Jackson是一款優(yōu)秀的JSON解析庫，添加了依賴之后就可以使用對應的注解，讓我們能夠自由的將Java對象和JSON做轉換。

比如Java對象轉JSON

@JsonProperty和@JSONField

為了解決JSON字符串和其實體bean的屬性名匹配不上的問題，@JsonProperty和@JSONField都可以將某一屬性名序列化為另一屬性名。

那么@JsonProperty和@JSONField有什么區(qū)別呢？

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.annotation.JSONField;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.hust.zhang.serializable.JsonUtils;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
public class JsonPropertiesVsJsonField {
    @AllArgsConstructor
    @Data
    @Builder
    static class Properties {
        @JsonProperty(value = "json-properties")
        private String jsonProperties;
        @JSONField(name = "json-field")
        private String jsonField;
    }
    public static void main(String[] args) {
        Properties properties = Properties.builder()
                .jsonProperties("test-properties")
                .jsonField("test-field")
                .build();
        System.out.println(JsonUtils.toJson(properties));
        System.out.println(JSON.toJSONString(properties));
    }
}

輸出結果如下，

{"jsonField":"test-field","json-properties":"test-properties"}
{"json-field":"test-field","jsonProperties":"test-properties"}

可以看到調用JsonUtils.toJson方法時，加了@JsonProperty才與bean實際屬性名匹配。
其中該方法定義如下，ObjectMapper的writeValueAsString方法。

/**
 * Json轉換工具類
 */
@Slf4j
public final class JsonUtils {
    /**
     * 私有無參構造方法 常量類不能實例化，直接引用
     */
    private JsonUtils() {
    }
    private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
    static {
        OBJECT_MAPPER.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        OBJECT_MAPPER.configure(JsonReadFeature.ALLOW_UNESCAPED_CONTROL_CHARS.mappedFeature(), true);
    }
    public static String toJson(Object object) {
        try {
            return OBJECT_MAPPER.writeValueAsString(object);
        } catch (JsonProcessingException e) {
            log.error("Failed to write the object to string" + object.getClass().getName());
            return null;
        }
    }
    public static <T>T parse(String json, Class<T> tClass){
        try {
            return OBJECT_MAPPER.readValue(json,tClass);
        } catch (JsonProcessingException e) {
            log.error("Failed to deserialize JSON content, json value : " + json);
            return null;
        }
    }
}

除此之外還可以看看@JsonAlias注解。