GraphQL Spring Boot 项目教程

2026-01-17 08:50:22作者：苗圣禹Peter

graphql-spring-boot 是一款强大的Spring Boot启动器，让集成GraphQL变得前所未有的简单。它为你的应用提供了开箱即用的GraphQL服务，支持GraphiQL、Altair和GraphQL Playground等调试工具，以及一系列自定义配置选项，满足你对GraphQL服务器的高级需求。无需繁琐的设置，无论是快速原型开发还是构建复杂API，这个库都能让你在Spring生态下无缝接入GraphQL技术，享受高效的前后端分离与数据查询能力。随着版本演进，请注意官方Spring框架已直接支持GraphQL，但此库仍是迁移前或特定需求下的宝贵资源。探索这个库，解锁现代Web应用的数据交互新纪元。

项目地址：https://gitcode.com/gh_mirrors/gr/graphql-spring-boot

1. 项目的目录结构及介绍

graphql-spring-boot/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── example/
│   │   │           ├── GraphQLProvider.java
│   │   │           ├── GraphQLDataFetchers.java
│   │   │           └── Application.java
│   │   └── resources/
│   │       ├── application.properties
│   │       └── schema.graphqls
├── pom.xml
└── README.md

目录结构介绍

src/main/java/com/example/: 包含主要的Java源代码文件。
- GraphQLProvider.java: 配置GraphQL实例和Schema。
- GraphQLDataFetchers.java: 实现数据获取器。
- Application.java: Spring Boot应用程序的入口点。
src/main/resources/: 包含资源文件。
- application.properties: 项目的配置文件。
- schema.graphqls: GraphQL的Schema定义文件。
pom.xml: Maven项目的配置文件。
README.md: 项目的说明文档。

2. 项目的启动文件介绍

Application.java

package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

@SpringBootApplication: 这是一个组合注解，包含了@Configuration、@EnableAutoConfiguration和@ComponentScan。
main方法: 启动Spring Boot应用程序。

3. 项目的配置文件介绍

application.properties

# 服务器端口
server.port=8080

# GraphQL配置
graphql.servlet.mapping=/graphql
graphql.servlet.enabled=true
graphql.servlet.corsEnabled=true

# GraphiQL和Playground配置
graphql.graphiql.enabled=true
graphql.playground.enabled=true

server.port: 指定服务器端口。
graphql.servlet.mapping: GraphQL服务的URL映射。
graphql.servlet.enabled: 启用GraphQL Servlet。
graphql.servlet.corsEnabled: 启用CORS支持。
graphql.graphiql.enabled: 启用GraphiQL界面。
graphql.playground.enabled: 启用Playground界面。

schema.graphqls

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

type Book {
    id: ID
    name: String
    pageCount: Int
    author: Author
}

type Author {
    id: ID
    firstName: String
    lastName: String
}

Query: 定义查询类型。
Book: 定义书籍类型。
Author: 定义作者类型。

以上是GraphQL Spring Boot项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

graphql-spring-boot

项目地址：https://gitcode.com/gh_mirrors/gr/graphql-spring-boot

登录后查看全文