在 Flutter 的 Ferry Graphql 中序列化標量 JSON 以實現靈活查詢

Question

我有以下 JSON 標量：

"""
The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).
"""
scalar JSON

我正在嘗試轉換，因為我的query正在接受input: JSON 。 當使用 graphql 操場進行測試時，查詢是 JSON object 因此以下工作：

query {
  carts(where: {
    owner:{id: "xxx"}
    store:{name: "yyy"}
  }) {
    id
  }
}
# query is the starting from the where: {...}

# build.yaml
# build.yaml
gql_build|schema_builder: #same for gql_build|schema_builder + gql_build|var_builder + ferry_generator|req_builder:
  options:
          type_overrides:
            DateTime:
              name: DateTime
            JSON:
              name: BuiltMap<String, dynamic>
              import: 'package:built_collection/built_collection.dart'
gql_build|serializer_builder:
        enabled: true
        options:
          schema: myapp|lib/graphql/schema.graphql
          custom_serializers:
            - import: 'package:myapp/app/utils/builtmapjson_serializer.dart'
              name: BuiltMapJsonSerializer

這是自定義序列化程序（builtmapjson_serializer.dart）

//// lib/app/utils/builtmapjson_serializer.dart
import 'package:built_collection/built_collection.dart';
import "package:gql_code_builder/src/serializers/json_serializer.dart";

class BuiltMapJsonSerializer extends JsonSerializer<BuiltMap<String, dynamic>> {
  @override
  BuiltMap<String, dynamic> fromJson(Map<String, dynamic> json) {
    print('MyJsonSerializer fromJson: $json');
    return BuiltMap.of(json);
  }

  @override
  Map<String, dynamic> toJson(BuiltMap<String, dynamic> operation) {
    print('MyJsonSerializer toJson: ${operation.toString()}');
    return operation.asMap();
  }
}

和用法：

Future testQuery() async {
    Map<String, dynamic> queryMap = {
      "where": {
        "owner": {
          "id": "xxx",
          "store": {"name": "yyy"}
        }
      }
    };
    final req = GFindCartsReq((b) {
      return b..vars.query.addAll(queryMap);
    });
    var resStream = _graphQLService.client.request(req);
    var res = await resStream.first;
    print(
        'linkExceptions: ${res.linkException}'); // Map: LinkException(Bad state: No serializer for '_InternalLinkedHashMap<String, Map<String, Object>>'.)
  }

因此，每當我嘗試查詢時，它都會拋出最后一行使用的注釋中說明的 linkException。 知道序列化它的方式應該是什么嗎？

Answer 1

// Write query like this
query FindCarts($owner_id: String!, $store_name: String!) {
  carts(where: {
    owner:{id: $owner_id}
    store:{name: $store_name}
  }) {
    id
  }
}
// And make request like this:
final req = GFindCartsReq((b) => b..vars.store_name = 'XXX'..vars.owner_id = 'YYY');

我認為您可能誤解了用例。 如果你想得到一個不同於 graphql 表示的 Dart object ，它們可以序列化和反序列化響應。 您可能想嘗試重讀本節： https://ferrygraphql.com/docs/custom-scalars/#create-a-custom-serializer

在文檔中的示例中，graphql 模式返回一個 int 作為時間戳，但我們希望實際使用日期 object，這就是序列化程序的目的。 它告訴 ferry 反序列化我們對 Date 的響應中的 int，以便我們可以在 dart 代碼中使用 Date。 您仍然可以使用 json 序列化程序（如您鏈接到的示例中），但它仍然不會妨礙您嘗試使用它 - 如果您的架構返回 json 字符串並且您想要反序列化json 字符串。 例如，在我的情況下，我的 graphql 模式實際上確實在某些對象上返回了“jsonb”類型。 為了處理這個問題，我使用了 built_value 的默認 json_object，如下所示：

(
...
          type_overrides:
            jsonb:
              name: JsonObject
              import: "package:built_value/json_object.dart"
          custom_serializers:
            - import: "package:built_value/src/json_object_serializer.dart"
              name: JsonObjectSerializer