java使用jackson标准化输出文件格式

查拉图斯特拉说

发布于 2023-12-21 08:51:42

1870

发布于 2023-12-21 08:51:42

文章被收录于专栏：后端架构

前言

当设计接口的时候，有时候总是需要去对不同的一些指标数据去进行一个格式化输出。通常可能会写一个实现方法。可能还不太一定能复用。今天这一节主要讲的是一个利用注解的方式。调用它的一些序列化方法对参数的结果。进行一个标准化格式输出，而且代码你还能够复用。非常的简单，方便。

操作步骤

首先，我们需要去实现。一个jason的序列化接口。你需要声明泛型的类型，也就是你需要注入的类型。然后你再实现他自己的一些重写他的方法。对他的方法进行一个逻辑处理到这里，基本上逻辑处理这一步已经完成了，剩下的你只需要加一些异常判断之类的就可以了。

具体逻辑处理代码

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;
import java.math.RoundingMode;

/**
 * 文件大小转化成标准单位输出
 *
 * @author Steven
 * @Date 2022/8/19 10:46
 */
public class FileSizeToStandardStrConverter extends JsonSerializer<Long> {

    private final int GB = 1024 * 1024 * 1024;
    private final int MB = 1024 * 1024;
    private final int KB = 1024;

    private String fileSizeToStandardStr(Long fileSize) {
        if (fileSize >= GB) {
            return getDivide(fileSize, GB).toPlainString() + "G";
        } else if (fileSize >= MB) {
            return getDivide(fileSize, MB).toPlainString() + "M";
        } else if (fileSize >= KB) {
            return getDivide(fileSize, KB).toPlainString() + "K";
        } else {
            return fileSize.toString() + "B";
        }
    }

    private BigDecimal getDivide(Long fileSize, Integer standardSize) {
        return BigDecimal.valueOf(fileSize).divide(BigDecimal.valueOf(standardSize), 1, RoundingMode.HALF_DOWN);
    }

    @Override
    public void serialize(Long value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        if (value != null) {
            gen.writeString(fileSizeToStandardStr(value));
        }
    }
}

使用注解

然后接着你还是需要到某一个返回的实体类里面的属性上面标上jason的序列化注解，然后指定使用某一个类的。累这样在你返回结果的时候，它自动会调用相应的处理类进行一个格式化输出，非常的简单，方便，而且自己非常的简洁，方便了代码的可读性，你可以在任何实体类上面都可以去使用它。他反式电话的时候自动会调用实现。当然他也可以自定义到某个方法上面。

    @ApiModelProperty(value = "文件大小（为空就是不存在，否则就会显示大小加单位）", example = "21M")
    @JsonSerialize(using = FileSizeToStandardStrConverter.class)
    private Long fileSize;

总结

本文介绍了一种通过注解技术统一不同参数结果输出方式、提高代码复用性的设计理念。具体步骤包括创建JSON序列化接口，标记需注入的泛型类型，并实现及重写对应逻辑处理函数。通过为实体类属性添加JSON序列化注解并指定类，系统会自动找到相应处理类进行格式化输出，简化复杂编码，提高代码可读性。更重要的是，这种方法具有灵活性和针对性，用户可以在任何实体类或特定方法中定制相关操作。