? 前兩天遇到一個需求，要求前端顯示金額，百分比等數值類型的時候，需要用千分位分割。而這些數值在后端都是BigDecimal類型。SpirngBoot默認的序列化和反序列化框架是Jackson，所以就想著在Jackson序列化的時候對BigDecimal數據類型做處理。四種方法，三種作用域全局，一種作用于局部：
首先寫序列化和反序列化類：
序列化器：
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import org.springframework.boot.jackson.JsonComponent;
import java.io.IOException;
import java.math.BigDecimal;
@JsonComponent
public class BigDecimalDeSerializer extends JsonDeserializer<BigDecimal> {
@Override
public BigDecimal deserialize(JsonParser jsonParser,
DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
//千分位分隔的數值從前端到后端是需要反序列化為BigDecimal。需要去掉“,”
return new BigDecimal(jsonParser.getText().replaceAll(",",""));
}
}
? 反序列化器
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.ser.ContextualSerializer;
import org.springframework.boot.jackson.JsonComponent;
import java.io.IOException;
import java.math.BigDecimal;
import java.text.DecimalFormat;
import java.util.Objects;
@JsonComponent
public class BigDecimalSerializer extends JsonSerializer<BigDecimal> implements ContextualSerializer {
private String format = "###,##0.00";
@Override
public void serialize(BigDecimal bigDecimal, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
jsonGenerator.writeString(new DecimalFormat(format).format(bigDecimal));
}
@Override
public JsonSerializer<?> createContextual(SerializerProvider serializerProvider, BeanProperty beanProperty) throws JsonMappingException {
if(beanProperty !=null ){
if(Objects.equals(beanProperty.getType().getRawClass(),BigDecimal.class)){
BigDecimalFormat bigDecimalFormat = beanProperty.getAnnotation((BigDecimalFormat.class));
if(bigDecimalFormat == null){
bigDecimalFormat = beanProperty.getContextAnnotation(BigDecimalFormat.class);
}
BigDecimalSerializer bigDecimalSerializer = new BigDecimalSerializer();
if(bigDecimalFormat != null){
bigDecimalSerializer.format = bigDecimalFormat.value();
}
return bigDecimalSerializer;
}
return serializerProvider.findValueSerializer(beanProperty.getType(),beanProperty);
}
return serializerProvider.findNullValueSerializer(beanProperty);
}
}
自定義注解實現（局部實用）：
? 寫一個注解，如下：@BigDecimalFormat，在你需要使用該序列化和反序列化器的時候直接在字段上面注釋即可。這樣只有被注解的字段才會使用自定義的序列化和反序列化器。
import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@JacksonAnnotationsInside
@JsonSerialize(using = BigDecimalSerializer.class)
@JsonDeserialize(using = BigDecimalDeSerializer.class)
public @interface BigDecimalFormat {
String value() default "###,##0.00";
}
用@JsonComponent
? 這是最簡單的方法，直接作用于全局，所有對BigDecima序列化和反序列化的時候都會使用這兩個序列化和反序列類，簡單實用。為了方便，在上面的序列化和反序列化類上直接加上了@JsonComponent。加了@JsonComponent的類會被一個JsonComponentModual加載。
集成SimpleModual
? 在沒有在類上加上@JsonComponent的時候，可以通過下面方式實現。編寫一個SimpleModule的子類，在modual里面加上自定義的序列化器。這個類會被Jackson2ObjectMapperBuilder加載自定義modual的時候加載。
import com.fasterxml.jackson.databind.module.SimpleModule;
import org.springframework.stereotype.Component;
import java.math.BigDecimal;
@Component
public class BigDecimalModual extends SimpleModule {
public BigDecimalModual(){
addSerializer(BigDecimal.class,new BigDecimalSerializer());
addDeserializer(BigDecimal.class,new BigDecimalDeSerializer());
}
}
在Jackson2ObjectMapperBuilder 中添加序列化和反序列化器
下面類定義的@bean方法bigDecimalObjectMapper()，并不是為了構建一個Bean，而是為了將兩個序列化器添加到Jackson2ObjectMapperBuilder中，這樣，其他所有的Jackson2ObjectMapperBuilder構建和配置的modual都會擁有這兩個序列化和反序列器。
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.deser.std.NumberDeserializers;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
import java.math.BigDecimal;
@Configuration
public class JacksonConfig {
@Bean
@Primary //請加上這個注解
public ObjectMapper bigDecimalObjectMapper(Jackson2ObjectMapperBuilder jackson2ObjectMapperBuilder){
jackson2ObjectMapperBuilder.serializerByType(BigDecimal.class,new BigDecimalSerializer());
jackson2ObjectMapperBuilder.deserializerByType(BigDecimal.class,new NumberDeserializers.BigDecimalDeserializer());
return jackson2ObjectMapperBuilder.build();
}
}
SpringBoot官網：
springboot官網有下面一種實現：
If you want to replace the default ObjectMapper completely, either define a @Bean of that type and mark it as @Primary or, if you prefer the builder-based approach, define a Jackson2ObjectMapperBuilder @Bean. Note that, in either case, doing so disables all auto-configuration of the ObjectMapper.
和Jackson2ObjectMapperBuilder實現很像。我的實驗代碼如下：
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.deser.std.NumberDeserializers;
import com.fasterxml.jackson.databind.module.SimpleModule;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
import org.springframework.context.annotation.Primary;
import java.math.BigDecimal;
@Configuration
public class JacksonConfig2 {
@Bean
@Primary
public ObjectMapper bigDecimalObjectMapper(Jackson2ObjectMapperBuilder jackson2ObjectMapperBuilder){
ObjectMapper objectMapper= jackson2ObjectMapperBuilder.build();
SimpleModule simpleModule = new SimpleModule();
simpleModule.addDeserializer(BigDecimal.class,new NumberDeserializers.BigDecimalDeserializer());
simpleModule.addSerializer(BigDecimal.class,new BigDecimalSerializer())
objectMapper.registerModule(simpleModule);
return objectMapper;
}
}
總結
? 在使用自定義注解實現的時候，你可以自定義格式化格式字符串，對一些字段做特殊處理。這個實現可以和其他三個全局實現一起使用，以便對字段做特殊處理。其他三種全局實現任選一種即可。個人推薦@JsonComponent。
?
