你好世界 - GraphQL 教程 - Apollo GraphQL 中文

4. 你好世界

概述

现在，我们将保持简单，并尝试一个经典的“你好世界”示例作为我们的模式。别担心，我们稍后会深入探讨播放列表和曲目！

在本课中，我们将

了解Query 类型
实现一个解析器函数用于“你好世界”示例
注册 Query 类型在我们的 GraphQL 服务器
比较和对比基于注释、模式优先和代码优先的方法

The `Query` 类型

The Query 类型定义了我们允许从我们的 GraphQL 服务器请求的所有内容。它是我们模式的入口点！

首先，让我们在项目的根目录中创建一个名为 Types 的文件夹，我们将在其中组织所有 GraphQL 模式类型。

然后，让我们添加一个名为 Query 的类。

Types/Query.cs

namespace Odyssey.MusicMatcher;

public class Query
{
  // where Query resolver functions will go
}

注意: 如果你使用的是 VS Code，C# Dev Kit 扩展为你提供“解决方案资源管理器”部分的访问权限。使用它可以快速创建带有上面显示的样板代码的文件夹和类。

在 Query 类中，让我们编写一个名为解析器的函数，用于一个名为 Hello 的字段。它将是一个 public 函数，返回一个 string 类型。在函数主体中，我们将返回一个硬编码值为 "Hello world" 的值。

Types/Query.cs

public string Hello()
{
    return "Hello world";
}

这是我们的第一个 解析器，一个用于填充模式中字段数据的函数。请记住，使用基于注释的方法，Hot Chocolate 会根据我们的解析器生成 GraphQL 模式。因此，现在，我们的模式看起来像这样：

生成的 GraphQL 模式

type Query {
  hello: String!
}

namespace Odyssey.MusicMatcher;

public class Query
{
    public string Hello()
    {
        return "Hello world";
    }
}

注册 `Query` 类型

我们的 GraphQL 服务器需要了解 Query 类型。跳转到 Program.cs 文件，找到我们添加 GraphQL 服务器的行。我们将链接一个名为 AddQueryType 的新函数，并将 Query 类型作为参数传递进去。

Program.cs

builder.Services.AddGraphQLServer()
   .AddQueryType<Query>();

The Program.cs 文件不知道这个 Query 类型来自哪里，因此我们还需要在文件顶部导入命名空间。

Program.cs

using Odyssey.MusicMatcher;

注意: 这个命名空间在您克隆的入门代码中默认定义。如果您查看 Query.cs 文件的顶部，您可以看到 Query 类型被定义为 Odyssey.MusicMatcher 命名空间的一部分。如果您将此命名空间更改为另一个值，您也需要相应地更改 Program.cs 中的导入！

让我们不要忘记保存更改并使用 dotnet run 重新启动服务器。

以下是使用模式优先方法时我们的“你好世界”示例的外观。请注意文件名。

Types/schema.graphql

type Query {
  hello: String!
}

Types/Query.cs

namespace Odyssey.MusicMatcher;

public class Query
{
  public string Hello()
  {
      return "Hello world";
  }
}

Program.cs

using Odyssey.MusicMatcher;

var builder = WebApplication.CreateBuilder(args);

builder.Services
  .AddGraphQLServer()
  .AddDocumentFromFile("Types/schema.graphql")
  .BindRuntimeType<Query>();

var app = builder.Build();

app.MapGraphQL();

app.Run();

我们可以看到解析器在 Query.cs 中保持不变，但我们有一个额外的文件包含 SDL 在 schema.graphql 中。我们还需要使用 AddDocumentFromFile 将该模式文件与 GraphQL 服务器连接起来，然后使用 BindRuntimeType 绑定 Query 类型。

如果解析器中的类型和模式不匹配，我们将在向服务器发送查询时收到错误。

即使我们不使用模式优先方法来实现服务器，与 API 消费者协商他们对 GraphQL 模式的期望和需求仍然很重要。

以下是使用代码优先方法时我们的“你好世界”示例的外观

Types/Query.cs

namespace Odyssey.MusicMatcher;

public class Query
{
  public string Hello()
  {
      return "Hello world";
  }
}

public class QueryType : ObjectType<Query>
{
  protected override void Configure(IObjectTypeDescriptor<Query> descriptor)
  {
      descriptor
          .Field(f => f.Hello())
          .Type<StringType>();
  }
}

Program.cs

using Odyssey.MusicMatcher

var builder = WebApplication.CreateBuilder(args);

builder.Services
  .AddGraphQLServer()
  .AddQueryType<QueryType>();

var app = builder.Build()

app.MapGraphQL();

app.Run();

我们可以看到添加了一个 QueryType 类，它实现了来自 Hot Chocolate 的 HotChocolate.Types.ObjectType 类。The Configure 方法包含将 Query 类与 GraphQL 服务器连接起来所需的代码。

请记住，基于注释和模式优先的方法最终都将被转换为幕后的此代码！

在本课程中，我们克隆了一个包含 .NET Web 模板的最小版本的存储库，添加了 Hot Chocolate 包并自行设置了所有代码，以便使“你好世界”示例能够运行。

不想为下一个项目重复所有这些工作？您可以使用 rover template 用于 Hot Chocolate！

首先，按照说明安装 Rover。 Rover 是一个命令行界面，用于管理和维护使用 Apollo 的图。

在终端窗口中，运行 rover template use subgraph-csharp-hotchocolate-annotation。

现在，您已经拥有一个完全可运行且随时可用的 GraphQL 服务器，它是在 Hot Chocolate 中实现的！

您可以通过运行 rover template list 查看适用于不同语言的所有可用模板的完整列表。

练习

在 GraphQL 中，Query 类型的用途是什么？

定义解析器组织 GraphQL 模式文件管理数据库查询充当模式的入口点

什么是 GraphQL 中的解析器？

包含 GraphQL 架构注释的文件单独的 GraphQL 架构文件一个用于填充架构中特定字段数据的函数GraphQL 类型定义

在基于注释的方法中，如何将 Query 类型注册到 GraphQL 服务器？

使用 AddDocumentFromFile 函数通过定义一个单独的 QueryResolver 类通过导入 GraphQL 架构文件使用 AddQueryType 函数

关键要点

在 GraphQL 架构中，Query 类型中的字段是我们的架构的入口点。这些是 GraphQL 消费者可以查询的顶级字段。
我们可以使用函数 AddQueryType<Query>() 将 Query 文件与我们的 GraphQL 服务器连接起来。
一个解析器是一个函数，它用于填充架构中字段的数据。

接下来

我们的 GraphQL 服务器已准备好接收查询。在下一课中，我们将学习编写和发送查询的最佳方式：Apollo Explorer。

分享您关于本课的问题和评论

本课程目前处于

测试版

.您的反馈有助于我们改进！如果您遇到困难或感到困惑，请告诉我们，我们会帮助您解决。所有评论都是公开的，必须遵守 Apollo 行为准则。请注意，已解决或已处理的评论可能会被删除。

您需要一个 GitHub 帐户才能在下方发布。没有帐户？请改在我们的 Odyssey 论坛上发布。

概述

The Query 类型

注册 Query 类型

练习

关键要点

接下来

分享您关于本课的问题和评论

The `Query` 类型

注册 `Query` 类型