Dart执行API调用时JSON编码自定义枚举实例报错如何解决

Dart 内置的jsonEncode仅原生支持基础可序列化类型（数字、字符串、布尔值、空值，以及由上述类型构成的列表、键值对）；对于自定义类/枚举类，只有实现了toJson()方法、且返回值是可直接序列化的基础类型时，才能被正常编码。
默认情况下Dart的枚举没有实现序列化逻辑，工具拿到PaymentStatus这类枚举实例时，无法判断该把它转换为哪种JSON格式，就会抛出Converting object to an encodable object failed的异常。
你现在的问题本质就是构造待编码的请求对象时，直接把PaymentStatus、PaymentMode、PaymentType这几个枚举实例塞进了要被序列化的Map里，没有做枚举值到可序列化类型的转换。

• 无依赖手动转换（最快适配现有代码的方案）
  构造JSON请求体时，不直接传入枚举实例，提前把枚举转为JSON可识别的字符串/数字值：
  1. 如果后端没有特殊格式要求，可直接取枚举的内置名称字段（Dart 2.15+支持），比如paymentStatus.name，拿到的就是枚举实例对应的字符串标识
  2. 如果需要和后端约定固定的枚举映射值，可写简单的转换函数，把枚举值对应到约定的字符串/数字：

     // 示例：PaymentStatus 转后端要求的字符串格式
     String paymentStatusToJson(PaymentStatus status) {
       switch (status) {
         case PaymentStatus.pending:
           return "UNPAID";
         case PaymentStatus.success:
           return "PAID";
         case PaymentStatus.refunded:
           return "REFUNDED";
       }
     }
     

     拼接请求体时直接调用这个函数拿返回值即可，改动成本极低。
• 扩展枚举的序列化能力（减少重复代码的方案）
  可以给项目里的所有自定义枚举写对应的扩展方法，把转换逻辑封装起来，避免在各个接口请求里重复写switch判断：

  extension PaymentModeExt on PaymentMode {
    String get toJson {
      // 对应枚举到约定值的转换逻辑
    }
  }
  

  后续用的时候直接写paymentMode.toJson即可，代码更整洁统一。
• 代码生成自动处理（适合长期维护的项目）
  如果项目里已经在用json_serializable、freezed这类序列化工具，只要给对应枚举添加@JsonEnum()注解、给承载这些字段的数据类添加@JsonSerializable()注解，重新运行代码生成命令后，工具会自动生成所有枚举的转换逻辑，不需要手写判断，从根源上避免原生序列化识别不了枚举的问题。

内容的提问来源于stack exchange，提问作者RINOSHA RAHMAN