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

最新推荐文章于 2024-12-27 10:24:12 发布
最新推荐文章于 2024-12-27 10:24:12 发布
阅读量248 收藏
点赞数
文章标签： mybatis spring boot java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_47367099/article/details/127420412
版权
本文探讨了在项目中采用统一错误码设计的优势，包括消除错误描述歧义、支持错误码层级以适应不同显示需求、简化i18n处理以及方便文档编制。同时，文章介绍了错误码的层级规划，如内部错误、客户端错误、第三方错误和业务逻辑错误，并提出了模块化的错误码管理。最后，作者提到了当前设计存在的问题，即错误码数量限制，以及可能的解决方案。
摘要由CSDN通过智能技术生成

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

欢迎大家讨论，指正。

该错误码的设计在仓库：

github:GitHub - valarchie/AgileBoot-Back-End: 基于Ruoyi做了大量重构优化的基础快速开发框架。采用Springboot + Vue 3 + Mybatis Plus + 更面向对象的业务建模 + 面向生产的项目。（非玩具项目）
gitee:AgileBoot-Back-End: 基于Ruoyi做了大量重构优化的基础快速开发框架。采用Springboot + Vue 3 + Mybatis Plus + 更面向对象的业务建模 + 面向生产的项目。（非玩具项目）

统一的错误码管理的优点

  1. 统一的错误码描述，如果没有统一的错误码的话，错误描述散落在项目内的不同地方，同一个错误码却产生不同
最低0.47元/天 解锁文章
AgileBoot - 基于SpringBoot + Vue3的前后端快速开发脚手架
Huangjiazhen711的博客
10-11 905
AgileBoot这个项目的建立是因为闲暇时间想自己捣鼓一点小东西，于是当时网上找了很多快速开发脚手架。比如Ruoyi/Jeecg-boot/ElAdmin/renren等框架。芋道也弄了一个Ruoyi-Pro的项目，但是功能一大堆，太重了，可能质量得不到保证。最后选择了Ruoyi框架作为自己开发一些小东西的脚手架。但是当我把Ruoyi项目翻了一遍之后。发现项目的代码水平和质量都… emm… 有点不像一个专业后端人员开发出来的项目。于是乎我基于Ruoyi项目，整个进行了重构。
错误代码的设计!
孤独是因为思念谁
02-02 1735
shipatrioc http://www.jdon.com Dec 3, 2004 8:04 PM 回复 是这样在系统中web端最终给客户的错误提示是根据这样一个class来显示的.public class ErrorCode { /**错误代码*/ private String code; /**错误名称*/ private String name; /*
错误码设计
weixin_30633949的博客
06-23 422
1. 获取错误码描述信息 2. 获取错误码字符串表示 /**统一格式：A-BB-CC A:错误级别，如1代表系统级错误，2代表服务级错误; B:项目或模块名称; C:具体错误编号*/ /**错误代码说明 (20502) 2: 服务级错误（1为系统级错误） 05: 服务模块代码 02: 具体错误代码*/ #d...
统一错误码示例
lingchen1120的博客
12-19 587
定义枚举类，实现错误码的统一定义 实现错误码的统一定义，方便管理，也避免出现代码中出现很多字面量和字面值。 /** * @Author 凌宸 * @create 2021-12-16 下午 5:12 * @Description * @Version 1.0 */ public enum ErrorCode { PARAMS_ERROR(10001,"参数有误"), ACCOUNT_PWD_NOT_EXIST(10002,"用户名或密码不存在"), TOKEN_ILLE
75.错误码设计、实现统一异常处理和封装统一返回结果
YouMing_Li的博客
01-24 807
定义方式大致如下，当然工作中更常见的是使用专门的protoc或者thrift文件定义，这样对接方都可以依据这个协议文件知道错误的含义，从而做出相应的处理。提供的中间件功能去在返回数据之前，拦截到出现的错误，在这里重新包装成我们定义的统一结构体。调用，异或是业务逻辑的处理，业务异常是很常见的，通常我们会为每个异常情况定义一个唯一的。提供几个常用的方法，比如出现异常时候需要调用的方法，正常情况下需要调用的方法。由此，我们看到了Gin提供的中间件的威力，中间件可以帮助我们做很多中间的事情。在日常工作中，无论是。
跨项目组项目开发之错误码设计
DeveloperX的博客
08-27 2665
跨项目组项目开发，错误码设计 引言 当项目还是大单体的时候，当项目还是一个项目组开发的时候，当项目还是自给自足不需要对外提供服务接口的时候，当项目还不涉及多个业务部门甚至部门是跨国的部门的时候，你也许都不需要考虑错误和故障的快速定位，你的服务接口中甚至不存在错误码。 那么在银行，当这些情况都发生了，你要怎么做？ 以广发行的贷中业务需求为例，在进行已有卡信贷过程的风险控制，数据流就经历了5个...
前后端接口设计-通讯错误码和业务错误码的思考
laokaizzz的专栏
10-08 5310
背景： 在前后端接口设计上，一般会有一个状态码，表示成功或者失败。 但是一个请求会有两个状态，一个是通讯层面的，200,500,400,404等。一个是业务层面的，自己定义的。在某些场景下可能会混淆。比如请求成功了，但是业务失败了，这个时候对应的code返回什么呢？ 看一下大厂的 微信的支付接口如下： 1、分为了两个码，一个是通讯的码，一个是业务的码。 2、通讯码相当于boolean值，只存成功或者失败，没有详细的分成不同编码，详细信息里显示信息。通讯成功后，再看里面业务的码是成功还是失败，失败
DB2数据库错误码大全
热门推荐
周氏“武功秘籍”之天马行空
03-01 4万+
DB2数据库错误代码大全sqlcode sqlstate 说明000 00000 SQL语句成功完成01xxx SQL语句成功完成，但是有警告+012 01545 未限定的列名被解释为一个有相互关系的引用+098 01568 动态SQL语句用分号结束+100 02000 没有找到满足SQL语句的行+110 01561 用DATA CAPTURE定义的表的更新操作不能发送到原来的子系统+111 ...
Springboot项目统一错误码
m0_61721601的博客
08-27 546
效仿http常见错误码比如404（未找到）,200（成功）等，在此基础上进行拓展，比如4开头就是客户端问题，5开头就是系统内部异常。有任何错误，我们都直接返回-1，其实它的意义不是特别好，前端不知道-1是什么，后端可能也不。-1代表什么，而http的错误码又太少 且可能跟我们的实际业务没有太大关联，所以说我们要定义一个通用的错误码，我们要定义一套错误码的规范。
错误码如何设计才合理？
A1373712651的博客
07-02 1770
一 前言 在工作中，接触过不少外部接口，其中包括：支付宝，微信支付，微博开发平台，阿里云等等。每家公司错误码风格都不尽相同，有使用纯数字的，有使用纯英文的，也有使用字母和数字组合的。也接触过很多内部系统，错误码设计也不尽相同。 错误码的输出路径 面向日志输出 服务内传递，最终是输出到日志。 域内服务间，比如同时大麦电商之间的系统，最终目的是输出到日志。 面向外部传递 域内向域外 服务端传递到前端 OpenAPI 错误码 内部不同域之间 错误码使用场景 通过错误码配置监控大
浅谈API错误码设计
最新发布
京东科技开发者
12-27 661
根据亚马逊官方文档的定义，错误码是通过对错误进行抽象，帮助用户或开发者识别和理解异常性质的代号。错误码与具体错误不是一对一的关系，而是错误类型的一种抽象表示。尽管错误码在系统中只是一个小模块，但它是不可或缺的。错误消息应该帮助用户轻松并快速地理解并解决API 错误，以下是一些设计原则：不要假设用户非常了解你的API。用户可能是客户端开发者、运维人员、IT人员或者APP的普通用户。不要假设用户了解服务实现的细节或熟悉错误上下文（例如日志分析）。
统一错误代码
weixin_44210239的博客
11-19 234
统一错误代码
错误编码的设计
铭星的专栏
11-14 5104
错误编码的设计 目的          编写本文档，设计错误编码的统一分配规则，统一编码实现方式，错误日志输出和查看等。        本文符合《SES全局资源分配规则.doc》及《供应宝错误编码规则.doc》的基本原则和思想。     分配规则        错误编码采用4字节正整数表示。分为全局错误和私有错误。全局错误编码从0x00000000-0x00FFFFFF。私有错误编码
Spring Boot项目系列（3）项目中统一异常处理，统一标准返回格式，统一错误返回码
weixin_43704107的博客
10-10 962
spring boot 项目 （3）----controller层，统一异常处理，统一标准返回格式，统一错误返回码     前言 spring boot 项目中的MVC分层，在controller层我们需要做的是什么，统一项目中的返回格式，统一异常的统一处理，统一错误的返回码。项目中的三个统一息息相关，互相联系。 项目架构     1.统一标准返回格式      项目中在controller层出现的各种返回，例：List ，Map<String,Object&
Python错误码设计
Python老吕的博客
07-15 1012
首先，我们可以定义一个错误码类，该类将包含错误码和对应的错误消息。# 示例错误码SUCCESS = 0, "操作成功"INVALID_ARGUMENT = 1, "无效的参数"FILE_NOT_FOUND = 2, "文件未找到"# ... 可以继续添加其他错误码return "未知错误"# 使用示例try:# 假设某个操作可能失败。
错误码应该如何设计？
在路上的博客
05-05 3515
在规约设计时，应该以服务业务为导向，避免过度设计，保持简洁；在管理使用时，应该以先到先得的原则统一审批生效，生效后永久固定。
错误码的设计使用
eck_燃的博客
08-13 939
承接上一篇的日志系统，有了日志系统为什么还要设计错误码系统呢，单纯的日志系统，再单应用的时候看日志解决问题还是可以胜任的，而出错也一般都是自身配置，资源超限诸如此类的，而企业级商用的系统，往往都是若干系统协调调用，其中任何一个系统出了问题，都有可能导致某个服务或者功能不可用，再通过调用顺序依次排查日志，不仅费时费力，而且由于相互依赖调用很难定位，那么日志系统在这时候就显得有点促襟见肘，错误码这个设计思想就孕育而生。 ...
海康威视SDK开发常见错误码解析与排查
在海康威视SDK开发过程中，遇到错误码是常见且关键的问题解决环节。这些错误码提供了详细的指导，帮助开发者定位和修复代码中的问题。以下是关于部分常见错误码的详细解释： 1. **NET_DVR_NOERROR (0)**：表示没有...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值