Flutter如何处理与API+MongoDB之间的命名规范不匹配问题

1. 基于json_serializable的自动转换实现 #

你使用的json_serializable本身就支持蛇形/驼峰自动映射，不需要手动逐个指定字段名，有两种配置方式：

全局配置（推荐） #

在项目根目录的build.yaml文件中添加如下配置，全项目所有@JsonSerializable的类都会自动实现蛇形命名和驼峰命名的双向转换：

targets:
  $default:
    builders:
      json_serializable:
        options:
          field_rename: snake

配置完成后重新执行生成命令即可：

flutter pub run build_runner build

你给出的示例User类不需要做任何修改，profileUrl会自动和接口返回的profile_url互相映射，序列化和反序列化都不需要额外处理。

单个字段特殊配置 #

如果只有个别字段需要单独映射，或者和全局规则不一致，可以用@JsonKey注解单独指定对应JSON字段名：

import 'package:json_annotation/json_annotation.dart';

@JsonSerializable()
class User {
  User(this.profileUrl, this.email);

  // 手动指定对应JSON中的picture_url字段
  @JsonKey(name: 'picture_url')
  String profileUrl;
  String email;

  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
  Map<String, dynamic> toJson() => _$UserToJson(this);
}

2. 业内通用处理规范 #

• 不建议强制前后端统一命名格式：不同技术生态有各自的官方推荐规范，后端（Python/Go/Java Spring等）以及MongoDB默认推荐蛇形命名，客户端/前端（Dart/JS/TS等）默认推荐小驼峰命名，强行统一反而会违反各自生态的lint规则，降低代码可读性和可维护性。
• 通用做法是在序列化/反序列化层做自动转换，也就是上面提到的配置方式，前后端各自遵循自身生态的开发规范，中间的转换逻辑由序列化框架自动处理，不需要额外手写转换代码，性能和可维护性都最优。

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