搭建SpringBoot（二） 自定义返回对象，自定义全局异常

最新推荐文章于 2024-06-19 15:24:57 发布
最新推荐文章于 2024-06-19 15:24:57 发布
阅读量586 收藏
点赞数 1
分类专栏： SpringBoot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/jijilan/article/details/102766654
版权

搭建SpringBoot（二） 自定义返回对象，自定义全局异常

项目源代码GitHub地址

定义返回对象类型

定义枚举类返回信息

需要实现枚举类的get方法

package cn.jijl.mist.common.result;

import lombok.Getter;

/**
 * @Author: liujiebang
 * @Description: 自定义参数枚举
 * @Date: 2018/7/2 16:54
 **/
@Getter
public enum ResultEnum {


    CODE_1(1, "操作成功！"),
    CODE_2(2, "操作失败！"),
    CODE_401(401, "账号或者密码错误！"),
    CODE_403(403, "没有获取授权！"),
    CODE_404(404, "找不到该路径！"),
    CODE_405(405, "请求方式错误！"),
    CODE_406(406, "Not Acceptable"),
    CODE_415(415, "请求参数格式错误！"),
    CODE_500(500, "服务器出错了，请联系后台开发人员！"),
    CODE_9999(9999, "服务器无法处理请求！");

    private Integer code;

    private String msg;

    ResultEnum(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }
}

定义返回对象的格式

返回对象需要序列化，并且实现get set方法 否则返回时会报错
org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver | Resolved [org.springframework.http.converter.HttpMessageNotWritableException: No converter found for return value of type: class cn.jijl.mist.common.result.ResultView]

package cn.jijl.mist.common.result;

import lombok.Data;

import java.io.Serializable;
/**
 * @Author jijl
 * @Description: RrestFul自定义响应类
 * @Date 14:29 2019/10/27
 * @Param 
 * @return 
 **/
@Data
public class ResultView implements Serializable {

    private Integer code;

    private String msg;

    private Object data;

    private long time;

    public static ResultView ok() {
        return new ResultView();
    }

    public static ResultView ok(Object data) {
        return new ResultView(data);
    }

    public static ResultView error(ResultEnum resultEnum) {
        return new ResultView(resultEnum.getCode(), resultEnum.getMsg());
    }

    public static ResultView error(ResultEnum resultEnum, String errMsg) {
        return new ResultView(resultEnum.getCode(), errMsg);
    }

    public static ResultView error(Integer code, String errMsg) {
        return new ResultView(code, errMsg);
    }

    public static ResultView error(String errMsg) {
        return new ResultView(errMsg);
    }

    private ResultView() {
        this.code = ResultEnum.CODE_1.getCode();
        this.msg = ResultEnum.CODE_1.getMsg();
    }

    private ResultView(Object data) {
        this.data = data;
        this.code = ResultEnum.CODE_1.getCode();
        this.msg = ResultEnum.CODE_1.getMsg();
        this.time = System.currentTimeMillis();
    }

    private ResultView(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
        this.time = System.currentTimeMillis();
    }

    private ResultView(String errMsg) {
        this.code = ResultEnum.CODE_2.getCode();
        this.msg = ResultEnum.CODE_2.getMsg() + errMsg;
        this.time = System.currentTimeMillis();
    }
}

测试

package cn.jijl.mist.modules.controller;


import cn.jijl.mist.common.result.ResultView;
import cn.jijl.mist.modules.entity.SysLog;
import cn.jijl.mist.modules.service.ISysLogService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * <p>
 * 系统日志表 前端控制器
 * </p>
 *  * @author jijl
 * @since 2019-10-25
 */
@Slf4j
@RestController
@RequestMapping("/sys-log")
public class SysLogController {
    @Autowired
    private ISysLogService iSysLogService;

    /**
     * @Author jijl
     * @Description: 测试
     * @Date 14:30 2019/10/27
     * @Param [id]
     * @return cn.jijl.mist.common.result.ResultView
     **/
    @GetMapping("/test")
    public ResultView get(String id) {
        SysLog sysLog = iSysLogService.getById(id);
        log.info("测试{}", sysLog);
        return ResultView.ok(sysLog);
    }
}
  • 控制台打印
 Consume Time：7 ms 2019-10-27 14:32:23
 Execute SQL：SELECT logid,errormessage,controller,method,ip,params,url,logtype,ctime,time,operation,username FROM sys_log WHERE logid='66' 

2019-10-27 14:32:23 | INFO  | http-nio-9001-exec-8 | cn.jijl.mist.modules.controller.SysLogController | 测试SysLog(logid=66, logtype=1, username=null, operation=null, method=null, params=null, controller=null, url=null, ip=null, time=null, errormessage=null, ctime=Sat Oct 26 04:16:00 CST 2019)
  • 返回实例
    在这里插入图片描述

自定义全局异常

定义前后区别

  • 定义之前若报错
    在这里插入图片描述
  • 定义之后若报错
    在这里插入图片描述

可以看出返回的json对象与前面定义的格式是一致的有利于前端提示信息，而且避免我们每个controller都去捕获异常定义格式

全局异常定义类创建

package cn.jijl.mist.common.exception;

import cn.jijl.mist.common.result.ResultEnum;
import cn.jijl.mist.common.result.ResultView;
import cn.jijl.mist.common.utils.IdentityUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.web.servlet.error.ErrorController;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @Author jijl
 * @Description: 全局异常定义
 * @Date 14:52 2019/10/27
 * @Param 
 * @return 
 **/
@Slf4j
@RestController
public class ErController implements ErrorController {

    private static final String ERROR_PATH = "/error";

    @RequestMapping(value = ERROR_PATH)
    public ResultView handleError(HttpServletResponse response, HttpServletRequest request) {
        String ip = IdentityUtil.getRemoteHost(request);
        log.info("请求错误:{}", response.getStatus());
        log.info("请求IP是:{}", ip);
        log.info(response.getStatus() + "异常");
        if (response.getStatus() == ResultEnum.CODE_401.getCode()) {
            return ResultView.error(ResultEnum.CODE_401);
        } else if (response.getStatus() == ResultEnum.CODE_403.getCode()) {
            return ResultView.error(ResultEnum.CODE_403);
        } else if (response.getStatus() == ResultEnum.CODE_404.getCode()) {
            return ResultView.error(ResultEnum.CODE_404);
        } else if (response.getStatus() == ResultEnum.CODE_405.getCode()) {
            return ResultView.error(ResultEnum.CODE_405);
        } else if (response.getStatus() == ResultEnum.CODE_406.getCode()) {
            return ResultView.error(ResultEnum.CODE_406);
        } else if (response.getStatus() == ResultEnum.CODE_415.getCode()) {
            return ResultView.error(ResultEnum.CODE_415);
        } else if (response.getStatus() == ResultEnum.CODE_500.getCode()) {
            return ResultView.error(ResultEnum.CODE_500);
        }
        return ResultView.error(ResultEnum.CODE_9999);
    }


    @Override
    public String getErrorPath() {
        return ERROR_PATH;
    }
}

Controller异常捕获类

package cn.jijl.mist.common.exception;


import cn.jijl.mist.common.result.ResultEnum;
import cn.jijl.mist.common.result.ResultView;
import com.alibaba.fastjson.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.TypeMismatchException;
import org.springframework.validation.BindException;
import org.springframework.validation.FieldError;
import org.springframework.web.HttpMediaTypeNotAcceptableException;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.Iterator;
import java.util.Set;


/**
 * @Author: liujiebang
 * @Description: Controller异常捕获类
 * @Date: 2018/7/2 16:51
 **/
@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {

    /**
     * 自定义全局异常
     *
     * @param e
     * @return
     */
    @ExceptionHandler(value = MyException.class)
    @ResponseBody
    public ResultView myExceptionHandler(MyException e) {
        ResultView resultView = ResultView.error(e.getResultEnum(), e.getMessage());
        return errorResponse(resultView);
    }

    /**
     * 授权异常
     *
     * @param e
     * @return
     */
    @ExceptionHandler(value = AuthException.class)
    @ResponseBody
    public ResultView authExceptionHandler(AuthException e) {
        ResultView resultView = ResultView.error(e.getResultEnum(), e.getMessage());
        return resultView;
    }


    /**
     * 获取bindingResult中的错误信息
     *
     * @param e
     * @return
     */
    @ExceptionHandler(value = BindException.class)
    @ResponseBody
    public ResultView bindExceptionHandler(BindException e) {
        FieldError fieldError = e.getFieldError();
        StringBuilder sb = new StringBuilder();
        String errorMsg = fieldError.getDefaultMessage();
        sb.append(ResultEnum.CODE_2.getMsg()).append(errorMsg);
        ResultView resultView = ResultView.error(ResultEnum.CODE_2.getCode(), sb.toString());
        return resultView;
    }


    /**
     * 请求参数类型不匹配
     *
     * @param e
     * @return
     */
    @ExceptionHandler({TypeMismatchException.class})
    @ResponseBody
    public ResultView typeMismatchExceptionHandler(TypeMismatchException e) {
        ResultView resultView = ResultView.error(ResultEnum.CODE_400.getCode(), "参数类型不匹配,参数" + e.getPropertyName() + "类型应该为" + e.getRequiredType());
        return resultView;
    }

    /**
     * 请求参数个数不匹配
     *
     * @param e
     * @return
     */
    @ExceptionHandler(value = MissingServletRequestParameterException.class)
    @ResponseBody
    public ResultView missingServletRequestParameterExceptionHandler(MissingServletRequestParameterException e) {
        ResultView resultView = ResultView.error(ResultEnum.CODE_400.getCode(), "缺少必要参数,参数名称为" + e.getParameterName());
        return resultView;
    }

    /**
     * 请求方式错误
     *
     * @param e
     * @return
     */
    @ExceptionHandler(value = HttpRequestMethodNotSupportedException.class)
    @ResponseBody
    public ResultView httpRequestMethodNotSupportedExceptionHandler(HttpRequestMethodNotSupportedException e) {
        ResultView resultView = ResultView.error(ResultEnum.CODE_405);
        return resultView;
    }

    /**
     * 返回解析错误
     *
     * @param e
     * @return
     */
    @ExceptionHandler({HttpMediaTypeNotAcceptableException.class})
    @ResponseBody
    public ResultView httpMediaTypeNotAcceptabledExceptionHandler(HttpMediaTypeNotAcceptableException e) {
        ResultView resultView = ResultView.error(ResultEnum.CODE_406);
        return resultView;
    }

    /**
     * Violation 参数校验异常
     *
     * @param e
     * @return
     */
    @ResponseBody
    @ExceptionHandler(value = ConstraintViolationException.class)
    public ResultView constraintViolationExceptionHandler(ConstraintViolationException e) {
        Set<ConstraintViolation<?>> constraintViolations = e.getConstraintViolations();
        Iterator<ConstraintViolation<?>> iterator = constraintViolations.iterator();
        StringBuffer sb = new StringBuffer(ResultEnum.CODE_2.getMsg());
        while (iterator.hasNext()) {
            ConstraintViolation<?> cvl = iterator.next();
            sb.append(",");
            sb.append(cvl.getMessageTemplate());
            break;
        }
        ResultView resultView = ResultView.error(ResultEnum.CODE_2.getCode(), sb.toString());
        return resultView;
    }


    /**
     * 默认异常
     *
     * @param e
     * @return
     */
    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public ResultView defaultErrorHandler(Exception e) {
        ResultView resultView = ResultView.error(ResultEnum.CODE_500);
        return resultView;
    }



    /**
     * 集成结果打印
     *
     * @param resultView
     * @return
     */
    private ResultView errorResponse(ResultView resultView) {
        String json = JSONObject.toJSONString(resultView);
        log.error("返回结果 = {}", json);
        return resultView;
    }
}
伋丶
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot：异常处理：自定义全局异常返回页面处理
q736317048的博客
11-29 1757
为什么要配置全局异常？ 比如代码中逻辑有问题、空指针、io等异常、页面就不能获取到数据了 Step1：先演示一下正常返回异常 @RestController @RequestMapping("api/v1/pub/test") public class TestController { @GetMapping("ExTest") //这里的Dto是我自定义的一个返回消息类 大家可以改为void public Dto testExt(){ int i = 1/..
springboot 自定义异常返回数据显示
梦游小草的博客
03-22 1004
背景： 由于在serviceImpl中处理数据业务逻辑时，有较多数据返回异常。通过HashMap或者是自定义dto返回异常给Controller，再处理给用户显示的话，步骤过于麻烦，因此，想着通过自定义ServiceException，用于直接抛出异常，在Controller中直接进行异常处理即可。 实现： ServiceImpl中直接抛出需要返回给用户看的数据，这边try...
Spring Boot的通用返回类Result
热门推荐
StillTogether的博客
08-11 3万+
先构建一个格式确定下来的Result类 public class Result&lt;T&gt; { private Integer code; private String msg; private T data; public Result() { super(); } public Result(Integer code...
springboot项目controller统一返回对象格式以及全局自定义异常
study_study_know的博客
12-23 1193
@ControllerAdvice与@ExceptionHandler捕获自定义异常，以及封装统一返回值
Springboot/Java 统一结果对象返回
最新发布
m0_63522638的博客
06-19 123
【代码】Springboot/Java 统一结果对象返回。
springBoot之自定义异常，返回对象
samHuangLiang的博客
03-13 882
package com.huangliang.test.core; public class MyException extends RuntimeException { private String errorCode; private String msg; public MyException(String message) { super(me...
Spring Boot 自定义返回对象以及统一封装
TaylorSwiftRed的博客
10-26 947
Spring Boot 自定义返回对象和全局封装返回对象
【SpringBoot3】Spring 请求处理流程，自定义返回类型处理（HttpMessageConverter）
不积跬步无以至千里，不积小流无以成江海。一个喜欢学习分享的程序员
02-01 1518
Spring MVC 架构，以下是处理流程： 1、客户端发送请求。 2、DispatcherServlet 接收请求。 3、HandlerMapping 进行映射，找到处理请求的 Controller。 4、Controller 方法处理请求。 5、数据绑定与验证（如果有的话）。 6、返回数据或视图给 DispatcherServlet。 7、ViewResolver 解析视图：如果返回的是视图名。 8、视图渲染，生成最终的响应结果。 9、DispatcherServlet 将最终的响应返回给客户端，请求
SpringBoot请求参数与响应返回值,ResponseEntity＜T＞自定义响应
m0_62652709的博客
11-16 3189
SpringBoot请求参数与响应返回值,ResponseEntity自定义响应
SpringBoot 系列 web 篇之自定义返回 Http Code 的 n 种姿势
程序员高级码农的博客
01-08 1374
虽然 http 的提供了一整套完整、定义明确的状态码，但实际的业务支持中，后端并不总会遵守这套规则，更多的是在返回结果中，加一个 code 字段来自定义业务状态，即便是后端 5xx 了，返回给前端的 http code 依然是 200那么如果我想遵守 http 的规范，不同的 case 返回不同的 http code 在 Spring 中可以做呢?本文将介绍四种设置返回的 HTTP CODE 的方式注解方式。
springboot下全局异常处理和自定义异常以及自定义返回值
诗礼银杏的博客
11-03 4845
1.介绍 全局异常处理，是mvc的一个新特性，避免大量的重复代码 自定义异常 ， 方便使用，抛出自己定义好的异常，配合全局异常处理使用，效果更佳 自定义返回值，类似异常，返回自己定义的返回值 2.全局异常处理重点知识 1. 新建一个类，我起名为ExceptionHandlerAdvice，意思是错误切面 2. 打上注解 @ResponseBody 和...
springboot配置统一异常处理后可以捕获异常信息，无法返回自定义的异常数据
程高伟
08-16 1万+
在使用springboot配置了统一异常处理，也可以捕获到异常信息，但是就是返回的数据还是老样子 关键错误信息： Failed to invoke @ExceptionHandler method: public org.springframework.web.HttpMediaTypeNotAcceptableException: Could not find acceptable...
springBoot(clound)创建统一返回对象（含springBoot创建）
前方的路在刚开始
05-17 1296
前言 你有没有因为，写接口的时候，每次都要创建一个jsonObject，然后每次都要添加一些msg、status这些必做的东西，而烦恼，今天看了别人的R类，有了启发，觉得得写一篇文章，方便以后给前端返回统一的接口。 首先，我们创建一个springBoot项目， 不会的,看我下面的demo 刷新maven完成 创建一个返回类R package com.example.demo.fanxing; import java.io.Serializable; publi..
SpringBoot系列教程之定义接口返回类型的几种方式
band_mmbx的博客
08-18 2324
当指定了 accept 时，并且传参中指定了 mediaType，则以传参为准如， 此时, 返回 json 格式如, 此时， 返回 xml 格式如，此时，此时返回的也是 xml 格式如，此时mediaType不传时 ，因为无法处理text/html类型，所以会出现 406如， 但是mediaType不传，虽然默认优先是 json，此时返回的也是 xml 格式，与请求头希望的保持一致但是若传参与 produce 冲突了，那么就直接 406 异常，不会选择 mediaType 设置的类型如。...
springboot 项目的控制器（controller端）的返回值、自定义注解、自定义异常、异常捕捉处理
w3x3g的博客
10-21 3221
springboot 项目的控制器（controller端）的返回值、自定义注解、自定义异常、异常捕捉处理
springboot的@RestControllerAdvice作用和捕获自定义异常返回自定义结果案例
qq_36138652的博客
03-16 8137
springboot
SpringBoot入门学习笔记-6-统一返回对象封装
Java自学笔记-springBoot微服务
06-19 488
springboot通过定义统一枚举类，统一返回对象，来统一维护状态，规范对外请求格式
Springboot自定义返回格式
learnC_的博客
03-03 1083
在Springboot中自定义返回数据的格式。
springBootjpa中@Query返回自定义对象类型
weixin_48133875的博客
11-23 1102
@Query返回自定义对象类型
关于springboot统一异常处理和自定义断言以及统一返回数据类的封装
weixin_44079262的博客
08-28 1187
作为一个小白Java工程师，我或多或少会对程序代码重构和优化，比较典型的就是我会抗拒老项目接口里的map入参，鬼知道里面是要哪些数据，里面又有哪些数据不可为空，就要一个个去看，代码里用if非空判断以及取值map.get啥啥啥的地方，而且更无语的还是那些老代码都比我岁数还大，都是伴随着项目出生的，所以基本都是common包里的公共方法，不可能轻易重构，改了还不如拉个springboot开源脚手架从0.8做起，做个新项目。...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值