Spring Boot 捕捉全局异常 统一返回值的问题

 更新时间:2020年06月17日 16:17:33   作者:CurtainMy  
这篇文章主要介绍了Spring Boot 捕捉全局异常 统一返回值,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

 在前后端分离的情况下,我们经常会定义一个统一的反回数据格式,通常都会包含状态码,返回信息,返回的数据,是否成功等参数。

1、ResultCode

  单独定义了一个ReturnCode枚举类用于存储代码和返回的Message

public enum ResultCode {
 //成功
 SUCCESS(200),
 // 失败
 FAIL(400),
 
 // 未认证(签名错误)
 UNAUTHORIZED(401),
 
 // 接口不存在
 NOT_FOUND(404),
 
 // 服务器内部错误
 INTERNAL_SERVER_ERROR(500);
 public int code;
 ResultCode(int code)
 {
  this.code=code;
 }
}

2、ResponseResult

/*
 统一返回信息
 */
public class ResponseResult<T> {
 public int code; //返回状态码200成功
 
 private String msg; //返回描述信息
 
 private T data; //返回内容体
 
 public ResponseResult<T> setCode(ResultCode retCode) {
  this.code = retCode.code;
  return this;
 }
 
 public int getCode() {
  return code;
 }
 
 public ResponseResult<T> setCode(int code) {
  this.code = code;
  return this;
 }
 
 public String getMsg() {
  return msg;
 }
 
 public ResponseResult<T> setMsg(String msg) {
  this.msg = msg;
  return this;
 }
 
 public T getData() {
  return data;
 }
 
 public ResponseResult<T> setData(T data) {
  this.data = data;
  return this;
 }
 
}

在定义一个统一返回类:

3、Response

public class Response {
 private final static String SUCCESS = "success";
 
 private final static String FAIL = "fail";
 
 public static <T> ResponseResult<T> makeOKRsp() {
  return new ResponseResult<T>().setCode(ResultCode.SUCCESS).setMsg(SUCCESS);
 }
 
 public static <T> ResponseResult<T> makeOKRsp(String message) {
  return new ResponseResult<T>().setCode(ResultCode.SUCCESS).setMsg(message);
 }
 
 public static <T> ResponseResult<T> makeOKRsp(T data) {
  return new ResponseResult<T>().setCode(ResultCode.SUCCESS).setMsg(SUCCESS).setData(data);
 }
 
 public static <T> ResponseResult<T> makeErrRsp(String message) {
  return new ResponseResult<T>().setCode(ResultCode.INTERNAL_SERVER_ERROR).setMsg(message);
 }
 
 public static <T> ResponseResult<T> makeRsp(int code, String msg) {
  return new ResponseResult<T>().setCode(code).setMsg(msg);
 }
 
 public static <T> ResponseResult<T> makeRsp(int code, String msg, T data) {
  return new ResponseResult<T>().setCode(code).setMsg(msg).setData(data);
 }
}

4、新建 IUserService

新建测试用户接口类

package com.example.demo.service;
import com.example.demo.entity.User;
public interface IUserService {
 public User getUserInfo();
}

5、新建 UserServiceImpl

新建测试用户信息服务类

package com.example.demo.service.impl;
import com.example.demo.entity.User;
import com.example.demo.service.UserService;
import org.springframework.stereotype.Service;
 
import java.io.File;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.logging.SimpleFormatter;
 
@Service
public class UserServiceImpl implements IUserService {
 public User getUserInfo(){
  User user = new User();
  user.setName("jack");
  user.setPassword(12341234);
 
  return user;
 }
 
}

6、在controller调用

@Autowired
 UserService service;
 @RequestMapping(value = "/getUserItem",method = RequestMethod.GET)
 public ResponseResult<User> getUserItem(){
  try {
   User user = service.getUserInfo();
   String[] arr= new String[]{"测试"};
   return Response.makeOKRsp(user);
  }catch (Exception e)
  {
   return Response.makeErrRsp("查询用户信息异常");
  }
 }

返回结果:

7、全局异常处理器 

/**
 * 全局异常处理
 */
@RestControllerAdvice
public class GlobalExceptionHandler {
 
 /*============= 请求错误 start ==============================================*/
 
 /**
  * HTTP 请求方式不支持异常
  * HttpRequestMethodNotSupportedException
  * @return {@link ResponseResult}
  */
 @ExceptionHandler(value = HttpRequestMethodNotSupportedException.class)
 public ResponseResult httpRequestMethodNotSupportException(HttpRequestMethodNotSupportedException e, HttpServletRequest request) {
  return Response.makeErrRsp("请求方式不支持异常");
 }
 
 /*============= 请求错误 end ==============================================*/
 
}

 修改一下getUserItem让其抛出自定义查询返回null的异常:

总结

到此这篇关于Spring Boot 捕捉全局异常 统一返回值的文章就介绍到这了,更多相关Spring Boot 捕捉全局异常 内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 详解Java I/O流中的字符流有哪些

    详解Java I/O流中的字符流有哪些

    字节流的功能已经十分强大,几乎可以直接或间接地处理任何类型的输入/输出操作,但它却不能直接操作16位的Unicode字符,这就需要使用字符流,所以在今天的内容中,小编会给大家讲解IO流中的字符流,希望各位能够继续耐心学习
    2023-10-10
  • Java Collection集合iterator方法解析

    Java Collection集合iterator方法解析

    这篇文章主要介绍了Java Collection集合iterator方法解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-01-01
  • java获取版本号及字节码编译版本方法示例

    java获取版本号及字节码编译版本方法示例

    这篇文章主要给大家介绍了关于java获得版本号及字节码编译版本的相关资料,文中通过示例代码介绍的非常详细,对大家学习或使用java具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧。
    2017-10-10
  • spring cloud gateway 如何修改请求路径Path

    spring cloud gateway 如何修改请求路径Path

    这篇文章主要介绍了spring cloud gateway 修改请求路径Path的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • java.util.NoSuchElementException原因及两种解决方法

    java.util.NoSuchElementException原因及两种解决方法

    本文主要介绍了java.util.NoSuchElementException原因及两种解决方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-06-06
  • Spring Cloud 中自定义外部化扩展机制原理及实战记录

    Spring Cloud 中自定义外部化扩展机制原理及实战记录

    这篇文章主要介绍了Spring Cloud 中自定义外部化扩展机制原理及实战,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-02-02
  • Java String.format()的用法

    Java String.format()的用法

    本篇文章主要介绍了JAVA的 String.format()的使用,具有一定的参考价值,有需要的可以了解一下,希望能够给你带来帮助
    2021-11-11
  • 深入浅析springboot中static和templates区别

    深入浅析springboot中static和templates区别

    这篇文章主要介绍了springboot中static和templates区别,本文通过图文实例代码相结合给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-02-02
  • Java中SSM框架实现增删改查功能代码详解

    Java中SSM框架实现增删改查功能代码详解

    这篇文章主要介绍了Java中SSM框架实现增删改查功能代码详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • Java多线程并发与并行和线程与进程案例

    Java多线程并发与并行和线程与进程案例

    这篇文章主要介绍了Java多线程并发与并行和线程与进程案例,文章基于Java的相关资料展开详细的内容介绍,具有一定的参考价价值,需要的小伙伴可以参考一下
    2022-06-06

最新评论