HTTP 与 Web

实现 GraphQL 服务器

本文档将向您展示如何实现 GraphQL 服务器。

您将构建什么

您将构建一个 GraphQL 服务器来管理您的个人任务（即待办事项列表）。

该应用程序包含以下几个文件

tasks.graphqls 模式文件
Task 数据类
GraphQLVerticle 类

您需要什么

文本编辑器或 IDE
Java 17 或更高版本
Maven 或 Gradle

创建项目

此项目的代码包含功能等效的 Maven 和 Gradle 构建文件。

使用 Maven

以下是您应该使用的 pom.xml 文件的内容

Maven pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

  <modelVersion>4.0.0</modelVersion>

  <groupId>io.vertx.howtos</groupId>
  <artifactId>graphql-howto</artifactId>
  <version>1.0-SNAPSHOT</version>

  <properties>
    <vertx.version>5.0.0.CR2</vertx.version>
  </properties>

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>io.vertx</groupId>
        <artifactId>vertx-stack-depchain</artifactId>
        <version>${vertx.version}</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

  <dependencies>
    <dependency>
      <groupId>io.vertx</groupId>
      <artifactId>vertx-web-graphql</artifactId>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.13.0</version>
        <configuration>
          <release>17</release>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>exec-maven-plugin</artifactId>
        <version>3.5.0</version>
        <configuration>
          <mainClass>io.vertx.howtos.graphql.GraphQLVerticle</mainClass>
        </configuration>
      </plugin>
    </plugins>
  </build>

</project>

使用 Gradle

假设您使用 Kotlin DSL 的 Gradle，您的 build.gradle.kts 文件应如下所示

Gradle build.gradle.kts

plugins {
  java
  application
}

repositories {
  mavenCentral()
}

java {
  toolchain {
    languageVersion.set(JavaLanguageVersion.of(17))
  }
}

dependencies {
  implementation(platform("io.vertx:vertx-stack-depchain:5.0.0.CR2"))
  implementation("io.vertx:vertx-web-graphql")
}

application {
  mainClass.set("io.vertx.howtos.graphql.GraphQLVerticle")
}

使用 Vert.x Web 和 GraphQL 管理任务

创建模式

首先，让我们为任务管理应用程序创建一个 GraphQL 模式

GraphQL 模式 src/main/resources/tasks.graphqls

type Task {
  id: String
  description: String
  completed: Boolean
}

type Query {
  allTasks(uncompletedOnly: Boolean = true): [Task]
}

type Mutation {
  complete(id: String!): Boolean
}

该模式定义了

Task 类型，包含 3 个字段：id、description 和 completed
allTasks 查询，返回一个任务数组，并可选地接受参数 uncompletedOnly（默认为 true）
complete 变更，它将任务 id 作为参数并返回一个 布尔值，指示操作是否成功

实现服务器

在应用程序中，任务将由 Task 类建模

Java src/main/java/io/vertx/howtos/graphql/Task.java

package io.vertx.howtos.graphql;

import java.util.UUID;

public record Task(String id, String description, boolean completed) {

  public Task(String description) {
    this(UUID.randomUUID().toString(), description, false); (1)
  }
}

1	创建 `Task` 实例时会分配一个随机标识符

Task 类字段名称必须与相应的 GraphQL 模式类型字段名称匹配。

启动时，我们将创建一些条目