SpringBoot2 综合案例(03):配置系统全局异常映射处理

Spring Boot 2 基础案例篇

包含：入门、日志管理、定时器、事务、AOP、数据库、缓存、NoSQL、监控、打包。

Spring Boot 2 高级案例篇

包含：整合常用中间件：分库分表、权限管理、Redis 集群、Dubbo、消息队列、定时器、搜索引擎、文件管理、邮件等

异常分类

这里的异常分类从系统处理异常的角度看，主要分类两类：业务异常和系统异常。

业务异常

业务异常主要是一些可预见性异常，处理业务异常，用来提示用户的操作，提高系统的可操作性。

常见的业务异常提示：

1)请输入指定参数2)用户 ID 不能为空3)手机号重复，请更换

系统异常

系统异常主要是一些不可预见性异常，处理系统异常，可以让展示出一个友好的用户界面，不易给用户造成反感。如果是一个金融类系统，在用户界面出现一个系统异常的崩溃界面，很有可能直接导致用户流失。

常见的系统异常提示：

1)页面丢失 4042)服务器异常 500

解决应用启动后 404 界面

引入页面 Jar 包

    org.springframework.boot    spring-boot-starter-thymeleaf

自定义首页接口

import org.springframework.stereotype.Controller;import org.springframework.ui.ModelMap;import org.springframework.web.bind.annotation.RequestMapping;@Controllerpublic class IndexController {    @RequestMapping("/")    public String index(ModelMap modelMap) {        modelMap.addAttribute("name","知了一笑") ;        return "index";    }}

首页界面

运行效果

SpringBoot2.0 中异常处理 项目结构图

自定义业务异常类

public class ServiceException extends Exception {    public ServiceException (String msg){        super(msg);    }}

自定义异常描述对象

public class ReturnException {    // 响应码    private Integer code;    // 异常描述    private String msg;    // 请求的 Url    private String url;    // 省略 get set 方法}

统一异常处理格式

1）两个基础注解

• @ControllerAdvice 定义统一的异常处理类
• @ExceptionHandler 定义异常类型对应的处理方式

2）代码实现

import org.springframework.web.bind.annotation.ControllerAdvice;import org.springframework.web.bind.annotation.ExceptionHandler;import org.springframework.web.bind.annotation.ResponseBody;import org.springframework.web.servlet.ModelAndView;import javax.servlet.http.HttpServletRequest;@ControllerAdvice// 异常以 Json 格式返回 等同 ExceptionHandler + ResponseBody 注解// @RestControllerAdvicepublic class HandlerException {    /**     * 自定义业务异常映射,返回 JSON 格式提示     */    @ExceptionHandler(value = ServiceException.class)    @ResponseBody    public ReturnException handler01 (HttpServletRequest request,ServiceException e){        ReturnException returnException = new ReturnException() ;        returnException.setCode(600);        returnException.setMsg(e.getMessage());        returnException.setUrl(String.valueOf(request.getRequestURL()));        return returnException ;    }    /**     * 服务异常     */    @ExceptionHandler(value = Exception.class)    public ModelAndView handler02 (HttpServletRequest request,Exception e){        ModelAndView modelAndView = new ModelAndView() ;        modelAndView.addObject("ExeMsg", e.getMessage());        modelAndView.addObject("ReqUrl", request.getRequestURL());        modelAndView.setViewName("/exemsg");        return modelAndView ;    }}

简单的测试接口

@Controllerpublic class ExeController {    /**     *  {     *    "code": 600,     *    "msg": "业务异常：ID 不能为空",     *    "url": "http://localhost:8003/exception01"     *  }     */    @RequestMapping("/exception01")    public String exception01 () throws ServiceException {        throw new ServiceException("业务异常：ID 不能为空");    }    @RequestMapping("/exception02")    public String exception02 () throws Exception {        throw new Exception("出现异常，全体卧倒");    }}

源代码地址

GitHub·地址https://github.com/cicadasmile/spring-boot-baseGitEE·地址https://gitee.com/cicadasmile/spring-boot-base

本文首发于 GitChat，未经授权不得转载，转载需与 GitChat 联系。

阅读全文: http://gitbook.cn/gitchat/activity/5d69454f47f1a31d3178c626

您还可以下载 CSDN 旗下精品原创内容社区 GitChat App ，阅读更多 GitChat 专享技术内容哦。