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感興趣後面還會更新此係列文章，完成對其他資料操作的整合。