GraphQL（三）：GraphQL集成SpringBoot原理

在GraphQL（二）：GraphQL服務搭建中咱們在pom文件中增長了以下依賴：

<dependency>
    <groupId>com.graphql-java</groupId>
    <artifactId>graphql-java-tools</artifactId>
    <version>4.0.0</version>
</dependency>
<dependency>
    <groupId>com.graphql-java</groupId>
    <artifactId>graphiql-spring-boot-starter</artifactId>
    <version>3.6.0</version>
</dependency>
<dependency>
    <groupId>com.graphql-java</groupId>
    <artifactId>graphql-spring-boot-starter</artifactId>
    <version>3.6.0</version>
</dependency>
複製代碼

接下來咱們來分析其中的部分原理。

包

添加了上述依賴後，會引入這麼幾個jar包：

1. graphiql-spring-boot-autoconfigure： 開發者工具graphiql的自動配置jar包
2. graphiql-spring-boot-starter： 開發者工具graphiql的實現
3. graphql-java： graphql的java實現
4. graphql-java-servlet： 封裝graphql服務爲servlet，處理graphql的request和response
5. graphql-java-tools： 自動加載*.graphqls文件，並屏蔽graphql-java的底層實現細節
6. graphql-spring-boot-autoconfigure： graphql-spring-boot的自動配置jar包
7. graphql-spring-boot-starter： starter

開發者工具的兩個包暫不討論。一切都是從graphql-spring-boot-autoconfigure開始的，經過graphql-spring-boot-autoconfigure完成了GraphQLServlet的自動配置。

@Configuration
@ConfigurationProperties(prefix = "graphql.servlet")
public class GraphQLServletProperties {

    private String mapping;

    public String getMapping() {
        return mapping != null ? mapping : "/graphql";
    }

    //省略
}

複製代碼

在GraphQLServletProperties配置類上啓動了ConfigurationProperties，前綴是"graphql.servlet"，所以咱們能夠在application.properties中以"graphql.servlet"開頭進行配置，好比將endpoint從默認的「/graphql」改成「/school」：

graphql.servlet.mapping=/school
複製代碼

一樣的，在GraphQLWebAutoConfiguration配置類中能夠找到關因而否啓用GraphQLServlet和跨域訪問的配置。

GraphQLServlet

經過graphql-spring-boot-autoconfigure，SpringBoot會自動掃描到GraphQLServlet的相關配置信息，在GraphQLServlet的構造函數中初始化了getHandler和postHandler分別用於處理get和post請求

和Spring的DispatcherServlet不同，GraphQLServlet重寫了doGet和doPost方法，同時GraphQLServlet並不包含攔截器（DispatcherServlet請求執行過程），GraphQL提供了一個GraphQLServletListener接口，容許咱們針對請求執行結果作處理：

private void doRequest(HttpServletRequest request, HttpServletResponse response, RequestHandler handler) {

    List<GraphQLServletListener.RequestCallback> requestCallbacks = runListeners(l -> l.onRequest(request, response));

    try {
        handler.handle(request, response);
        runCallbacks(requestCallbacks, c -> c.onSuccess(request, response));
    } catch (Throwable t) {
        response.setStatus(500);
        log.error("Error executing GraphQL request!", t);
        runCallbacks(requestCallbacks, c -> c.onError(request, response, t));
    } finally {
        runCallbacks(requestCallbacks, c -> c.onFinally(request, response));
    }
}
複製代碼

那麼，若是要在GraphQL中實現攔截器的功能要怎麼作呢？

GraphQL提供了一個Instrumentation接口：

容許咱們在執行前、解析前、驗證前、數據獲取前、字段數據獲取前（最後兩個是同樣的做用）插入本身的邏輯，可是它跟Spring的攔截器不同，它沒有提供跳過執行的功能，要攔截掉執行只能拋出異常。

FiledResolverScanner

在GraphQL（二）：GraphQL服務搭建中咱們提到，實現Resolver須要知足以下約定：

1. <field>
2. is<field> – only if the field is of type Boolean
3. get<field>
4. getField<field>（最新版增長的契約）
複製代碼

關於這部分契約的定義在官方文檔中並無找到，那就從源代碼去找是如何定義契約。

在graphql-java-tools(4.0.0版本)中，能夠找到一個FieldResolverScanner類，負責了FieldResolver的掃描，找到方法findResolverMethod：

private fun findResolverMethod(field: FieldDefinition, search: Search): java.lang.reflect.Method? {

    val methods = getAllMethods(search.type)
    val argumentCount = field.inputValueDefinitions.size + if(search.requiredFirstParameterType != null) 1 else 0
    val name = field.name

    val isBoolean = isBoolean(field.type)

    // Check for the following one by one:
    //   1. Method with exact field name
    //   2. Method that returns a boolean with "is" style getter
    //   3. Method with "get" style getter
    return methods.find {
        it.name == name && verifyMethodArguments(it, argumentCount, search)
    } ?: methods.find {
        (isBoolean && it.name == "is${name.capitalize()}") && verifyMethodArguments(it, argumentCount, search)
    } ?: methods.find {
        it.name == "get${name.capitalize()}" && verifyMethodArguments(it, argumentCount, search)
    }
}
複製代碼

這就是定義以上契約的地方。