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

最新推荐文章于 2021-05-26 16:53:34 发布
最新推荐文章于 2021-05-26 16:53:34 发布
阅读量357 收藏
点赞数
文章标签： java json
原文链接：http://www.cnblogs.com/jpfss/p/10724326.html
版权

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

96
天马行空LQ
1.3 2018.12.15 15:21* 字数 491 阅读 345 评论 0 赞赏 1

前言： 日常开发中我们一般都会做对外接口的统一数据返回模板，以下是我所采用的数据返回模板，分享出来目的是欢迎大家学习和帮助改进。

以下,Enjoy:

DataResult.java(数据模板类)：

/**
 * @Auther: 折戟沉沙
 * @Description: 接口返回 数据模板
 * @Version: 1.0
 */
public class DataResult<T> {

    private String code;
    private String msg;
    private T body;


    /**
     * 默认处理成功,无需传入Code,Desc
     * @param body
     */
    public DataResult(T body){
        this.code = PlatStateCode.getByState("CD000001").getCode();
        this.msg = PlatStateCode.getByState("CD000001").getDesc();
        this.body = body;
    }

    public DataResult(String code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public DataResult(PlatStateCode platStateCode){
        this.code = platStateCode.getCode();
        this.msg = platStateCode.getDesc();
    }

    public DataResult(PlatExceptionCode platExceptionCode){
        this.code = platExceptionCode.getCode();
        this.msg = platExceptionCode.getDesc();
    }

    public DataResult(PlatStateCode platStateCode, T body){
        this.code = platStateCode.getCode();
        this.msg = platStateCode.getDesc();
        this.body = body;
    }

    public DataResult(PlatExceptionCode platExceptionCode, T body){
        this.code = platExceptionCode.getCode();
        this.msg = platExceptionCode.getDesc();
        this.body = body;
    }

    @Override
    public String toString() {
        return "ResultData{" +
                "code=" + code +
                ", body=" + body +
                ", msg='" + msg + '\'' +
                '}';
    }

    public String getCode() {
        return code;
    }

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

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public T getBody() {
        return body;
    }

    public void setBody(T body) {
        this.body = body;
    }
}

PlatStateCode.java(平台状态码类):

/**
 * @Auther: 折戟沉沙
 * @Description: 统一平台状态代码
 * @Version:1.0
 */
public enum  PlatStateCode {
    /** 处理成功 */
    SUCCESS("CD000001", "处理成功"),
    /** 处理中 */
    PROCESSING("CD000002", "处理中"),
    /** 处理失败 */
    FAILURE("CD000003", "处理失败"),
    ;

    private final String code;
    private final String desc;

    private PlatStateCode(String code, String desc) {
        this.code = code;
        this.desc = desc;
    }

    public String getCode() {
        return code;
    }

    public String getDesc() {
        return desc;
    }

    public static PlatStateCode getByState(String state) {
        if (state == null || state.length() == 0) {
            return null;
        }
        for (PlatStateCode each : values()) {
            if (state.equals(each.getCode())) {
                return each;
            }
        }
        return null;
    }

    @Override
    public String toString() {
        return "[" + code + ":" + desc + "]";
    }
}

PlatExceptionCode.java(平台错误状态码枚举类):

/**
 * @Auther: 折戟沉沙
 * @Description: 平台代码错误枚举类
 * @Version: 1.0
 */
public enum  PlatExceptionCode {

    /** 通用方法报错信息 */
    FAILURE_REQ_URL("CD001001", "无效请求地址", PlatStateCode.FAILURE),
    ERR_OPER_TYPE("CD001002", "无效操作类型", PlatStateCode.FAILURE),
    FAILURE_REQ_PRM_NULL("CD001003", "请求参数不能为空", PlatStateCode.FAILURE),
    FAILURE_REQ_PRM_ERR("CD001004", "请求参数异常，请重试", PlatStateCode.FAILURE),
    FAILURE_REQ_LOGIN_OUT("CD001005", "登录超时，请重新登录", PlatStateCode.FAILURE),
    FAILURE_REQ_NOT_LOGIN("CD001006", "未登录，请登录操作", PlatStateCode.FAILURE),
    FAILURE_REQ_ERR("CD001007", "非法请求", PlatStateCode.FAILURE),
   ;

    private final String code;
    private final String desc;
    private final PlatStateCode state;

    PlatExceptionCode(String code, String desc, PlatStateCode state) {
        this.code = code;
        this.desc = desc;
        this.state = state;
    }

    public String getCode() {
        return code;
    }

    public String getDesc() {
        return desc;
    }

    public PlatStateCode getState() {
        return state;
    }

    public static PlatExceptionCode getByCode(String resCode) {
        if (resCode == null || resCode.length() == 0) {
            return null;
        }
        for (PlatExceptionCode each : values()) {
            if (each.getCode().equals(resCode)) {
                return each;
            }
        }
        return null;
    }

    @Override
    public String toString() {
        return "[" + code + ":" + desc + "]";
    }
}

如何使用？

使用AOP切面拦截对外接口，统一处理数据模板的封装

DataResultChange.java(数据模板AOP类):

/**
 * @Auther: 折戟沉沙
 * @Description: 统一处理对外接口 数据模板
 * @Version: 1.0
 */
@Aspect
@Component
public class DataResultChange {

    private Logger logger = LoggerFactory.getLogger(DataResultChange.class);

    @Around("execution(*  com.dofun.*..*Controller.*(..))")
    public Object logServiceAccess(ProceedingJoinPoint pjp) {
        Object result;
        try {
            result = pjp.proceed();
            if (!(result instanceof DataResult))
                result = new DataResult(result);// 默认成功,包装数据返回
        } 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);
            }
        }
        return result;
    }
}

DataResultChange类中通过@Around("execution(* com.dofun...Controller.*(..))")拦截到所有对外的接口方法。

  1. result = pjp.proceed();获取到拦截到的方法的返回数据报文。
  2. if (!(result instanceof DataResult))判断数据报文是否为我们定义的数据模板(DataResult)，如果不是，则执行封装操作。

以上1、2步骤就是拦截到接口，数据返回正常的步骤。(一般来说只有处理成功状态才会执行try块)

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

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

ServiceException.java(自定义业务异常类):

/**
 * @Auther: 折戟沉沙
 * @Description: 业务通用异常
 * @Version: 1.0
 */
public class ServiceException extends RuntimeException{

    private String code;

    public ServiceException(){}

    public ServiceException(String message){
        super(message);
    }

    public ServiceException(String code,String message){
        super(message);
        this.code = code;
    }

    /**
     * 平台错误代码枚举类
     */
    public ServiceException(PlatExceptionCode platExceptionCode){
        super(platExceptionCode.getDesc());
        this.code = platExceptionCode.getCode();
    }

    /**
     * 平台状态代码枚举类
     */
    public ServiceException(PlatStateCode platStateCode){
        super(platStateCode.getDesc());
        this.code = platStateCode.getCode();
    }

    public ServiceException(String message,Throwable e){
        super(message,e);
    }

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.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
    }
}

以上便是服务器日常开发中，如何去封装对外接口的数据模板，谢谢阅读！

转载于:https://www.cnblogs.com/jpfss/p/10724326.html

WGH100817
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
封装后提供外部访问方法
weixin_43358395的博客
07-06 397
private int a; public int getA() { return a; } public void setA(int a) { this.a = a; } 权限修饰 变量返回类型 get+大写变量名（）{ 有返回值 return 变量； } 权限修饰 Void set+大写变量名（变量类型 变量）{ this.变量 = 变量； } ...
异常处理，对外接口封装
Block_chain的博客
11-10 1428
异常统一捕获和处理，还有数据统一的封装。这个是在项目里面经常会用到。所以我写了一个。以供自己方便使用。当一个笔记的编写。 1、BaseExcpetion，是异常基本运行时异常。 package com.test.cn; /** * 封装运行时异常 * * @author BlockChain * */ public class BaseException extends Ru...
私人博客定制----封装数据库接口
LXY的博客
11-10 350
封装MySQLAPI 我们先把初始化句柄和断开句柄进行一个封装 static MYSQL* MySQLInit(){ //1.初始化一个Mysql句柄建立连接 MYSQL* connect_fd = mysql_init(NULL); //2.和数据库建立连接 if (mysql_real_conne...
服务接口统一返回的格式GOOD
Baple的专栏
10-25 1万+
表达，从简单开始。--《Robin Williams：写给大家看的设计书》 1.14.1 统一返回的格式 很明显地，默认情况下，我们选择了 JSON 作为统一的格式返回接口结果。这里简单说明一下选取JSON统一返回的原因： JSON当前很流行，且普通接口都采用此格式返回JSON在绝大部分开发语言中都支持，跨语言 JSON在浏览器浏览时，有可视化插件支持，如FF下： 1.
接口数据返回---标准格式
热门推荐
IT云清
11-11 3万+
在项目开发中，初期搭建框架时，定好通用的接口数据返回格式，定义好全局的状态码，是非常有必要的。一个项目，甚至整个公司，遵循同一套接口返回格式规范，这样可以极大的提高进度，降低沟通成本。
Disciplina-POO-2018.1
05-09
面向对象编程（OOP）是现代软件开发中的核心概念，它基于类和对象，强调数据封装、继承和多态等特性。Java 是一种广泛使用的OOP语言，它的设计目标是具有“写一次，到处运行”的跨平台能力。以下将详细介绍Java和OOP...
PHP短信接口
04-18
4. **处理响应**：接收服务器返回的数据，通常为JSON格式，解析并检查状态码和返回信息，判断发送是否成功。 5. **错误处理**：当请求失败或返回异常时，提供适当的错误提示和处理机制。 在实际开发中，为了保证...
拼多多java开发面试题
最新发布
07-25
- 抽象：提供抽象类或接口定义通用的行为模板。 2. **设计模式** - 设计模式是解决特定问题的最佳实践集合。 - 常见的设计模式有单例模式、工厂模式、装饰器模式、策略模式等。 - 单例模式确保一个类只有一个...
VB封装DLL教程_ASP
02-19
2. **编写函数和过程**：在类库中定义公共函数和过程，这些是DLL对外提供的接口。确保它们有正确的返回类型和参数，以便在ASP中正确调用。 3. **编译DLL**：完成代码编写后，编译VB项目生成DLL文件。这个文件将包含...
Spring-boot-backend--EmployeeManager:Spring Boot后端员工经理
04-01
1. RESTful API：系统对外提供RESTful API接口，使用HTTP动词（GET、POST、PUT、DELETE）和资源路径来操作员工数据。 2. 数据模型：设计`Employee`实体类，包含ID、姓名、职位、入职日期等属性，以及对应的...
对外接口的封装、混淆与打包Demo
02-02
http://blog.csdn.net/zhoup324/article/details/79236489
服务端返回接口格式的两种方法
weixin_30810583的博客
02-01 310
1、 　　@responseBody注解的作用是将controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML 　　数据，需要注意的呢，在使用此注解之后不会再走试图处理器，而是直接将数据写入到输入流中，他的效果等同于通过response对象输出指定格式的数据。 2、　　 　　@RequestMap...
Java 泛型
aozhao8862的博客
05-08 156
泛型类定义： public class Test<T> { private T body; public T getBody() { return body; } public void setBody(T body) { this.body = body; } } ...
数据报套接字——简单的回射服务器示例
include_heqile的博客
12-29 1035
文章目录ServerClient Server #define WIN32_LEAN_AND_MEAN #include &lt;windows.h&gt; #include &lt;winsock2.h&gt; #include &lt;ws2tcpip.h&gt; #include &lt;stdlib.h&gt; #include &lt;stdio.h&gt; #pragma comme...
SpringBoot统一接口返回信息格式
weixin_43135547的博客
10-23 1514
平常有时候写代码的时候发现很多不规范，包括公司代码也是， 就直接返回了！虽可用但给人感觉。。。。你懂得！还是得规范 关于SpringBoot统一接口返回信息格式： 1.定义一个返回信息的实体类： public class Msg { /*错误码*/ private Integer code; /*提示信息 */ private String msg; /*具体内容*/ private T data; public Integer getCode() { return code; } pub
1、接口返回数据和JSON详解
u013437812的博客
05-26 6966
一、接口返回的数据格式 1、Json格式(常用网站：www.bejson.com) JSON格式的数据一般包括三组数据：{error_code:0;msg:"返回信息";data:[ ] } error_code:错误码，0代表成功； msg:对错误码的中文说明； data:真正的返回数据 JSON数据的特点： （1）json就是一种数据类型：整数、小数、字符串...... （2）json数据由两部分组成： MAP对象，键值对：{key:value,key:value} 数组：[v
如何根据请求报文跟返回报文写webservice接口
qq_35783669的博客
11-24 997
不太明白怎么写，有没有高人指点一下迷津
【随笔】Java web 返回参数模板 Response
一个写了10年bug的程序员日常笔记。
11-06 1501
Java web 返回参数模板 Response public class Response&lt;T&gt; { private int version = 0; private int status = 0; private String errMsg = ""; /** @deprecated */ @Deprecated privat...
应用SDK与对外接口的封装、混淆与打包
andayoung
02-02 9167
从事Android开发久了不可避免的会接触对外接口的封装，下面本人就以自己写过的一个例子系统讲讲怎样对应用sdk的开发。 1.封装 我们在与其他公司合作的时候，往往会有技术方面的协作，但我们又不想过多的暴露我们某些技术方面的细节，比如：ip地址、技术参数、核心算法。 于是我们会对这部分代码进行封装，这部分需要精通Java的设计模式。 下面上传我的项目： 新建一个Android
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值