GraphQL才是API的未来？再谈GraphQL在SpringBoot项目中的应用

骑猪看日落 2022-09-04 14:51 238阅读 0赞

**点击关注公众号，利用****碎片时间学习****![e4d9c8a406a931768a4905c3ad74d386.png][]**

## 前言 ##

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

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

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

## 快速开始 ##

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

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

![0ca4dbac4c1f74030c24d3402e526dab.png][]

点击下方的Generate按钮：

![16fc2bfbdad9258222f3175c9482988d.png][]

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

![724ad3b0a5bfc31d940b7339be93f567.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容器][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[项目结构][Link 1]（controller,service,dao等）：

![39fd77684c3a8872d15693c8f56790c7.png][]

### 测试 ###

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

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

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

![53ed36cba5c6b8ce695eb47e5a8cabc0.png][]

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

![666513240b1921e8900487e4a27be6f4.png][]

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

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

![110dd106f424974b8fedfb569ab19da6.png][]

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

![ef6d7652f83d01608b45875456c43011.png][]

## 结束语 ##

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

关于示例的完整代码，我提交到了github，感兴趣可以下载下来看下，地址：

> https://github.com/xxd763795151/graphql.demo

*（感谢阅读，希望对你所有帮助)*

*来源：www.toutiao.com/i6929867921162273292*

推荐好文

[强大，10k+点赞的 SpringBoot 后台管理系统竟然出了详细教程！][10k_ SpringBoot]

[分享一套基于SpringBoot和Vue的企业级中后台开源项目，代码很规范！][SpringBoot_Vue]

[能挣钱的，开源 SpringBoot 商城系统，功能超全，超漂亮][SpringBoot]![01cbfd2de8771c89bdf01d7a308e55f2.png][]

[e4d9c8a406a931768a4905c3ad74d386.png]: /images/20220829/3496ffcc2444461aaceb12e40346d2ed.png
[0ca4dbac4c1f74030c24d3402e526dab.png]: /images/20220829/290f46e7a0ef49ceaddbf2ba40dec95b.png
[16fc2bfbdad9258222f3175c9482988d.png]: /images/20220829/a33426b6020d442b99c5a0262f92586e.png
[724ad3b0a5bfc31d940b7339be93f567.png]: /images/20220829/6782da896a0a413a94f681f8b8eccca6.png
[spring]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc79b745cb0e3e532f103289d05017f4edf3e504fa237b6a1c0037169a456882bfcc492c6bbb&idx=1&mid=2247506667&scene=21&sn=16e7221ce8a99b5e32438a9696254392#wechat_redirect
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc79ac76cb0e2560647530420582981afaed8f2c210d989bb91c8267f0ffbcaa010d477875e2&idx=1&mid=2247500248&scene=21&sn=feca0954b4a6c7f8cc405d050a8d8a25#wechat_redirect
[39fd77684c3a8872d15693c8f56790c7.png]: /images/20220829/db526dab9e274322bed799b6daa1721a.png
[3]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc79b708cb0e3e1e0f25f16f4e5ef9aa146e0e864dfa47e7c2d38fc1518c26628107642db93f&idx=2&mid=2247506598&scene=21&sn=503f3fdb8d914961af366c718e42a649#wechat_redirect
[53ed36cba5c6b8ce695eb47e5a8cabc0.png]: /images/20220829/f1093ab4118e49799feecf75720ed002.png
[666513240b1921e8900487e4a27be6f4.png]: /images/20220829/94578f456c8944c0923455481d3356ca.png
[110dd106f424974b8fedfb569ab19da6.png]: /images/20220829/5a8d835c1f3c4b6b88277b0cbcd6b22f.png
[ef6d7652f83d01608b45875456c43011.png]: /images/20220829/74a0b6dac3404846ac81389f604a923a.png
[10k_ SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzI4Njc5NjM1NQ%3D%3D&chksm=ebd5c411dca24d07446a4f22772cd12d2cc1143b62eb922a14500ae981cd57fb850ef74ca257&idx=2&mid=2247498557&scene=21&sn=84902d7030e174e152615d8fae3755cc#wechat_redirect
[SpringBoot_Vue]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799be6cb0e12f0b58479f8b031bc5ae79efdca1880ff9b19f0a107c3a88c37b9596dc73203&idx=2&mid=2247497288&scene=21&sn=65d7111a19e920df1e9416959594b2f4#wechat_redirect
[SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799a9ccb0e138a64a2671f31b8d4be1b3c061a288f7b0d1d4af02a60c45a72231446b91e00&idx=2&mid=2247497522&scene=21&sn=c5b4e596be4ac7d7f293e7e2f0ea0769#wechat_redirect
[01cbfd2de8771c89bdf01d7a308e55f2.png]: /images/20220829/b6346f24aa914782849290e6ebf7e32c.png