快捷導(dǎo)航

springboot框架的全局異常處理方案詳解

更新時(shí)間：2021年03月12日 14:27:58 作者：一起隨緣

這篇文章主要介紹了springboot框架的全局異常處理方案,本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

系統(tǒng)框架搭建的前期過(guò)程中，為了約束代碼規(guī)范，我們會(huì)對(duì)一些通用功能做一些處理，比如聲明一些系統(tǒng)公用錯(cuò)誤類、封裝通用返回結(jié)果、統(tǒng)一異常處理等，這樣做的優(yōu)勢(shì)是團(tuán)隊(duì)開發(fā)過(guò)程中能夠形成統(tǒng)一的代碼規(guī)范，增強(qiáng)代碼可讀性，同時(shí)又便于后期代碼維護(hù)。本文主要介紹下框架中異常的處理：

1.聲明全局異常處理類，并添加@ControllerAdvice和@RestController注解
代碼如下：

@ControllerAdvice
@RestController
public class GlobalExceptionHandler {
	
	private final Logger logger = Logger.getLogger(GlobalExceptionHandler.class);

	//空指針異常
  @ExceptionHandler(NullPointerException.class)
  public Map<String, Object> nullPointer(NullPointerException e,HttpServletRequest req){
    logger.error(e.getMessage());
		e.printStackTrace();
    return ResultObject.newResultObj(ErrorCode.NULLPOINTER);
  }
	
	//IO異常
	@ExceptionHandler(IOException.class,HttpServletRequest req, HttpServletResponse res)
  public Map<String, Object> IOException(IOException e){
  	 logger.error(e.getMessage());
		 e.printStackTrace();
     return ResultObject.newResultObj(ErrorCode.IOEXCEPTION);
  }
  
	
	//權(quán)限不足異常	
	@ExceptionHandler(UnauthorizedException.class)
	public Map<String, Object> unauth(HttpServletRequest req, HttpServletResponse res){
		return ResultObject.newResultObj(ErrorCode.UNAUTH);
	}
	
	//未登錄異常	
	@ExceptionHandler(AuthorizationException.class)
	public Map<String, Object> unlogin(HttpServletRequest req, HttpServletResponse res){
		return ResultObject.newResultObj(ErrorCode.NOTLOGIN);
	}
	
	//其它異常
	@ExceptionHandler(Exception.class)
	public Map<String, Object> error(Exception e,HttpServletRequest req, HttpServletResponse res){
		logger.error(e.getMessage());
		e.printStackTrace();
		return ResultObject.newResultObj(ErrorCode.SYSTEM);
	}
	
}

2.聲明系統(tǒng)通用錯(cuò)誤處理類

/**
 * 系統(tǒng)通用錯(cuò)誤處理類
 */
public class ErrorCode {

  //返回碼
  private int code = 0;
	
  //描述信息
  private String errmsg = "SUCCESS";
	
  //成功
  public static final ErrorCode SUCCESS 					  = new ErrorCode(0,"SUCCESS");
  public static final ErrorCode PARAMS 					  = new ErrorCode(100000,"參數(shù)錯(cuò)誤");
  public static final ErrorCode SYSTEM 					  = new ErrorCode(100001,"系統(tǒng)錯(cuò)誤");
	public static final ErrorCode UNLOGIN 					  = new ErrorCode(100002,"未登錄");
  public static final ErrorCode UNAUTH 					  = new ErrorCode(100003,"權(quán)限錯(cuò)誤");
	public static final ErrorCode NULLPOINTER 					= new ErrorCode(100004,"空指針錯(cuò)誤");
	public static final ErrorCode IOEXCEPTION 					= new ErrorCode(100005,"IO錯(cuò)誤");
  public static final ErrorCode UPLOAD_FAIL 					= new ErrorCode(100006,"文件上傳失敗");
  public static final ErrorCode REPEAT 					  = new ErrorCode(100007,"數(shù)據(jù)已存在");

  public ErrorCode() {}

  @Override
  public String toString() {
    return String.format("{\"errmsg\": \"%s\", \"code\": %d}", errmsg, code);
  }

  public int getCode() {
    return code;
  }

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

  public String getErrmsg() {
    return errmsg;
  }

  public ErrorCode setErrmsg(String errmsg) {
    this.errmsg = errmsg;
    return this;
  }

  public ErrorCode(int code, String errmsg) {
    this.code = code;
    this.errmsg = errmsg;
  }

}

3.聲明全局異常處理類中的結(jié)果返回類

import java.util.HashMap;
import java.util.Map;
import javax.servlet.http.HttpServletResponse;
import com.xxx.ErrorCode;//此處引用自己errorCode類所在的包路徑
import org.json.JSONObject;

public class ResultObject {	
	
	/**
	 * 輸出錯(cuò)誤信息
	 * @param errorCode
	 */
	public static Map<String, Object> newResultObj(ErrorCode errorCode){
		Map<String, Object> obj = new HashMap<String, Object>();
		obj.put("code", errorCode.getCode());
		obj.put("errmsg", errorCode.getErrmsg());
		return obj;
	}
	
	/**
	 * 輸出帶數(shù)據(jù)的成功信息
	 * @param data
	 */
	public static Map<String, Object> newResultObj(Object data){
		Map<String, Object> obj = new HashMap<String, Object>();
		obj.put("code", ErrorCode.SUCCESS.getCode());
		obj.put("errmsg", ErrorCode.SUCCESS.getErrmsg());
		if(null != data){
			obj.put("data", data);
		}
		return obj;		
	}
	
	/**
	 * 輸出帶數(shù)據(jù)的錯(cuò)誤信息
	 * @param errorCode
	 * @param data
	 */
	public static Map<String, Object> newResultObj(ErrorCode errorCode, Object data){
		Map<String, Object> obj = new HashMap<String, Object>();
		obj.put("code", errorCode.getCode());
		obj.put("errmsg", errorCode.getErrmsg());
		if(null != data){
			obj.put("data", data);
		}
		return obj;				
	}
	
	
	/**
	 * 輸出結(jié)果
	 */
	public static void outputResult(HttpServletResponse response, ErrorCode errorCode){
		try {
			JSONObject json = new JSONObject();
			json.put("code", errorCode.getCode());
			json.put("errmsg", errorCode.getErrmsg());
			
			response.setCharacterEncoding("UTF-8");
			response.setContentType("application/json;charset=UTF-8");
			response.getWriter().write(json.toString());
		} catch (Exception e1) {
		}
	}
}

到此這篇關(guān)于springboot框架的全局異常處理方案的文章就介紹到這了,更多相關(guān)springboot全局異常處理內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: