ASP.NET Core中为指定类添加WebApi服务功能

Posted 2021-05-02 dotNET跨平台

POCO Controller是 ASP.NET Core 中的一个特性，虽然在2015年刚发布的时候就有这个特性了，可是大多数开发者都只是按原有的方式去写，而没有用到这个特性。其实，如果利用这个特性进行稍微封装后，用在SOA架构中Service层的场景中是极其便利的。这篇文章主要就是说我最近在学习使用开源AOP库AspectCore写WebApi动态代理客户端的时候，实现为普通类无添加WebApi服务的过程。

POCO控制器简介

POCO控制器就是ASP.NET Core项目中所有带有Controller后缀的类、或者标记了[Controller]特性的类，虽然没有像模版项目中那样继承自Controller类，也会被识别为控制器，拥有跟普通控制器一样的功能，像下面这段代码中，两个类都会被识别成控制器：

 
   
   
 

  
    
    
  
public class PocoController
  
    
    
  
{
  
    
    
  
    public IActionResult Index()
  
    
    
  
    {
  
    
    
  
        return new ContentResult() { Content = “Hello from POCO controller!” };
  
    
    
  
    }
  
    
    
  
}
  
    
    
  

  
    
    
  
[Controller]
  
    
    
  
public class Poco
  
    
    
  
{
  
    
    
  
    public IActionResult Index()
  
    
    
  
    {
  
    
    
  
        return new ContentResult() { Content = “Hello from POCO controller!” };
  
    
    
  
    }
  
    
    
  
}
  
    
    
  

 
   
   
 

POCO控制器原理

其实，在ASP.NET Core中，已经不像旧版本的 ASP.NET WebApi 那样，通过ControllerFactory来创建Controller，多亏于ASP.NET Core一脉相承的IoC框架 Microsoft.Extensions.DependencyInjection，ASP.NET Core中的内部实现变得更优雅。其中POCO控制器的核心原理就在IApplicationFeatureProvider<ControllerFeature>这个接口的实现ControllerFeatureProvider。

通过aspnet/Mvc项目的Github源码仓库中查询得知，Mvc里把Controller、ViewComponent、TagHelper、Views等组件定义为特性(Feature)，如ControllerFeature，特性里就存放了应用中被识别为相组件的类型的集合，如如ControllerFeature中就存放了所有Controller类型。IApplicationFeatureProvider<ControllerFeature>这个接口是用来给MVC框架提供控制器类型识别的接口，当把这个接口的实现注册到服务配置中，就能为其中识别的类型提供控制器功能。

ControllerFeatureProvider是这个接口的默认实现，其中有一个方法IsController(TypeInfo typeInfo)的功能就是判断某类型是否为控制器的。而接口方法PopulateFeature(IEnumerable<ApplicationPart> parts,ControllerFeature feature)则为把传入的 “Mvc应用部分（ApplicationPart，大概是指Mvc的作用程序集）”中的类型都一一判断，如果是控制器，那么就加入控制器特性对象中。

实现自定义判断规则

通过上面的剖析，我们就知道要实现自定义的控制器判断规则，只需要重写ControllerFeature类或者重新实现IApplicationFeatureProvider<ControllerFeature>接口，但是由于PopulateFeature不是虚方法或抽象方法，所以不能被重写，那么只能重新写一个类来实现IApplicationFeatureProvider<ControllerFeature>接口了。为了兼容原来规则，我把原来的规则照搬过来，复制了IsController的方法（开源的好处），并且在PopulateFeature中加入了自己的规则。先贴代码，避免篇幅过长，IsController方法的实现就直接链接到源码了：

 
   
   
 

  
    
    
  
internal class ServiceControllerFeatureProvider : IApplicationFeatureProvider<ControllerFeature>
  
    
    
  
{
  
    
    
  
    private const string ControllerTypeNameSuffix = "Controller";
  
    
    
  
    private readonly IEnumerable<Type> ServiceTypes;
  
    
    
  

  
    
    
  
    public ServiceControllerFeatureProvider(IEnumerable<Type> ServiceTypes)
  
    
    
  
    {
  
    
    
  
            this.ServiceTypes = ServiceTypes;
  
    
    
  
    }
  
    
    
  

  
    
    
  
    public void PopulateFeature(IEnumerable<ApplicationPart> parts, ControllerFeature feature)
  
    
    
  
    {
  
    
    
  
        foreach (var type in Reflection.CurrentAssembiles.SelectMany(o => o.DefinedTypes))
  
    
    
  
        {
  
    
    
  
            if (IsController(type) || ServiceTypes.Any(o => type.IsClass && o.IsAssignableFrom(type)) && !feature.Controllers.Contains(type))
  
    
    
  
            {
  
    
    
  
                    feature.Controllers.Add(type);
  
    
    
  
            }
  
    
    
  
        }
  
    
    
  
    }
  
    
    
  

  
    
    
  
    protected bool IsController(TypeInfo typeInfo)
  
    
    
  
    {
  
    
    
  
        //...
  
    
    
  
    }
  
    
    
  
}
  
    
    
  

 
   
   
 

上面代码的原理，是按照我的框架的需求来改写的，构造方法传入的参数ServiceTypes是定义了服务方法的接口的类型，接口和对应实现类似于以下代码，这些代码可以写在一个.NET Core控制台项目中。

 
   
   
 

  
    
    
  
public interface ITestService
  
    
    
  
{
  
    
    
  
    string Test(string name);
  
    
    
  
}
  
    
    
  

  
    
    
  
[Route("test")]
  
    
    
  
public class TestService : ITestService
  
    
    
  
{
  
    
    
  
    [Route("{name}"), HttpGet]
  
    
    
  
    public string Test(string name)
  
    
    
  
    {
  
    
    
  
        return "Hello " + name;
  
    
    
  
    }
  
    
    
  
}
  
    
    
  

 
   
   
 

其中TestService类就是会被识别为控制器的类，但是接口和实现是可以分开在不同程序集的。通过原本ControllerFeatureProvider类中PopulateFeature方法的parts参数中的类型是不包括除了引用了Mvc的程序集的其它程序集的，所以我这里用自己实现的类型扫描类Reflection中的CurrentAssembiles静态变量来获取当前应用程序的所有引用的（自己创建的项目）程序集的，具体实现的代码在我的框架[Shriek]的源码中。

配置自定义规则

现在，我们拥有了自定义控制器识别规则ServiceControllerFeatureProvider，那么，怎么配置到Mvc中呢？又要去翻源码了！在MvcCoreMvcBuilderExtensions.cs扩展类中，有一个IMvcBuilder的扩展方法ConfigureApplicationPartManager（IMvcCoreBuilder也有这样的扩展方法），它的参数是传入ApplicationPartManager参数的委托，而ApplicationPartManager中有一个FeatureProviders属性，用来存储所有IApplicationFeatureProvider实例，会在应用第一次运行的时候，循环这些“特性提供器”提供所有上面提到的MVC特性。所以，只要我们在这里添加我们自定义的控制器特性提供器，MVC框架内部就能识别我们的指定的类型为控制器，并为他们添加控制器的相关功能。

设计有点绕，那么我们用代码来实现：

 
   
   
 

  
    
    
  
//示例直接new ServiceCollection对象，下面有完整的能运行的示例代码。
  
    
    
  
var services = new ServiceCollection();
  
    
    
  

  
    
    
  
services.AddMvcCore()
  
    
    
  
        .ConfigureApplicationPartManager(manager =>
  
    
    
  
        {
  
    
    
  
            var featureProvider = new ServiceControllerFeatureProvider(typeof(ITestService));
  
    
    
  
            manager.FeatureProviders.Add(featureProvider);
  
    
    
  
        });
  
    
    
  

 
   
   
 

看看效果

现在，在TestService类所在项目文件中引入以下Nuget包（没错，运行一个webapi只需要两个Nuget包）：

 
   
   
 

  
    
    
  
    <PackageReference Include="Microsoft.AspNetCore.Hosting" Version="2.0.0" />
  
    
    
  
    <PackageReference Include="Microsoft.AspNetCore.Mvc.Core" Version="2.0.0" />
  
    
    
  

 
   
   
 

然后在控制台程序的入口文件Program.cs的Main方法中写入一下代码：

 
   
   
 

  
    
    
  
internal class Program
  
    
    
  
{
  
    
    
  
    public static void Main(string[] args)
  
    
    
  
    {
  
    
    
  
       new WebHostBuilder()
  
    
    
  
            .UseKestrel()
  
    
    
  
            .UseUrls("http://localhost:8080")
  
    
    
  
            .ConfigureServices(services =>
  
    
    
  
            {
  
    
    
  
                services.AddMvcCore()
  
    
    
  
                .ConfigureApplicationPartManager(manager =>
  
    
    
  
                {
  
    
    
  
                    var featureProvider = new ServiceControllerFeatureProvider(typeof(ITestService));
  
    
    
  
                    manager.FeatureProviders.Add(featureProvider);
  
    
    
  
                });
  
    
    
  
            })
  
    
    
  
            .Configure(app => app.UseMvc())
  
    
    
  
            .Build()
  
    
    
  
            .Start();
  
    
    
  
    }
  
    
    
  
}
  
    
    
  

 
   
   
 

一切编译通过后，点击运行，在浏览器中访问”http://localhost:8080/test/elderjames”，如果看到返回了“Hello elderjames”，那么就大功告成啦！

总结

这篇文章中主要介绍了通过实现IApplicationFeatureProvider<ControllerFeature>接口实现设置指定类型为WebApi控制器的方法。

在接下来的文章中，我会介绍如何从接口获取自定义特性标签，实现从接口获得mvc特性，使得接口和实现类都不依赖MVC库的方法，只要在接口中以标记特性的方式定义了路由和http方法，实现类的操作就都按照接口的路由和http方法去提供WebApi服务，最后还要介绍使用功能强大的.NTE Core开源AOP框架AspectCore实现的动态代理客户端，注册以上所说的接口，即可获得可以调用对应的WebApi服务。这些工作的源码可以在我的框架示例项目中运行，大家有兴趣可以看看效果。