ASP.NET Core MVC 入门到精通 - 3. 使用MediatR

冷不防 2022-10-16 07:56 55阅读 0赞

> [ASP.NET Core MVC 入门到精通 - 3. 使用MediatR][ASP.NET Core MVC _ - 3. _MediatR]

> 环境：
> 
>  *  .NET 5
>  *  ASP.NET Core MVC (project)

# 1. MediatR #

MediatR .NET中的简单中介者模式实现，一种`进程内消息传递机制`（无其他外部依赖）。支持以同步或异步的形式进行请求/响应，命令，查询，通知和事件的消息传递，并通过C\#泛型支持消息的智能调度。

> Simple mediator implementation in .NET  
> In-process messaging with no dependencies.  
> Supports request/response, commands, queries, notifications and events, synchronous and async with intelligent dispatching via C\# generic variance.

> 另：中介者模式 - 定义一个中介对象来封装一系列对象之间的交互，使原有对象之间的耦合松散，且可以独立地改变它们之间的交互。中介者模式又叫调停模式，它是迪米特法则的典型应用。

# 2. 安装 & 配置 #

对于.NET5 (.net core), 使用nuget 安装`MediatR.Extensions.Microsoft.DependencyInjection`.

配置：

public void ConfigureServices(IServiceCollection services)
    {
        services.AddControllersWithViews();
        services.AddMediatR(typeof(Startup));
    }

# 3. MediatR消息类型 #

## 3.1. Notifications 通知模式 ##

Notifications 通知模式用于生产者发送通知，消费者（可以多个）接收到通知后，进行后续处理。  
例：一个APS.NET 页面，访问时，发送Notifications通知；消费者简单记录收到通知的时间。

### 3.1.1. 定义基于INotification的通知类 ###

public class Ping : INotification {  }

### 3.1.2. 定义消费者（关注通知的处理方法） ###

public class Pong1 : INotificationHandler<Ping>
    {
        public Task Handle(Ping notification, CancellationToken cancellationToken)
        {
            Debug.WriteLine($"Pong1, {DateTime.Now}");
            return Task.CompletedTask;
        }
    }
    
    public class Pong2 : INotificationHandler<Ping>
    {
        public Task Handle(Ping notification, CancellationToken cancellationToken)
        {
            Debug.WriteLine($"Pong2, {DateTime.Now}");
            return Task.CompletedTask;
        }
    }

### 3.1.3. 发送消息通知 ###

// 基于dotnet core的依赖注入，注入IMediator对象
    private readonly IMediator _mediator;
    public HomeController(ILogger<HomeController> logger, IMediator mediator)
    {
        _logger = logger;
        _mediator = mediator;
    }
    
    
    public async Task<IActionResult> IndexAsync()
    {
        // e.g. 访问首页时，发送通知
        await _mediator.Publish(new Ping());
        return View();
    }

### 3.1.4. 输出 ###

Pong1, 5/27/2021 4:37:18 PM
    Pong2, 5/27/2021 4:37:18 PM

## 3.2. Request/Response 请求响应模式 ##

request/response用于命令和查询的场景。

### 3.2.1. 创建请求类： ###

public class RequestModel: IRequest<string>
    { 
    }

### 3.2.2. 创建请求处理类 ###

> 不同于通知模式，request/response只能有一个请求处理。

public class RequestHandeler : IRequestHandler<RequestModel, string>
    { 
        public Task<string> Handle(RequestModel request, CancellationToken cancellationToken)
        { 
            return Task.FromResult($"Pong {DateTime.Now}"); // 测试，返回内容给request
        }
    }

### 3.2.3. 页面中发送请求 ###

private readonly ILogger<HomeController> _logger;
    private readonly IMediator _mediator;
    
    public HomeController(ILogger<HomeController> logger, IMediator mediator)
    { 
        _logger = logger;
        _mediator = mediator;
    }
    
    public async Task<IActionResult> IndexAsync()
    { 
        // send request, and show Response
        var response = await _mediator.Send(new RequestModel());
        Debug.WriteLine("Got response in controller: " +response);
    
        return View();
    }

### 3.2.4. 输出 ###

Got response in controller: Pong 5/28/2021 2:04:26 PM

# 4. 总结 #

*  MediatR是一种`进程内消息传递机制`。
 *  支持以同步或异步的形式进行请求/响应，命令，查询(CQRS)，通知和事件的消息传递，并通过C\#泛型支持消息的智能调度。
 *  其核心是消息的解耦。
 *  应用场景: 实现CQRS、EventBus等。

# 5. 参考 & 代码 #

*  参考: [https://github.com/jbogard/MediatR][https_github.com_jbogard_MediatR]
 *  代码: [https://github.com/jackniu81/dotnet/tree/main/MediatR-Demo][https_github.com_jackniu81_dotnet_tree_main_MediatR-Demo]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzI4ODcxNA_size_16_color_FFFFFF_t_70_pic_center]

[ASP.NET Core MVC _ - 3. _MediatR]: https://jackniu81.github.io/2021/05/27/asp-net-core-3-MediatR/
[https_github.com_jbogard_MediatR]: https://github.com/jbogard/MediatR
[https_github.com_jackniu81_dotnet_tree_main_MediatR-Demo]: https://github.com/jackniu81/dotnet/tree/main/MediatR-Demo
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzI4ODcxNA_size_16_color_FFFFFF_t_70_pic_center]: /images/20221014/bd9124954e7c490d9dc2065a84bc5487.png