SpringBoot優雅處理全局異常

前言

本篇文章主要介紹的是SpringBoot項目進行全局異常的處理。

SpringBoot全局異常準備

說明：如果想直接獲取工程那麼可以直接跳到底部，通過鏈接下載工程代碼。

開發準備

環境要求JDK：1.8SpringBoot：1.5.17.RELEASE

首先還是Maven的相關依賴:

<code>
  
<
properties
>

        
<
project.build.sourceEncoding
>
UTF-8
project.build.sourceEncoding
>

        
<
java.version
>
1.8
java.version
>

        
<
maven.compiler.source
> 
1.8
maven.compiler.source
>

        
<
maven.compiler.target
>
1.8
maven.compiler.target
>

    
properties
>

    
<
parent
>

        
<
groupId
>
org.springframework.boot
groupId
>

        
<
artifactId
>
spring-boot-starter-parent
artifactId
>

        
<
version
>
1.5.17.RELEASE
version
>

         
<
relativePath
 />

    
parent
>

    
<
dependencies
>

         
        
<
dependency
>

            
<
groupId
>
org.springframework.boot
groupId
>

            
<
artifactId
>
spring-boot-starter-web
artifactId
>

        
dependency
>

         
        
<
dependency
>

            
<
groupId
> 
org.springframework.boot
groupId
>

            
<
artifactId
>
spring-boot-starter-test
artifactId
>

            
<
scope
>
test
scope
>

        
dependency
>


        
<
dependency
>

            
<
groupId
>
com.alibaba
groupId
>

            
<
artifactId
>
fastjson
artifactId
>

             
<
version
>
1.2.41
version
>

        
dependency
>

    
dependencies
>

    
/<code>

配置文件這塊基本不需要更改，全局異常的處理只需在代碼中實現即可。

代碼編寫

SpringBoot的項目已經對有一定的異常處理了，但是對於我們開發者而言可能就不太合適了，因此我們需要對這些異常進行統一的捕獲並處理。SpringBoot中有一個ControllerAdvice的註解，使用該註解表示開啟了全局異常的捕獲，我們只需在自定義一個方法使用ExceptionHandler註解然後定義捕獲異常的類型即可對這些捕獲的異常進行統一的處理。

我們根據下面的這個示例來看該註解是如何使用吧。

示例代碼:

<code>
 
public
  
class
 
MyExceptionHandler
 
{

     
	
public
 String exceptionHandler(Exception e){
		System.
out
.println(
"未知異常！原因是:"
+e);
       	
return
 e.getMessage();
    }
}

/<code>

上述的示例中，我們對捕獲的異常進行簡單的二次處理，返回異常的信息，雖然這種能夠讓我們知道異常的原因，但是在很多的情況下來說，可能還是不夠人性化，不符合我們的要求。那麼我們這裡可以通過自定義的異常類以及枚舉類來實現我們想要的那種數據吧。

自定義基礎接口類

首先定義一個基礎的接口類，自定義的錯誤描述枚舉類需實現該接口。代碼如下:

<code>
public
 
interface
 
BaseErrorInfoInterface
 {
     
	 
String 
getResultCode 
(
)
;
	
	 
	 
String 
getResultMsg
(
)
;
}

/<code>

自定義枚舉類

然後我們這裡在自定義一個枚舉類，並實現該接口。代碼如下:

<code>
public
 
enum
 CommonEnum 
implements
 BaseErrorInfoInterface {
	 
	SUCCESS(
"200"
, 
"成功!"
), 
	BODY_NOT_MATCH(
"400"
,
"請求的數據格式不符!"
),
	SIGNATURE_NOT_MATCH(
"401"
,
"請求的數字簽名不匹配!"
),
	NOT_FOUND(
"404"
, 
"未找到該資源!"
), 
	INTERNAL_SERVER_ERROR(
"500"
,  
"服務器內部錯誤!"
),
	SERVER_BUSY(
"503"
,
"服務器正忙，請稍後再試!"
)
	;

	 
	
private
 
String
 resultCode;

	 
	
private
 
String
 resultMsg;

	CommonEnum(
String
 resultCode, 
String
 resultMsg) {
		
this
.resultCode = resultCode;
		
this
.resultMsg = resultMsg;
	}

	 
	
public
 
String
 getResultCode() {
		
return
 resultCode;
	}

	 
	
public
 
String
 getResultMsg() {
		
return
 resultMsg;
	}

}

/<code>

自定義異常類

然後我們在來自定義一個異常類，用於處理我們發生的業務異常。代碼如下:

<code>
public 
 
class
 
BizException
 
extends
 
RuntimeException
 
{

	
private
 
static
 
final
 
long
 serialVersionUID = 
1L
;

	 
	
protected
 String errorCode;
	 
	
protected
 String errorMsg;

	
public
 
BizException
()
 
{
		
super
();
	}

	
public
 
BizException
(BaseErrorInfoInterface errorInfoInterface)
 
{
		
super
(errorInfoInterface.getResultCode());
		
this
.errorCode = errorInfoInterface.getResultCode();
		
this
.errorMsg = errorInfoInterface.getResultMsg();
	}
	
	
 
public
 
BizException
(BaseErrorInfoInterface errorInfoInterface, Throwable cause)
 
{
		
super
(errorInfoInterface.getResultCode(), cause);
		
this
.errorCode = errorInfoInterface.getResultCode();
		
this
.errorMsg = errorInfoInterface.getResultMsg();
	}
	
	
public
 
BizException
(String errorMsg)
 
{
		
super
(errorMsg);
		
this
.errorMsg = errorMsg;
	}
	
	
public
 
BizException
(String errorCode, String errorMsg)
 
{
		
super
(errorCode);
		
this
.errorCode = errorCode;
		
this
.errorMsg = errorMsg;
	}

	
public
 
BizException
(String errorCode, String errorMsg, Throwable cause)
 
{
		
super
(errorCode, cause);
		
this 
.errorCode = errorCode;
		
this
.errorMsg = errorMsg;
	}
	

	
public
 String 
getErrorCode
()
 
{
		
return
 errorCode;
	}

	
public
 
void
 
setErrorCode
(String errorCode)
 
{
		
this
.errorCode = errorCode;
	}

	
public
 String 
getErrorMsg
()
 
{
		
return
 errorMsg;
	}

	
public
 
void
 
setErrorMsg
(String errorMsg)
 
{
		
this
.errorMsg = errorMsg;
	}

	
public
 String  
getMessage
()
 
{
		
return
 errorMsg;
	}

	 
	
public
 Throwable 
fillInStackTrace
()
 
{
		
return
 
this
;
	}

}

/<code>

自定義數據格式

順便這裡我們定義一下數據的傳輸格式。代碼如下:

<code>
public
 
class
 
ResultBody
 {
	 
	
private
 String code;

	 
	
private
 String message;

	 
	
private
 Object result;

	
public
 
ResultBody
(
) 
 {
	}

	
public
 
ResultBody
(
BaseErrorInfoInterface errorInfo
)
 {
		
this
.code = errorInfo.getResultCode();
		
this
.message = errorInfo.getResultMsg();
	}

	
public
 String 
getCode
(
)
 {
		
return
 code;
	}

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

	
public
 String 
getMessage
(
)
 {
		
return
 message;
	}

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

	
public
 Object 
getResult
(
)
 {
		
return
 result;
	}

	
public
 
void
 
setResult
(
Object result
)
 {
		
this
.result = result;
	}

	 
	
public
 
static
 ResultBody 
success
(
)
 {
		
return
 success(
null
);
	}

	 
	
public
 
static
 ResultBody 
success
( 
Object data
)
 {
		ResultBody rb = 
new
 ResultBody();
		rb.setCode(CommonEnum.SUCCESS.getResultCode());
		rb.setMessage(CommonEnum.SUCCESS.getResultMsg());
		rb.setResult(data);
		
return
 rb;
	}

	 
	
public
 
static
 ResultBody 
error
(
BaseErrorInfoInterface errorInfo
)
 {
		ResultBody rb = 
new
 ResultBody();
		rb.setCode(errorInfo.getResultCode());
		rb.setMessage(errorInfo.getResultMsg());
		rb.setResult(
null
);
		
return
 rb;
	}

	 
	
public
 
static
 ResultBody 
error
(
String code, String message
)
 {
		ResultBody rb = 
new
 ResultBody();
		rb.setCode(code);
		rb.setMessage(message);
		rb.setResult(
null
);
		
return
 rb;
	}

	 
	
public
 
static
 ResultBody 
error
(
 String message
)
 {
		ResultBody rb = 
new 
 ResultBody();
		rb.setCode(
"-1"
);
		rb.setMessage(message);
		rb.setResult(
null
);
		
return
 rb;
	}

	@
Override
	
public
 String 
toString
(
)
 {
		
return
 JSONObject.toJSONString(
this
);
	}

}

/<code>

自定義全局異常處理類

最後我們在來編寫一個自定義全局異常處理的類。代碼如下:

<code>
 
public
 
class
 
GlobalExceptionHandler
 
{
	
private
 static 
final
 Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler
.
class
);

	
	 
       
       
	
public
  ResultBody bizExceptionHandler(HttpServletRequest req, BizException e){
    	logger.error( 
"發生業務異常！原因是：{}"
,e.getErrorMsg());
    	
return
 ResultBody.error(e.getErrorCode(),e.getErrorMsg());
    }

	 
	 
	 
	
public
 ResultBody exceptionHandler(HttpServletRequest req, NullPointerException e){
		logger.error(
"發生空指針異常！原因是:"
,e);
		
return
 ResultBody.error(CommonEnum.BODY_NOT_MATCH);
	}


     
     
	 
	
public
 ResultBody exceptionHandler(HttpServletRequest req, Exception e){
    	logger.error(
"未知異常！原因是:"
,e);
       	
return
 ResultBody.error(CommonEnum.INTERNAL_SERVER_ERROR);
    }
}

/<code>

因為這裡我們只是用於做全局異常處理的功能實現以及測試，所以這裡我們只需在添加一個實體類和一個控制層類即可。

實體類

又是萬能的用戶表 (▽)

代碼如下：

<code>
public
 
class
 
User
 
implements
 
Serializable
{ 

	
private
 
static
 
final
 
long
 serialVersionUID = 
1L
;
	 
	 
private
 
int
 id;
	  
	 
private
 String name;
	  
	 
private
 
int
 age;
	 
	 
public
 
User
()
{
	 }

	
public
 
int
 
getId
()
 
{
		
return
 id;
	}
	
	
public
 
void
 
setId
(
int 
 id)
 
{
		
this
.id = id;
	}

	
public
 String 
getName
()
 
{
		
return
 name;
	}

	
public
 
void
 
setName
(String name)
 
{
		
this
.name = name;
	}

	
public
 
int
 
getAge
()
 
{
		
return
 age;
	}

	
public
 
void
 
setAge
(
int
 age)
  
{
		
this
.age = age;
	}

	
public
 String 
toString
()
 
{
		
return
 JSONObject.toJSONString(
this
);
	}
}
/<code>

Controller 控制層

控制層這邊也比較簡單，使用Restful風格實現的CRUD功能，不同的是這裡我故意弄出了一些異常，好讓這些異常被捕獲到然後處理。這些異常中，有自定義的異常拋出，也有空指針的異常拋出，當然也有不可預知的異常拋出(這裡我用類型轉換異常代替)，那麼我們在完成代碼編寫之後，看看這些異常是否能夠被捕獲處理成功吧！

代碼如下:

<code>
 
 
public
 
class
 
UserRestController
 
{

	 
    
public 
 boolean insert(  User user) {
    	System.
out
.println(
"開始新增..."
);
    	 
        
if
(user.getName()==
null
){
            
throw
  new BizException(
"-1"
,
"用戶姓名不能為空！"
);
        }
        
return
 
true
;
    }

     
    
public
 boolean update(  User user) {
    	System.
out
.println(
"開始更新..."
);
        
        String str=
null
;
        str.equals(
"111"
);
        
return
 
true
;
    }

     
    
public
 boolean delete(  User user)  {
        System.
out
.println(
"開始刪除..."
);
         
        Integer.parseInt(
"abc123"
);
        
return
 
true
;
    }

     
    
public
 List findByUser(User user) {
    	System.
out 
.println(
"開始查詢..."
);
        List userList =new ArrayList<>();
        User user2=new User();
        user2.setId(
1L
);
        user2.setName(
"xuwujing"
);
        user2.setAge(
18
);
        userList.add(user2);
        
return
 userList;
    }
    
}

/<code>

App 入口

和普通的SpringBoot項目基本一樣。

代碼如下:

<code>
 
public
 
class
 
App
 
{
    
public
 
static
 
void
 
main
( String[] args )
    
{
		SpringApplication.run(App
.
class
, 
args 
)
;
		System.out.println(
"程序正在運行..."
);
    }
}

/<code>

功能測試

我們成功啟動該程序之後，使用Postman工具來進行接口測試。

首先進行查詢，查看程序正常運行是否ok，使用GET 方式進行請求。

GET http://localhost:8181/api/user

返回參數為:

{"id":1,"name":"xuwujing","age":18}

示例圖:

可以看到程序正常返回，並沒有因自定義的全局異常而影響。

然後我們再來測試下自定義的異常是否能夠被正確的捕獲並處理。

使用POST方式進行請求

POST http://localhost:8181/api/user

Body參數為:

{"id":1,"age":18}

返回參數為:

{"code":"-1","message":"用戶姓名不能為空！","result":null}

示例圖:

可以看出將我們拋出的異常進行數據封裝，然後將異常返回出來。

然後我們再來測試下空指針異常是否能夠被正確的捕獲並處理。在自定義全局異常中，我們除了定義空指針的異常處理，也定義最高級別之一的Exception異常，那麼這裡發生了空指針異常之後，它是回優先使用哪一個呢？這裡我們來測試下。

使用PUT方式進行請求。

PUT http://localhost:8181/api/user

Body參數為:

{"id":1,"age":18}

返回參數為:

{"code":"400","message":"請求的數據格式不符!","result":null}

示例圖:

我們可以看到這裡的的確是返回空指針的異常護理，可以得出全局異常處理優先處理子類的異常。

那麼我們在來試試未指定其異常的處理，看該異常是否能夠被捕獲。

使用DELETE方式進行請求。

DELETE http://localhost:8181/api/user

Body參數為:

{"id":1}

返回參數為:

{"code":"500","message":"服務器內部錯誤!","result":null}

這裡可以看到它使用了我們在自定義全局異常處理類中的Exception異常處理的方法。到這裡，測試就結束了。順便再說一下，自義定全局異常處理除了可以處理上述的數據格式之外，也可以處理頁面的跳轉，只需在新增的異常方法的返回處理上填寫該跳轉的路徑並不使用ResponseBody 註解即可。 細心的同學也許發現了在GlobalExceptionHandler類中使用的是ControllerAdvice註解，而非RestControllerAdvice註解，如果是用的RestControllerAdvice註解，它會將數據自動轉換成JSON格式，這種於Controller和RestController類似，所以我們在使用全局異常處理的之後可以進行靈活的選擇處理。

其它

關於SpringBoot優雅的全局異常處理的文章就講解到這裡了，如有不妥，歡迎指正！

項目地址

SpringBoot全局異常的處理項目工程地址:https://github.com/xuwujing/springBoot-study/tree/master/springboot-exceptionHandler