互联网公司接口统一返回

简介: 互联网公司接口统一返回

互联网公司接口统一返回


版本说明

spring-boot=2.2.5.RELEASE


相关链接



接口统一返回

CommonResponse

package top.simba1949.response;
import lombok.AllArgsConstructor;
import lombok.Data;
/**
 * @Author Theodore
 * @Date 2020/3/20 15:55
 */
@Data
@AllArgsConstructor
public class CommonResponse {
    /** 请求结果 */
    private Boolean status;
    /** 错误码,当 status=false 时,需要设置 */
    private ErrorCode errorCode;
    /** 信息,当 status=false 时,存储错误信息;也可以存储其他信息 */
    private String message;
    /** 返回数据 */
    private Object data;
}

ErrorCode

package top.simba1949.response;
/**
 * @Author Theodore
 * @Date 2020/3/20 16:14
 */
public enum ErrorCode {
    SYSTEM_SUCCESS("0000000", "成功"),
    SYSTEM_FAILURE("0000001", "系统异常")
    ;
    private String code;
    private String message;
    ErrorCode(String code, String message) {
        this.code = code;
        this.message = message;
    }
    public String getCode() {
        return code;
    }
    public void setCode(String code) {
        this.code = code;
    }
    public String getMessage() {
        return message;
    }
    public void setMessage(String message) {
        this.message = message;
    }
}


ResponseBuilder

package top.simba1949.response;
/**
 * @Author Theodore
 * @Date 2020/3/20 16:40
 */
public class ResponseBuilder {
    /**
     * 成功:无数据返回
     * @return
     */
    public static CommonResponse buildSuccess(){
        return new CommonResponse(true, null, null, null);
    }
    /**
     * 成功:有数据返回
     * @param data
     * @return
     */
    public static CommonResponse buildSuccess(Object data){
        return new CommonResponse(true, null, null, data);
    }
    /**
     * 失败:无数据返回
     * @param errorCode
     * @param message
     * @return
     */
    public static CommonResponse buildFailure(ErrorCode errorCode, String message){
        return new CommonResponse(false, errorCode, message, null);
    }
    /**
     * 失败:有数据返回
     * @param errorCode
     * @param message
     * @param data
     * @return
     */
    public static CommonResponse buildFailure(ErrorCode errorCode, String message, Object data){
        return new CommonResponse(false, errorCode, message, data);
    }
}


目录
相关文章
|
5月前
|
消息中间件 缓存 运维
云his系统源码 SaaS应用 功能易扩 统一对外接口管理
运营运维 系统运维、综合监管、系统运营
81 1
|
5月前
|
安全 C# 开发者
C#中的默认接口方法:接口演化的新篇章
【1月更文挑战第11天】本文探讨了C# 8.0中引入的默认接口方法,这一特性允许在接口中定义具有默认实现的方法。文章介绍了默认接口方法的语法、使用场景,以及它们如何影响接口的设计和实现,同时讨论了默认接口方法带来的好处和潜在的陷阱。
|
3月前
|
存储 调度 数据库
软件研发核心问题之数据从哪里来,主要包括哪些类型的数据的问题如何解决
软件研发核心问题之数据从哪里来,主要包括哪些类型的数据的问题如何解决
|
4月前
|
自然语言处理 搜索推荐 安全
电商 API 接口:连接数字商业的关键纽带
**电商API接口是商业世界的隐形支柱,连接电商平台、应用和服务,确保高效运行和创新。它们促进用户体验提升(如实时库存、安全支付),拓展业务功能(如个性化推荐、智能客服),加速数据流通分析,并增强系统灵活性。随着技术进步,AI、大数据和物联网将使API接口更加智能、安全,成为电商在全球化竞争中的关键优势。**
|
5月前
|
分布式计算 运维 并行计算
OneData是阿里巴巴内部进行数据整合及管理的方法体系和工具
OneData是阿里巴巴内部进行数据整合及管理的方法体系和工具
469 2
|
架构师 API 开发者
为什么 API 治理需要内部倡导?
要做 API 治理就要将 API 作为数字资产来管理。就像一个人如果要投资理财,就必须先清楚自己有多少可利用的资金和资源。何况 API 作为新时代最重要的数据和服务入口,值得企业和团队投入更多的精力来关注它。第一件事情就是要全面整理公司内部的 API 资产清单,否则后续的 API 治理工作都会化为空谈。
83 0
|
缓存 监控 DataWorks
巧用API网关构建大型应用体系架构
近期阿里云重磅发布了BizWorks一体化的云原生应用的开发和运营平台,内置阿里巴巴业务中台构建的最佳技术实践。它已经将API网关作为关键组件融入其中,并且基于API网关为用户提供能力开放平台。那么API网关是如何在BizWorks中起到作用?API网关在实际业务中又起到怎样帮助?本文就此展开详细说明。
315 0
统一结果返回
统一结果返回,可参考
66 0
|
JSON 前端开发 数据格式
微服务项目:尚融宝(9)(后端接口:统一返回结果)
项目中我们会将响应封装成json返回,一般我们会将所有接口的数据格式统一, 使前端对数据的操作更一致、轻松。 一般情况下,统一返回数据格式没有固定的格式,只要能描述清楚返回的数据状态以及要返回的具体数据就可以。但是一般会包含 状态码、返回消息、数据 这几部分内容
微服务项目:尚融宝(9)(后端接口:统一返回结果)
老项目改造返回值规范化
已经运行的项目,开始由于赶工期等因素,未做统一的接口返回规范。现在要做规范化,还必须要保留原先的接口,尤其是APP的接口,有的版本会存在一个比较长的时间。因此需要保留两个版本,又不想维护两套代码。
98 0