Spring Boot + GraphQL 才是 API 的未来！

拼搏现实的明天。 2022-08-28 05:38 178阅读 0赞

来源：[www.toutiao.com/i6929867921162273292][www.toutiao.com_i6929867921162273292]

## **前言** ##

在浅尝GraphQL一文描述了GraphQL及基本使用，本文提供一个基本示例，描述如何基于spring boot的web项目快速应用。

graphql-java的官方文档：Getting started with GraphQL Java and Spring Boot，提供了相关依赖用以快速配置，但是个人真心不建议使用这个库及相关配置方式来搭建脚手架，在实际开发中，业务比较复杂的时候，会导致需要配置的业务代码比较多也比较繁琐，相对下面这种方式，代码复杂性比较高。

本文提供一种更灵活快捷的方式，在spring boot项目中快速应用开发。使用的依赖也和上面官方提供的都不一样，请注意区分。

## **快速开始** ##

### 创建spring boot工程 ###

通过Spring Initializr快速搭建，我选的jdk版本及spring boot版本，如下所示，其它版本未做兼容性测试。

![20211018094359731.png][]

点击下方的Generate按钮：

![2021101809440069.png][]

打开工程结构如下，我将application.properties删除了替换成applicaiton.yml，因为我个人比较喜欢yaml的配置方式：

![20211018094400581.png][]

### 引入相关依赖 ###

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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>2.4.6</version>
      <relativePath/> 
     </parent>
     <groupId>com.xuxd</groupId>
     <artifactId>graphql.demo</artifactId>
     <version>0.0.1-SNAPSHOT</version>
     <name>graphql.demo</name>
     <description>GraphQL Demo project for Spring Boot</description>
     <properties>
      <java.version>1.8</java.version>
      <maven.compiler.source>1.8</maven.compiler.source>
      <maven.compiler.target>1.8</maven.compiler.target>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
      <lombok.version>1.18.20</lombok.version>
      <graphql-java-tools.version>11.0.1</graphql-java-tools.version>
      <gson.version>2.8.7</gson.version>
     </properties>
     <dependencies>
      <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter</artifactId>
      </dependency>
    
      <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
      </dependency>
    
      <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-test</artifactId>
       <scope>test</scope>
      </dependency>
    
      <dependency>
       <groupId>org.projectlombok</groupId>
       <artifactId>lombok</artifactId>
       <version>${lombok.version}</version>
       <scope>provided</scope>
      </dependency>
    
      <dependency>
       <groupId>com.graphql-java-kickstart</groupId>
       <artifactId>graphql-java-tools</artifactId>
       <version>${graphql-java-tools.version}</version>
      </dependency>
    
      <dependency>
       <groupId>com.google.code.gson</groupId>
       <artifactId>gson</artifactId>
       <version>${gson.version}</version>
      </dependency>
     </dependencies>
    
     <build>
      <plugins>
       <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
       </plugin>
      </plugins>
     </build>
    
    </project>

### 初始化GraphQL实例 ###

我们将创建一个GraphQL实例并将其注册到spring容器中，代码如下：

创建一个GraphQLProvider类：

@Component
    public class GraphQLProvider {
    
        private GraphQL graphQL;
    
        @Autowired
        private IItemService itemService;
    
        @Bean
        public GraphQL graphQL() {
            return graphQL;
        }
    
        @PostConstruct
        public void init() throws IOException {
            GraphQLSchema graphQLSchema = SchemaParser.newParser()
                .file("graphql/base.graphqls")
                .resolvers(new Query(), new Mutation())
                .file("graphql/item.graphqls")
                .resolvers(new ItemResolver(itemService))
    //            .file("book.graphqls")
    //            .resolvers(new BookResolver())  //其它定义照上面的示例，继续增加
                .build().makeExecutableSchema();
    
            this.graphQL = graphQL.newGraphQL(graphQLSchema).build();
        }
    
    }

关于`*.graphqls`或者对应的Resolver如ItemResolver，可以参看浅尝GraphQL相关描述，这里只是作了微调整，相关代码如下：

**base.grqphqls**

schema {
        # 查询
        query: Query
        # 更新
        mutation: Mutation
    }
    
    type Query {
        version: String
    }
    
    type Mutation {
        version: String
    }

**item.graphqls**

# 定义一个查询类型
    extend type Query {
        queryItemList: ItemList  # 定义查询项目列表
        queryById(id: ID): Item
    }
    
    extend type Mutation {
        updateName(param: Param): Item
    }
    
    # 定义项目字段
    type Item {
        id: ID!
        code: String!
        name: String!
    }
    
    type ItemList {
        itemList: [Item!]!  #获取项目列表
        total: Int!      # 获取项目总数
    }
    
    input Param {
        id: ID!
        name: String!
    }

ItemResolver

public class ItemResolver implements GraphQLQueryResolver, GraphQLMutationResolver {
    
        private IItemService itemService;
    
        public ItemResolver(IItemService itemService) {
            this.itemService = itemService;
        }
    
        // 对应item.graphqls里的queryItemList
        public ItemList queryItemList() {
            return itemService.queryItemList();
        }
    
        public Item queryById(Long id) {
            return itemService.queryById(id);
        }
    
        public Item updateName(Param param) {
            return itemService.updateName(param);
        }
    }

相关业务代码比较多，就不一一贴了。

### 提供API ###

我们需要暴露一个接口来接收请求，并作相关处理，也只需提供一个接口即可。因此我们创建一个Controller：GraphqlController.

@RestController
    @RequestMapping("/graphql")
    @Log
    public class GraphqlController {
    
        @Autowired
        private GraphQL graphQL;
    
        @PostMapping
        public Object execute(@RequestBody GraphqlRequest request) {
            ExecutionInput executionInput = ExecutionInput.newExecutionInput()
                .query(request.getQuery())
                .variables(request.getVariables())
                .build();
            Map<String, Object> result = new HashMap<>();
    
            ExecutionResult executionResult = graphQL.execute(executionInput);
            List<GraphQLError> errors = executionResult.getErrors();
    
            if (errors != null && !errors.isEmpty()) {
                result.put("errors", errors);
                return result;
            }
            return executionResult.getData();
        }
    }

到这一步，其实基本功能都已配置完成，可以启动项目进行相关测试了。

整个项目的代码结构如下，我尽量用了一个比较常规的web项目结构（controller,service,dao等）：

![20211018094401103.png][]

### 测试 ###

示例中总共提供了3个接口，两个查询一个更新，分别进行测试：

ItemList queryItemList();
    
    Item queryById(Long id);
    
    Item updateName(Param param);

**查询所有项目列表（只获取每个项目的编码和名称，以及列表总数）：**

![20211018094401392.png][]

**根据ID查询，获取项目的id和名称**

![20211018094401968.png][]

**更新指定ID的项目名称**

我们项目Id为1编码为test的项目修改为“java项目”

![20211018094402979.png][]

再查询一下，可以看到结果更新了：

![20211018094403430.png][]

## **结束语** ##

这样整个项目的GraphQL相关的基本配置已经完成，可以进行业务开发了。

**近期热文推荐：**

1.[1,000+ 道 Java面试题及答案整理(2021最新版)][1_000_ _ Java_2021]

2.[别在再满屏的 if/ else 了，试试策略模式，真香！！][if_ else]

3.[卧槽！Java 中的 xx ≠ null 是什么新语法？][Java _ xx _ null]

4.[Spring Boot 2.5 重磅发布，黑暗模式太炸了！][Spring Boot 2.5]

5.[《Java开发手册（嵩山版）》最新发布，速速下载！][Java]

觉得不错，别忘了随手点赞+转发哦！

[www.toutiao.com_i6929867921162273292]: http://www.toutiao.com/i6929867921162273292
[20211018094359731.png]: /images/20220828/a0defba1ef5046bd88d79b2a4198478c.png
[2021101809440069.png]: /images/20220828/7ff20c4cc77a489d9cfbe8eb1273b654.png
[20211018094400581.png]: /images/20220828/f936fcf624694743b74733c1fcb3053b.png
[20211018094401103.png]: /images/20220828/cf5426b9ab6643768dbf922336d5d540.png
[20211018094401392.png]: /images/20220828/0c56fed1dbe94963934d75ecf978a7b3.png
[20211018094401968.png]: /images/20220828/46cb5a37cb294d4ebea95a071a96e6b4.png
[20211018094402979.png]: /images/20220828/e030ad94a43e4c819208c3d6e709f1fe.png
[20211018094403430.png]: /images/20220828/d191137c331f4e7fb967c6f54b38a979.png
[1_000_ _ Java_2021]: https://www.javastack.cn/mst/
[if_ else]: https://www.javastack.cn/article/2021/strategy-pattern-instead-of-if-else/
[Java _ xx _ null]: https://www.javastack.cn/article/2021/intellij-idea-ligatures-settings/
[Spring Boot 2.5]: https://www.javastack.cn/article/2021/spring-boot-2.5-released/
[Java]: http://www.javastack.cn/article/2020/alibaba-release-java-develop-rules-songshan/