SpringBoot开发秘籍 - 集成Graphql Query
概述
REST作为一种现代网络应用非常流行的软件架构风格受到广大WEB开发者的喜爱,在目前软件架构设计模式中随处可见REST的身影,但是随着REST的流行与发展,它的一个最大的缺点开始暴露出来:
在很多时候客户端需要的数据往往在不同的地方具有相似性,但却又不尽相同。如同样的用户信息,在有的场景下前端只需要用户的简要信息(名称、头像),在其他场景下又需要用户的详细信息。当这样的相似但又不同的地方多的时候,就需要开发更多的接口来满足前端的需要。
随着这样的场景越来越多,接口越来越多,文档越来越臃肿,前后端沟通成本呈指数增加。
基于上面的场景,我们迫切需要有一种解决方案或框架,可以使得在使用同一个领域模型(DO、DTO)的数据接口时可以由前端指定需要的接口字段,而后端根据前端的需求自动适配并返回对应的字段。
这就是我们今天的主角GraphQL。
场景模拟
考虑下面的场景:
用户 与 文章 是一对多的关系,一个用户可以发表多篇文章,同时又可以根据文章找到对应的作者。
我们需要构建以下几个Graphql查询:
-
根据用户ID获取用户详情,并获取此用户发表的所有文章
-
根据文章ID获取文章详情,并获取文章作者的信息
当然项目是基于SpringBoot开发的。
开发实战
在正式开发之前我推荐你在IDEA上安装一下 JS GraphQL插件,这个插件方便我们编写Schema,语法纠错,代码高亮等等。。。
创建一个SpringBoot项目
通过IDEA创建一个SpringBoot项目,并引入对应的jar
<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> <!--graphql start--> <dependency> <groupId>com.graphql-java</groupId> <artifactId>graphql-spring-boot-starter</artifactId> <version>5.0.2</version> </dependency> <dependency> <groupId>com.graphql-java</groupId> <artifactId>graphql-java-tools</artifactId> <version>5.2.4</version> </dependency> <!--graphql end--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> </dependencies>
这里主要需要引入 graphql-spring-boot-starter
和 graphql-java-tools
。
建立Java实体类
User
@Data public class User { private int userId; private String userName; private String realName; private String email; private List<Post> posts; public User() { } public User(int userId, String userName, String realName, String email) { this.userId = userId; this.userName = userName; this.realName = realName; this.email = email; } }
Post
@Data public class Post { private int postId; private String title ; private String text; private String category; private User user; public Post() { } public Post(int postId, String title, String text, String category) { this.postId = postId; this.title = title; this.text = text; this.category = category; } }
定义了两个JAVA实体:Post,User。
编写Schema文件
在resources/schema目录下创建GraphQL Schema文件
schema { query: Query, } type Query { # 获取具体的用户 getUserById(id:Int) : User # 获取具体的博客 getPostById(id:Int) : Post } type User { userId : ID!, userName : String, realName : String, email : String, posts : [Post], } type Post { postId : ID!, title : String!, text : String, category: String user: User, }
如上,我们通过 type
关键字定义了两个对象,User与Post。在属性后面添加!表明这是一个非空属性,通过[Post]表明这是一个Post集合,类似于Java对象中List。
通过Query关键字定义了两个查询对象,getUserById,getPostById,分别返回User对象和Post对象。
关于schema的语法大家可以参考链接:https://graphql.org/learn/schema
编写业务逻辑
PostService
@Service public class PostService implements GraphQLQueryResolver { /** * 为了测试,只查询id为1的结果 */ public Post getPostById(int id){ if(id == 1){ User user = new User(1,"javadaily","JAVA日知录","zhangsan@qq.com"); Post post = new Post(1,"Hello,Graphql","Graphql初体验","日记"); post.setUser(user); return post; }else{ return null; } } }
UserService
@Service public class UserService implements GraphQLQueryResolver { List<User> userList = Lists.newArrayList(); public User getUserById(int id){ return userList.stream().filter(item -> item.getUserId() == id).findAny().orElse(null); } @PostConstruct public void initUsers(){ Post post1 = new Post(1,"Hello,Graphql1","Graphql初体验1","日记"); Post post2 = new Post(2,"Hello,Graphql2","Graphql初体验2","日记"); Post post3 = new Post(3,"Hello,Graphql3","Graphql初体验3","日记"); List<Post> posts = Lists.newArrayList(post1,post2,post3); User user1 = new User(1,"zhangsan","张三","zhangsan@qq.com"); User user2 = new User(2,"lisi","李四","lisi@qq.com"); user1.setPosts(posts); user2.setPosts(posts); userList.add(user1); userList.add(user2); } }
基于Graphql的查询需要实现 GraphQLQueryResolver
接口,由于为了便于演示我们并没有引入数据层,请大家知悉。
配置Graphql 端点
server.port = 8080 graphql.servlet.corsEnabled=true # 配置端点 graphql.servlet.mapping=/graphql graphql.servlet.enabled=true
配置完端口和端点后我们就可以对我们编写的Graphql接口进行测试了。
接口地址为:localhost:8080/graphql
测试
这里我使用的是Chrome浏览器的 Altair Graphal Client
插件,当然你还可以使用其他的客户端工具,如:graphql-playground。
安装插件
浏览器输入chrome://extensions/,在扩展中心搜索Altair后即可添加至浏览器。
查询
启动SpringBoot项目,然后在打开的Altair插件界面,输入Graphql端点 http://localhost:8080/graphql,然后点击 Docs
,将鼠标移至需要的查询上,点击 ADD QUERY
即可添加对应的查询。
点击Send Request 即可看到查询结果:
然后我们在Query中可以根据我们的需要新增或删除接口字段并重新请求接口,会看到响应结果中也会根据我们的请求自动返回结果:
小结
Graphql支持的数据操作有:
-
查询(Query):获取数据的基本查询。
-
变更(Mutation):支持对数据的增删改等操作。
-
订阅(Subscription):用于监听数据变动、并靠websocket等协议推送变动的消息给对方。
本节内容我们基于SpringBoot完成了Query的数据操作,实现过程还是相对比较简单。希望此文能让大家对Graphql有一个整体的了解,如果大家对Graphql感兴趣后面还会更新此系列文章,完成对其他数据操作的整合。
以上,希望对你有所帮助!
本文分享自微信公众号 - JAVA日知录(javadaily)。
如有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
说说SVG的feTurbulence滤镜
很多时候,我们在布置游戏地图或者动漫场景的时候,需要模拟火焰,树丛,云朵等等这些大自然鬼斧神工创造出来的形状或者纹理,这个时候,你会发现这些形状整体看起来很有规律,但形状的延续却完全随机,乱中有序。 上个世纪80年代,Ken Perlin 就思考过怎样模拟这些自然纹理这个问题,并且,给出了他的答案。在完全随机的白噪声函数上,用缓动曲线进行平滑插值,让函数的图像更加趋近于自然噪声的图像,也就是符合自然界形状和纹理规律的图像,由此发明了Perlin噪声算法。Perlin噪声算法提出后在很多场景都发挥了很大的作用,为迪士尼创造电影场景提供了许多帮助,曾经获得奥斯卡科技成果奖,是一个演技得到过认可的算法。 如今Perlin算法成了计算机图形学基础中的一员,任何跟图形学相关的工具库,都有他的实现,我们可以利用这些工具,从应用的角度学习Perlin噪声算法。 在SVG中,feTurbulence滤镜就可以利用Perlin函数创建丰富的图像。使用feTurbulence滤镜的时候,我们可以通过调整参数直观地看到效果,本文是对feTurbulence滤镜的学习记录,通过一些实验了解不同参数对feTur...
- 下一篇
2021年IT行业八大趋势预测
在新冠疫情的影响下,过去一年的IT行业产生着或多或少的变化。而今,2020年已走过一个季度,本文根据国内外一些调研机构的数据,整合了以下八条更适合国内的2021年IT行业趋势分析,希望能为相关决策者提供参考价值。 1.数字化转型速度加快 很多组织在几年前就开始实施数字化转型,但到了2020年,数字化转型的发展速度程度超过了任何人的预期。由于需要在网上开展更多业务,各行业组织不得不以比原先计划更快地采用数字化模型和流程。 为了跟上这一趋势,许多公司已将预算从其他计划转移到了数字化转型。IDC公司的分析师表示:“如今全球各地的组织加快数字化转型,从2020年到2023年,直接数字化转型(DX)投资将以15.5%的复合年增长率(CAGR)增长,预计市场规模将达6.8万亿美元,随着组织在现有战略和投资的基础上发展,将在未来成为更大规模的数字化组织。到2022年,70%的组织将加速使用数字技术,改造现有业务流程,以推动客户参与度、员工生产力和业务弹性。” 2.新兴技术快速发展提供新的拓展领域及发展空间 随着云计算、大数据的快速发展,企业将数据部署在云端不仅能够实现自有数据的充分利用从而提升经营效...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- CentOS8编译安装MySQL8.0.19
- Eclipse初始化配置,告别卡顿、闪退、编译时间过长
- SpringBoot2整合MyBatis,连接MySql数据库做增删改查操作
- Mario游戏-低调大师作品
- SpringBoot2整合Thymeleaf,官方推荐html解决方案
- CentOS8安装MyCat,轻松搞定数据库的读写分离、垂直分库、水平分库
- Springboot2将连接池hikari替换为druid,体验最强大的数据库连接池
- Linux系统CentOS6、CentOS7手动修改IP地址
- SpringBoot2编写第一个Controller,响应你的http请求并返回结果
- Hadoop3单机部署,实现最简伪集群