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使用HtmlUnit爬虫工具模拟登陆CSDN案例

    JAVA使用HtmlUnit爬虫工具模拟登陆CSDN案例

    今天小编就为大家分享一篇关于JAVA使用HtmlUnit爬虫工具模拟登陆CSDN案例,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-12-12
  • Nacos集群搭建过程详解

    Nacos集群搭建过程详解

    这篇文章主要为大家介绍了Nacos集群搭建过程详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-05-05
  • Java套接字(Socket)网络编程入门

    Java套接字(Socket)网络编程入门

    这篇文章主要介绍了Java套接字(Socket)网络编程入门,Socket可以理解为是对TCP/IP协议的抽象,需要的朋友可以参考下
    2015-10-10
  • java后端请求兑现request的中文乱码问题解决

    java后端请求兑现request的中文乱码问题解决

    文章主要讲述了在处理处理方案工作中遇到中文乱码问题的解决过程,通过复现和分析乱码问题,发现是由于解码规则和后端服务编码不一致导致的,最终通过修改过滤器中的编码设置解决了问题
    2025-02-02
  • idea创建Spring项目的方法步骤(图文)

    idea创建Spring项目的方法步骤(图文)

    这篇文章主要介绍了idea创建Spring项目的方法步骤(图文),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-01-01
  • Java实现的求解经典罗马数字和阿拉伯数字相互转换问题示例

    Java实现的求解经典罗马数字和阿拉伯数字相互转换问题示例

    这篇文章主要介绍了Java实现的求解经典罗马数字和阿拉伯数字相互转换问题,涉及java输入输出及字符串、数组的遍历与转换相关操作技巧,需要的朋友可以参考下
    2018-04-04
  • Spring Boot集成 Spring Boot Admin 监控

    Spring Boot集成 Spring Boot Admin 监控

    这篇文章主要介绍了Spring Boot集成 Spring Boot Admin 监控,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • Java定义形式及可变参数实例解析

    Java定义形式及可变参数实例解析

    这篇文章主要介绍了Java定义形式及可变参数实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-12-12
  • logback TimeBasedRollingPolicy按天生成日志源码解析

    logback TimeBasedRollingPolicy按天生成日志源码解析

    这篇文章主要为大家介绍了logback TimeBasedRollingPolicy按天生成日志源码解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-11-11
  • Java使用iText生成PDF的步骤和示例

    Java使用iText生成PDF的步骤和示例

    iText 是一个用于创建和处理 PDF 文档的开源 Java 库,iText 主要用于生成 PDF 文件,可以将文本、图像、表格、列表等内容添加到 PDF 中,同时支持对 PDF 进行编辑、合并、分割、加密、数字签名等操作,本文介绍了Java使用iText生成PDF的步骤和示例
    2024-10-10

最新评论