SpringBoot学习：全局异常处理器

最新推荐文章于 2023-08-25 10:05:21 发布
最新推荐文章于 2023-08-25 10:05:21 发布
阅读量214 收藏
点赞数
分类专栏： SpringBoot学习总结 文章标签： 全局异常 exception 自定义异常 @ExceptionHandler @RestControllerAdvice
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_26869339/article/details/89950152
版权

实际项目开发中，程序往往会发生各式各样的异常情况，特别是身为服务端开发人员的我们，总是不停的编写接口提供给前端调用，分工协作的情况下，避免不了异常的发生，如果直接将错误的信息直接暴露给用户，这样的体验可想而知，如果这接口是给第三方调用，估计别人会暴走。

  • 采用try-catch的方式
    笨方法不推荐使用，增大了代码量，异常过多时，很难管理业务代码和异常的匹配
  • springboot提供解决方案

  1. 自定义异常类

    @Setter
@Getter
@NoArgsConstructor
public class AppointException extends RuntimeException {

    private Integer code;

    public AppointException(Integer code, String message) {
        super(message);
        this.setCode(code);
    }

    public AppointException(ApiConsts api) {
        super(api.getMsg());
        this.setCode(api.getCode());
    }

    /**
     * notFound
     *
     * @return
     */
    public static AppointException notFound() {
        return new AppointException(ApiConsts.NOT_FOUND);
    }

    /**
     * 未知错误
     *
     * @return
     */
    public static AppointException unknown() {
        return new AppointException(ApiConsts.UNKNOWN);
    }

    /**
     * 指定code和message
     *
     * @param code
     * @param message
     * @return
     */
    public static AppointException errorMessage(Integer code, String message) {
        return new AppointException(code, message);
    }

    /**
     * @param api
     * @return
     */
    public static AppointException errorMessage(ApiConsts api) {
        return new AppointException(api.getCode(), api.getMsg());
    }
}

  2. 自定义异常处理器

    import static org.apache.commons.lang3.StringUtils.defaultString;


/**
 * @author: hs
 * @Date: 2019/5/7 17:10
 * @Description: 自定义全局异常处理器。
 */
@RestControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

    @ExceptionHandler(Exception.class)
    public AbstractApiResult globalErrorHandler(Exception e, HttpServletResponse response) {
        logger.error("出错啦...", e);
        if (e instanceof MethodArgumentNotValidException) {
            MethodArgumentNotValidException exec = (MethodArgumentNotValidException) e;
            response.setStatus(HttpStatus.BAD_REQUEST.value());
            return AbstractApiResult.error(response.getStatus(), exec.getMessage());
        }
        if (e instanceof AppointException) {
            AppointException exec = (AppointException) e;
            response.setStatus(exec.getCode());
            return AbstractApiResult.error(exec.getCode(), exec.getMessage());
        }
        if (e instanceof IllegalArgumentException) {
            IllegalArgumentException exec = (IllegalArgumentException) e;
            response.setStatus(HttpStatus.BAD_REQUEST.value());
            return AbstractApiResult.error(response.getStatus(), exec.getMessage());
        }
        if (e instanceof MultipartException) {
            response.setStatus(HttpStatus.BAD_REQUEST.value());
            return AbstractApiResult.error(response.getStatus(), "图片大小不能超过3M");
        }
        response.setStatus(HttpStatus.INTERNAL_SERVER_ERROR.value());
        return AbstractApiResult.error(response.getStatus(), e.getMessage());
    }

    /**
     * 通用的接口映射异常处理方法
     */
    @Override
    protected ResponseEntity<Object> handleExceptionInternal(Exception ex, Object body, HttpHeaders headers,
                                                             HttpStatus status, WebRequest request) {

        logger.error("出错啦..", ex);
        if (ex instanceof MethodArgumentNotValidException) {
            MethodArgumentNotValidException exec = (MethodArgumentNotValidException) ex;
            return new ResponseEntity<>(AbstractApiResult.error(status.value(), exec.getBindingResult().getAllErrors().get(0).getDefaultMessage()), status);
        }
        //参数转化异常
        if (ex instanceof MethodArgumentTypeMismatchException) {
            MethodArgumentTypeMismatchException exec = (MethodArgumentTypeMismatchException) ex;
            logger.error("参数转换失败，方法：" + exec.getParameter().getMethod().getName() + "，参数：" + exec.getName()
                    + ",信息：" + exec.getLocalizedMessage());
            return new ResponseEntity<>(AbstractApiResult.error(ApiConsts.CONVERSION_PARAMS), status);
        }
        //请求类型异常
        if (ex instanceof HttpRequestMethodNotSupportedException) {
            HttpRequestMethodNotSupportedException exec = (HttpRequestMethodNotSupportedException) ex;
            return new ResponseEntity<>(AbstractApiResult.error(status.value(), "错误的请求类型：".concat(exec.getMethod())), status);
        }
        if (ex instanceof BindException) {
            BindException exec = (BindException) ex;
            FieldError fieldError = exec.getFieldError();
            //jsr303验证异常,异常堆栈信息来源于FieldError中的toString方法。
            if (!Objects.equal(fieldError, null)) {
                String field = defaultString(fieldError.getField());
                String message = defaultString(fieldError.getDefaultMessage());
                return new ResponseEntity<>(AbstractApiResult.error(status.value(), field.concat(message)), status);
            }
            return new ResponseEntity<>(AbstractApiResult.error(status.value(), exec.getMessage()), status);
        }
        return new ResponseEntity<>(AbstractApiResult.error(status.value(), ex.getMessage()), status);
    }
}

  3. 响应返回体

    @Data
public abstract class AbstractApiResult {
    /**
     * 状态码
     */
    protected Integer code;

    /**
     * 成功的返回.
     *
     * @param data 数据
     * @return ApiResult 正常返回体
     */
    public static AbstractApiResult success(Object data) {
        return new SuccessApiResult(data);
    }

    /**
     * 错误返回.
     *
     * @param errorCode 错误码
     * @param errorMessage 错误信息
     * @return ApiResult 错误返回体
     */
    public static AbstractApiResult error(Integer errorCode, String errorMessage) {
        return new ErrorApiResult(errorCode, errorMessage);
    }

    /**
     *
     * @param api enum ：包含错误码和错误信息
     * @return
     */
    public static AbstractApiResult error(ApiConsts api) {
        return new ErrorApiResult(api.getCode(), api.getMsg());
    }

}


    @Data
@EqualsAndHashCode(callSuper = true)
public class ErrorApiResult extends AbstractApiResult {
    /**
     * 错误信息
     */
    private String message;

    ErrorApiResult(Integer code, String message) {
        this.code = code;
        this.message = message;
    }
}

    @Data
@EqualsAndHashCode(callSuper = true)
public class SuccessApiResult extends AbstractApiResult {
    /**
     * 响应数据
     */
    private Object data;

    SuccessApiResult(Object data) {
        this.code = 0;
        this.data = data;
    }
}

  4. 辅助与model

    @Getter
@AllArgsConstructor(access = AccessLevel.PRIVATE)
public enum ApiConsts {
    /**
     * client端异常信息返回
     */
    SUCCESS(1, "请求成功"),
    UNKNOWN(-1, "未知错误"),
    NOT_FOUND(404, "not found"),
    PORTABILITY_PARAMS(1001, "携带参数错误"),
    CONVERSION_PARAMS(1002, "参数转换失败"),
    REQUEST_TYPE(405, "错误的请求类型:");

    private final Integer code;
    private final String msg;
}

    @Data
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain = true)
@ApiModel("交易记录详情")
public class RecordDetails {

    @NotBlank
    private String tacheCode;
    @NotBlank
    private String processCode;
    @NotBlank
    private String senceId;
    private String proOrderId;
    private Integer numId;
    private Integer iccId;
    private String imsi;
    private Integer simId;
    @NotNull
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime beginTime;
    @NotNull
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime endTime;
}

  5. 接口验证

    @RestController
@RequestMapping("/conf")
@Api(description = "表格配置")
public class FromHeaderController {

    
    @GetMapping("/from/{serviceCode}")
    @ApiOperation(value = "table配置信息", notes = "接口返回table表格的配置信息")
    @ApiImplicitParam(value = "服务名称", name = "serviceCode", paramType = "path")
    public AbstractApiResult listFromHeaders(@PathVariable(value = "serviceCode") Integer serviceCode) {
        if (Objects.equal(serviceCode,1)) {
            throw AppointException.errorMessage(ApiConsts.PORTABILITY_PARAMS);
        }
       
        return AbstractApiResult.success(serviceCode);
    }
}

    请求http://localhost:9001/conf/from/1，返回结果如下：
    在这里插入图片描述

    @Slf4j
@RestController
@RequestMapping("/details")
@Api(description = "交易记录列表操作")
public class RecordDetailsController {

    private final RecordDetailsService recordDetailsService;

    @Autowired
    public RecordDetailsController(RecordDetailsService recordDetailsService) {
        this.recordDetailsService = recordDetailsService;
    }

    @PostMapping(value = "/recordData", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
    @ApiOperation(value = "查询框选散点图信息")
    public AbstractApiResult listRecordDetails(@Validated @RequestBody RecordDetails recordDetails) {
        log.info("recordDetails:{}",recordDetails);
        List<RecordDetails> recordDetailses = recordDetailsService.listRecordDetails(recordDetails);
        return AbstractApiResult.success(null);
    }
}

    请求http://localhost:9001/details/recordData，返回结果如下：
    在这里插入图片描述

大小鱼鱼鱼与鱼.
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
超实用的SpringBoot中全局异常处理器（供参考）
小方编程的专栏
02-06 577
import com.xxx.exception.CodingCloudException; import com.xxx.exception.ResourceNotFoundException; import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.StringUtils; import org.apache.com...
springboot中全局异常处理器
weixin_30677073的博客
07-25 208
　　Spring Boot 中全局异常处理器，就是把错误异常统一处理的方法。等价于Springmvc中的异常处理器。 步骤一：基于前面的springBoot入门小demo修改 步骤二：修改HelloController类 　　修改HelloController，使得访问/hello一定会产生异常: some exception package cn.xdf.springboot.web...
springboot全局异常处理器
qq_36521848的博客
06-06 1348
通过aop监控程序异常，全局异常捕获 定义全局异常处理器： import java.util.HashMap; import java.util.Map; import org.springframework.web.bind.annotation.ControllerAdvice; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotat
SpringBoot全局异常处理（最佳实践）
Java知音
08-25 3510
目录异常处理方案分类基于请求转发基于异常处理器基于过滤器常见异常处理实现方案BasicExceptionController@ExceptionHandler@ControllerAdvice+@ExceptionHandlerSimpleMappingExceptionResolverHandlerExceptionResolverFilter全局异常处理实现方案请求转发异常处理器+请求转发补充...
【学习】SpringBoot之全局异常处理器
adam8560的博客
05-14 130
/** * 全局异常处理器 **/ @ControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler(Exception.class) @ResponseBody public Map<String,Object> handlerExceptio...
SpringBoot中定义全局异常处理器示例代码
03-31
SpringBoot中定义全局异常处理器示例代码SpringBoot中定义全局异常处理器示例代码
spingmvc+mybatis+统一异常处理机制
10-31
搭建部分大致跟网上其他资料差不多，唯一不同的加入了统一错误处理，为了方便开发人员开发，所有错误码用一张表存在数据库中，然后由应用将整表缓存，缓存采用的spring自带的cache，开发中所有错误包括系统异常在...
基于 Java Web 项目的 SpringBoot 框架初始化模板，可基于此快速开发毕设等中小型项目
最新发布
03-13
7、全局异常处理器 8、封装统一响应对象 9、自定义响应码 10、可配置式国际化 11、可配置式多类型对象存储 12、可实现多级缓存 13、毫秒级离线 IP 查询 14、SpringDoc + Knife4j 接口文档 15、全局跨域处理 16、...
基于SpringBoot编写的RESTFul API，使用HTTP状态码与JSON作为响应规范+源代码+文档说明
11-29
你只需要在你的验证实体对象中使用验证注解，如@NotNull、@NotBlank等，同时在你的controller方法中加入@Validated注解即可，验证结果信息已经由全局异常处理器帮你做好了。 ## TOKEN验证 当我们的API需要登录后...
毕业设计，基于SpringBoot+Vue+MySql开发的行者外卖管理系统网站，内含Java完整源代码，数据库脚本
02-05
毕业设计，基于SpringBoot+Vue+MySql开发的行者外卖管理系统网站，内含Java完整源代码，数据库脚本 行者外卖管理系统网站，是一个面向外卖管理后台的平台，...通过AOP技术加入了全局异常处理器，对异常进行统一处理
SpringBoot学习：接口鉴权JWT
大小鱼鱼鱼鱼鱼
06-13 5251
import static org.apache.commons.lang3.StringUtils.defaultIfBlank; import static org.apache.commons.lang3.math.NumberUtils.toInt; import static org.apache.commons.lang3.math.NumberUtils.toLong; /** ...
Type mismatch 问题
weixin_30270889的博客
08-23 4247
　　今天在写MapReduce程序时遇到了Type mismatch的问题，真的非常蛋疼，折腾了好久，后来找到了问题所在。 　　即setOutputKeyClass() 会同时限定Mapper和Reducer的输出 key 类型，同理，setOutputValueClass()会同时限定Mapper和Reducer的输出value类型。如果Mapper和Reducer的输出key或va...
手把手教你整合最优雅SSM框架：SpringMVC + Spring + MyBatis
霍力强的专栏
12-03 2万+
http://blog.csdn.net/qq598535550/article/details/51703190我们看招聘信息的时候，经常会看到这一点，需要具备SSH框架的技能；而且在大部分教学课堂中，也会把SSH作为最核心的教学内容。 但是，我们在实际应用中发现，SpringMVC可以完全替代Struts，配合注解的方式，编程非常快捷，而且通过restful风格定义url，让地址看起来非常优雅
手把手教你整合最优雅SSM框架 SpringMVC + Spring + MyBatis
qq_43717814的博客
11-21 1064
手把手教你整合最优雅SSM框架 SpringMVC + Spring + MyBatis
SpringBoot全局异常处理器配置
小龙哒的博客
04-16 1327
文章目录配置handler配置异常处理类 配置handler @ControllerAdvice @Slf4j public class MyExceptionHandler { @ResponseBody @ExceptionHandler(Exception.class) public ResultRes<String> errorHandler(Exce...
解决org.springframework.web.method.annotation.MethodArgumentTypeMismatchException警告
热门推荐
赣江
06-21 5万+
场景： spring项目中无法访问到对应controller，查看日志，没有报错，只有warnring： org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver.logException Resolved [org.springframework.web.method.annotation.Method...
全局异常处理方案
satan880的博客
11-28 370
全局异常处理方案： @ControllerAdvice @ResponseBody public class GlobalExceptionHandler {   private final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);   @ExceptionHandler(value ...
Type mismatch:
weixin_33842304的博客
04-10 1159
Type mismatch: cannot convert from java.sql.PreparedStatement to com.mysql.jdbc.PreparedStatement import java.sql.PreparedStatement; java连接数据库的问题：Type mismatch: cannot convert from ResultSet to R...
异常 --TypeMismatchException
舒婷(Zoe)
07-23 9209
从昨天晚上就一直遇到这个异常：感觉好怪，一条一条的找了很久 还是没有解决：org.hibernate.TypeMismatchException: Provided id of the wrong type for class  com.demo.pojo.Userinfo. E
springboot怎么配置全局异常
05-10
@ControllerAdvice用于定义全局异常处理器类，@ExceptionHandler用于定义处理特定异常的方法。 以下是一个示例： 1. 创建一个全局异常处理器类GlobalExceptionHandler： ``` @ControllerAdvice public class ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值