SpringBoot定义优雅全局统一Restful API 响应框架四

如果没有看前面几篇文章请先看前面几篇

SpringBoot定义优雅全局统一Restful API 响应框架

SpringBoot定义优雅全局统一Restful API 响应框架二

SpringBoot定义优雅全局统一Restful API 响应框架三

目前我们好像似乎解决所有问题,达到了我们理想的效果如下

SpringBoot定义优雅全局统一Restful API 响应框架四

但是在业务错误返回时候不太理想如下

SpringBoot定义优雅全局统一Restful API 响应框架四

没有必要返回 reuqesterrorMsg

还有如果业务非常复杂的时候,会不会出现错误码分配使用混乱和重复问题这个问题应该如何避免和解决呢?

这个时候我想到 使用业务错误常量来代替错误码,这样更加见字识意, 进一步抽象错误常量公共接口模块

package cn.soboys.springbootrestfulapi.common.error;

import java.util.List;

/**
 * @author 公众号 程序员三时
 * @version 1.0
 * @date 2023/5/9 20:14
 * @webSite https://github.com/coder-amiao
 * 定义错误常量 代替错误码,避免业务复杂错误码分配重复等问题
 */
public interface CommonErrorConstant {
    /**
     * 公共错误码定义
     */
    public static final String InvalidRequest = "InvalidRequest";
    public static final String InvalidArgument = "InvalidArgument";
    public static final String NotFound = "NotFound";
    public static final String UnknownError = "UnknownError";
    public static final String OK = "OK";
    public static final String FAIL = "FAIL";



    /**
     * 其他自定义业务错误码
     */



}

通用错误码

package cn.soboys.springbootrestfulapi.common.error;

import cn.soboys.springbootrestfulapi.common.resp.ResultCode;

/**
 * @author 公众号 程序员三时
 * @version 1.0
 * @date 2023/5/2 21:36
 * @webSite https://github.com/coder-amiao
 */
public enum CommonErrorCode implements ResultCode {

    /**
     * 错误请求
     */
    INVALID_REQUEST(false, CommonErrorConstant.InvalidRequest, "Invalid request, for reason: "),
    /**
     * 参数验证错误
     */
    INVALID_ARGUMENT(false, CommonErrorConstant.InvalidArgument, "Validation failed for argument "),
    /**
     * 未找到资源
     */
    NOT_FOUND(false, CommonErrorConstant.NotFound, "Resource  not found."),
    /**
     * 未知错误
     */
    UNKNOWN_ERROR(false, CommonErrorConstant.UnknownError, "Unknown server internal error.");


    CommonErrorCode(Boolean success, String code, String message) {
        this.success = success;
        this.code = code;
        this.message = message;

    }

    /**
     * 响应是否成功
     */
    private Boolean success;
    /**
     * 响应状态码
     */
    private String code;
    /**
     * 响应信息
     */
    private String message;


    @Override
    public String getCode() {
        return code;
    }

    @Override
    public String getMessage() {
        return message;
    }

    @Override
    public boolean getSuccess() {
        return success;
    }


}

正常请求

SpringBoot定义优雅全局统一Restful API 响应框架四

错误请求

  1. 调整后的业务异常
    SpringBoot定义优雅全局统一Restful API 响应框架四

  2. 调整未知错误异常

SpringBoot定义优雅全局统一Restful API 响应框架四

对应代码已经上传更新github
SpringBoot定义优雅全局统一Restful API 响应框架四

在留一下一个思考问题,如果接口错误需要国际化应该如何实现?

如果你觉得对您有帮助关注公众号,程序员三时 我会给大家不定期分享热门技术,做开源项目,技术交流,面试,学习,分享自己入行多年一些感受和经验

原文链接:https://www.cnblogs.com/kenx/p/17387625.html

本站文章如无特殊说明,均为本站原创,如若转载,请注明出处:SpringBoot定义优雅全局统一Restful API 响应框架四 - Python技术站

(0)
上一篇 2023年5月10日
下一篇 2023年5月10日

相关文章

  • Spring Boot异步线程间数据传递的四种方式

    下面让我来详细解释一下Spring Boot异步线程间数据传递的四种方式。 1. 使用CompletableFuture CompletableFuture是Java8中推出的异步编程API,可以很好的处理异步任务,同时也提供了一些方法来实现线程间的数据传递。 使用CompletableFuture来传递数据,主要有以下两个方法: CompletableFu…

    Java 2023年5月26日
    00
  • 利用Hadoop实现求共同好友的示例详解

    利用Hadoop实现求共同好友需要以下几个步骤: 划分好友关系 拆分好友关系,生成单向二元组 合并具有相同好友的二元组 在合并结果中找到共同好友 下面的示例中,我们假设有三个人A、B、C,他们之间的好友关系如下所示: A的好友:B、C、D B的好友:A、C、E C的好友:A、B、D、E 使用Hadoop来实现求A和B的共同好友和A和C的共同好友。 划分好友关…

    Java 2023年5月20日
    00
  • Java整合Jackson实现反序列化器流程

    Java整合Jackson实现反序列化器的流程包括以下几个步骤: 引入Jackson库 在项目中引入Jackson库,可以选择maven或gradle方式引入,也可以手动下载该库并引入到项目中。 以下是pom.xml文件中使用maven引入Jackson库的示例: <!–引入Jackson库–> <dependency> <…

    Java 2023年5月26日
    00
  • 基于java中的PO VO DAO BO POJO(详解)

    “基于java中的PO VO DAO BO POJO(详解)” 这个话题是讲解Java中常用于开发的一些设计模式和编程技术。在下面的回答中,我会逐一介绍PO、VO、DAO、BO、POJO的概念和用法,并且会提供两个示例来展示这些技术的实际应用。 PO PO(Persistent Object)是指持久化对象,它对应数据库中的一张表中的一条记录。PO中的每个字…

    Java 2023年5月20日
    00
  • JAVA StringBuffer类与StringTokenizer类代码解析

    JAVA StringBuffer类与StringTokenizer类代码解析 StringBuffer类 StringBuffer类是java中的一个类,位于java.lang包中。该类用于提供可变的字符串,它的长度和内容可以随时改变。在字符串频繁变化的应用场景下,使用StringBuffer相较于直接操作String具有更好的性能表现。 StringBu…

    Java 2023年5月26日
    00
  • MyBatis动态SQL表达式详解

    MyBatis动态SQL是针对不同情况下需要根据不同条件动态调整SQL语句的需求而产生的一种功能,具有很强的灵活性和可读性。其中动态SQL表达式是实现动态SQL的关键,本文将解析MyBatis中动态SQL表达式的使用方法和一些示例。 什么是MyBatis动态SQL表达式 MyBatis动态SQL表达式一般用于编写可动态调整SQL的Mapper文件,可以根据不…

    Java 2023年5月19日
    00
  • Java多线程实现Callable接口

    Java多线程实现Callable接口攻略 在Java程序中,使用多线程可以增加程序的并发处理能力,提升程序的性能。Callable接口是Java提供的一种实现多线程的方式,相比Runnable接口,它具备更强的返回值类型、异常处理和线程中断能力。本篇攻略将介绍Java多线程实现Callable接口的完整过程及示例说明。 一、接口说明 1. Callable…

    Java 2023年5月18日
    00
  • SpringBoot 整合jdbc和mybatis的方法

    以下是SpringBoot整合jdbc和mybatis的方法的完整攻略: 前置要求 在进行SpringBoot整合jdbc和mybatis之前,需要确保已满足以下要求: 已安装好JDK,并配置好环境变量。 已安装好Maven。 已安装好MySQL,创建好了相应的数据库和表,并记录下来数据库的连接信息。 建立SpringBoot项目 首先,需要新建一个Spri…

    Java 2023年5月20日
    00
合作推广
合作推广
分享本页
返回顶部