springBoot中编写全局异常类

为什么要写全局异常：因为现在都是前后端分离，要返回数据到前端，都会返回json。此外，代码里面太多try catch，影响代码美观。还有就是对异常进行自定义和统一管理

首先我们来看看工程目录，看看需要添加哪些包那些类

首先，我们需要建立一exception的包，然后在这个包下创建我们自己定义的异常类，这里，我们定义了一个HospitalException的异常（还可以根据自己的需求添加其它自定义的异常类）

package com.yy.hospital.exception;

public class HospitalException extends Exception {
    /**
     *  自定义项目内异常
     */
    public HospitalException(String message){
        super(message);
    }
}

在写统一处理异常的控制器类之前，我们可以自己定义统一异常类返回的对象类型，所以我在domain层里面定义了一个ErrorInfo类

package com.yy.hospital.domain;


//自定义错误类
public class ErrorInfo<T> {

    public static final int ok=0;
    public static final int ERROR = 100;

    private int code;
    private String message;
    private String url;
    private T data;

    public int getCode() {
        return code;
    }

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

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
}

然后，我们再在controller层定义一个统一处理异常的控制器类ExceptionController

package com.yy.hospital.controller;


import com.yy.hospital.domain.ErrorInfo;
import com.yy.hospital.exception.HospitalException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;

// 统一的异常类进行处理(把默认的异常返回信息改成自定义的异常返回信息)
// 当GlobalContrller抛出HospitalException异常时，将自动找到此类中对应的方法执行，并返回json数据给前台
@ControllerAdvice
public class ExceptionController {

    @ResponseBody
    @ExceptionHandler(value = HospitalException.class)    //异常处理器，处理HospitalException异常
    public ResponseEntity<?> hanlerException(HttpServletRequest request,HospitalException e){
        ErrorInfo<String> error = new ErrorInfo<>();
        error.setCode(ErrorInfo.ERROR);
        error.setMessage(e.getMessage());
        error.setUrl(request.getRequestURI().toString());
        error.setData("some data");
        return new ResponseEntity<>(error, HttpStatus.OK);
    }
}

这样，我们全局异常类就定义好啦

------------------------------------------------------测试分割线---------------------------------------------------------

现在我们可以来测试下，我们在Contrller层写一个GlobalController来模拟异常的controller

package com.yy.hospital.controller;

import com.yy.hospital.exception.HospitalException;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
//controller层模拟异常的controller
public class GlobalController {
    @RequestMapping("/testError")
    public ResponseEntity<?> testError() throws HospitalException {
        throw new HospitalException("医院自定义异常！");
    }
}

然后我们通过postman软件来模拟前端发送请求

可以看到，ExceptionController发送了ErrorInfo数据给前台了，成功！