完成突变 - GraphQL 教程 - Apollo GraphQL 中文

13. 总结

10m

概述

在上一课中，我们完成了构建对 REST API 的请求，以创建新的房源。终点就在眼前！

在本课中，我们将

完成我们的突变数据提取器方法，并创建一些新的房源

在数据提取器中连接点

我们的模式已完成，包含了我们使突变正常工作所需的所有类型，并且ListingService已更新，包含一个新方法。现在我们只需要连接数据提取器中的最后一个部分！

首先，确保我们的生成代码考虑了这些新的模式类型，然后重启服务器。

任务！

我已经重启了服务器。

接下来，我们将回到我们的 ListingDataFetcher文件。还记得我们在类的 featuredListings方法上使用的 @DgsQuery注解吗？我们还可以使用另一个注解，将其标记为负责一个突变：@DgsMutation！

让我们将其导入文件顶部。

datafetchers/ListingDataFetcher

import com.netflix.graphql.dgs.DgsMutation;

现在我们可以添加此注解，并在其下方编写新方法。我们将给它与我们 Mutation类型的字段相同的名称：createListing。

public class ListingDataFetcher {

  @DgsMutation
  public void createListing() {}

  // other methods
}

如果使用 IntelliJ 作为 IDE，你会立即看到方法名称下方出现黄色波浪线。将鼠标悬停在上面，我们会看到一条消息，鼓励我们使用 @InputArgument注解，并添加 input 参数，模式字段期望。

@DgsMutation
public void createListing(@InputArgument CreateListingInput input) {

}

我们尚未定义 CreateListingInput Java 类，我们可以将其用作 input的数据类型，但幸运的是，DGS 帮我们解决了这个问题！更新模式并重启服务器后，我们应该会在生成的代码文件夹中看到一个专门为此目的而创建的新类：CreateListingInput！

提示：如果你没有看到生成的 CreateListingInput类，请尝试重启服务器。

我们可以将其从生成的文件夹导入以完成注解。

// other imports
import com.example.listings.generated.types.CreateListingInput;

// other annotations
@DgsMutation
public void createListing(@InputArgument CreateListingInput input) {

}

我们还会发现，现在可以为我们的 createListing方法分配适当的返回值类型，因为生成的代码文件夹现在也包含一个 CreateListingPayload类。

datafetchers/ListingDataFetcher

// other imports
import com.example.listings.generated.types.CreateListingInput;
import com.example.listings.generated.types.CreateListingResponse;

// other annotations
@DgsMutation
public CreateListingResponse createListing(@InputArgument CreateListingInput input) {

}

准备响应主体

我们期望我们的方法返回 CreateListingResponse的一个实例，因此让我们创建一个新的对象，我们可以在调用成功或失败时设置它。

CreateListingResponse response = new CreateListingResponse();

在此之后，我们将创建一个新的 try/catch块，然后返回 response。

CreateListingResponse response = new CreateListingResponse();

try {
  // happy path
} catch (Exception e) {
 // sad path
}

return response;

在 try中，如果一切按预期进行，我们将向响应附加属性。我们希望使用所有传递到此方法作为 input的属性，因此我们将直接将 input传递给 ListingService类的 createListingRequest方法。我们将捕获端点返回的最新创建的房源，作为 ListingModel类型，称为 createdListing。然后，我们将设置 response上的一些属性，以显示房源已按预期创建。

try {
  ListingModel createdListing = listingService.createListingRequest(input);
  response.setListing(createdListing);
  response.setCode(200);
  response.setMessage("success");
  response.setSuccess(true);
} catch (Exception e) {
  // sad path
}

处理悲观路径

如果我们的端点调用因任何原因失败，我们希望能够控制返回给客户端的内容。在 catch块中，我们可以考虑任何抛出的异常。我们将设置异常消息，以及其他属性 code和 success，在返回的 response对象上。

try {
  // try block logic
} catch (Exception e) {
  response.setListing(null);
  response.setCode(500);
  response.setMessage(e.getMessage());
  response.setSuccess(false);
}

这里有一个重要的一点需要讨论，关于 Listing类（DGS 从我们的模式中生成的）和 ListingModel类（我们编写扩展 Listing）。

我们选择扩展开箱即用的 Listing类有两个原因。

我们希望能够根据需要在类上定义自己的逻辑（属性和方法）。
我们忽略了 REST API 返回的 JSON 上的一些属性；我们需要能够将 @JsonIgnoreProperties应用到类上，这样额外的属性就不会导致错误。我们无法将其应用于生成的 Listing类，因为每次服务器重启时都会丢失注解！

但你可能已经注意到，除了忽略未知属性外，我们的 ListingModel实际上除了从 Listing继承的内容之外，没有任何其他功能！

ListingModel 类

package com.example.listings.models;
import com.example.listings.generated.types.Listing;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
@JsonIgnoreProperties(ignoreUnknown = true)
public class ListingModel extends Listing {}

这会导致一个隐蔽的错误。 ListingModel 看起来像 Listing，但它与之不同。如果我们尝试在期望 Listing实例的地方传递 ListingModel，我们会遇到麻烦。

为了理解这个问题，回想一下，我们的 CreateListingResponse类型有一个 listing 字段，它返回 Listing类型（不是 ListingModel！）。

type CreateListingResponse {
  # ...other fields
  "The newly created listing"
  listing: Listing
}

生成的 CreateListingResponse类也是如此；它期望其 listing属性返回 Listing类的实例。

generated.types/CreateListingResponse

public class CreateListingResponse {
  // ... other properties
    /**
  * The newly created listing
  */
  private Listing listing;

这意味着我们的 createListing数据提取器方法做了一些奇怪的事情。它没有给新的 CreateListingResponse实例传递它期望的 Listing，而是传递了一个 ListingModel；因为所有属性都相同（目前），所以这没有引起注意。

但如果我们将来给我们的 ListingModel添加一些自定义逻辑会发生什么？

假设我们在 ListingModel上设置了一个新属性——可能是房源 title和 id属性的派生 hash。

包含自定义 hash 属性的 ListingModel 示例

@JsonIgnoreProperties(ignoreUnknown = true)
public class ListingModel extends Listing {
  public String hash;
  public String getHash() {
      return this.hash;
  }
  public void setHash() {
    String titleAndId = this.getTitle() + this.getId();
    this.hash = titleAndId.replaceAll("\s+", "");
  }

我们可以在新创建的 hash 属性上访问它，直到我们将其设置为 listing 属性在 CreateListingResponse 上。现在我们的 ListingModel 被视为 Listing 的实例，因此 hash 属性不再有效！

public CreateListingResponse createListing(@InputArgument CreateListingInput input) {
  ListingModel createdListing = listingService.createListingRequest(input);
  CreateListingResponse response = new CreateListingResponse();
  // We could still access createdListing.getHash() here!
  if (createdListing != null) {
      response.setListing(createdListing);
      // We can no longer access response.listing.getHash() here! Listing does not have a hash property
      response.setCode(200);
      response.setMessage("success");
      response.setSuccess(true);
      return response;
  }
  // ...sad path
}

现在这个问题还不算太大，因为我们还没有给 ListingModel 添加很多特殊的属性，我们可能想在将来访问或使用这些属性。当我们设置 ListingModel 实例作为响应的 listing 属性时，它会自动被视为 Listing 实例，因此任何非 Listing 属性将被忽略。

我们看到了我们想要的功能，所以我们不需要更改我们的实现；但是，重要的是要记住我们的 GraphQL 架构预期我们返回的数据形式。我们服务器端的职责是准备和返回满足这些预期的数据！

运行一个简单的变异

我们将重启服务器以确保所有更改都已应用。

任务！

我已重启服务器。

在Explorer 中，填写以下操作：

mutation CreateListing($input: CreateListingInput!) {
  createListing(input: $input) {
    code
    success
    message
    listing {
      title
      description
      costPerNight
      amenities {
        name
        category
      }
    }
  }
}

并将以下内容添加到变量面板中。

{
  "input": {
    "title": "Mars' top destination",
    "description": "A really cool place to stay",
    "costPerNight": 44.0,
    "amenities": ["am-1", "am-2"],
    "numOfBeds": 2
  }
}

当我们运行操作时，我们会看到这个变异按预期工作！我们可以清楚地看到我们为 code、success 和 message 设置的值 - 不用说我们刚刚创建的新列表的详细信息！

太棒了，你做到了！

旅程的终点

任务！

我到达了终点线！

你已经构建了一个 GraphQL API！你拥有一个正在运行的 GraphQL 服务器，充满了星际列表，它使用 REST API 作为数据源。你已经编写了查询和变异，并在此过程中学习了一些常见的 GraphQL 约定。你已经探索了如何在你的架构设计中使用 GraphQL 参数、变量和输入类型。花点时间庆祝一下；你学到了很多东西！

但旅程并没有结束！当你准备好让你的 GraphQL API 更进一步 时，跳入本系列中的下一门课程：与 Java 和 DGS 联合。

感谢你加入本课程；我们希望在下一门课程中见到你！

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

本课程目前正在

测试版

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

你需要一个 GitHub 帐户才能在下面发帖。没有吗？改为在我们的 Odyssey 论坛发帖。