Java接口统一样式返回模板的实现

 更新时间:2019年12月04日 10:03:09   作者:Axe_Lai  
这篇文章主要介绍了Java接口统一样式返回模板的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

前言

一开始,我们在写项目的时候,前端要什么数据,我们就返回什么数据,每个接口也都写得不一样很乱;随着前后端的分离;对于代码规范的要求也越来越严谨;接口都是统一样式的返回模板;

下面,接受一种我之前用过的返回模板;

一、首先来看下我们的Controller接口

  /**
   * 获取用户信息
   * @param token 微信登入者token
   * @param id 商品id
   * @return 商品详细信息
   */
  @PostMapping(value = "getUserInfo")
  @ResponseBody
  public ResultResponse getUserInfo(
      @RequestParam(value = "token") String token){
    ResultResponse result = new ResultResponse();
    //这里获取用户信息的类就不贴出来了
    User user = userService.getUserByToken(token);
    result.setData(user );
    return result.setStatus(ResponseCode.SUCCESS);
  }

我们可以看出,接口返回的是ResultResponse类;下面来剖析这个类;

二、统一样式返回模板ResultResponse剖析

2.1ResultResponse类:

package com.himo.common;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.Data;

/**
 * @Author: laixiansong
 * @Description: http请求
 * @Vesion: 1.0.0
 * @Date: 2017/10/17
 */
@Data
public class ResultResponse<T> {

  /** 错误码 */
  private Integer code;
  /** 错误信息 */
  private String msg;

  @JsonInclude(JsonInclude.Include.NON_NULL)
  private T data;

  public void setData(T data) {
    this.data = data;
  }
  public ResultResponse setStatus(ResponseCode responseCode){
    this.code = responseCode.getCode();
    this.msg = responseCode.getDesc();
    return this;
  }
  public String getMsg() {
    return msg;
  }
}

ResultResponse类包含了错误码、错误信息、返回的对象json;

2.2枚举类

从ResultResponse类中我们可以看出,错误码和错误信息是一一对应的,我们用一个枚举类ResponseCode来封装;

ResponseCode:

package com.himo.common;
/**
 * @Author: laixiansong
 * @Description:
 * @Vesion: 1.0.0
 * @Date: 2017/10/17
 */
public enum ResponseCode {
  SUCCESS(0,"SUCCESS"),
  ERROR(1,"ERROR"),
  REQUEST_PARAMS_ERROR(1003,"请求参数错误"),
  NOT_WX_LOGIN(1004,"非微信端登录"),
  WX_LOGIN_PARAMS_ERROR(1005,"微信登录code错误"),
  NO_LOGIN(1006,"登录状态失效"),
   ;
  private final int code;
  private final String desc;
  ResponseCode(int code, String desc){
    this.code = code;
    this.desc = desc;
  }
  public int getCode() {
    return code;
  }
  public String getDesc() {
    return desc;
  }
}

我们可以在枚举类中加入我们想要增加的错误信息和错误码;

这样就是一个完成的Java接口返回的模板了;

总结

技术在不断更新换代,但是它的基础没有变,要想更好的维护项目,使得代码更加的美观和正规,所有接口统一返回统一类是非常有必要的;

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

相关文章

  • java实现国产sm4加密算法

    java实现国产sm4加密算法

    这篇文章主要介绍了java实现国产sm4加密算法的步骤,帮助大家更好的理解和使用Java,感兴趣的朋友可以了解下
    2020-12-12
  • Java中字符编码格式详解

    Java中字符编码格式详解

    在java应用软件中,会有多处涉及到字符集编码,有些地方需要进行正确的设置,有些地方需要进行一定程度的处理。本文主要给大家讲解java中字符的编码格式等相关问题
    2016-03-03
  • Spring Boot @Async 异步任务执行方法

    Spring Boot @Async 异步任务执行方法

    本篇文章主要介绍了Spring Boot @Async 异步任务执行方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-05-05
  • 解决idea中Terminal终端无法执行GIT命令+Terminal 中文乱码问题

    解决idea中Terminal终端无法执行GIT命令+Terminal 中文乱码问题

    这篇文章主要介绍了解决idea中Terminal终端无法执行GIT命令+Terminal 中文乱码问题,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-07-07
  • Spring Boot之搞定mongoTemplate的知识小结

    Spring Boot之搞定mongoTemplate的知识小结

    这篇文章主要介绍了Spring Boot之搞定mongoTemplate的知识小结,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-12-12
  • Java处理Markdown格式转换为Word文档

    Java处理Markdown格式转换为Word文档

    这篇文章主要为大家详细介绍了如何使用Java实现处理Markdown格式转换为Word文档,文中的示例代码讲解详细,感兴趣的小伙伴可以参考一下
    2025-03-03
  • JavaWeb如何实现本地文件上传功能

    JavaWeb如何实现本地文件上传功能

    这篇文章主要介绍了JavaWeb如何实现本地文件上传功能,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-02-02
  • 详解Spring中@Valid和@Validated注解用法

    详解Spring中@Valid和@Validated注解用法

    本文将以新增一个员工为功能切入点,以常规写法为背景,慢慢烘托出 @Valid 和 @Validated 注解用法详解,文中的示例代码讲解详细,感兴趣的可以了解一下
    2022-07-07
  • Java Spring 循环依赖解析

    Java Spring 循环依赖解析

    这篇文章主要介绍了Java Spring 循环依赖解析,Spring 现在其实是我们 Java 程序开发离不开的基础框架,个人觉得除了 JDK 我们用得最多的 Java 中间件就是 Spring ,今天我们一起来学习一下 Spring 的循环依赖。下面详细内容需要的小伙伴可以参考一下
    2022-02-02
  • Java Session验证码案例代码实例解析

    Java Session验证码案例代码实例解析

    这篇文章主要介绍了Java Session验证码案例代码实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06

最新评论