纯净、安全、绿色的下载网站

首页|软件分类|下载排行|最新软件|IT学院

当前位置:首页IT学院IT技术

SpringBoot封装统一响应体 浅谈SpringBoot怎样封装统一响应体

天猫精灵998   2021-05-24 我要评论
想了解浅谈SpringBoot怎样封装统一响应体的相关内容吗天猫精灵998在本文为您仔细讲解SpringBoot封装统一响应体的相关知识和一些Code实例欢迎阅读和指正我们先划重点:SpringBoot封装统一响应体,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);
}

相关文章

猜您喜欢

  • 程序员SQL 语句 程序员最实用的 SQL 语句收藏看完这篇就够了

    想了解程序员最实用的 SQL 语句收藏看完这篇就够了的相关内容吗熬过无人问津的日子才会有远方在本文为您仔细讲解程序员SQL 语句的相关知识和一些Code实例欢迎阅读和指正我们先划重点:程序员SQL,语句,程序员实用SQL,语句下面大家一起来学习吧。..
  • python 制作Web可视化页面 python使用Streamlit库制作Web可视化页面

    想了解python使用Streamlit库制作Web可视化页面的相关内容吗法纳斯特在本文为您仔细讲解python 制作Web可视化页面的相关知识和一些Code实例欢迎阅读和指正我们先划重点:python,Web可视化,python,Streamlit,python,可视化页面下面大家一起来学习吧。..

网友评论

Copyright 2020 www.Shellfishsoft.com 【贝软下载站】 版权所有 软件发布

声明:所有软件和文章来自软件开发商或者作者 如有异议 请与本站联系 点此查看联系方式