@JsonSerialize(using = ToStringSerializer.class)和@JsonSerialize注解的使用方法

朴灿烈づ我的快乐病毒、 2024-03-26 11:45 55阅读 0赞

1.  ### fastjson的ToStringSerializer注解： ###

java中long数据能表示的范围比js中number大，在跟前端交互时，这样也就意味着部分数值在js中存不下(变成不准确的值)。

解决办法可以这样：

使用fastjson的ToStringSerializer注解，让系统序列化时，保留相关精度。

/**
     * 记录属性的主键
     */
    @JsonSerialize(using = ToStringSerializer.class)
    private Long id;

> **场景**： id为long，传到后台就变了值 。  
> 测试一下，这个要是只有几位数的情况下，其实都不需要这个注解，大于某个值，19位数的时候就会出问题，导致精度丢失；  
> 解决办法：在实体类上面添加这个注解就可以了。  
> **原因**：使用fastjson的ToStringSerializer注解，让系统序列化时，保留相关精度。  
> ToStringSerializer是一个类，还有一个与它类似的是  
> @JsonSerialize(using = LongToStringUtil.class) 和前端交互时，值比number数值更大，会导致精度缺失，使用JsonSerialize注解，可以帮助我们解决该问题。  
> 在using = LongToStringUtil.class，可以使用我们自定义的类，来将我们传入的值转换为String类型，来传入到前端，可以解决精度问题，定义的LongToStringUtil类需要继承自JsonSerializer类。

1.  ### @JsonSerialize注解自定义class的使用方法： ###

关于这个注解的方法，可以自己定义class，作为using的值来使用。

/** 
    * 订单创建时间 
    */
    @JsonSerialize(using = DateToLongSerializer.class)
    private Date createTime;

这个的意义就是当转成json时，把时间转成秒的格式。

public class DateToLongSerializer extends JsonSerializer<Date> {
        @Override
        public void serialize(Date date, JsonGenerator jsonGenerator, 
                    SerializerProvider serializerProvider) throws IOException {
            jsonGenerator.writeNumber(date.getTime() / 1000);
        }
    }

1.  ### @JsonSerialize注解处理BigDecimal自定义方法： ###

*  #### BigDecimal 类型的字段，指定保留两位小数（或者更多自定义）: ####

**创建一个注解类，统一帮助我们实现对BigDecimal此类型字段数值的封装操作**

import com.fasterxml.jackson.core.JsonGenerator;
    import com.fasterxml.jackson.databind.JsonSerializer;
    import com.fasterxml.jackson.databind.SerializerProvider;
    import java.io.IOException;
    import java.math.BigDecimal;
     
    public class BigDecimal2Serializer extends JsonSerializer<BigDecimal> {
        // private DecimalFormat df = new DecimalFormat("0.00"); // 为空时也保留2位
        public BigDecimal2Serializer() {
        }
        @Override
        public void serialize(BigDecimal value, JsonGenerator gen, SerializerProvider 
    serializers) throws IOException {
            if (value != null) {
                BigDecimal number = value.setScale(2, BigDecimal.ROUND_HALF_UP);
                gen.writeNumber(number);
                // gen.writeNumber(df.format(number));    // 转换
            } else {
                gen.writeNumber(value);
            }
     
        }
    }

创建完注解类后，具体什么字段需要保留两位有效数字，就在对应的字段上加上此注解

@JsonSerialize(using = BigDecimal2Serializer.class)
    private BigDecimal price;

最后返回的值就是保留两位有效数字的

*  #### 相关方法 ####

**构造器描述**

> BigDecimal(int) 创建一个具有参数所指定整数值的对象。  
> BigDecimal(double) 创建一个具有参数所指定双精度值的对象。  
> BigDecimal(long) 创建一个具有参数所指定长整数值的对象。  
> BigDecimal(String) 创建一个具有参数所指定以字符串表示的数值的对象。

**方法**

> add(BigDecimal) BigDecimal对象中的值相加，然后返回这个对象。  
> subtract(BigDecimal) BigDecimal对象中的值相减，然后返回这个对象。  
> multiply(BigDecimal) BigDecimal对象中的值相乘，然后返回这个对象。  
> divide(BigDecimal) BigDecimal对象中的值相除，然后返回这个对象。  
> toString() 将BigDecimal对象的数值转换成字符串。  
> doubleValue() 将BigDecimal对象中的值以双精度数返回。  
> floatValue() 将BigDecimal对象中的值以单精度数返回。  
> longValue() 将BigDecimal对象中的值以长整数返回。  
> intValue() 将BigDecimal对象中的值以整数返回。

**4舍5入**

> BigDecimal.setScale() 方法用于格式化小数点  
> setScale(1) 表示保留一位小数，默认用四舍五入方式  
> setScale(1,BigDecimal.ROUND\_DOWN) 直接删除多余的小数位，如2.35会变成2.3  
> setScale(1,BigDecimal.ROUND\_UP) 进位处理，2.35变成2.4  
> setScale(1,BigDecimal.ROUND\_HALF\_UP) 四舍五入，2.35变成2.4  
> setScaler(1,BigDecimal.ROUND\_HALF\_DOWN) 四舍五入，2.35变成2.3，如果是5则向下舍  
> setScaler(1,BigDecimal.ROUND\_CEILING) 接近正无穷大的舍入  
> setScaler(1,BigDecimal.ROUND\_FLOOR) 接近负无穷大的舍入，数字>0和ROUND\_UP作用一样，数字<0和ROUND\_DOWN作用一样  
> setScaler(1,BigDecimal.ROUND\_HALF\_EVEN) 向最接近的数字舍入，如果与两个相邻数字的距离相等，则向相邻的偶数舍入。

#### **更多** ####

*  Long数据类型防止精度丢失，添加注解：@JsonFormat(shape = Shape.STRING)

*  BigDecimal数据类型的限制注解使用：@DecimalMin、@DecimalMax、@Digits

@ApiModelProperty(value = "报账总金额")
    @DecimalMin(value = "0", inclusive = false, message = "报账总金额必须大于0")
    @Digits(integer = 10, fraction = 2, message = "报账总金额 最大长度:10，允许精度:2")
    private BigDecimal financeMoney;
    
    @ApiModelProperty(value = "供应商", required = true)
    @NotBlank(message = "供应商不能为空")
    @Len(min = 1, max = 500)
    private String provider;
    
    @ApiModelProperty(value = "价格")
    @NotNull(message = "价格不能为空")
    @Min(value = 100, message = "价格不能低于100")
    @Max(value = 5000, message = "价格不能超过5000")
    @Size(min = 10, max = 50, message = "数量必须不低于10不超过50")
    private Integer price;

#### **@Valid和@Validated区别，**[参考链接][Link 1] ####

![1bbbf35dfdec06899634fb6711eaa073.png][]

--------------------

#### 类型转换： ####

开发中会出现一些对返回数据进行转换的要求，如果直接去修改返回对象代码显得很臃肿，如何由于的进行转换。可以在对象转换成Json的时候进行替换，编写**@JsonSerialize**转换类：

public class MySerializer extends JsonSerializer<Integer> {
        @Override
        public void serialize(Integer status, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException, JsonProcessingException {
            String statusStr = "";
            switch (status) {
                case 0:
                    statusStr = "待审核";
                    break;
                case 1:
                    statusStr = "审核通过";
                    break;
                case 2:
                    statusStr = "审核不通过";
                    break;
                default:
                    statusStr = "状态获取失败";
            }
            jsonGenerator.writeString(statusStr);
        }
    }

在需要转换的字段上面加@JsonSerialize注解：

/**
     * 文字型状态值
     */
    @JsonSerialize(using = MySerializerUtils.class)
    private int status;

--------------------

// String类型字段
    @JsonSerialize(using = StringToArraySerializer.class)
    @JsonProperty(value = "pserial")
    private String pSerial;
    
    
    
    import cn.hutool.json.JSONException;
    import com.alibaba.fastjson.JSONArray;
    import com.baomidou.mybatisplus.core.toolkit.StringUtils;
    import com.fasterxml.jackson.core.JsonGenerator;
    import com.fasterxml.jackson.databind.JsonSerializer;
    import com.fasterxml.jackson.databind.SerializerProvider;
    import lombok.NoArgsConstructor;
    
    import java.io.IOException;
    
    /**
     * 字符串数组转数组
     * '["0","1","2"]' -> ["0","1","2"]
     * @author csp
     * @date 2022/05/8 11:05
     */
    @NoArgsConstructor
    public class StringToArraySerializer extends JsonSerializer<String> {
    
        @Override
        public void serialize(String jsonStr, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
            if (StringUtils.isNotBlank(jsonStr)) {
                try {
                    JSONArray jsonArray = JSONArray.parseArray(jsonStr);
                    String[] strArray = new String[jsonArray.size()];
                    for (int i = 0; i < jsonArray.size(); i++) {
                        strArray[i]=jsonArray.getString(i);
                    }
                    jsonGenerator.writeArray(strArray, 0, strArray.length);
                } catch (JSONException e) {
                    e.printStackTrace();
                }
            }
        }
    }

--------------------

> **【实现方式】**  
> 方式一：通过使用工具类，在请求进入前，或响应前对参数进行处理，然后进行封装，此方法略
> 
> 方式二：使用 @JsonDeserialize 和 @JsonSerialize 注解对在序列化和[反序列化][Link 2]时对参数进行处理  
> 【Pojo 类】
> 
> @JsonDeserialize  
> 是在反序列化时，所以就是对参数进行封装，故到的是 setXxxx() 方法，所以需要将注解添加到对应的 set 方法上，若使用了 Lombok 需要自己定义相应的 set 方法。  
> 需要使用 using 属性指定处理参数的类，该类需要继承 JsonDeserializer 类，并重写 deserialize()。
> 
> @JsonSerialize  
> 是在序列化时，所以需要获取数据，那么需要使用到 getXxxx() 方法，故需要将注解添加到对应的 get 方法上，若使用了 Lombok 需要自己定义相应的 get 方法。  
> 需要使用 using 属性指定处理参数的类，该类需要继承 JsonSerializer 类，并重写 serialize()。

--------------------

如果本篇文章对你有帮助的话，很高兴能够帮助上你。

当然，如果你觉得文章有什么让你觉得不合理、或者有更简单的实现方法又或者有理解不来的地方，希望你在看到之后能够在评论里指出来，我会在看到之后尽快的回复你。

[Link 1]: https://blog.csdn.net/wounler/article/details/125233260?ops_request_misc=%257B%2522request%255Fid%2522%253A%2522167956127316800180671853%2522%252C%2522scm%2522%253A%252220140713.130102334..%2522%257D&request_id=167956127316800180671853&biz_id=0&utm_medium=distribute.pc_search_result.none-task-blog-2~all~baidu_landing_v2~default-2-125233260-null-null.142%5Ev76%5Einsert_down1,201%5Ev4%5Eadd_ask,239%5Ev2%5Einsert_chatgpt&utm_term=%40Validated%20%E5%92%8C%20%40Valid&spm=1018.2226.3001.4187
[1bbbf35dfdec06899634fb6711eaa073.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/b6542e297b8b490692cef87a51b95944.png
[Link 2]: https://so.csdn.net/so/search?q=%E5%8F%8D%E5%BA%8F%E5%88%97%E5%8C%96&spm=1001.2101.3001.7020