5 Star 32 Fork 19

duoec / duo-graphql

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Duo-GraphQL

※ Duo-GraphQL介绍

Duo-GraphQL基于graphql-java引擎实现,对Schema构建、DataFetch绑定、任务编排优化做了自动化实现,让开发者专注于领域功能开发,与当前主流的多团队的微服务敏捷开发模式无缝契合。

GraphQL是BFF的技术实现之一,BFF层相当大一部分风险和技术负担是:底层领域服务会在这里交汇。对于新人来说,要理解这么多领域、各领域的关系,是个不小的门槛(特别是对领域还划分还不太清晰的情况)。基于GraphQL的BFF实现,可以解耦这一错综复杂的关系网。使用GraphQL技术,各领域服务还可以专注在自己的领域数据内,而不需要太过关注其它领域的数据整合。

Duo-GraphQL实现了以下功能:

  1. Schema、Resolver(DataFetcher)自动生成和绑定,不依靠人工。

  2. 支持领域。各领域微服务(GraphQL Provider)以传统RESTful API项目的方式独立开发、维护、部署,多个领域服务共同组建一张大图,最大程度上保留传统微服务组织架构与开发模式。

  3. 一个引擎支持多Schema。默认会有两个:业务Schema、当前GraphQL状态Schema。

  4. 实现三大类DataProvider:innerProvider / remoteProvider / duoDocProvider,分别对应常用的固定少变的基础领域服务、复杂多变的业务领域服务和旧的RESTful领域服务接入。

  5. 做了大量性能优化,任务编排,请求合并等工作,最大限度的提高性能。

  6. 自定义指令支持,只需要实现接口BaseGraphqlDirectiveFactory,不需要直接面对GraphQL规则。

  7. 一个GraphQL Provider工程支持多个领域。本功能用于领域过小,还不需要单独一个项目时使用。另外支持向其它领域服务注入字段。比如在文章领域向用户领域注入userArticles字段等。

※ Duo-GraphQL架构

Duo-GraphQL框架图

※ Getting Start

本项目是在spring boot上开发的,引擎和Provider都建议使用spring boot 2.x版本

至少需要两部分服务:GraphQL Engine和GraphQL Provider。搭建文档详见下面两个链接:

GraphQL Engine:《GraphQL-Engine-Getting-Start

GraphQL Provider:《GraphQL-Provider-Getting-Start

以上getting start里的代码,请查看当前项目的目录 /demo

你也可以直接使用GraphQL客户端请求:http://demo.duoec.com/graphql

curl 'http://demo.duoec.com/graphql' \
-H 'Accept-Encoding: gzip, deflate, br' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Connection: keep-alive' \
-H 'client: M' \
--data-binary '{"query":"{\n  article {\n    articleSearch(query: { keyword: \"1\", pageNo: 1, pageSize: 10 }) {\n      list {\n        id\n        title\n        content\n      }\n      total\n    }\n  }\n}\n","variables":{}}' \
--compressed

※ 文档中心

一、引擎端: GraphQL-Engine

  1. Duo-GraphQL是如何工作的?
  2. 请求头透传
  3. 添加监控
  4. 自定义请求上下文
  5. 自定义指令: Directive
  6. 订阅: Subscription
  7. ScalarJson
  8. 分布式部署
  9. Schema构建
  10. 异常处理
  11. GraphLQ Provider
    1. 远端数据供应端: RemoteProvider
    2. 内部数据供应端: InnerProvider
    3. 旧RESTful接口接入
  12. 合并请求
  13. 多GraphQL Schema实现
  14. GraphQL Engine调试
  15. 注册中心
    1. 使用Zookeeper注册中心
    2. 使用Redis注册中心
  16. 依赖Duo-Doc服务
  17. 权限控制
  18. gql查询缓存
  19. 开发期间设置GraphQL Provider请求地址
  20. Redis配置
  21. Mock & GraphiQL
  22. Mesh Service支持
  23. SkyWalking探针

二、数据供应端: GraphQL-Provider

  1. 视图
    1. 基础视图
    2. 非基础视图
  2. 选择字段: Selection
  3. GraphQL操作实现
    1. 实现Query
    2. 实现Mutation
    3. 实现Subscription
  4. 批量接口
  5. 一个GraphQL Provider提供多个领域服务
  6. 向其它领域图(Type)注入字段
  7. 字段映射
  8. 生成api.json
  9. GraphQL Provider服务调试
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

Duo-GraphQL基于graphql-java引擎实现,对Schema构建、DataFetch绑定、任务编排优化做了自动化实现,让开发者专注于领域功能开发,与当前主流的多团队的微服务敏捷开发模式无缝契合。 GraphQL是BFF的技术实现之一,BFF层相当大一部分风险和技术负担是:底层领域服务会在这里交汇。对于新人来说,要理解这么多领域、各领域的关系,是个不小的门槛(特别是对领域还划分还不太清晰的情况)。基于GraphQL的BFF实现,可以解耦这一错综复杂的关系网。使用GraphQL技术,各领域服务还可以专注在自己的领域数据内,而不需要太过关注其它领域的数据整合。 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/duoec/duo-graphql.git
git@gitee.com:duoec/duo-graphql.git
duoec
duo-graphql
duo-graphql
master

搜索帮助