GraphQL- Java实战入门

客官°小女子只卖身不卖艺 2021-06-11 15:11 661阅读 0赞

[http://www.zhaiqianfeng.com/2017/06/learn-graphql-action-by-java.html][http_www.zhaiqianfeng.com_2017_06_learn-graphql-action-by-java.html]

本篇主要使用[graphql-java][]来演示如何使用Java来构建GraphQL API，文中使了Gradle作为构建工具，但未使用其特性，因此你也可以使用Maven，只是简单添加依赖即可。主要涉及到枚举(enum)、输入类型(input)、参数(argument)、接口(interface)、联合(union)等服务端，以及客户端查询测试。本例代码存放在 [https://github.com/zhaiqianfeng/GraphQL-Demo/tree/master/java][https_github.com_zhaiqianfeng_GraphQL-Demo_tree_master_java]

[![GraphQL][]][GraphQL]

#### 添加依赖 ####

gradle

maven

本文示例使用的构建工具是Gradle。

#### 示例代码结构 ####

示例结构目录如下

每个示例基本遵循流程：**提供带查询的示例数据-> 定义GrapQL数据类型 -> 定义暴露给客户端的query api和mutaion api -> 创建GraphQL Schema -> 测试输出**。

#### 简单示例 ####

示例代码如下

<table style="border-spacing:0px;margin:0px;width:auto;border:none;font-size:14px;table-layout:fixed;"> 
 <tbody> 
  <tr style="background-color:rgb(249,249,249);"> 
   <td style="padding:0px;vertical-align:middle;border-style:none;"><pre style="font-family:consolas, Menlo, 'PingFang SC', 'Microsoft YaHei', monospace;font-size:13px;margin-bottom:0px;padding:10px;color:rgb(197,200,198);background:rgb(29,31,33);line-height:1.6;border:none;"></pre> 
    <div style="height:20px;">
      // com.zqf.get_start.GraphQL_Simple 
    </div> 
    <div style="height:20px;">
      //服务端示例数据 
    </div> 
    <div style="height:20px;">
      User user=new User(); 
    </div> 
    <div style="height:20px;">
      user.setName("zhaiqianfeng"); 
    </div> 
    <div style="height:20px;">
      user.setSex("男"); 
    </div> 
    <div style="height:20px;">
      user.setIntro("博主，专注于Linux,Java,nodeJs,Web前端:Html5,JavaScript,CSS3"); 
    </div> 
    <div style="height:20px;"></div> 
    <div style="height:20px;">
      //定义GraphQL类型 
    </div> 
    <div style="height:20px;">
      GraphQLObjectType userType = newObject() 
    </div> 
    <div style="height:20px;">
      .name("User") 
    </div> 
    <div style="height:20px;">
      .field(newFieldDefinition().name("name").type(GraphQLString)) 
    </div> 
    <div style="height:20px;">
      .field(newFieldDefinition().name("sex").type(GraphQLString)) 
    </div> 
    <div style="height:20px;">
      .field(newFieldDefinition().name("intro").type(GraphQLString)) 
    </div> 
    <div style="height:20px;">
      .build(); 
    </div> 
    <div style="height:20px;"></div> 
    <div style="height:20px;">
      //定义暴露给客户端的查询query api 
    </div> 
    <div style="height:20px;">
      GraphQLObjectType queryType = newObject() 
    </div> 
    <div style="height:20px;">
      .name("userQuery") 
    </div> 
    <div style="height:20px;">
      .field(newFieldDefinition().type(userType).name("user").staticValue(user)) 
    </div> 
    <div style="height:20px;">
      .build(); 
    </div> 
    <div style="height:20px;"></div> 
    <div style="height:20px;">
      //创建Schema 
    </div> 
    <div style="height:20px;">
      GraphQLSchema schema = GraphQLSchema.newSchema() 
    </div> 
    <div style="height:20px;">
      .query(queryType) 
    </div> 
    <div style="height:20px;">
      .build(); 
    </div> 
    <div style="height:20px;"></div> 
    <div style="height:20px;">
      //测试输出 
    </div> 
    <div style="height:20px;">
      GraphQL graphQL = GraphQL.newGraphQL(schema).build(); 
    </div> 
    <div style="height:20px;">
      Map&lt;String, Object&gt; result = graphQL.execute("{user{name,sex,intro}}").getData(); 
    </div> 
    <div style="height:20px;">
      System.out.println(result); 
    </div></td> 
  </tr> 
 </tbody> 
</table>

执行输出

#### 参数(argument)示例 ####

参数示例代码比较多，请参考[github上的源码:GraphQL\_argument.java][github_GraphQL_argument.java]，做如下几点说明。

##### 定义形参 #####

传输参数是通过argument方法传入并指定类型，如

##### 接收参数 #####

获取参数使用DataFetchingEnvironment，如

获取参数有如下两个重构

但当我使用后者把传入的userInfo转换为User时，异常

因此不得不如下蹩脚书写

##### Resolver #####

解析数据使用的是DataFetcher，如

为了简洁，你可以使用lambda表达式

#### 联合(union)示例 ####

这部分没说明好说的，如果了解了union的概念代码示例非常清晰，请参考[github上的源码:GraphQL\_union.java][github_GraphQL_union.java]。使用GraphQLUnionType定义union类型，其中possibleType指定可以union的类型，重点是关注typeResolver来做类型转换，但个人觉得这里实现有待改进，对于Java这种强类型语言自动处理比较人性化。

#### 接口(interface)示例 ####

graphql-java对GraphQL的接口实现确实使用的Java接口，但个人觉得使用集成或许更合适。定义接口使用的GraphQLInterfaceType关键字，实现接口使用的withInterface关键字。

##### 坑：对象为定义 #####

上面的关键字都不难理解，蛋疼的是把如下的定义放在方法体中却提示为定义

<table style="border-spacing:0px;margin:0px;width:auto;border:none;font-size:14px;table-layout:fixed;"> 
 <tbody> 
  <tr style="background-color:rgb(249,249,249);"> 
   <td style="padding:0px;vertical-align:middle;border-style:none;"><pre style="font-family:consolas, Menlo, 'PingFang SC', 'Microsoft YaHei', monospace;font-size:13px;margin-bottom:0px;padding:10px;color:rgb(197,200,198);background:rgb(29,31,33);line-height:1.6;border:none;"></pre> 
    <div style="height:20px;">
      GraphQLInterfaceType animalInterface = newInterface()//定义接口(interface)类型 
    </div> 
    <div style="height:20px;">
      .name("IAnimal") 
    </div> 
    <div style="height:20px;">
      .description("动物接口") 
    </div> 
    <div style="height:20px;">
      .field(newFieldDefinition() 
    </div> 
    <div style="height:20px;">
      .name("name") 
    </div> 
    <div style="height:20px;">
      .type(GraphQLString)) 
    </div> 
    <div style="height:20px;">
      .typeResolver(new TypeResolver() { 
    </div> 
    <div style="height:20px;">
      @Override 
    </div> 
    <div style="height:20px;">
      public GraphQLObjectType getType(TypeResolutionEnvironment env) { 
    </div> 
    <div style="height:20px;">
      if (env.getObject() instanceof Dog4Interface) { 
    </div> 
    <div style="height:20px;">
      return dogType; //提示 dogType 未定义 
    </div> 
    <div style="height:20px;">
      } 
    </div> 
    <div style="height:20px;">
      if (env.getObject() instanceof Fish4Interface) { 
    </div> 
    <div style="height:20px;">
      return fishType; //提示 fishType 未定义 
    </div> 
    <div style="height:20px;">
      } 
    </div> 
    <div style="height:20px;">
      return null; 
    </div> 
    <div style="height:20px;">
      } 
    </div> 
    <div style="height:20px;">
      }) 
    </div> 
    <div style="height:20px;">
      .build(); 
    </div> 
    <div style="height:20px;"></div> 
    <div style="height:20px;">
      GraphQLObjectType dogType = newObject()//定义Dog类型 
    </div> 
    <div style="height:20px;">
      .name("Dog4Interface") 
    </div> 
    <div style="height:20px;">
      .field(newFieldDefinition().name("name").type(GraphQLString)) 
    </div> 
    <div style="height:20px;">
      .field(newFieldDefinition().name("legs").type(GraphQLInt)) 
    </div> 
    <div style="height:20px;">
      .withInterface(animalInterface) 
    </div> 
    <div style="height:20px;">
      .build(); 
    </div> 
    <div style="height:20px;"></div> 
    <div style="height:20px;"></div> 
    <div style="height:20px;">
      GraphQLObjectType fishType = newObject()//定义Fish类型 
    </div> 
    <div style="height:20px;">
      .name("Fish4Interface") 
    </div> 
    <div style="height:20px;">
      .field(newFieldDefinition().name("name").type(GraphQLString)) 
    </div> 
    <div style="height:20px;">
      .field(newFieldDefinition().name("tailColor").type(GraphQLString)) 
    </div> 
    <div style="height:20px;">
      .withInterface(animalInterface) 
    </div> 
    <div style="height:20px;">
      .build(); 
    </div></td> 
  </tr> 
 </tbody> 
</table>

也看到了有开发者提了issue:[Circularity between object and interface type definitions][]，但依然没看到有效的解决方案，只好顺着作者愿意，把上面的定义作为字段才能解决，具体代码可参考[github上的源码:GraphQL\_interface.java][github_GraphQL_interface.java]

##### Schema加入额外类型 #####

最后还要提示下，由于查询返回的接口，但实现并没有自动添加到Schema中，因此需要在创建Schema时间，将其手动加入

#### 结束语 ####

虽然遇到了许多坑，但最后还是把需要的功能演示出来了，但无论是那种类库，基本的流程一般不会改变：基本遵循流程：**定义GrapQL数据类型 -> 定义暴露给客户端的query api和mutaion api -> 创建GraphQL Schema**。

[http_www.zhaiqianfeng.com_2017_06_learn-graphql-action-by-java.html]: http://www.zhaiqianfeng.com/2017/06/learn-graphql-action-by-java.html
[graphql-java]: http://graphql-java.readthedocs.io/
[https_github.com_zhaiqianfeng_GraphQL-Demo_tree_master_java]: https://github.com/zhaiqianfeng/GraphQL-Demo/tree/master/java
[GraphQL]: /images/20210527/316d969c152e48b3851cd81ea55f9698.png
[github_GraphQL_argument.java]: https://github.com/zhaiqianfeng/GraphQL-Demo/blob/master/java/src/main/java/com/zqf/advance/GraphQL_argument.java
[github_GraphQL_union.java]: https://github.com/zhaiqianfeng/GraphQL-Demo/blob/master/java/src/main/java/com/zqf/advance/GraphQL_union.java
[Circularity between object and interface type definitions]: https://github.com/graphql-java/graphql-java/issues/205
[github_GraphQL_interface.java]: https://github.com/zhaiqianfeng/GraphQL-Demo/blob/master/java/src/main/java/com/zqf/advance/GraphQL_interface.java