服务器开发-对外接口返回数据-封装模板

    <!-- 作者区域 -->
    <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">

天马行空LQ

关注

1.3

2018.12.15 15:21*
字数 491
阅读 345评论 0喜欢 17赞赏 1

    <!-- 文章内容 -->
    <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>

posted @ 2019-04-17 16:22 星朝阅读(1192) 评论(0) 编辑收藏举报

会员力量，点亮园子希望

刷新页面返回顶部

星朝

服务器开发-对外接口返回数据-封装模板

服务器开发-对外接口返回数据-封装模板

那么在在日常开发中如何使用抛出异常呢？

第一步：自定义业务异常类

第二步：代码中演示异常抛出

第三步：回顾DataResultChange.java中的catch中的异常处理逻辑

公告