服務器開發-對外接口返回數據-封裝模板
<!-- 作者區域 -->
<div class="author">
<a class="avatar" href="/u/ec8f2b01713f">
<img src="//upload.jianshu.io/users/upload_avatars/3101087/c4c883ba-3dcf-488d-81bc-03a15e236216.jpg?imageMogr2/auto-orient/strip|imageView2/1/w/96/h/96" alt="96">
<!-- 文章內容 -->
<div data-note-content="" class="show-content">
<div class="show-content-free">
<blockquote>
前言： 日常開發中我們一般都會做對外接口的統一數據返回模板，以下是我所采用的數據返回模板，分享出來目的是歡迎大家學習和幫助改進。
以下,Enjoy:
DataResult.java(數據模板類)：
/** * @Auther: 折戟沉沙 * @Description: 接口返回 數據模板 * @Version: 1.0 */
public class DataResult<T> {
<span class="hljs-keyword">private</span> String code;
<span class="hljs-keyword">private</span> String msg;
<span class="hljs-keyword">private</span> T body;
<span class="hljs-comment">/**
* 默認處理成功,無需傳入Code,Desc
* <span class="hljs-doctag">@param</span> body
*/</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">DataResult</span><span class="hljs-params">(T body)</span></span>{
<span class="hljs-keyword">this</span>.code = PlatStateCode.getByState(<span class="hljs-string">"CD000001"</span>).getCode();
<span class="hljs-keyword">this</span>.msg = PlatStateCode.getByState(<span class="hljs-string">"CD000001"</span>).getDesc();
<span class="hljs-keyword">this</span>.body = body;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">DataResult</span><span class="hljs-params">(String code, String msg)</span> </span>{
<span class="hljs-keyword">this</span>.code = code;
<span class="hljs-keyword">this</span>.msg = msg;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">DataResult</span><span class="hljs-params">(PlatStateCode platStateCode)</span></span>{
<span class="hljs-keyword">this</span>.code = platStateCode.getCode();
<span class="hljs-keyword">this</span>.msg = platStateCode.getDesc();
}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">DataResult</span><span class="hljs-params">(PlatExceptionCode platExceptionCode)</span></span>{
<span class="hljs-keyword">this</span>.code = platExceptionCode.getCode();
<span class="hljs-keyword">this</span>.msg = platExceptionCode.getDesc();
}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">DataResult</span><span class="hljs-params">(PlatStateCode platStateCode, T body)</span></span>{
<span class="hljs-keyword">this</span>.code = platStateCode.getCode();
<span class="hljs-keyword">this</span>.msg = platStateCode.getDesc();
<span class="hljs-keyword">this</span>.body = body;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">DataResult</span><span class="hljs-params">(PlatExceptionCode platExceptionCode, T body)</span></span>{
<span class="hljs-keyword">this</span>.code = platExceptionCode.getCode();
<span class="hljs-keyword">this</span>.msg = platExceptionCode.getDesc();
<span class="hljs-keyword">this</span>.body = body;
}
<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">toString</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> <span class="hljs-string">"ResultData{"</span> +
<span class="hljs-string">"code="</span> + code +
<span class="hljs-string">", body="</span> + body +
<span class="hljs-string">", msg='"</span> + msg + <span class="hljs-string">'\''</span> +
<span class="hljs-string">'}'</span>;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">getCode</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> code;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">setCode</span><span class="hljs-params">(String code)</span> </span>{
<span class="hljs-keyword">this</span>.code = code;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">getMsg</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> msg;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">setMsg</span><span class="hljs-params">(String msg)</span> </span>{
<span class="hljs-keyword">this</span>.msg = msg;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> T <span class="hljs-title">getBody</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> body;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">setBody</span><span class="hljs-params">(T body)</span> </span>{
<span class="hljs-keyword">this</span>.body = body;
}
}
PlatStateCode.java(平台狀態碼類):
/** * @Auther: 折戟沉沙 * @Description: 統一平台狀態代碼 * @Version:1.0 */
public enum PlatStateCode {
/** 處理成功 */
SUCCESS("CD000001", "處理成功"),
/** 處理中 */
PROCESSING("CD000002", "處理中"),
/** 處理失敗 */
FAILURE("CD000003", "處理失敗"),
;
<span class="hljs-keyword">private</span> <span class="hljs-keyword">final</span> String code;
<span class="hljs-keyword">private</span> <span class="hljs-keyword">final</span> String desc;
<span class="hljs-function"><span class="hljs-keyword">private</span> <span class="hljs-title">PlatStateCode</span><span class="hljs-params">(String code, String desc)</span> </span>{
<span class="hljs-keyword">this</span>.code = code;
<span class="hljs-keyword">this</span>.desc = desc;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">getCode</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> code;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">getDesc</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> desc;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> PlatStateCode <span class="hljs-title">getByState</span><span class="hljs-params">(String state)</span> </span>{
<span class="hljs-keyword">if</span> (state == <span class="hljs-keyword">null</span> || state.length() == <span class="hljs-number">0</span>) {
<span class="hljs-keyword">return</span> <span class="hljs-keyword">null</span>;
}
<span class="hljs-keyword">for</span> (PlatStateCode each : values()) {
<span class="hljs-keyword">if</span> (state.equals(each.getCode())) {
<span class="hljs-keyword">return</span> each;
}
}
<span class="hljs-keyword">return</span> <span class="hljs-keyword">null</span>;
}
<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">toString</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> <span class="hljs-string">"["</span> + code + <span class="hljs-string">":"</span> + desc + <span class="hljs-string">"]"</span>;
}
}
PlatExceptionCode.java(平台錯誤狀態碼枚舉類):
/** * @Auther: 折戟沉沙 * @Description: 平台代碼錯誤枚舉類 * @Version: 1.0 */
public enum PlatExceptionCode {
<span class="hljs-comment">/** 通用方法報錯信息 */</span>
FAILURE_REQ_URL(<span class="hljs-string">"CD001001"</span>, <span class="hljs-string">"無效請求地址"</span>, PlatStateCode.FAILURE),
ERR_OPER_TYPE(<span class="hljs-string">"CD001002"</span>, <span class="hljs-string">"無效操作類型"</span>, PlatStateCode.FAILURE),
FAILURE_REQ_PRM_NULL(<span class="hljs-string">"CD001003"</span>, <span class="hljs-string">"請求參數不能為空"</span>, PlatStateCode.FAILURE),
FAILURE_REQ_PRM_ERR(<span class="hljs-string">"CD001004"</span>, <span class="hljs-string">"請求參數異常，請重試"</span>, PlatStateCode.FAILURE),
FAILURE_REQ_LOGIN_OUT(<span class="hljs-string">"CD001005"</span>, <span class="hljs-string">"登錄超時，請重新登錄"</span>, PlatStateCode.FAILURE),
FAILURE_REQ_NOT_LOGIN(<span class="hljs-string">"CD001006"</span>, <span class="hljs-string">"未登錄，請登錄操作"</span>, PlatStateCode.FAILURE),
FAILURE_REQ_ERR(<span class="hljs-string">"CD001007"</span>, <span class="hljs-string">"非法請求"</span>, PlatStateCode.FAILURE),
;
<span class="hljs-keyword">private</span> <span class="hljs-keyword">final</span> String code;
<span class="hljs-keyword">private</span> <span class="hljs-keyword">final</span> String desc;
<span class="hljs-keyword">private</span> <span class="hljs-keyword">final</span> PlatStateCode state;
PlatExceptionCode(String code, String desc, PlatStateCode state) {
<span class="hljs-keyword">this</span>.code = code;
<span class="hljs-keyword">this</span>.desc = desc;
<span class="hljs-keyword">this</span>.state = state;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">getCode</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> code;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">getDesc</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> desc;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> PlatStateCode <span class="hljs-title">getState</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> state;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> PlatExceptionCode <span class="hljs-title">getByCode</span><span class="hljs-params">(String resCode)</span> </span>{
<span class="hljs-keyword">if</span> (resCode == <span class="hljs-keyword">null</span> || resCode.length() == <span class="hljs-number">0</span>) {
<span class="hljs-keyword">return</span> <span class="hljs-keyword">null</span>;
}
<span class="hljs-keyword">for</span> (PlatExceptionCode each : values()) {
<span class="hljs-keyword">if</span> (each.getCode().equals(resCode)) {
<span class="hljs-keyword">return</span> each;
}
}
<span class="hljs-keyword">return</span> <span class="hljs-keyword">null</span>;
}
<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">toString</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> <span class="hljs-string">"["</span> + code + <span class="hljs-string">":"</span> + desc + <span class="hljs-string">"]"</span>;
}
}
如何使用？
使用AOP切面攔截對外接口，統一處理數據模板的封裝
DataResultChange.java(數據模板AOP類):
/** * @Auther: 折戟沉沙 * @Description: 統一處理對外接口 數據模板 * @Version: 1.0 */
@Aspect
@Component
public class DataResultChange {
<span class="hljs-keyword">private</span> Logger logger = LoggerFactory.getLogger(DataResultChange.class);
<span class="hljs-meta">@Around</span>(<span class="hljs-string">"execution(* com.dofun.*..*Controller.*(..))"</span>)
<span class="hljs-function"><span class="hljs-keyword">public</span> Object <span class="hljs-title">logServiceAccess</span><span class="hljs-params">(ProceedingJoinPoint pjp)</span> </span>{
Object result;
<span class="hljs-keyword">try</span> {
result = pjp.proceed();
<span class="hljs-keyword">if</span> (!(result <span class="hljs-keyword">instanceof</span> DataResult))
result = <span class="hljs-keyword">new</span> DataResult(result);<span class="hljs-comment">// 默認成功,包裝數據返回</span>
} <span class="hljs-keyword">catch</span> (Throwable e) {
logger.error(e.getMessage(), e);
<span class="hljs-comment">//自定義業務異常</span>
<span class="hljs-keyword">if</span> (e <span class="hljs-keyword">instanceof</span> ServiceException) {
result = <span class="hljs-keyword">new</span> DataResult(((ServiceException) e).getCode(), e.getLocalizedMessage());
}
<span class="hljs-comment">//表單驗證異常</span>
<span class="hljs-keyword">else</span> <span class="hljs-keyword">if</span> (e <span class="hljs-keyword">instanceof</span> MethodArgumentNotValidException) {
result = <span class="hljs-keyword">new</span> DataResult(PlatExceptionCode.FAILURE_REQ_PRM_ERR);
}
<span class="hljs-comment">//未知異常</span>
<span class="hljs-keyword">else</span> {
result = <span class="hljs-keyword">new</span> DataResult(PlatStateCode.FAILURE);
}
}
<span class="hljs-keyword">return</span> result;
}
}
DataResultChange類中通過@Around("execution(* com.dofun...Controller.*(..))")攔截到所有對外的接口方法。
- result = pjp.proceed();獲取到攔截到的方法的返回數據報文。
- if (!(result instanceof DataResult))判斷數據報文是否為我們定義的數據模板(DataResult)，如果不是，則執行封裝操作。
以上1、2步驟就是攔截到接口，數據返回正常的步驟。(一般來說只有處理成功狀態才會執行try塊)
那么在在日常開發中如何使用拋出異常呢？
第一步：自定義業務異常類
ServiceException.java(自定義業務異常類):
/** * @Auther: 折戟沉沙 * @Description: 業務通用異常 * @Version: 1.0 */
public class ServiceException extends RuntimeException{
<span class="hljs-keyword">private</span> String code;
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">ServiceException</span><span class="hljs-params">()</span></span>{}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">ServiceException</span><span class="hljs-params">(String message)</span></span>{
<span class="hljs-keyword">super</span>(message);
}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">ServiceException</span><span class="hljs-params">(String code,String message)</span></span>{
<span class="hljs-keyword">super</span>(message);
<span class="hljs-keyword">this</span>.code = code;
}
<span class="hljs-comment">/**
* 平台錯誤代碼枚舉類
*/</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">ServiceException</span><span class="hljs-params">(PlatExceptionCode platExceptionCode)</span></span>{
<span class="hljs-keyword">super</span>(platExceptionCode.getDesc());
<span class="hljs-keyword">this</span>.code = platExceptionCode.getCode();
}
<span class="hljs-comment">/**
* 平台狀態代碼枚舉類
*/</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">ServiceException</span><span class="hljs-params">(PlatStateCode platStateCode)</span></span>{
<span class="hljs-keyword">super</span>(platStateCode.getDesc());
<span class="hljs-keyword">this</span>.code = platStateCode.getCode();
}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">ServiceException</span><span class="hljs-params">(String message,Throwable e)</span></span>{
<span class="hljs-keyword">super</span>(message,e);
}
<span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">getCode</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> code;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">setCode</span><span class="hljs-params">(String code)</span> </span>{
<span class="hljs-keyword">this</span>.code = code;
}
}
第二步：代碼中演示異常拋出
if (code.length() != 6) {
logger.error("請求參數異常!code=" + code);
throw new ServiceException(PlatExceptionCode.FAILURE_REQ_PRM_ERR);
}
在實際代碼邏輯中，我們遇到的異常都可以像以上方式直接拋出.
第三步：回顧DataResultChange.java中的catch中的異常處理邏輯
} catch (Throwable e) {
logger.error(e.getMessage(), e);
//自定義業務異常
if (e instanceof ServiceException) {
result = new DataResult(((ServiceException) e).getCode(), e.getLocalizedMessage());
}
//表單驗證異常
else if (e instanceof MethodArgumentNotValidException) {
result = new DataResult(PlatExceptionCode.FAILURE_REQ_PRM_ERR);
}
//未知異常
else {
result = new DataResult(PlatStateCode.FAILURE);
}
}
在catch中，我們做了攔截ServiceException異常，然后封裝數據模板的狀態代碼為傳入的錯誤狀態碼。
注意點：
1.Controller采用的@RestController，會自動把所有方法的報文封裝為Json格式，所以最終的DataResult數據模板返回出去是JSON格式。
{
"code": "CD000001",
"msg": "處理成功",
"body": {
"ossPaths": "https://github.com"
}
}
2.Controller中方法返回類型必須為Object
@RestController
@RequestMapping("/test")
@Api(value = "演示-用戶操作層",description = "用於-簡書-代碼演示")
public class TestController {
@RequestMapping(value = "/getOssPath/{code}",method = RequestMethod.GET)
public Object getOssPath(@PathVariable("code") String code){
if (code.length() != 6) {
logger.error("請求參數異常!code=" + code);
throw new ServiceException(PlatExceptionCode.FAILURE_REQ_PRM_ERR);
}
return ossService.getOssPath(code);// 數據類型為 Map
}
}
以上便是服務器日常開發中，如何去封裝對外接口的數據模板，謝謝閱讀！
</div>
</div>
</div>