Rejoiner扩展开发：如何自定义TypeModification实现业务需求

【免费下载链接】rejoiner Generates a unified GraphQL schema from gRPC microservices and other Protobuf sources 项目地址: https://gitcode.com/gh_mirrors/re/rejoiner

Rejoiner作为一款从gRPC微服务和其他Protobuf源生成统一GraphQL schema的强大工具，其灵活性很大程度上体现在对类型的自定义修改能力上。本文将为您详细介绍如何通过自定义TypeModification接口实现业务特定的GraphQL类型调整需求，帮助开发者轻松扩展Rejoiner的功能边界。

TypeModification核心概念解析

TypeModification是Rejoiner框架中用于修改GraphQL类型的核心接口，定义于rejoiner/src/main/java/com/google/api/graphql/rejoiner/TypeModification.java文件中。它继承自Function<GraphQLObjectType, GraphQLObjectType>接口，包含一个获取类型名称的getTypeName()方法，允许开发者在schema生成过程中对GraphQL对象类型进行灵活调整。

Rejoiner架构下的类型修改流程示意图

常用TypeModification操作方法

Rejoiner的Type类提供了多种便捷的类型修改方法，通过Type.find()定位目标类型后，可链式调用以下方法创建TypeModification实例：

1. 移除字段操作

TypeModification removeField = Type.find("QueryType").removeField("greeting");

上述代码会创建一个从"QueryType"类型中移除"greeting"字段的修改操作，常见于隐藏不需要暴露的字段。

2. 添加字段操作

通过addField()方法可以为现有类型添加新的GraphQL字段定义，扩展类型功能：

Type.find("UserType").addField(GraphQLFieldDefinition.newFieldDefinition()
    .name("fullName")
    .type(GraphQLString)
    .dataFetcher(environment -> {
        User user = environment.getSource();
        return user.getFirstName() + " " + user.getLastName();
    })
    .build());

3. 替换字段操作

replaceField()方法允许完全替换现有字段的定义，适用于需要改变字段行为或类型的场景：

Type.find("ProductType").replaceField(GraphQLFieldDefinition.newFieldDefinition()
    .name("price")
    .type(GraphQLFloat)
    .dataFetcher(priceDataFetcher)
    .build());

自定义TypeModification实现步骤

步骤1：创建TypeModification实现类

创建自定义的TypeModification实现类，实现Function接口的apply方法来定义具体的修改逻辑：

public class CustomTypeModification implements TypeModification {
  private final String typeName;
  
  public CustomTypeModification(String typeName) {
    this.typeName = typeName;
  }
  
  @Override
  public String getTypeName() {
    return typeName;
  }
  
  @Override
  public GraphQLObjectType apply(GraphQLObjectType inputType) {
    // 实现自定义修改逻辑
    return inputType.transform(builder -> 
        builder.field(GraphQLFieldDefinition.newFieldDefinition()
            .name("customField")
            .type(GraphQLString)
            .dataFetcher(environment -> "custom value")
            .build())
    );
  }
}

步骤2：注册TypeModification

通过SchemaModule将自定义TypeModification注册到Rejoiner框架中：

@SchemaModule
public class CustomSchemaModule {
  @SchemaModification
  public static TypeModification addCustomFieldToUserType() {
    return new CustomTypeModification("UserType");
  }
}

步骤3：应用修改

在SchemaBundle中收集所有TypeModification并应用到最终的schema生成过程，Rejoiner会自动处理所有注册的类型修改。

实际应用场景举例

场景1：权限控制字段隐藏

根据用户角色动态隐藏敏感字段：

Type.find("UserType").removeField("creditCardNumber");

场景2：计算字段添加

为订单类型添加动态计算的总金额字段：

Type.find("OrderType").addField(GraphQLFieldDefinition.newFieldDefinition()
    .name("totalAmount")
    .type(GraphQLFloat)
    .dataFetcher(environment -> {
        Order order = environment.getSource();
        return order.getItems().stream()
            .mapToDouble(item -> item.getPrice() * item.getQuantity())
            .sum();
    })
    .build());

测试TypeModification的最佳实践

Rejoiner提供了完善的测试支持，您可以在测试代码中直接验证TypeModification的效果：

@Test
public void testCustomTypeModification() {
  GraphQLObjectType modifiedType = new CustomTypeModification("TestType").apply(originalType);
  assertTrue(modifiedType.hasField("customField"));
}

查看rejoiner/src/test/java/com/google/api/graphql/rejoiner/TypeTest.java获取更多测试示例。

总结与扩展建议

通过TypeModification接口，Rejoiner赋予了开发者强大的schema定制能力。无论是简单的字段增删，还是复杂的类型转换，都可以通过实现自定义TypeModification来完成。建议在实际开发中：

1. 保持TypeModification的职责单一，每个修改只做一件事
2. 通过单元测试确保修改逻辑的正确性
3. 参考官方文档docs/SCHEMA_MODIFICATIONS.md了解更多高级用法

掌握TypeModification的使用，将帮助您构建更符合业务需求的GraphQL API，充分发挥Rejoiner在微服务架构中的优势。

要开始使用Rejoiner进行扩展开发，请先克隆仓库：

git clone https://gitcode.com/gh_mirrors/re/rejoiner

【免费下载链接】rejoiner Generates a unified GraphQL schema from gRPC microservices and other Protobuf sources 项目地址: https://gitcode.com/gh_mirrors/re/rejoiner