脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Java接口

Java接口统一样式返回模板简介

 更新时间：2019年10月31日 10:51:01   作者：web_bird  
这篇文章主要介绍了Java接口统一样式返回模板简介,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

这篇文章主要介绍了Java接口统一样式返回模板简介,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

背景

在进行接口开发时，一般需要一个固定的返回样式，成功和失败的时候，都按照这种格式来进行统一的返回，这样，在与其他人进行接口之间的联调时不会显得很杂乱无章。而这种固定的格式如果放在Java的每个接口单独处理时，又会在接口开发时很繁琐，所以这个时候可以采用封装一个实体类，统一返回固定模板格式的内容。

封装模板

先看一下没有封装之前，接口代码和返回格式：

/**
 * 用户修改
 * @return 返回修改的用户信息
 */
@PutMapping(value = "update")
public User update(@RequestBody User user) {
    User updatedUser = userService.update(user);
    return updatedUser;
}
{
  "userId": "0d67cfa7-f6a1-46b6-8e5a-b605afc98c44",
  "username": "ww",
  "password": "123456",
  "status": 0,
  "createTime": 310863886132307,
  "updateTime": 312955781619836
}

很显然，这种原始的内容返回虽然很直观，但是如果在发生错误的时候，那么接口的返回就比较的不自然了，甚至会将底层的错误对外暴露，下面介绍下一个简单的统一接口样式的封装：

枚举类ResponseCode：定义返回码code及提示信息msg

我们先定义一个枚举类，用于封装返回的code码和提示信息msg，当然也可以封装其他的信息，比如状态status，这个可以根据自己的项目自由选择。

package com.server.config;

/**
 * @Package com.server.config
 * @Author wuzy
 * @Date 2019/10/30 14:47
 * @Version V1.0
 * @Description: code码封装枚举类
 */

public enum ResponseCode {
  /** 成功 */
  SUCCESS("200", "成功"),

  /** 操作失败 */
  ERROR("500", "操作失败");

  private ResponseCode(String value, String msg){
    this.val = value;
    this.msg = msg;
  }

  public String val() {
    return val;
  }

  public String msg() {
    return msg;
  }

  private String val;
  private String msg;
}

封装类ResultData： 定义code、msg及数据data

再定义一个封装类ResultData，该类用于接口返回时的统一格式封装，这里，我们定义了三个属性，分别为状态码code，提示消息msg以及返回的数据data。下面是具体的代码：

package com.server.config;

import lombok.Data;

/**
 * @Package com.server.config
 * @Author wuzy
 * @Date 2019/10/30 14:38
 * @Version V1.0
 * @Description: 返回样式封装
 */
@Data
public class ResultData {

  private String code;

  private String msg;

  private Object data;

  public static ResultData success(Object data) {
    return resultData(ResponseCode.SUCCESS.val(), ResponseCode.SUCCESS.msg(), data);
  }

  public static ResultData success(Object data, String msg) {
    return resultData(ResponseCode.SUCCESS.val(), msg, data);
  }

  public static ResultData fail(String code, String msg) {
    return resultData(code, msg, null);
  }
  public static ResultData fail(String code, String msg, Object data) {
    return resultData(code, msg, data);
  }

  private static ResultData resultData(String code, String msg, Object data) {
    ResultData resultData = new ResultData();
    resultData.setCode(code);
    resultData.setMsg(msg);
    resultData.setData(data);
    return resultData;
  }
}

可以根据自己项目的需求进行方法、属性等内容的扩展。

测试实例

这里，我们使用UserController中的save()方法进行测试，查看其添加了统一样式之后的效果，先看下该方法：

  /**
   * 用户保存
   * @return 返回保存的用户信息
   */
  @PostMapping(value = "save")
  @ApiOperation(value = "保存用户信息", notes = "保存用户的详细信息")
  public ResultData save(@RequestBody User user) {
    try {
      User savedUser = null;
      if (user != null) {
        if (StringUtils.isEmpty(user.getUserId())) {
          user.setUserId(UUID.randomUUID().toString());
        }
        savedUser = userService.save(user);
                // int i = 1/0;  // 测试异常现象时放开这行代码
      }
      return ResultData.success(savedUser);
    } catch (Exception e) {
      e.printStackTrace();
      return ResultData.fail(ResponseCode.ERROR.val(), "用户保存过程中发生异常,请检查！");
    }
  }

先看一下成功（也就是调用success方法）的情况

{
 "code": "200",
 "msg": "成功",
 "data": {
   "userId": "0d67cfa7-f6a1-46b6-8e5a-b605afc98c44",
   "username": "ww",
   "password": "123456",
   "status": 0,
   "createTime": 310863886132307,
   "updateTime": 312955781619836
  }
}

再看一下发生异常或者保存失败时候的错误提示信息，这里使用1/0的异常来测试，结果如下：

{
 "code": "500",
 "msg": "用户保存过程中发生异常,请检查！",
 "data": null
}

到这里，基本上关于接口样式的模板也就介绍完了，如有不准确的地方，请留言多多指教。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

相关文章

  • Java 语言实现清除带 html 标签的内容方法

    Java 语言实现清除带 html 标签的内容方法

    下面小编就为大家带来一篇Java 语言实现清除带 html 标签的内容方法。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2017-02-02
  • Java GUI编程实现在线聊天室

    Java GUI编程实现在线聊天室

    这篇文章主要为大家详细介绍了Java GUI编程实现在线聊天室，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2018-07-07
  • java,android,MD5加密算法的实现代码(16位,32位)

    java,android,MD5加密算法的实现代码(16位,32位)

    下面小编就为大家带来一篇java,android,MD5加密算法的实现代码(16位,32位)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2016-09-09
  • Spring Boot使用AOP在指定方法执行完后执行异步处理操作

    Spring Boot使用AOP在指定方法执行完后执行异步处理操作

    这篇文章主要介绍了Spring Boot使用AOP在指定方法执行完后执行异步处理操作,本文通过实例代码给大家介绍的非常详细,需要的朋友可以参考下
    2024-06-06
  • SpringBoot大事务问题的常用优化方案

    SpringBoot大事务问题的常用优化方案

    大事务是指运行时间比较长,操作的数据比较多的事务123,大事务的产生原因包括操作的数据比较多、大量的锁竞争、事务中有其他非数据库的耗时操作等,本文给大家总结了SpringBoot大事务问题的常用优化方案,需要的朋友可以参考下
    2024-04-04
  • SpringBoot如何访问本地图片

    SpringBoot如何访问本地图片

    这篇文章主要介绍了SpringBoot如何访问本地图片问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-08-08
  • 详解Java中KMP算法的图解与实现

    详解Java中KMP算法的图解与实现

    KMP算法是一种神奇的字符串匹配算法，在对超长字符串进行模板匹配的时候比暴力匹配法的效率会高不少。本文将利用图解为大家详细讲解KMP算法的实现，需要的可以参考一下
    2022-05-05
  • Java回溯法解决全排列问题流程详解

    Java回溯法解决全排列问题流程详解

    从n个不同元素中任取m（m≤n）个元素，按照一定的顺序排列起来，叫做从n个不同元素中取出m个元素的一个排列。当m=n时所有的排列情况叫全排列。这篇文章主要介绍了Java回溯法解决全排列问题
    2022-10-10
  • Arrays.sort(arr)是什么排序及代码逻辑

    Arrays.sort(arr)是什么排序及代码逻辑

    在学习过程中观察到Arrays.sort(arr)算法可以直接进行排序，但不清楚底层的代码逻辑是什么样子，今天通过本文给大家介绍下Arrays.sort(arr)是什么排序，感兴趣的朋友一起看看吧
    2022-02-02
  • Springboot3.3 整合Cassandra 4.1.5的详细过程

    Springboot3.3 整合Cassandra 4.1.5的详细过程

    这篇文章主要介绍了Springboot3.3 整合Cassandra 4.1.5的详细过程,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧
    2024-06-06

最新评论