2024年Go最新@JsonProperty注解(3)，2024年最新神级Golang进阶笔记

2401_84910899

于 2024-05-14 03:37:54 发布

阅读量899

点赞数 5

分类专栏：程序员文章标签： go 学习面试

本文链接：https://blog.csdn.net/2401_84910899/article/details/138830306

版权

程序员专栏收录该内容

60 篇文章 0 订阅

订阅专栏

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以添加戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

@JsonProperty源码

JsonProperty的源码是一个注解类，注解类上的几个元注解就不解释了，可以参考文末链接7，该注解的主要作用就是在pojo属性上执行自定义处理器流程。

@Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonProperty {
    String USE_DEFAULT_NAME = "";
    int INDEX_UNKNOWN = -1;
    String value() default "";
    boolean required() default false;
    int index() default -1;
    String defaultValue() default "";
    JsonProperty.Access access() default JsonProperty.Access.AUTO;
    public static enum Access {
        AUTO,
        READ_ONLY,
        WRITE_ONLY,
        READ_WRITE;
        private Access() {
        }
    }
}

那么下面就看一下处理器流程做了一些什么事，找到JacksonAnnotationIntrospector类，

先看在jackson 2.6版本之后找到添加了@JsonProperty注解的pojo属性做了什么事，注意这里是一个过期的旧方法，保留是为了兼容使用老版本jackson的方法（@Deprecated注解）。首先该方法通过反射拿到成员变量，然后再获取注解中的属性值（eg：@JsonProperty(value = “x_axis”)），如果找到则返回value值，否则就返回原成员变量的name。

    /**
     * Since 2.6, we have supported use of {@link JsonProperty} for specifying
     * explicit serialized name
     */
    @Override
    @Deprecated // since 2.8
    public String findEnumValue(Enum<?> value)
    {
        // 11-Jun-2015, tatu: As per [databind#677], need to allow explicit naming.
        //   Unfortunately cannot quite use standard AnnotatedClass here (due to various
        //   reasons, including odd representation JVM uses); has to do for now
        try {
            // We know that values are actually static fields with matching name so:
            Field f = value.getClass().getField(value.name());
            if (f != null) {
                JsonProperty prop = f.getAnnotation(JsonProperty.class);
                if (prop != null) {
                    String n = prop.value();
                    if (n != null && !n.isEmpty()) {
                        return n;
                    }
                }
            }
        } catch (SecurityException e) {
            // 17-Sep-2015, tatu: Anything we could/should do here?
        } catch (NoSuchFieldException e) {
            // 17-Sep-2015, tatu: should not really happen. But... can we do anything?
        }
        return value.name();
    }

下面再看一下jackson2.7之后是怎么做的，首先该方法不是根据成员变量的name获取类的属性，而是直接遍历类中所有的属性，然后用哈希表expl存属性的name和注解中的value映射关系，然后一次性遍历一遍把所有的属性的真实值集合返回出来（如果没有配置@JsonProperty的value则是属性原值，如果配有@JsonProperty的value则返回value值），这么做的好处在于不用一次一次的解析真实属性值而是一起解析真实属性值。

@Override // since 2.7
    public String[] findEnumValues(Class<?> enumType, Enum<?>[] enumValues, String[] names) {
        HashMap<String,String> expl = null;
        for (Field f : ClassUtil.getDeclaredFields(enumType)) {
            if (!f.isEnumConstant()) {
                continue;
            }
            JsonProperty prop = f.getAnnotation(JsonProperty.class);
            if (prop == null) {
                continue;
            }
            String n = prop.value();
            if (n.isEmpty()) {
                continue;
            }
            if (expl == null) {
                expl = new HashMap<String,String>();
            }
            expl.put(f.getName(), n);
        }
        // and then stitch them together if and as necessary
        if (expl != null) {
            for (int i = 0, end = enumValues.length; i < end; ++i) {
                String defName = enumValues[i].name();
                String explValue = expl.get(defName);
                if (explValue != null) {
                    names[i] = explValue;
                }
            }
        }
        return names;
    }

其他属性的解析也基本上如出一辙，代码如下，

    @Override
    public Boolean hasRequiredMarker(AnnotatedMember m)
    {
        JsonProperty ann = _findAnnotation(m, JsonProperty.class);
        if (ann != null) {
            return ann.required();
        }
        return null;
    }

    @Override
    public JsonProperty.Access findPropertyAccess(Annotated m) {
        JsonProperty ann = _findAnnotation(m, JsonProperty.class);
        if (ann != null) {
            return ann.access();
        }
        return null;
    }

    @Override
    public Integer findPropertyIndex(Annotated ann) {
        JsonProperty prop = _findAnnotation(ann, JsonProperty.class);
        if (prop != null) {
          int ix = prop.index();
          if (ix != JsonProperty.INDEX_UNKNOWN) {
               return Integer.valueOf(ix);
          }
        }
        return null;
    }
    
    @Override
    public String findPropertyDefaultValue(Annotated ann) {
        JsonProperty prop = _findAnnotation(ann, JsonProperty.class);
        if (prop == null) {
            return null;
        }
        String str = prop.defaultValue();
        // Since annotations do not allow nulls, need to assume empty means "none"
        return str.isEmpty() ? null : str;
    }

序列化和反序列化配置

另外，序列化和反序列化中会有些常见配置，比如常见的如下，

DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES

在反序列化json字符串成Java对象时，遇到未知属性是否抛出异常信息。

@Slf4j
public class DeserializationFeatureDemo {
    /**
     * 注意上面的实例对象必须要有无参构造函数，否则在反序列化时创建实例对象
     * 会抛出异常com.fasterxml.jackson.databind.exc.InvalidDefinitionException
     */
    @Data
    @Builder
    @AllArgsConstructor
    @NoArgsConstructor
    private static class Person {
        private String name;
        private Long age;
    }

    public static void main(String[] args) {
        String jsonStr = "{\"name\":\"张三\",\"age\":18,\"sex\":\"男\"}";
        System.out.println("serialize java object to json : " + jsonStr);
        Person A = parse(jsonStr, Person.class, false);
        System.out.println("after deserialize to object :" + JSON.toJSONString(A));
        Person B = parse(jsonStr, Person.class, true);
        System.out.println("after deserialize to object :" + JSON.toJSONString(B));
    }

    private static <T> T parse(String json, Class<T> tClass, boolean failOnUnknownProperties) {
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, failOnUnknownProperties);
        T result = null;
        try {
            result = objectMapper.readValue(json, tClass);
        } catch (JsonProcessingException e) {
            log.error("Failed to deserialize JSON content, json value : " + json);
        }
        return result;
    }
}

可以看到输出结果，配置设为true时在反序列化未知属性直接抛出异常信息，

JsonReadFeature.ALLOW_UNESCAPED_CONTROL_CHARS

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以添加戳这里获取

]

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以添加戳这里获取

2401_84910899

关注

5
点赞
踩
19

收藏

觉得还不错? 一键收藏
0
评论
2024年Go最新@JsonProperty注解(3)，2024年最新神级Golang进阶笔记

下面再看一下jackson2.7之后是怎么做的，首先该方法不是根据成员变量的name获取类的属性，而是直接遍历类中所有的属性，然后用哈希表expl存属性的name和注解中的value映射关系，然后一次性遍历一遍把所有的属性的真实值集合返回出来（如果没有配置@JsonProperty的value则是属性原值，如果配有@JsonProperty的value则返回value值），这么做的好处在于不用一次一次的解析真实属性值而是一起解析真实属性值。另外，序列化和反序列化中会有些常见配置，比如常见的如下，
复制链接

扫一扫