Spring 转换 model 为 json 时增加属性

缘起

目前的项目中有个需求是在附件对象转换成 json 时增加个 url 属性，以前的方式是在返回附件对象或列表时候做一次统一处理，这次想看看 spring 或者 jackson fasterxml 是否自带类似功能，结果一查，还真有。

当前业务系统的处理附件的方式是上传附件之后将其基本信息统一存储到附件表中，然后通过相应的 url 拼接附件 id 的方式来读取相应附件（以便更方便控制授权），也就是说将附件对象返回前端的时候需要将其 url 也放置到 json 中，但是这个 url 属性并不在基本信息中存在。

实现

查了一下，发现 @JsonAppend 完全可以满足这个需要。

而@JsonAppend 在 jackson fasterxml 中是通过 VirtualBeanPropertyWriter 来处理的。

首先构造一个 mixin 接口，在其上配置 @JsonAppend:

@JsonAppend(
    props = {
        @JsonAppend.Prop(name = "url", value = AttachmentUrl.class),
    }
)
public interface AttachmentMixin {
}

之后就是实现 VirtualBeanPropertyWriter 的子类，在这儿可以通过 @Autowired 注入相应的处理方法：

public class AttachmentUrl extends VirtualBeanPropertyWriter {

    private static final long serialVersionUID = 1028128817195205673L;

    @Autowired UrlService urlService;

    public AttachmentUrl() {
    }

    public AttachmentUrl(BeanPropertyDefinition propDef,
        Annotations contextAnnotations,
        JavaType declaredType, UrlService urlService) {
        super(propDef, contextAnnotations, declaredType);

        this.urlService = urlService;
    }

    @Override
    protected Object value(Object bean, JsonGenerator gen, SerializerProvider prov) {

        if (urlService != null) {
            return urlService.getAttachUrl((Attachment) bean);
        }
        return null;
    }

    @Override
    public VirtualBeanPropertyWriter withConfig(MapperConfig<?> config,
        AnnotatedClass declaringClass, BeanPropertyDefinition propDef, JavaType type) {
        return new AttachmentUrl(propDef, null, type, urlService);
    }
}

注意：在 withConfig 方法中会创建新的对象，这个对象 return new AttachmentUrl(propDef, null, type, urlService);，这儿的 urlService不能使用 this.urlService, 因为urlService 是 spring 通过默认构造函数注入的，如果使用 this，则会成为 null。

最后配置 Jackson2ObjectMapperBuilderCustomizer：

@Configuration
public class JacksonConfiguration {

    /**
     * 自定义 {@link Jackson2ObjectMapperBuilder}.
     *
     * @return 略
     */
    @Bean
    public Jackson2ObjectMapperBuilderCustomizer objectMapperBuilderCustomizer() {
        return builder -> builder.mixIn(Attachment.class, AttachmentMixin.class);
    }
}

原理

spring 通过 org.springframework.http.converter.json.SpringHandlerInstantiator 实现对于 jackson fasterxml 的配置，也就是说在此处注入相应的 bean，对于 @JsonAppend 的处理方法为：

@Override
	public VirtualBeanPropertyWriter virtualPropertyWriterInstance(MapperConfig<?> config, Class<?> implClass) {
		return (VirtualBeanPropertyWriter) this.beanFactory.createBean(implClass);
	}

Over