如何在Java/Spring Boot Maven项目中使用Netflix DGS的graphql-dgs-extended-scalars JSON标量

此前遇到需要使用graphql-dgs-extended-scalars中JSON标量的需求，但一直找不到清晰的使用教程，现将总结的简单使用说明分享如下：

• 引入对应依赖
  在项目构建配置文件中添加graphql-dgs-extended-scalars依赖，版本需和项目中现有DGS框架版本保持一致：
  Maven配置示例（pom.xml）

  <dependency>
      <groupId>com.netflix.graphql.dgs</groupId>
      <artifactId>graphql-dgs-extended-scalars</artifactId>
      <version>替换为你的DGS版本号</version>
  </dependency>
  

  Gradle配置示例（build.gradle）

  implementation 'com.netflix.graphql.dgs:graphql-dgs-extended-scalars:替换为你的DGS版本号'
  

• 注册JSON标量
  在项目的DGS配置类中添加JSON标量的注册Bean：

  import com.netflix.graphql.dgs.extendedscalars.ExtendedScalars;
  import graphql.schema.GraphQLScalarType;
  import org.springframework.context.annotation.Bean;
  import org.springframework.context.annotation.Configuration;
  
  @Configuration
  public class DgsCustomScalarConfig {
      @Bean
      public GraphQLScalarType jsonScalar() {
          return ExtendedScalars.Json;
      }
  }
  

• 在Schema中声明并使用JSON标量
  首先在GraphQL Schema文件中声明JSON标量，再将需要动态结构的字段类型指定为JSON：

  scalar JSON
  
  type YourCustomBusinessType {
      id: ID!
      name: String!
      # 动态结构字段，无需提前定义内部字段
      dynamicPayload: JSON
  }
  

• 业务代码直接使用
  对应字段在Java代码中可以直接使用Map、com.fasterxml.jackson.databind.JsonNode或者自定义POJO类型，框架会自动完成序列化、反序列化操作，无需额外手动转换。

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