0

0

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

看不見的法師

看不見的法師

发布时间:2025-07-03 17:51:06

|

848人浏览过

|

来源于php中文网

原创

如何在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页面调试。

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

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

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

添加依赖

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

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

打开 pom.xml 文件,添加如下依赖:


    org.springframework.boot
    spring-boot-starter-graphql



    org.springframework.boot
    spring-boot-starter-web

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

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

    com.graphql-java-kickstart
    graphiql-spring-boot-starter
    11.0.0

这样配置完成后,启动项目后访问 /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 类来匹配这个结构:

Codiga
Codiga

可自定义的静态代码分析检测工具

下载
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 对应起来。一旦熟悉流程,以后每次新增一个查询都不会太麻烦。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

832

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

738

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

734

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

397

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

398

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16925

2023.08.03

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

63

2026.01.14

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何进行WebSocket调试
如何进行WebSocket调试

共1课时 | 0.1万人学习

TypeScript全面解读课程
TypeScript全面解读课程

共26课时 | 5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号