spring boot jackson配置

忘是亡心i 2022-12-09 05:20 204阅读 0赞

项目中使用的json是jackson。这个呢是spring boot自带的，一开始是用阿里的fastjson的。但是 总是有漏洞。还是用jackson，谷歌的gson也感觉非常棒。

## 需求 ##

在controller 使用`@RestController` 返回json。使用的是 jackson。在处理`BigDecimal`的时候，**想去掉 小数点后面的 00**，**例如 280.00**.

## 全局配置 ##

这种需求 肯定是全局配置一下了。看了一下文档，配置一下，感觉还可以 写一下吧。

import com.fasterxml.jackson.annotation.JsonInclude;
    import com.fasterxml.jackson.core.JsonGenerator;
    import com.fasterxml.jackson.core.JsonParser;
    import com.fasterxml.jackson.core.json.JsonReadFeature;
    import com.fasterxml.jackson.databind.DeserializationFeature;
    import com.fasterxml.jackson.databind.JsonSerializer;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import com.fasterxml.jackson.databind.SerializerProvider;
    import com.fasterxml.jackson.databind.json.JsonMapper;
    import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
    import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
    import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.Primary;
    
    import java.io.IOException;
    import java.math.BigDecimal;
    import java.text.DecimalFormat;
    import java.time.LocalDateTime;
    import java.time.format.DateTimeFormatter;
    
    
    /** * @Author: plani * 创建时间: 2020/9/22 9:41 */
    @Configuration
    public class JacksonConfig { 
    
        @Bean
        @Primary
        @ConditionalOnMissingBean(ObjectMapper.class)
        public ObjectMapper jacksonObjectMapper()
        { 
            JsonMapper.Builder builder = JsonMapper.builder();
            // 通过该方法对mapper对象进行设置，所有序列化的对象都将按改规则进行系列化
            // Include.Include.ALWAYS 默认
            // Include.NON_DEFAULT 属性为默认值不序列化
            // Include.NON_EMPTY 属性为 空（""） 或者为 NULL 都不序列化，则返回的json是没有这个字段的。这样对移动端会更省流量
            // Include.NON_NULL 属性为NULL 不序列化
            builder.serializationInclusion(JsonInclude.Include.NON_EMPTY);
            //有未知属性 要不要抛异常
            builder.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
            //是否允许JSON字符串包含未转义的控制字符(值小于32的ASCII字符，包括制表符和换行符)的特性。如果feature设置为false，则在遇到这样的字符时抛出异常。
            builder.configure(JsonReadFeature.ALLOW_UNESCAPED_CONTROL_CHARS, true);
            //确定解析器是否允许使用单引号(撇号，字符'\ ")引用字符串(名称和字符串值)的特性。如果是，这是除了其他可接受的标记。但不是JSON规范)。
            builder.configure(JsonParser.Feature.ALLOW_SINGLE_QUOTES, true);
            JsonMapper jsonMapper = builder.build();
            JavaTimeModule javaTimeModule = new JavaTimeModule();
            //添加 序列器 这里是对 BigDecimal 类型处理，这是关键代码
            javaTimeModule.addSerializer(BigDecimal.class, new JsonSerializer<BigDecimal>() { 
                @Override
                public void serialize(BigDecimal value, JsonGenerator gen, SerializerProvider serializers) throws IOException { 
                    DecimalFormat fnum = new DecimalFormat("#.##");
                    //把 这个BigDecimal 属性对应的值，写成 String 类型
                    gen.writeString(fnum.format(value));
                }
            });
            //处理 时间格式
            javaTimeModule.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
            //注册
            jsonMapper.registerModule(javaTimeModule);
            return jsonMapper;
        }
    }

上面最重要的 就是 **addSerializer** 这个方法，用来处理对应类型的 转化。注释的很清楚，看不懂的可以留言问我。

## 额外 ##

网上有好多上面是`ObjectMapper` 这个进行设置，这个呢里面有不少是 **标记过时的**。 **所以 我用了JsonMapper**

## 测试 ##

写一个 controller 方法，返回含有`BigDecimal`的类，来测试一下

@PostMapping("test")
        public Map test() { 
            Map<String, Object> map = new HashMap<>();
            BigDecimal bigDecimal = new BigDecimal("280.00");
            map.put("one", bigDecimal);
            return map;
        }

用postman测试一下  
![在这里插入图片描述][20200922111428949.png_pic_center]  
可以看见 280.00 被转成了 280。 好了，研究我的深度学习去了

[20200922111428949.png_pic_center]: /images/20221123/d7cbaf246c734537bb9e652c67a74aea.png