Strawberry Shake 中处理 Shopify API 的 Decimal 类型解析问题

在 GraphQL 客户端开发中，类型系统的精确匹配是保证数据正确传输和处理的关键。本文将以 Strawberry Shake 与 Shopify API 集成为例，探讨如何处理 Decimal 类型在 GraphQL 中的特殊场景。

问题背景

当开发者使用 Strawberry Shake 14.3.0 版本与 Shopify GraphQL API 交互时，可能会遇到一个典型的数据类型解析问题。Shopify 的 API 中定义了 Decimal 类型字段，但在实际响应中这些值却以字符串形式传输（如 "24.99"），而 Strawberry Shake 的默认解析器期望直接获取数值类型。

技术原理

这个问题源于 JavaScript/JSON 处理浮点数的固有局限性。Shopify 选择将 Decimal 类型作为字符串传输是为了避免以下问题：

1. JavaScript 使用 IEEE 754 双精度浮点数标准，可能导致精度丢失
2. 大数值或高精度小数在 JSON 序列化/反序列化过程中可能产生舍入误差
3. 金融相关数据需要保持精确的十进制表示

解决方案

Strawberry Shake 提供了灵活的标量类型重绑定机制来解决这类问题。具体实现步骤如下：

1. 自定义标量类型处理

在项目配置中，我们需要重新定义 Decimal 类型的序列化行为：

// 在 Strawberry Shake 配置中添加
services.AddGraphQLClient()
    .ConfigureBuilder(builder => builder
        .ConfigureSchema(sb => sb
            .AddType(new DecimalType("Decimal"))));

2. 实现自定义解析器

创建 Decimal 类型的自定义解析器来处理字符串格式的数值：

public class DecimalType : ScalarType<decimal, StringValueNode>
{
    public DecimalType(string name) : base(name)
    {
    }

    public override IValueNode ParseResult(object? resultValue)
    {
        if (resultValue is null)
        {
            return NullValueNode.Default;
        }

        if (resultValue is string s)
        {
            return new StringValueNode(s);
        }

        if (resultValue is decimal d)
        {
            return new StringValueNode(d.ToString(CultureInfo.InvariantCulture));
        }

        throw new SerializationException(
            $"The specified value {resultValue} is not a valid decimal string representation.");
    }

    public override bool TrySerialize(object? value, out object? serialized)
    {
        if (value is null)
        {
            serialized = null;
            return true;
        }

        if (value is decimal d)
        {
            serialized = d.ToString(CultureInfo.InvariantCulture);
            return true;
        }

        serialized = null;
        return false;
    }

    public override bool TryDeserialize(object? serialized, out object? value)
    {
        if (serialized is null)
        {
            value = null;
            return true;
        }

        if (serialized is string s && decimal.TryParse(
            s,
            NumberStyles.Float,
            CultureInfo.InvariantCulture,
            out var d))
        {
            value = d;
            return true;
        }

        value = null;
        return false;
    }
}

3. 配置 JSON 序列化

对于 System.Text.Json 的序列化配置：

services.Configure<JsonSerializerOptions>(options =>
{
    options.Converters.Add(new DecimalJsonConverter());
});

public class DecimalJsonConverter : JsonConverter<decimal>
{
    public override decimal Read(
        ref Utf8JsonReader reader,
        Type typeToConvert,
        JsonSerializerOptions options)
    {
        if (reader.TokenType == JsonTokenType.String)
        {
            return decimal.Parse(reader.GetString()!, CultureInfo.InvariantCulture);
        }

        return reader.GetDecimal();
    }

    public override void Write(
        Utf8JsonWriter writer,
        decimal value,
        JsonSerializerOptions options)
    {
        writer.WriteStringValue(value.ToString(CultureInfo.InvariantCulture));
    }
}

最佳实践

1. 金融数据一致性：对于价格、税率等金融数据，始终使用字符串传输可以避免任何潜在的精度问题
2. 文化设置：确保使用不变文化（InvariantCulture）进行解析，避免本地化问题
3. 错误处理：实现健壮的错误处理机制，应对格式不正确的输入
4. 性能考虑：对于高频访问的字段，可以考虑缓存解析结果

总结

通过理解 Shopify API 的设计选择并正确配置 Strawberry Shake 的类型系统，开发者可以可靠地处理 Decimal 类型数据。这种模式不仅适用于 Shopify 集成，也可应用于其他需要高精度十进制处理的 GraphQL 场景。

自定义标量类型是 GraphQL 类型系统的强大特性，合理利用这一特性可以解决实际开发中的各种数据表示和传输挑战。