中介者模式及在NetCore中的使用MediatR来实现

2020 年 11 月 15 日
筆記
.NET Core, 设计模式

在现实生活中，常常会出现好多对象之间存在复杂的交互关系，这种交互关系常常是“网状结构”，它要求每个对象都必须知道它需要交互的对象。例如，每个人必须记住他（她）所有朋友的电话；而且，朋友中如果有人的电话修改了，他（她）必须告诉其他所有的朋友修改，这叫作“牵一发而动全身”，非常复杂。

如果把这种“网状结构”改为“星形结构”的话，将大大降低它们之间的“耦合性”，这时只要找一个“中介者”就可以了。如前面所说的“每个人必须记住所有朋友电话”的问题，只要在网上建立一个每个朋友都可以访问的“通信录”就解决了。这样的例子还有很多，例如，你刚刚参力口工作想租房，可以找“房屋中介”；或者，自己刚刚到一个陌生城市找工作，可以找“人才交流中心”帮忙。

在软件的开发过程中，这样的例子也很多，例如，在 MVC 框架中，控制器（C）就是模型（M）和视图（V）的中介者；还有大家常用的 QQ 聊天程序的“中介者”是 QQ 服务器。所有这些，都可以采用“中介者模式”来实现，它将大大降低对象之间的耦合性，提高系统的灵活性。

中介者模式的适用场景

一般在以下情况下可以考虑使用中介者模式：

一组定义良好的对象，现在要进行复杂的相互通信。
想通过一个中间类来封装多个类中的行为，而又不想生成太多的子类。

模式的定义与特点

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

中介者模式是一种对象行为型模式，其主要优点如下。

降低了对象之间的耦合性，使得对象易于独立地被复用。
将对象间的一对多关联转变为一对一的关联，提高系统的灵活性，使得系统易于维护和扩展。

其主要缺点是：当同事类太多时，中介者的职责将很大，它会变得复杂而庞大，以至于系统难以维护。

广义中介者

在实际开发中，经常会简化中介者模式，来是开发变得简单，比如有如下的简化。

通常会去掉同事对象的父类，这样可以让任意的对象，只需要有交互，就可以成为同事
通常不定义Mediator接口，把具体的中介者对象实现成为单例
同事对象不再持有中介者，而是在需要的时候直接获取中介者对象并调用；中介者也不再持有同事对象，而是在具体处理方法里面去创建，或获取，或从数据传入需要的同事对象。

经过这样的简化、变形的情况称为广义中介者。

简而概之（伪代码演示）

中介者模式就是通过一个中介者，来让多个交错纵横的引用的类相互解耦，通过访问中介者类的方法就可以访问其他类的方法，每个类之间是相互平等的。比如下面的代码，我们有一个学生类，一个教师类，我们在控制器中有两个Action来处理这两个类的新增，那我们的实现应该是如下的：

public class Student{//属性...}
public class Teacher{//属性...}

服务类

public class StudentService
{
　　public void Add(Student entity){//添加方法}
}
public class TeacherService
{
　　public void Add(Teacher entity){//添加方法}
}

控制器的实现，可以看到有多个服务类被实例化。

public class AddController : Controller
{
　　StudentService studentService = new StudentService();
　　TeacherService teacherService = new TeacherService();
　　public IActionResult Student(Student entity)
　　{
　　　　studentService.Add(entity);
　　　　return Content("添加成功");
　　}
　　public IActionResult Teacher(Teacher entity)
　　{
　　　　teacherService.Add(entity);
　　　　return Content("添加成功");
　　}
}

如果我们用了中介者模式，那就可以免去这些服务类的实例化，直接使用中介者类执行对应的添加方法就行了，下面就进行简单的实现。

中介者模式的简单实现

下面只是通过简单的例子来体现中介者模式的思想，不用过于纠结是否合理，我们可以在实际项目中按自己的需求来实现，就想上面描述的广义的中介者模式。

学生类和教师类以及对应的服务类

public class Base{}
public class Student : Base{//属性...}
public class Teacher : Base{//属性...}
public class StudentService
{
    public string Add(Student entity){return "已添加学生";}
}
public class TeacherService
{
    public string Add(Teacher entity){return "已添加教师";}
}

中介者类

public interface IMediator{string Add(Base entity);}
public class Mediator ： IMediator
{
    private StudentService studentService = new StudentService();
    private TeacherService teacherService = new TeacherService();
    public string Add(Base entity)
    {
        if(entity is Student)
            return studentService.Add((Student)entity);
        else if (entity is Teacher)
            return teacherService.Add((Teacher)entity);
        return "添加失败";
    }
}

控制器中使用中介者类

public class AddController : Controller
{
    private IMediator iMediator = new Mediator();
    public IActionResult Student(Student entity)
    {
        return Content(iMediator.Add(entity));
    }
    public IActionResult Teacher(Teacher entity)
    {
        return Content(iMediator.Add(entity));
    }
}

访问学生新增接口就会出现如下结果：

在NetCore中使用MediatR实现中介者模式

通过 .NET CORE 自带的 IoC 注入

引用 MediatR nuget:install-package MediatR

引用IOC扩展 nuget:installpackage MediatR.Extensions.Microsoft.DependencyInjection //扩展包

在Startup类中的ConfigureServices方法中注册MediatR服务，下面这句话可以扫描继承IRequestHandler接口的实现对象并添加到IOC的容器中

services.AddMediatR(typeof(Startup).GetTypeInfo().Assembly);

为我们的学生类和教师类继承IRequest接口，表示该对象是处理器的一个对象。

public class Student : IRequest<string>{//属性...}
public class Teacher : IRequest<string>{//属性...}

为我们的服务类添加IRequestHandler接口创建处理器对象。

public class StudentService : IRequestHandler<Student,string>
{
    public Task<string> Handle(Student entity, CancellationToken cancellationToken)
    {
        return Task.FromResult("已添加学生");
    }
}
public class TeacherService : IRequestHandler<Teacher, string>
{
    public Task<string> Handle(Teacher entity, CancellationToken cancellationToken)
    {
        return Task.FromResult("已添加教师");
    }
}

在控制器中使用，通过调用中介者的Send方法，自动匹配对应使用该处理器对象的处理器方法。

public class AddController : Controller
{
    private readonly IMediator _mediator;

    public AddController(IMediator mediator)
    {
        _mediator = mediator;
    }
    public IActionResult Student(Student entity)
    {
        return Content(_mediator.Send(entity).Result);
    }
    public IActionResult Teacher(Teacher entity)
    {
        return Content(_mediator.Send(entity).Result);
    }
}

这样我们的改造就完成了。继承IRequest接口有一个泛型表示处理器返回参数类型，与IRequestHandler接口的第二个参数和IRequestHandler接口定义的方法Handle方法的返回值对应，可以不定义表示返回void。IRequestHandler接口的第一个参数必须为继承IRequest接口的类。

Tags: .NET Core 设计模式