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

时间 2020-05-07

标签 asp.net asp core 使用 graphql 最终 data loader 栏目 ASP 繁體版

原文原文链接

ASP.NET Core中使用GraphQL - 目录html

在以前的几章中，咱们的<code>GraphQL</code>查询是没有优化过的。下面咱们以<code>CustomerType</code>中的<code>orders</code>查询为例git

CustomerType.cs

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

在这个查询中，咱们获取了某个顾客中全部的订单，这里若是你只是获取一些标量字段，那很简单。github

可是若是须要获取一些关联属性呢？例如查询系统中的全部订单，在订单信息中附带顾客信息。json

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);  
        });
}

这里当获取<code>customer</code>信息的时候，系统会另外初始化一个请求，以便从数据仓储中查询订单相关的顾客信息。c#

若是你了解<code>dotnet cli</code>, 你能够针对如下查询，在控制台输出全部的EF查询日志缓存

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

查询结果：async

{
  "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"
        }
      }
    ]
  }
}

产生日志以下：ide

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条语句就完成上述的查询，后面查询单个顾客信息其实能够整合成一条语句。函数

为了实现这个效果，咱们就须要介绍一下<code>GraphQL</code>中的<code>DataLoader</code>。优化

<code>DataLoader</code>是<code>GraphQL</code>中的一个重要功能，它为<code>GraphtQL</code>查询提供了批处理和缓存的功能。

为了使用<code>DataLoader</code>, 咱们首先须要在<code>Startup.cs</code>中注册2个新服务IDataLoaderContextAccessor 和DataLoaderDocumentListener

Startup.cs

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

若是你的某个<code>GraphQL</code>类型须要<code>DataLoader</code>, 你就能够在其构造函数中注入一个<code>IDataLoaderContextAccessor</code>接口对象。

可是为了使用<code>DataLoader</code>, 咱们还须要将它添加到咱们的中间件中。

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);
}

而后咱们修改<code>OrderType</code>类

OrderType

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

完成以上修改以后，咱们从新运行项目, 使用相同的<code>query</code>, 结果以下，查询语句的数量变成了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)

<code>DataLoader</code>背后的原理

<code>GetOrAddBatchLoader</code>方法会等到全部查询的顾客id列表准备好以后才会执行，它会一次性把全部查询id的顾客信息都收集起来。这种技术就叫作批处理，使用了这种技术以后，不管有多少个关联的顾客信息，系统都只会发出一次请求来获取全部数据。

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