ASP.NET Core中使用GraphQL - 最終章 Data Loader

本文轉載自查看原文 2018-11-16 23:01 1359 NET Core/ GraphQL

ASP.NET Core中使用GraphQL - 目錄

在之前的幾章中，我們的GraphQL查詢是沒有優化過的。下面我們以CustomerType中的orders查詢為例

CustomerType.cs

Field<ListGraphType<OrderType>, IEnumerable<Order>>()  
    .Name("Orders")
    .ResolveAsync(ctx =>
    {
        return dataStore.GetOrdersAsync();
    });

在這個查詢中，我們獲取了某個顧客中所有的訂單，這里如果你只是獲取一些標量字段，那很簡單。

但是如果需要獲取一些關聯屬性呢？例如查詢系統中的所有訂單，在訂單信息中附帶顧客信息。

OrderType

public OrderType(IDataStore dataStore, IDataLoaderContextAccessor accessor)  
{
    Field(o => o.Tag);
    Field(o => o.CreatedAt);
    Field<CustomerType, Customer>()
        .Name("Customer")
        .ResolveAsync(ctx =>
        {            
            return dataStore.GetCustomerByIdAsync(ctx.Source.CustomerId);  
        });
}

這里當獲取customer信息的時候，系統會另外初始化一個請求，以便從數據倉儲中查詢訂單相關的顧客信息。

如果你了解dotnet cli, 你可以針對以下查詢，在控制台輸出所有的EF查詢日志

{
  orders{
    tag
    createdAt
    customer{
      name
      billingAddress
    }
  }
}

查詢結果：

{
  "data": {
    "orders": [
      {
        "tag": "XPS 13",
        "createdAt": "2018-11-11",
        "customer": {
          "name": "Lamond Lu",
          "billingAddress": "Test Address"
        }
      },
      {
        "tag": "XPS 15",
        "createdAt": "2018-11-11",
        "customer": {
          "name": "Lamond Lu",
          "billingAddress": "Test Address"
        }
      }
    ]
  }
}

產生日志如下：

info: Microsoft.EntityFrameworkCore.Database.Command[20101]
      Executed DbCommand (16ms) [Parameters=[], CommandType='Text', CommandTimeout='30']
      SELECT [o].[OrderId], [o].[CreatedAt], [o].[CustomerId], [o].[CustomerId1], [o].[Tag]
      FROM [Orders] AS [o]
info: Microsoft.EntityFrameworkCore.Database.Command[20101]
      Executed DbCommand (6ms) [Parameters=[@__get_Item_0='?' (DbType = Int32)], CommandType='Text', CommandTimeout='30']
      
      SELECT TOP(1) [e].[CustomerId], [e].[BillingAddress], [e].[Name]
      FROM [Customers] AS [e]
      WHERE [e].[CustomerId] = @__get_Item_0
info: Microsoft.EntityFrameworkCore.Database.Command[20101]
      Executed DbCommand (5ms) [Parameters=[@__get_Item_0='?' (DbType = Int32)], CommandType='Text', CommandTimeout='30']
      
      SELECT TOP(1) [e].[CustomerId], [e].[BillingAddress], [e].[Name]
      FROM [Customers] AS [e]
      WHERE [e].[CustomerId] = @__get_Item_0
info: Microsoft.AspNetCore.Hosting.Internal.WebHost[2]
      Request finished in 864.2749ms 200

從日志上我們很清楚的看到，這個查詢使用了3個查詢語句，第一個語句查詢所有的訂單信息，第二個和第三個請求分別查詢了2個訂單的顧客信息。這里可以想象如果這里有N的訂單，就會產生N+1個查詢語句，這是非常不效率的。正常情況下我們其實可以通過2條語句就完成上述的查詢，后面查詢單個顧客信息其實可以整合成一條語句。

為了實現這個效果，我們就需要介紹一下GraphQL中的DataLoader。

DataLoader是GraphQL中的一個重要功能，它為GraphtQL查詢提供了批處理和緩存的功能。

為了使用DataLoader, 我們首先需要在Startup.cs中注冊2個新服務IDataLoaderContextAccessor 和DataLoaderDocumentListener

Startup.cs

services.AddSingleton<IDataLoaderContextAccessor, DataLoaderContextAccessor>();  
services.AddSingleton<DataLoaderDocumentListener>();

如果你的某個GraphQL類型需要DataLoader, 你就可以在其構造函數中注入一個IDataLoaderContextAccessor接口對象。

但是為了使用DataLoader, 我們還需要將它添加到我們的中間件中。

GraphQLMiddleware.cs

public async Task InvokeAsync(HttpContext httpContext, ISchema schema, IServiceProvider serviceProvider)  
{
    ....
    ....
        
    var result = await _executor.ExecuteAsync(doc =>
    {
        ....
        ....
        doc.Listeners.Add(serviceProvider                                                             .GetRequiredService<DataLoaderDocumentListener>());
    }).ConfigureAwait(false);

    ....
    ....            
}

下一步，我們需要為我們的倉儲類，添加一個新方法，這個方法可以根據顧客的id列表，返回所有的顧客信息。

DataStore.cs

public async Task<Dictionary<int, Customer>> GetCustomersByIdAsync(
    IEnumerable<int> customerIds,
    CancellationToken token)  
{
    return await _context.Customers
        .Where(i => customerIds.Contains(i.CustomerId))
        .ToDictionaryAsync(x => x.CustomerId);
}

然后我們修改OrderType類

OrderType

Field<CustomerType, Customer>()  
    .Name("Customer")
    .ResolveAsync(ctx =>
    {            
        var customersLoader = accessor.Context.GetOrAddBatchLoader<int, Customer>("GetCustomersById", dataStore.GetCustomersByIdAsync);
        return customersLoader.LoadAsync(ctx.Source.CustomerId);  
    });

完成以上修改之后，我們重新運行項目, 使用相同的query, 結果如下，查詢語句的數量變成了2個，效率大大提高

info: Microsoft.EntityFrameworkCore.Infrastructure[10403]
      Entity Framework Core 2.1.4-rtm-31024 initialized 'ApplicationDbContext' using provider 'Microsoft.EntityFrameworkCore.SqlServer' with options: None
info: Microsoft.EntityFrameworkCore.Database.Command[20101]
      Executed DbCommand (19ms) [Parameters=[], CommandType='Text', CommandTimeout='30']
      SELECT [o].[OrderId], [o].[CreatedAt], [o].[CustomerId], [o].[CustomerId1], [o].[Tag]
      FROM [Orders] AS [o]
info: Microsoft.EntityFrameworkCore.Database.Command[20101]
      Executed DbCommand (10ms) [Parameters=[], CommandType='Text', CommandTimeout='30']
      SELECT [i].[CustomerId], [i].[BillingAddress], [i].[Name]
      FROM [Customers] AS [i]
      WHERE [i].[CustomerId] IN (1)

DataLoader背后的原理

GetOrAddBatchLoader方法會等到所有查詢的顧客id列表准備好之后才會執行，它會一次性把所有查詢id的顧客信息都收集起來。這種技術就叫做批處理，使用了這種技術之后，無論有多少個關聯的顧客信息，系統都只會發出一次請求來獲取所有數據。

本文源代碼： https://github.com/lamondlu/GraphQL_Blogs/tree/master/Part%20X

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。