AgileBoot 项目内统一的错误码设计分析

目录
  • 引言
  • 统一的错误码管理的优点
  • 无错误码设计的缺陷
    • Ruoyi项目
    • 错误码的层级
    • 错误码的模块
    • 错误码代码例子
    • 错误码的使用
    • 该错误码的设计缺陷

引言

本篇文章主要探讨关于统一错误码的设计,并提供笔者的实现

欢迎大家讨论,指正。

该错误码的设计在仓库:

github:github.com/valarchie/A…

gitee:gitee.com/valarchie/A…

统一的错误码管理的优点

  • 统一的错误码描述,如果没有统一的错误码的话,错误描述散落在项目内的不同地方,同一个错误码却产生不同的错误描述,会导致歧义。
  • 错误码的层级,在与客户端的交互过程中,我们可能需要根据错误的层级,来做不同的显示。例如系统内部的错误,我们产生红色的警告框。业务上操作类型的错误(例如用户名不能超过64位),我们 则以正常的黄色提示框来提醒用户。
  • i18n的处理。统一的错误码管理,才使得国际化更好实现。我们可以给每一种错误码定义唯一的key,来找到对应不同语言的错误描述。
  • 集中的错误码管理便于形成文档供调用者参考。例如我们提供接口给其他团队调用,可以提供给他们详细的错误码列表。

无错误码设计的缺陷

Ruoyi项目

  • 错误描述散落在项目的各个地方,一旦有改变错误描述的需求,要满项目去寻找关联的错误描述,然后逐一修改。这种情形很容易造成疏漏。
  • 如果需要翻译的话,这种随意的字符串形式也很难去做国际化翻译。
  • 没有准确的错误码,在一些情形下,调用方需要根据你返回的错误码进行不同的处理。如果没有准确的错误码,仅凭错误描述,比较难以实现。

错误码的层级

错误码的层级有助于客户端对于不同级别的错误进行处理。比如有的错误进行隐藏,有的错误直接暴露给用户。这边我规划了四层错误码。 错误码集合

  • 1~9999 为保留错误码 或者 常用错误码
  • 10000~19999 为内部错误码
  • 20000~29999 客户端错误码 (客户端异常调用之类的错误)
  • 30000~39999 为第三方错误码 (代码正常,但是第三方异常)
  • 40000~49999 为业务逻辑 错误码 (无异常,代码正常流转,并返回提示给用户)

错误码的模块

为了更好的分门别类,笔者给错误码设定了模块,便于客户端的特殊处理。例如客户端可以专门给某一个模块的错误进行一个统一的处理。 模块对应的数字在千位和百位。例如1XX01,XX代表了模块的意义。

/**
 * 系统内的模块
 */
public enum Module {
    /**
     * 普通模块
     */
    COMMON(0),
    /**
     * 权限模块
     */
    PERMISSION(1),
    /**
     * 登录模块
     */
    LOGIN(2),
    /**
     * 数据库模块
     */
    DB(3),
    /**
     * 上传
     */
    UPLOAD(4),
    /**
     * 用户
     */
    USER(5),
    /**
     * 配置
     */
    CONFIG(6),
    /**
     * 职位
     */
    POST(7),
    ;
    private final int code;
    Module(int code) { this.code = code * 100; }
    public int code() {return code; }
}

错误码代码例子

/**
     * 10000~19999是内部错误码  例如 框架有问题之类的
     */
    public enum Internal implements ErrorCodeInterface {
        /**
         * 内部错误码
         */
        INVALID_PARAMETER(Module.COMMON, 1, "参数异常"),
        UNKNOWN_ERROR(Module.COMMON, 2, "未知异常, 请查看系统日志"),
        GET_ENUM_FAILED(Module.COMMON, 3, "获取枚举类型失败, 枚举类: {}"),
        GET_CACHE_FAILED(Module.COMMON, 4, "获取缓存失败"),
        LOGIN_CAPTCHA_GENERATE_FAIL(Module.LOGIN, 1, "验证码生成失败"),
        INVALID_TOKEN(Module.PERMISSION, 1, "token异常"),
        DB_INTERNAL_ERROR(Module.DB, 1, "数据库异常: {}"),
        ;
        private final int code;
        private final String msg;
        private static final int BASE_CODE = 10000;
        Internal(Module module, int code, String msg) {
            this.code = BASE_CODE + module.code() + code;
            this.msg = msg;
        }
        @Override
        public int code() {
            return this.code;
        }
        @Override
        public String message() {
            return this.msg;
        }
    }

错误码的使用

为了便于错误码在编写代码时方便使用,我创建了ErrorCode这个类,并将四个层级的错误类一并放进这个类当中。

代码中的例子

 if (roleService.checkRoleNameUnique(getRoleId(), getRoleName())) {
            throw new ApiException(ErrorCode.Business.ROLE_NAME_IS_NOT_UNIQUE, getRoleName());
 }

通过这样的形式进行调用:ErrorCode.Business.ROLE_NAME_IS_NOT_UNIQUE

该错误码的设计缺陷

缺陷在于:

  • 一个模块内的错误码上线是100个。 解决该问题的话,有两种形式。一是:尽量设计比较通用的错误码,粒度过细会导致错误码不够用。二是:使用重复的模块,比如原来User模块,再起一个User2模块。

探讨关于错误码的设计,欢迎小伙伴留言评论指正。

Any corrections or suggestions are appreciated.

Agileboot是一个致力于规范、质量,健壮的前后端开发脚手架。

以上就是AgileBoot 项目内统一的错误码设计分析的详细内容,更多关于AgileBoot 项目内统一错误码的资料请关注我们其它相关文章!

(0)

相关推荐

  • laravel返回统一格式错误码问题

    背景 最近在学习开发一个安卓项目,后端接口项目开始用PHP的Yii2.0框架新启了个项目,后换成laravel5.5,最近看到laravel升级了新版本,于是又将项目更新到laravel6.4 在使用yii和laravel的过程中,两个框架对web-api都非常友好,也都对restful做了不同程度的支持,但是还是遇到了一些问题,下面以laravel6.4为例,简单描述下我遇到的问题. 问题一:访问接口返回页面代码 最典型的就是laravel new 一个项目后,在浏览器直接访问localhos

  • java使用枚举封装错误码及错误信息详解

    目录 枚举封装错误码及错误信息 用法如下 封装返回结果类和枚举错误码 枚举错误码 封装返回结果类 枚举封装错误码及错误信息 使用枚举类型来封装project中所需要的错误码和错误信息,十分方便. 用法如下 package com.dear.simpler.dbservice; /** * * @author lixiang *使用枚举类型来封装异常码和异常信息 * */ public enum DBServiceError { //RPC层调用错误码 DB_SERVICE_OK(20100,"服

  • HTTP请求返回415错误码定位解决方法

    今天在工作中,发现我再调用外部API接口的时候,发现一个奇怪的问题,就是我Eclipse中写代码调用外部API接口时返回HTTP状态码是415,但是我将相同的报文放在HttpRequester里面请求的时候却又可以拿到正常返回结果,而不是415错误. 不知道有没有人跟我一样遇到过这个问题,这里记录一下解决办法. 首先我们还是看下HTTP的状态码关于415返回码的说明吧. 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式 乍看之下,当时并没有看出来是什么意思,

  • php curl返回错误码60如何解决

    今天有用户调用一个curl方法时,遇到如下的错误,查找了一些资料终于解决了.解决方法记录一下,留着自己以后自已查阅用. 错误代码 cURL error 60: SSL certificate problem: unable to get local issuer certificate 自定义接管错误输出后,可能如下显示 cURL error 60 错误 curl code ERROR 60错误 错误原因 curl 配置中开启了证书校验 就是使用了以下配置 curl_setopt($ch, CU

  • Laravel手动返回错误码示例

    设想到一个情景,如果新增数据库时用户提交的数据正确,也就是通过了验证,但是添加数据库时发生错误,比如: if(!$users->save()){ //新增数据库时发生错误 } 那么需要返回错误信息,这个时候怎么手动呢?找到了一个函数,特此记录,感觉够用了: $errors=array( 'message'=>"新增数据库发生错误,请稍后再试" ); // $errors 定义返回的错误信息 // 422 表示返回该信息的状态码 return new JsonResponse

  • 服务器错误码500 501 502 503 504 505 详解

    服务器会经常的出现错误,那么在平时的时候出现了服务器错误,我们要如何去解决了,今天小编就简单的说说服务器500错误.501错误.502错误.503错误.504错误.505错误的一些问题所在. 1.服务器500错误.500错误的出现原因是很多的,但是你要知道,500错误是服务器内部错误,而且一般程序上是ASP错误为多的,可能是你的用户权限的问题导致,或者是数据库连接出现了错误,那么要好好检查下服务器语句错误问题. 2.服务器501错误.服务器501错误是服务器还是不具有请求功能的,而且501错误原

  • AgileBoot 项目内统一的错误码设计分析

    目录 引言 统一的错误码管理的优点 无错误码设计的缺陷 Ruoyi项目 错误码的层级 错误码的模块 错误码代码例子 错误码的使用 该错误码的设计缺陷 引言 本篇文章主要探讨关于统一错误码的设计,并提供笔者的实现 欢迎大家讨论,指正. 该错误码的设计在仓库: github:github.com/valarchie/A… gitee:gitee.com/valarchie/A… 统一的错误码管理的优点 统一的错误码描述,如果没有统一的错误码的话,错误描述散落在项目内的不同地方,同一个错误码却产生不同

  • Spring Cloud Feign 自定义配置(重试、拦截与错误码处理) 代码实践

    基于 spring-boot-starter-parent 2.1.9.RELEASE, spring-cloud-openfeign 2.1.3.RELEASE 引子 Feign 是一个声明式.模板化的HTTP客户端,简化了系统发起Http请求.创建它时,只需要创建一个接口,然后加上FeignClient注解,使用它时,就像调用本地方法一样,作为开发者的我们完全感知不到这是在调用远程的方法,也感知不到背后发起了HTTP请求: /** * @author axin * @suammry xx 客

  • SpringBoot validator参数验证restful自定义错误码响应方式

    目录 validator参数验证restful自定义错误码响应 一.定义restful统一结果返回 二.定义一个错误码枚举 三.静态封装CommonResult 四.定义BaseController来处理验证错误自定义错误码返回 五.验证实例 小结一下 使用validator-api验证springboot的参数 一.这个方法在网上大部分都可以查到 二.针对上面的例子 三.估计到了这里又会有人问 validator参数验证restful自定义错误码响应 关于spring web应用中关于如何使用

  • Spring Boot 如何自定义返回错误码错误信息

     说明 •在实际的开发过程中,很多时候要定义符合自己业务的错误码和错误信息,而不是统一的而不是统一的下面这种格式返回到调用端 INTERNAL_SERVER_ERROR(500, "Internal Server Error"), 下面我们来看看如何将我们自定义的错误码和错误信息返回到调用端. 1 自定义错误码 •首先我们要定义一个枚举类 public enum ErrorEnum { /* * 错误信息 * */ E_20011(20011, "缺少必填参数"),

  • 微信支付 :curl出错,错误码:60两个问题的解决

    如下是运行微信支付测试代码时出错代码: Warning: curl_setopt() expects parameter 2 to be long, string given in D:\wwwroot\weixinpaytest\pay\WxPay.JsApiPay.php on line 99   Fatal error: Uncaught exception 'WxPayException' with message 'curl出错,错误码:60' in D:\wwwroot\weixin

  • SQLite 错误码整理

    复制代码 代码如下: #define SQLITE_OK           0   /* 成功 | Successful result *//* 错误码开始 */#define SQLITE_ERROR        1   /* SQL错误 或 丢失数据库 | SQL error or missing database */#define SQLITE_INTERNAL     2   /* SQLite 内部逻辑错误 | Internal logic error in SQLite */#

  • 微信企业号 根据错误码返回错误信息类封装

    微信企业号根据错误码返回错误信息类封装 微信开发中返回错误码每次需要查询错误返回码文档才知道具体的错误信息(查看返回的errormsg也可知道),因此封装一个 错误码返回的类来查看! 纯粹的体力劳动!!! <span style="font-size:14px;">package org.oms.wechat.utils; /** * 企业号根据错误码返回错误信息类 * @author sunlight * */ public class ErrorCodeText { p

  • 安装SQL2005 29506错误码的解决方案

    在windows7下安装SQL2005时会提示不兼容,需要安装SQL2005 SP3或更高的版本,不用管它,一路安装下去,等装完在开始菜单没有SQL Server Management Studio. 没关系,只要下载微软的"SQL Server Management Studio Express"就能解决 (地址是http://www.microsoft.com/downloads/details.aspx?displaylang=zh-cn&FamilyID=c243a5a

  • IIS卸载后重装时提示:安装程序无法复制一个或多个文件 特定错误码是 0xe0000233

    IIS卸载后重装时提示: --------------------------- Windows 安装程序 --------------------------- 安装程序无法复制一个或多个文件.特定错误码是 0xe0000233.按"确定"以继续:或者按"取消",停止安装并且再试一次.如果继续,组件可能无法正常运行. --------------------------- 确定 取消 --------------------------- 网上找的解决办法都是说没

随机推荐