Java 使用 Graphql 搭建查询服务详解
更新时间：2016年12月09日 11:24:47 投稿：lqh
这篇文章主要介绍了Java 使用 Graphql 搭建查询服务详解的相关资料,需要的朋友可以参考下
背景
随着React的开源，facebook相继开源了很多相关的项目，这些项目在他们内部已经使用了多年，其中引起我注意的就是本次讨论的是graphql，目前官方只有nodejs版，由于很多公司的后台技术栈都是Java，所以便有了graphql的java版实现，在github上可以找到，废话不多说，直接看代码吧，具体介绍还是去看官网吧，不然就跑题了。
GraphQLSchema
Schema相当于一个数据库，它有很多GraphQLFieldDefinition组成，Field相当于数据库表/视图，每个表/视图又由名称、查询参数、数据结构、数据组成.
1） 先定义一个数据结构（GraphQLOutputType）字段，然后定义一个初始化方法
private GraphQLOutputType userType;
private void initOutputType() {
/**
* 会员对象结构
*/
userType = newObject()
.name("User")
.field(newFieldDefinition().name("id").type(GraphQLInt).build())
.field(newFieldDefinition().name("age").type(GraphQLInt).build())
.field(newFieldDefinition().name("sex").type(GraphQLInt).build())
.field(newFieldDefinition().name("name").type(GraphQLString).build())
.field(newFieldDefinition().name("pic").type(GraphQLString).build())
.build();
}
2）再定义两个表/视图，它包括名称，查询参数，数据结构，以及数据检索器
/**
* 查询单个用户信息
* @return
*/
private GraphQLFieldDefinition createUserField() {
return GraphQLFieldDefinition.newFieldDefinition()
.name("user")
.argument(newArgument().name("id").type(GraphQLInt).build())
.type(userType)
.dataFetcher(environment -> {
// 获取查询参数
int id = environment.getArgument("id");
// 执行查询, 这里随便用一些测试数据来说明问题
User user = new User();
user.setId(id);
user.setAge(id + 15);
user.setSex(id % 2);
user.setName("Name_" + id);
user.setPic("pic_" + id + ".jpg");
return user;
})
.build();
}
/**
* 查询多个会员信息
* @return
*/
private GraphQLFieldDefinition createUsersField() {
return GraphQLFieldDefinition.newFieldDefinition()
.name("users")
.argument(newArgument().name("page").type(GraphQLInt).build())
.argument(newArgument().name("size").type(GraphQLInt).build())
.argument(newArgument().name("name").type(GraphQLString).build())
.type(new GraphQLList(userType))
.dataFetcher(environment -> {
// 获取查询参数
int page = environment.getArgument("page");
int size = environment.getArgument("size");
String name = environment.getArgument("name");
// 执行查询, 这里随便用一些测试数据来说明问题
List<User> list = new ArrayList<>(size);
for (int i = 0; i < size; i++) {
User user = new User();
user.setId(i);
user.setAge(i + 15);
user.setSex(i % 2);
user.setName(name + "_" + page + "_" + i);
user.setPic("pic_" + i + ".jpg");
list.add(user);
}
return list;
})
.build();
}
3）接着定义一个Schema，并将其初始化，它包含一个名称，以及一个或多个表/视图（Field）
private GraphQLSchema schema;
public GraphSchema() {
initOutputType();
schema = GraphQLSchema.newSchema().query(newObject()
.name("GraphQuery")
.field(createUsersField())
.field(createUserField())
.build()).build();
}
4）完成以上步骤之后，还需要定义一个model，类名不限，但是结构需要满足前面定义的数据结构，而且必须是public的
public class User {
private int id;
private int age;
private int sex;
private String name;
private String pic;
// getter, setter...
}
5）之后写一个main方法，来测试一下
public static void main(String[] args) {
GraphQLSchema schema = new GraphSchema().getSchema();
String query1 = "{users(page:2,size:5,name:\"john\") {id,sex,name,pic}}";
String query2 = "{user(id:6) {id,sex,name,pic}}";
String query3 = "{user(id:6) {id,sex,name,pic},users(page:2,size:5,name:\"john\") {id,sex,name,pic}}";
Map<String, Object> result1 = (Map<String, Object>) new GraphQL(schema).execute(query1).getData();
Map<String, Object> result2 = (Map<String, Object>) new GraphQL(schema).execute(query2).getData();
Map<String, Object> result3 = (Map<String, Object>) new GraphQL(schema).execute(query3).getData();
// 查询用户列表
System.out.println(result1);
// 查询单个用户
System.out.println(result2);
// 单个用户、跟用户列表一起查
System.out.println(result3);
}
输出：
{users=[{id=0, sex=0, name=john_2_0, pic=pic_0.jpg}, {id=1, sex=1, name=john_2_1, pic=pic_1.jpg}, {id=2, sex=0, name=john_2_2, pic=pic_2.jpg}, {id=3, sex=1, name=john_2_3, pic=pic_3.jpg}, {id=4, sex=0, name=john_2_4, pic=pic_4.jpg}]}
{user={id=6, sex=0, name=Name_6, pic=pic_6.jpg}}
{user={id=6, sex=0, name=Name_6, pic=pic_6.jpg}, users=[{id=0, sex=0, name=john_2_0, pic=pic_0.jpg}, {id=1, sex=1, name=john_2_1, pic=pic_1.jpg}, {id=2, sex=0, name=john_2_2, pic=pic_2.jpg}, {id=3, sex=1, name=john_2_3, pic=pic_3.jpg}, {id=4, sex=0, name=john_2_4, pic=pic_4.jpg}]}
6）最后把main方法里面的代码放到web层，只需要定义一个query参数，很容易就把查询服务搭建好了，dataFetcher 里面还是调用原来的查询接口
7）引入maven依赖
<dependency> <groupId>com.graphql-java</groupId> <artifactId>graphql-java</artifactId> <version>2.0.0</version> </dependency>
关于graphql查询什么定义，看看这个或许对你有帮助
json
{
id=6,
sex=0,
name="Name_6",
pic="pic_6.jpg"
}
query
{
id,
sex,
name,
pic
}
后面那部分，其实就是json字符串，去掉=和value的结果，还是可读的
结语
graphql 带了一种全新的思维方式，可以简化web api的开发，由客户端指定需要什么数据，服务端返回什么数据，减少不必要的流量传输，对移动端友好，还提供多种数据聚合查询，多个查询只是用一个请求，既满足api最小粒度，又满足前端需要，减少请求，提高性能。
感觉以后会朝这方面去发展，大趋所驱。
相关文章
Springboot使用pdfbox提取PDF图片的代码示例
PDFBox是一个用于创建和处理PDF文档的Java库，它可以使用Java代码创建、读取、修改和提取PDF文档中的内容，本文就给大家介绍Springboot如何使用pdfbox提取PDF图片，感兴趣的同学可以借鉴参考2023-06-06
springboot 集成easy-captcha实现图像验证码显示和登录
本文主要介绍了springboot 集成easy-captcha实现图像验证码显示和登录，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2023-04-04
Spring中如何使用@Value注解实现给Bean属性赋值
这篇文章主要介绍了Spring中如何使用@Value注解实现给Bean属性赋值的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-08-08
这篇文章主要介绍了SpringBoot中的五种对静态资源的映射规则的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2019-12-12
文章主要介绍了Java中Map和Set两种数据结构的定义、实现、方法及应用场景,Map用于存储键值对,键唯一,值可重复；Set用于存储唯一元素,无序,两者都提供了丰富的操作方法,如添加、删除、查找等,感兴趣的朋友一起看看吧2025-02-02
这篇文章主要介绍了Java之SpringBean生命周期问题理解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下2021-07-07
本篇文章介绍了，Thread类创建线程的方法。需要的朋友参考下2013-05-05
springboot使用定时器@Scheduled不管用的解决
这篇文章主要介绍了springboot使用定时器@Scheduled不管用的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-12-12
这篇文章主要介绍了Java hutool List集合对象拷贝的相关资料,文章还分享了在实现过程中遇到的一些问题,并强调了阅读源码和正确配置CopyOptions的重要性,需要的朋友可以参考下2024-12-12
这篇文章主要为大家详细介绍了Java类获取Spring中bean的5种方式，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2016-03-03
最新评论