浅谈SpringBoot如何封装统一响应体

一、前言

在上一篇 springboot 参数校验 中我们对参数校验添加了异常处理，但是还是有不规范的地方，没有用统一响应体进行返回，在这篇文章中介绍如何封装统一响应体。

关于统一响应体的封装，没有一个标准答案，我在各种技术社区看了一遍，汇总了一个复用性比较好的方案。

二、添加结果类枚举

在项目目录下面建一个 responseentity 的 package，然后在里面建一个 resultenum 枚举类，添加如下代码：

这边介绍一下枚举类的用法。枚举类的作用实际上就是定义常量，如果不使用枚举类，通常采用静态常量来表示：

public static final integer ok_code = 200;
public static final string ok_message = "成功";
public static final integer bad_request_code = 400;
public static final string bad_request_message = "参数错误";

这样的话存在一些问题，一是字段表意不明，特别是看别人的代码时，会很懵逼；第二当业务规模增大之后，可能要维护成百上千的静态常量，如果都写在一个文件里面，容易造成命名混淆，阅读也比较麻烦。

然后使用枚举类定义常量就比较方便，相当于一个接口，使用时只需要封装内部的数据类型，并且限定数据域。而且对于不同的枚举变量，可以调用不同的处理方法（实现枚举类的抽象方法可以做到这一点）。关于枚举类的一些知识点汇总如下：

• 使用enum定义的枚举类默认继承了java.lang.enum，实现了java.lang.comparable接口，且不能继承其他类，也不可以被继承。但枚举类可以实现一个或多个接口；
• 枚举类的所有实例必须放在第一行显示，不需使用new，不需显示调用构造方法，每个变量都是public static final修饰的，最终以分号结束。在之后的反编译中，我们就可以理解枚举类其实也是颗语法糖；
• 枚举类的构造方法是私有的，默认的就是 private，所以不用再添加 private；

枚举类内部常用的方法：

• valueof() ：返回当前枚举类的name属性，如果没有，则throw new java.lang.illegalargumentexception()；
• values() ：是编译器自动生成的方法，enum中并没有该方法，返回包括所有枚举变量的数组；
• tostring() 和 name() ：两个方法一样，返回当前枚举类变量的name属性，如果觉得不够用，可以覆盖默认的 tostring ，结合 switch case 来灵活的实现 tostring() 方法；
• ordinal() ：枚举类会给所有的枚举变量一个默认的次序，该次序从0开始，是根据我们定义的次序来排序的。而ordinal()方法就是获取这个次序（或者说下标）；
• compareto() ：比较的是两个枚举变量的次序，返回两个次序相减后的结果；

定义了枚举类之后，在类的上面添加 lombok 的 @getter 注解，给对象的每个属性添加 getter 方法，方便后面获取常量。例如要获取 ok 的状态码，就可以这样写：

resultenum.ok.getcode()

这边再解释下 @data 、@getter 和 @setter 的区别：

• @data：注解在类上；提供类所有属性的 getter 和 setter 方法，此外还提供了equals、canequal、hashcode、tostring 方
• @getter：注解在属性上：为属性提供 getter 方法；注解再类上表示当前类中所有属性都生成getter方法
• @setter：注解在属性上:为属性提供 setter 方法；注解再类上表示当前类中所有属性都生成setter方法

三、添加统一结果类

还是在 responseentity 目录下面，建一个 serverresponse 类，添加如下代码：

@data
public class serverresponse {
	private boolean success;
    private integer code;
    private string message;
    private object data;

	// 构造方法设为私有
    private serverresponse() {}

	public static serverresponse ok(object params) {
        serverresponse serverresponse = new serverresponse();
        serverresponse.setsuccess(resultenum.ok.getsuccess());
        serverresponse.setcode(resultenum.ok.getcode());
        serverresponse.setmessage(resultenum.ok.getmessage()); // 成功展示默认提示信息
        serverresponse.setdata(params); // 返回传入的参数
        return serverresponse;
    }

	public static serverresponse badrequest(@nullable string message) {
        serverresponse serverresponse = new serverresponse();
        serverresponse.setsuccess(resultenum.bad_request.getsuccess());
        serverresponse.setcode(resultenum.bad_request.getcode());
        serverresponse.setmessage(message != null ? message : resultenum.bad_request.getmessage()); // 校验失败传入指定的提示信息
        serverresponse.setdata(null); // 校验失败不返回参数
        return serverresponse;
    }
}

在上面的代码中，成员变量和构造方法都是私有的，只有静态方法向外暴露。然后处理成功的方法，message 展示默认提示信息，即定义在枚举类里面的常量，data 是需要传给前端的 json 参数；处理参数错误的方法，message 展示传进去的错误信息，如果传的是 null ，则展示默认提示信息，即定义在枚举类里面的常量，data 是传给前端的参数，但是在参数错误的情况下就不需要传了，因此是 null 。

这边有一个问题，暂时不清楚 java 是否支持函数参数可选，本人测试发现定义函数的时候有参数，但是调用的时候不传，ide 会给错误提示，因此这里通过传 null 来解决

四、控制层返回

在定义了统一结果类之后，就可以在接口中使用了。还是用之前那个方法，通过 post 请求获取用户信息，再原封不动返回过去：

@postmapping("validateuser")
public serverresponse uservalidate(@requestbody @validated userdto userdto) {
    return serverresponse.ok(null);
}

这边先给参数传 null ，不给前端进行返回，看一下响应的结果：

然后传递参数：

@postmapping("validateuser")
public serverresponse uservalidate(@requestbody @validated userdto userdto) {
    return serverresponse.ok(userdto);
}

看一下响应的结果：

五、异常处理类使用统一响应体

然后我们给异常处理的方法也添加统一响应体：

@restcontrolleradvice
public class globalexceptionhandler {
    @exceptionhandler(value = methodargumentnotvalidexception.class)
    public serverresponse handlemethodargumentnotvalidexception(methodargumentnotvalidexception e) {
        // 注意传进去的表达式有可能是 null
        // 因此在 serverresponse 对 message 是否为 null 进行了判断
        // 如果是 null 就展示默认的提示内容
        return serverresponse.badrequest(objects.requirenonnull(e.getbindingresult().getfielderror()).getdefaultmessage());
    }

    // 其他异常处理方法
}

然后我们模拟一下参数异常的情况：

这样看起来是正常了，但是存在一个问题，后端判断参数异常的时候，因为我们捕获了异常，所以返回给前端的状态码还是 200 ，如何让状态码改为 400 呢？在 springboot 中指定 http 状态码主要有三种方式：

• httpservletresponse
• @responsestatus
• responseentity

这边使用第三种方式，具体的用法看一下代码应该就明白了。我们把刚才统一结果类的方法修改下：

public static responseentity<serverresponse> badrequest(@nullable string message) {
	serverresponse serverresponse = new serverresponse();
    serverresponse.setsuccess(resultenum.bad_request.getsuccess());
    serverresponse.setcode(resultenum.bad_request.getcode());
    serverresponse.setmessage(message != null ? message : resultenum.bad_request.getmessage()); // 校验失败传入指定的提示信息
    serverresponse.setdata(null); // 校验失败不返回参数
    return new responseentity<>(serverresponse, httpstatus.bad_request); // 使用 responseentity 对象设置响应状态码
}

可以看到我们用一个 responseentity 对象包裹了我们封装的响应体，然后返回了这个对象。其中第二个参数就是状态码，httpstatus.bad_request 就代表 400 。然后我们还要修改下异常处理类的返回类型：

@restcontrolleradvice
public class globalexceptionhandler {
    @exceptionhandler(value = methodargumentnotvalidexception.class)
    public responseentity<serverresponse> handlemethodargumentnotvalidexception(methodargumentnotvalidexception e) {
        return serverresponse.badrequest(objects.requirenonnull(e.getbindingresult().getfielderror()).getdefaultmessage());
    }

    // 其他异常处理方法
}

再来调试一下，这下状态码正常了：

在统一结果类中所有的方法都根据上面的示例进行修改即可，我这边添加了几个方法，给各位参考下，具体可以根据业务场景进行添加：

@data
public class serverresponse {
    private boolean success;
    private integer code;
    private string message;
    private object data;

    // 构造方法设为私有
    private serverresponse() {}

    /**
     * 200 请求成功
     * @param params 传给前端的参数
     * @return responseentity<serverresponse>
     */
    public static responseentity<serverresponse> ok(object params) {
        serverresponse serverresponse = new serverresponse();
        serverresponse.setsuccess(resultenum.ok.getsuccess());
        serverresponse.setcode(resultenum.ok.getcode());
        serverresponse.setmessage(resultenum.ok.getmessage()); // 成功展示默认提示信息
        serverresponse.setdata(params); // 返回传入的参数
        return new responseentity<>(serverresponse, httpstatus.ok);
    }

    /**
     * 201 创建成功
     * @return responseentity<serverresponse>
     */
    public static responseentity<serverresponse> created() {
        serverresponse serverresponse = new serverresponse();
        serverresponse.setsuccess(resultenum.created.getsuccess());
        serverresponse.setcode(resultenum.created.getcode());
        serverresponse.setmessage(resultenum.created.getmessage());
//        serverresponse.setdata(null);
        return new responseentity<>(serverresponse, httpstatus.created);
    }

    /**
     * 204 请求成功，没有响应体
     * @return responseentity<serverresponse>
     */
    public static responseentity<serverresponse> nocontent() {
        return new responseentity<>(null, httpstatus.no_content);
    }

    /**
     * 400 参数错误
     * @param message 自定义错误信息
     * @return responseentity<serverresponse>
     */
    public static responseentity<serverresponse> badrequest(@nullable string message) {
        serverresponse serverresponse = new serverresponse();
        serverresponse.setsuccess(resultenum.bad_request.getsuccess());
        serverresponse.setcode(resultenum.bad_request.getcode());
        serverresponse.setmessage(message != null ? message : resultenum.bad_request.getmessage()); // 校验失败传入指定的提示信息
//        serverresponse.setdata(null); // 校验失败不返回参数
        return new responseentity<>(serverresponse, httpstatus.bad_request); // 使用 responseentity 对象设置响应状态码
    }
}

此外，@responsestatus 也是一种设置状态码常用的方法，只需要在 controller 方法中加一个注解就可以：

@postmapping("validateuser")
@responsestatus(code=httpstatus.bad_request, reason="参数异常")
public serverresponse uservalidate(@requestbody @validated userdto userdto) {
    return serverresponse.ok(userdto);
}

到此这篇关于浅谈springboot如何封装统一响应体的文章就介绍到这了,更多相关springboot封装统一响应体内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！