api返回值的標準化
例如
|
1
|
{"status":200,"message":"操作成功","data":"{\"id\":1,\"name\":\"張三\"}"} |
封裝返回對象
對象被封裝在base.util.responseutils類型下，返回值是標準的responseentity對象，返回體進行了二次封裝，主要有status,messsage和data組成，返回方法有ok和okmessage，如果真是返回消息，不需要對象，可以選擇使用okmessage，反之使用ok方法。
封裝的返回對象：
|
1
2
3
4
5
6
7
8
9
10
|
@builder@getter@noargsconstructor@allargsconstructorstatic class responsebody {private int status;private string message;private object data;} |
httperror和我們封裝的httperror
對于http error來說有很多種，基本可以定為code在400到500之間的，像客戶端參數問題就是400- bad request,而沒有認證就是401-unauthorized,認證但沒有對應的權限就是403-forbidden,請求的
資源沒有發現就是404-not found，請求方式錯誤（方法是post，你發起請求用了get）就是405- method not allowed等。
使用標準http響應狀態碼
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
@getmapping(get_http_error)responseentity<?> gethttperror() throws ioexception {return responseentity.badrequest().build();}@testpublic void gethttperror() throws exception { mockmvc .perform( get(linddemo.get_http_error) .accept(mediatype.application_json_utf8)) .andexpect(status().is(400));} |
響應的結果
|
1
2
3
4
5
6
7
8
9
|
mockhttpservletresponse: status = 400 error message = null headers = {} content type = null body = forwarded url = null redirected url = null cookies = [] |
使用我們封裝的status狀態碼
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
@getmapping(get_error)responseentity<?> geterror() throws ioexception {return responseutils.badrequest("傳入的參數非法！");}@testpublic void geterror() throws exception { mockmvc .perform( get(linddemo.get_error) .accept(mediatype.application_json_utf8)) .andexpect(status().isok());} |
響應的結果
|
1
2
3
4
5
6
7
8
9
|
mockhttpservletresponse: status = 200 error message = null headers = {content-type=[application/json;charset=utf-8]} content type = application/json;charset=utf-8 body = {"status":400,"message":"傳入的參數非法！","data":{}} forwarded url = null redirected url = null cookies = [] |
通過上面的響應結果可以看到，我們封裝的請求httpcode還是200，只不過把請求錯誤400狀態碼寫在了body
對象里，目前這種方法用的比較多，像一些第三方接口用的都是這種方式，他們會規定相應的響應規范。
總結
事實上，兩種響應體都沒有問題，關鍵在于開發之間的規則要確定，不要在項目里兩者兼用！
以上所述是小編給大家介紹的java api返回值的標準化詳解整合，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復大家的。在此也非常感謝大家對服務器之家網站的支持！
原文鏈接：https://www.cnblogs.com/lori/p/10494923.html
