自定义注解

自定义注解@JsonFormat

目前的@JsonFormat只对Date类型的shape进行了特殊处理，支持shape和pattern。我需要对一个double类型的数字进行百分比格式化，所以就得自己写个注解和序列化类了。

首先定义一个number的注解:

package cn.kevin.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * json数字格式化
 * Created by yongkang.zhang on 2017/8/21.
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface JsonNumberFormat {
    String format();
}

再定义一个自定义序列化的类:

package cn.kevin.annotation;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.BeanProperty;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.ser.ContextualSerializer;

import java.io.IOException;
import java.lang.reflect.AnnotatedElement;
import java.text.DecimalFormat;

/**
 * 数字序列化
 * Created by yongkang.zhang on 2017/8/21.
 */
public class NumberSerializer extends JsonSerializer implements ContextualSerializer {

    private final String format;

    public NumberSerializer(String format) {
        this.format = format;
    }

    public NumberSerializer() {
        this.format = null;
    }

    @Override
    public void serialize(Number number, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
        assert this.format != null;
        DecimalFormat format = new DecimalFormat(this.format);
        jsonGenerator.writeString(format.format(number));
    }

    @Override
    public JsonSerializer createContextual(SerializerProvider serializerProvider, BeanProperty beanProperty) throws JsonMappingException {
        // final AnnotatedElement annotated = beanProperty.getMember().getAnnotated(); 这个是用在get方法上注解上的
        return new NumberSerializer(beanProperty.getAnnotation(JsonNumberFormat.class).format());
    }
}

这样我们就能在某个number字段上使用了，具体的形式是:

@JsonNumberFormat(format="##0.00'%'")
@JsonSerialize(using = NumberSerializer.class)
private Double percent;

note:

1. 这种是jackson的注解，所以在序列化的时候必须使用jackson的方式进行序列化