SpringBoot開發祕籍 - 集成Graphql Query

概述

REST做爲一種現代網絡應用很是流行的軟件架構風格受到廣大WEB開發者的喜好，在目前軟件架構設計模式中隨處可見REST的身影，可是隨着REST的流行與發展，它的一個最大的缺點開始暴露出來：前端

在不少時候客戶端須要的數據每每在不一樣的地方具備類似性，但卻又不盡相同。
如一樣的用戶信息，在有的場景下前端只須要用戶的簡要信息（名稱、頭像），在其餘場景下又須要用戶的詳細信息。當這樣的類似但又不一樣的地方多的時候，就須要開發更多的接口來知足前端的須要。java

隨着這樣的場景愈來愈多，接口愈來愈多，文檔愈來愈臃腫，先後端溝通成本呈指數增長。web

基於上面的場景，咱們迫切須要有一種解決方案或框架，可使得在使用同一個領域模型（DO、DTO）的數據接口時能夠由前端指定須要的接口字段，然後端根據前端的需求自動適配並返回對應的字段。spring

這就是咱們今天的主角GraphQL。chrome

場景模擬

考慮下面的場景：後端

用戶與文章是一對多的關係，一個用戶能夠發表多篇文章，同時又能夠根據文章找到對應的做者。設計模式

咱們須要構建如下幾個Graphql查詢：瀏覽器

根據用戶ID獲取用戶詳情，並獲取此用戶發表的全部文章微信
根據文章ID獲取文章詳情，並獲取文章做者的信息websocket

固然項目是基於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源創計劃」，歡迎正在閱讀的你也加入，一塊兒分享。