Spring Boot整合GraphQL实现API查询的详细教程

如何在spring boot中集成graphql？1. 添加依赖：引入spring-boot-starter-graphql和spring-boot-starter-web，可选graphiql-spring-boot-starter用于图形界面；2. 定义schema：在schema.graphqls中声明query和book类型；3. 创建java模型：实现与schema对应的book类；4. 编写resolver：通过bookqueryresolver类实现查询逻辑；5. 测试接口：通过/graphql发送post请求或使用/graphiql页面调试。

GraphQL 作为一种灵活的 API 查询语言，近年来在前后端交互中越来越受欢迎。Spring Boot 作为 Java 开发中最主流的框架之一，自然也提供了对 GraphQL 的良好支持。如果你正在寻找一种方式将 GraphQL 集成到你的 Spring Boot 项目中，这篇教程应该能帮你搞定。

添加依赖

要在 Spring Boot 中使用 GraphQL，第一步是引入必要的依赖。目前最常用的方式是使用 Spring Boot Starter for GraphQL，它基于 GraphQL Java Tools 实现。

打开 pom.xml 文件，添加如下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-graphql</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

如果你打算通过浏览器访问 GraphiQL 来测试接口，可以再加一个 UI 工具包：

<dependency>
    <groupId>com.graphql-java-kickstart</groupId>
    <artifactId>graphiql-spring-boot-starter</artifactId>
    <version>11.0.0</version>
</dependency>

这样配置完成后，启动项目后访问 /graphiql 就能看到图形化界面了。

定义 Schema 和数据模型

GraphQL 的核心是 schema（模式），你需要先定义好查询结构和返回的数据类型。

在 src/main/resources 目录下创建一个 .graphqls 文件，比如叫 schema.graphqls，内容如下：

type Query {
    getBookById(id: ID): Book
}

type Book {
    id: ID
    title: String
    author: String
}

这段代码定义了一个简单的查询入口：可以通过 getBookById 获取一本图书的信息，图书包含 id、title 和 author 三个字段。

接下来，你需要创建一个对应的 Java 类来匹配这个结构：

public class Book {
    private String id;
    private String title;
    private String author;

    // 构造方法、getter/setter 省略
}

编写 Resolver 实现查询逻辑

有了 schema 和数据模型之后，下一步就是实现具体的查询逻辑。这一步需要用到一个 resolver 类，它负责处理每个查询字段的执行。

创建一个类，加上 @Component 注解，并继承 GraphQLQueryResolver：

@Component
public class BookQueryResolver {

    public Book getBookById(String id) {
        // 这里可以调用数据库或其它服务获取数据
        return new Book(id, "示例书名", "张三");
    }
}

Spring Boot 会自动扫描这个类并绑定到 GraphQL 查询上。

如果你有多个查询或者需要处理嵌套结构，可以在 resolver 中添加更多方法，只要保证方法名与 schema 中的字段一致即可。

测试你的 GraphQL 接口

完成上述步骤后，启动应用。你可以通过两种方式测试接口：

• 使用 HTTP 请求访问 /graphql，发送 POST 请求体为标准的 GraphQL 查询语句。
• 如果你添加了 GraphiQL 依赖，可以直接访问 /graphiql 页面，在界面上输入查询语句进行调试。

例如，输入如下查询：

query {
  getBookById(id: "1") {
    title
    author
  }
}

你应该能收到类似以下的响应：

{
  "data": {
    "getBookById": {
      "title": "示例书名",
      "author": "张三"
    }
  }
}

如果一切正常，说明你的 Spring Boot 项目已经成功集成了 GraphQL 查询功能。

基本上就这些，虽然看起来有点步骤多，但每一步都比较简单，关键是要把 schema、resolver 和 model 对应起来。一旦熟悉流程，以后每次新增一个查询都不会太麻烦。

以上就是Spring Boot整合GraphQL实现API查询的详细教程的详细内容，更多请关注php中文网其它相关文章！