SpringBoot怎么封装统一响应体

发布时间:2021-05-25 13:54:36 作者:小新
来源:亿速云 阅读:442

这篇文章主要介绍了SpringBoot怎么封装统一响应体,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。

一、前言

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

二、添加结果类枚举

在项目目录下面建一个 responseEntity 的 package,然后在里面建一个 ResultEnum 枚举类,添加如下代码:

SpringBoot怎么封装统一响应体

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

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 = "参数错误";

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

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

枚举类内部常用的方法:

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

ResultEnum.OK.getCode()

这边再解释下 @Data@Getter@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 ,不给前端进行返回,看一下响应的结果:

SpringBoot怎么封装统一响应体

然后传递参数:

@PostMapping("validateUser")
public ServerResponse userValidate(@RequestBody @Validated UserDTO userDTO) {
    return ServerResponse.ok(userDTO);
}

看一下响应的结果:

SpringBoot怎么封装统一响应体

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

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

@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());
    }

    // 其他异常处理方法
}

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

SpringBoot怎么封装统一响应体

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

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

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());
    }

    // 其他异常处理方法
}

再来调试一下,这下状态码正常了:

SpringBoot怎么封装统一响应体

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

@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一种全新的编程规范,其设计目的是用来简化新Spring应用的初始搭建以及开发过程,SpringBoot也是一个服务于框架的框架,服务范围是简化配置文件。

感谢你能够认真阅读完这篇文章,希望小编分享的“SpringBoot怎么封装统一响应体”这篇文章对大家有帮助,同时也希望大家多多支持亿速云,关注亿速云行业资讯频道,更多相关知识等着你来学习!

推荐阅读:
  1. java webserver-封装响应协议
  2. SpringBoot 统一异常处理

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

springboot

上一篇:python怎么用terminal输入参数

下一篇:怎么解决.cuda()加载用时很长的问题

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》