求你了，不要再在对外接口中使用枚举类型了！

最新推荐文章于 2024-10-12 22:35:37 发布

倾听铃的声

最新推荐文章于 2024-10-12 22:35:37 发布

阅读量114

点赞数

分类专栏：后端文章标签： java 开发语言分布式单例模式数据库架构

本文链接：https://blog.csdn.net/m0_67698950/article/details/125408140

版权

本文通过一个线上异常案例，分析了在对外接口中使用枚举类型可能导致的问题。当二方库升级，新增枚举项时，未升级的系统会因反序列化失败引发异常。文中讨论了RPC框架的反序列化原理，引用《阿里巴巴Java开发手册》的约定，并提出使用字符串代替枚举以避免兼容性问题。此外，还探讨了枚举作为参数和返回值的优缺点，建议在接口设计中谨慎使用枚举。

摘要由CSDN通过智能技术生成

最近，我们的线上环境出现了一个问题，线上代码在执行过程中抛出了一个IllegalArgumentException，分析堆栈后，发现最根本的的异常是以下内容：

java.lang.IllegalArgumentException: 

No enum constant com.a.b.f.m.a.c.AType.P_M

大概就是以上的内容，看起来还是很简单的，提示的错误信息就是在AType这个枚举类中没有找到P_M这个枚举项。

于是经过排查，我们发现，在线上开始有这个异常之前，该应用依赖的一个下游系统有发布，而发布过程中是一个API包发生了变化，主要变化内容是在一个RPC接口的Response返回值类中的一个枚举参数AType中增加了P_M这个枚举项。

但是下游系统发布时，并未通知到我们负责的这个系统进行升级，所以就报错了。

我们来分析下为什么会发生这样的情况。

问题重现

首先，下游系统A提供了一个二方库的某一个接口的返回值中有一个参数类型是枚举类型。

一方库指的是本项目中的依赖

二方库指的是公司内部其他项目提供的依赖

三方库指的是其他组织、公司等来自第三方的依赖

public interface AFacadeService {

    public AResponse doSth(ARequest aRequest);

}

public Class AResponse{

    private Boolean success;

    private AType aType;

}

public enum AType{

    P_