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接口返回的模板了;

总结

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

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

相关文章

  • idea设置@Author文件头注释的实现步骤

    idea设置@Author文件头注释的实现步骤

    本文主要介绍了idea设置@Author文件头注释的实现步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-07-07
  • Java LinkedList的实现原理图文详解

    Java LinkedList的实现原理图文详解

    今天小编就为大家分享一篇关于Java LinkedList的实现原理图文详解,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-01-01
  • Java实现储存对象并按对象某属性排序的几种方法示例

    Java实现储存对象并按对象某属性排序的几种方法示例

    这篇文章主要介绍了Java实现储存对象并按对象某属性排序的几种方法,结合实例形式详细分析了Java储存对象并按对象某属性排序的具体实现方法与操作注意事项,需要的朋友可以参考下
    2020-05-05
  • 解析Java格式字符串的使用

    解析Java格式字符串的使用

    本文通过实例给大家介绍了java格式字符串的使用,代码简单易懂,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2022-02-02
  • SpingMvc复杂参数传收总结

    SpingMvc复杂参数传收总结

    这篇文章主要为大家介绍了SpingMvc复杂参数传收总结,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08
  • 详解Springboot-MyBatis配置-配置端口号与服务路径(idea社区版2023.1.4+apache-maven-3.9.3-bin)

    详解Springboot-MyBatis配置-配置端口号与服务路径(idea社区版2023.1.4+apache-mav

    这篇文章主要介绍了Springboot-MyBatis配置-配置端口号与服务路径(idea社区版2023.1.4+apache-maven-3.9.3-bin),本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-07-07
  • java读取http请求中的body实例代码

    java读取http请求中的body实例代码

    下面小编就为大家带来一篇java读取http请求中的body实例代码。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-09-09
  • 使用Autowired为什么会被IDEA警告最佳修改方法

    使用Autowired为什么会被IDEA警告最佳修改方法

    这篇文章主要介绍了使用Autowired为什么会被IDEA警告,应该怎么修改最佳,除了使用@Autowired以外,我们其实也有几种好用的方式,使用@Resource替代@Autiwired方法是其中一种,只需要改变一个注解,这里就不展示了,需要的朋友可以参考下
    2023-02-02
  • MyBatis中正则使用foreach拼接字符串

    MyBatis中正则使用foreach拼接字符串

    这篇文章主要介绍了MyBatis中正则使用foreach拼接字符串,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-01-01
  • Java实现对中文字符串的排序功能实例代码

    Java实现对中文字符串的排序功能实例代码

    这篇文章主要介绍了Java实现中文字符串的排序功能实例代码的相关资料,需要的朋友可以参考下
    2016-04-04

最新评论