Spring GraphQL迁移报错：FieldsConflict返回Int与String类型冲突

问题描述 #

迁移过程中执行查询时遭遇验证错误：

"message": "Validation error (FieldsConflict@[getProductsByCategory/facets]) : 'values/value' : returns different types 'Int' and 'String'"

执行的查询语句 #

query {
    getProductsByCategory(
        lang: "fr",
        categoryCode:"C600_C605_C603"
        ) {
        facets {
            ...on RatingFacet {
                code
                description
                name
                multiSelect
                order
                values {
                    code
                    description
                    count
                    selected
                    value
                }
            }
            ...on ChoicesFacet {
                code
                description
                name
                multiSelect
                order
                values {
                    code
                    description
                    count
                    selected
                    value
                }
            }
        }
    }
}

对应的GraphQL类型定义 #

type CategorySearchResult {
    facets: [Facet!]!
   ...
}

union Facet =  RatingFacet | ChoicesFacet

interface FacetInterface {
    code: String!
    description: String
    name: String!
    multiSelect: Boolean
    order: Int!
}

interface FacetValue {
    code: String!
    description: String
    count: Int
    selected: Boolean!
}

type ChoicesFacet implements FacetInterface {
    ...
    values: [ChoiceFacetValue!]!
}
type ChoiceFacetValue implements FacetValue {
    ...
    value: String! <-- 错误位置
}

type RatingFacet implements FacetInterface {
    ...
    values: [RatingFacetValue!]!
}
type RatingFacetValue implements FacetValue {
    ...
    value: Int! <-- 错误位置
}

疑问：不确定遗漏了什么，是否需要为Union创建类型解析器？错误似乎与实现FacetValue的RatingFacetValue和ChoiceFacetValue类型有关。

问题原因与解决方法 #

问题根源 #

核心是GraphQL接口的字段类型一致性约束：FacetValue接口未定义value字段，但两个实现类分别给value指定了String和Int类型。查询中统一请求values.value时，GraphQL无法确定该字段的返回类型，触发字段类型冲突验证。另外Spring GraphQL对接口/联合类型的校验比com.graphql更严格，这是迁移后问题显现的直接原因。

解决步骤 #

方案1：将接口字段定义为联合类型（推荐）

修改FacetValue接口，明确value字段为联合类型，告知GraphQL该字段可返回两种类型：

interface FacetValue {
    code: String!
    description: String
    count: Int
    selected: Boolean!
    value: String | Int! # 定义为联合类型
}

查询时需通过内联片段区分不同类型的value：

values {
    code
    description
    count
    selected
    ... on ChoiceFacetValue {
        value
    }
    ... on RatingFacetValue {
        value
    }
}

方案2：拆分字段（备选）

若不想使用联合类型，可给不同类型的value单独命名，避免字段名冲突：

type ChoiceFacetValue implements FacetValue {
    ...
    stringValue: String!
}

type RatingFacetValue implements FacetValue {
    ...
    intValue: Int!
}

查询时分别请求对应字段：

# RatingFacet的values片段
...on RatingFacet {
    values {
        intValue
        code
        description
        count
        selected
    }
}
# ChoicesFacet的values片段
...on ChoicesFacet {
    values {
        stringValue
        code
        description
        count
        selected
    }
}

关于联合类型解析器

当前错误与Facet联合类型无关，不需要为它额外创建解析器。只有当Spring GraphQL无法自动识别联合类型的具体实现类时，才需要添加类型解析器，但这和本次字段冲突问题没有关联。

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