Springboot 项目中关于异常的设计

Springboot 项目中关于异常的设计ErrorCode错误码接口/** * @Description 异常码接口 * @Author yin.jinbiao * @Date 2021/10/1 20:24 * @Version 1.0 */public interface ErrorCode { int getCode(); String getMsg();}ErrorCodeEnum自定义错误码枚举(参考支付宝开发平台设计)/** * @Descr
摘要由CSDN通过智能技术生成

Springboot 项目中关于异常的设计

ErrorCode

错误码接口

/**
 * @Description 异常码接口
 * @Author yin.jinbiao
 * @Date 2021/10/1 20:24
 * @Version 1.0
 */
public interface ErrorCode {
   

    int getCode();

    String getMsg();
}

ErrorCodeEnum

自定义错误码枚举(参考支付宝开发平台设计)

/**
 * @Description 错误码
 * @Author yin.jinbiao
 * @Date 2021/9/27 14:31
 * @Version 1.0
 */
@Getter
public enum ErrorCodeEnum implements ErrorCode {
   

    /**
     * 接口调用成功
     */
    SUCCESS(10000,"success."),
    /**
     * 服务不可用
     */
    UNKNOW_ERROR(20000,"unknow error."),
    /**
     * 授权权限不足
     */
    UNKNOW_PERMISSION(20001,"unknow permission."),
    /**
     * 缺少必选参数
     */
    PARAM_MISS(40001,"missing param."),
    /**
     * 非法的参数
     */
    PARAM_ILLEGAL(40002,"illegal param."),
    /**
     * 业务处理失败
     */
    BUSINESS_FAIL(40004,"business fail."),
    /**
     * 权限不足
     */
    PERMISSION_DENY(40006,"permission denied."),
    /**
     * 调用频次超限
     */
    CALL_LIMTIED(40005,"call limited.")
    ;

    private int code;
    private String msg;
    ;

    ErrorCodeEnum(Integer code, String msg) {
   
        this.code = code;
        this.msg = msg;
    }

}

CustomException

自定义异常

/**
 * @Description 业务异常
 * @Author yin.jinbiao
 * @Date 2021/9/27 14:26
 * @Version 1.0
 */
@Data
public class CustomException extends 
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Spring Boot是一个用于构建独立的、生产级别的Java应用程序的框架。在Spring Boot,接口设计是非常重要的一部分,它决定了应用程序的功能和可扩展性。以下是一些关于Spring Boot项目接口设计的要点: 1. RESTful风格:Spring Boot鼓励使用RESTful风格设计接口,通过HTTP方法(GET、POST、PUT、DELETE等)和URL路径来表示资源的操作。 2. URL设计:URL应该简洁、清晰,并且符合语义化。例如,使用名词表示资源,使用动词表示操作。 3. 请求参数:合理设计请求参数,包括路径参数、查询参数、请求体参数等。参数应该具有明确的含义,并且符合业务逻辑。 4. 响应格式:接口的响应格式应该符合统一的规范,通常使用JSON格式。响应应该包含必要的状态码、错误信息和数据。 5. 接口版本管理:如果需要对接口进行升级或者兼容性处理,可以考虑使用接口版本管理,通过URL或者请求头来区分不同版本的接口。 6. 安全性设计:对于需要保护的接口,可以考虑使用身份验证、授权等安全机制来保护接口的访问。 7. 异常处理:合理处理接口可能出现的异常情况,并返回合适的错误信息。可以使用统一的异常处理机制来处理异常。 8. 接口文档:编写清晰、详细的接口文档,包括接口的功能描述、请求参数、响应格式等信息。可以使用Swagger等工具来生成接口文档。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值