Util应用框架核心(三) - 服务注册器

本节介绍服务注册器的开发.

如果你不需要扩展Util应用框架,直接跳过.

当你把某些功能封装到自己的类库,并希望启动时自动执行初始化代码进行配置时,定义服务注册器.

服务注册器概述

服务注册器是Util项目启动时自动执行的代码块.

Util应用框架的某些类库使用服务注册器进行配置,比如 Util.ObjectMapping.AutoMapper .

当你引用 Util.ObjectMapping.AutoMapper 类库,不需要进行任何配置就可以直接使用 AutoMapper 的基本功能.

定义服务注册器

服务注册器只需实现 Util.Infrastructure.IServiceRegistrar 接口,启动器会扫描查找它.

你可以把服务注册器放在任何地方,不过放在约定的位置会更容易维护.

约定: 服务注册器名称以 ServiceRegistrar 结尾,放到 Infrastructure 目录中.

IServiceRegistrar 接口代码

/// <summary>
/// 服务注册器
/// </summary>
public interface IServiceRegistrar {
    /// <summary>
    /// 排序号
    /// </summary>
    int OrderId { get; }

    /// <summary>
    /// 是否启用
    /// </summary>
    bool Enabled {
        get;
    }

    /// <summary>
    /// 注册服务,该操作在启动开始时执行,如果需要延迟执行某些操作,可在返回的Action中执行,它将在启动最后执行
    /// </summary>
    /// <param name="context">服务上下文</param>
    Action Register( ServiceContext context );
}

/// <summary>
/// 服务上下文
/// </summary>
public class ServiceContext {
    /// <summary>
    /// 初始化服务上下文
    /// </summary>
    /// <param name="hostBuilder">主机生成器</param>
    /// <param name="assemblyFinder">程序集查找器</param>
    /// <param name="typeFinder">类型查找器</param>
    public ServiceContext( IHostBuilder hostBuilder, IAssemblyFinder assemblyFinder, ITypeFinder typeFinder ) {
        HostBuilder = hostBuilder ?? throw new ArgumentNullException( nameof( hostBuilder ) );
        AssemblyFinder = assemblyFinder ?? throw new ArgumentNullException( nameof( assemblyFinder ) );
        TypeFinder = typeFinder ?? throw new ArgumentNullException( nameof( typeFinder ) );
    }

    /// <summary>
    /// 主机生成器
    /// </summary>
    public IHostBuilder HostBuilder { get; }

    /// <summary>
    /// 程序集查找器
    /// </summary>
    public IAssemblyFinder AssemblyFinder { get; }

    /// <summary>
    /// 类型查找器
    /// </summary>
    public ITypeFinder TypeFinder { get; }
}

注册服务

Register 方法用于定义服务配置.

Register 方法传递服务上下文 ServiceContext 参数,除了可以获得主机生成器 IHostBuilder 外,还可以获取类型查找器 ITypeFinder.

你可以在服务注册器中查找某些类型,并进行配置,比如查找 ISingletonDependency 接口的实现类,并配置单例依赖关系.

Register 方法的返回类型是一个委托 Action.

如果希望服务配置方法立即执行,返回 null.

如果希望服务注册器延迟到最后执行,返回委托.

启用服务注册器

只有已启用的服务注册器才会生效 .

服务注册器的执行顺序

通常服务注册器用来配置服务的依赖注入关系,执行顺序不太重要.

不过如果你的服务注册器依赖执行顺序,需要在某些服务注册器的前面或后面执行,可以设置排序号 OrderId.

启动器使用排序号对服务注册器进行排序, OrderId 越小的先执行.

此外,如果你需要将服务注册器延迟到最后执行,可以让 Register 方法返回委托.

启动器在执行服务注册器 Register 方法后保存返回的委托实例列表.

在执行委托实例之前,启动器可能会执行其它操作.

在之前的版本会配置依赖注册器,不过它的作用有限,已经删除,未来可能添加其它操作.

禁用和启用服务注册器

当引用包含服务注册器的类库,启动时会自动运行初始化配置代码.

对于大部分场景都是预期行为.

不过有些时候自动执行服务注册器会导致问题,你需要禁用它.

服务注册器配置 Util.Infrastructure.ServiceRegistrarConfig 用于禁用和启用服务注册器.

ServiceRegistrarConfig 使用 AppContext.SetSwitch 方法来完成禁用和启用.

/// <summary>
/// 服务注册器配置
/// </summary>
public class ServiceRegistrarConfig {
    /// <summary>
    /// 服务注册器配置实例
    /// </summary>
    public static readonly ServiceRegistrarConfig Instance = new ();

    /// <summary>
    /// 禁用服务注册器
    /// </summary>
    /// <param name="serviceName">服务注册器名称</param>
    public static void Disable( string serviceName ) {
        AppContext.SetSwitch( serviceName, false );
    }

    /// <summary>
    /// 启用服务注册器
    /// </summary>
    /// <param name="serviceName">服务注册器名称</param>
    public static void Enable( string serviceName ) {
        AppContext.SetSwitch( serviceName, true );
    }

    /// <summary>
    /// 是否启用
    /// </summary>
    /// <param name="serviceName">服务注册器名称</param>
    public static bool IsEnabled( string serviceName ) {
        var result = AppContext.TryGetSwitch( serviceName, out bool isEnabled );
        if ( result && isEnabled == false )
            return false;
        return true;
    }
}

直接传递服务名称不太方便,可以在 ServiceRegistrarConfig 上定义扩展方法来禁用和启用服务注册器.

服务注册器范例

下面以 Util.ObjectMapping.AutoMapper 类库的服务注册器为例进行说明.

在服务注册器定义服务名称,一般使用带命名空间的服务注册器类名.

设置排序号.

Enabled属性使用 ServiceRegistrarConfig 配置的 IsEnabled 方法,默认为启用状态,可以通过 ServiceRegistrarConfig 禁用它.

Register 方法使用类型查找器查找所有实现了 IAutoMapperConfig 接口的配置实例并进行配置.

创建 AutoMapper ObjectMapper 对象,并传递给 MapTo 扩展类.

最后,通过主机生成器 ConfigureServices 配置 IObjectMapper 单例服务.

/// <summary>
/// AutoMapper服务注册器
/// </summary>
public class AutoMapperServiceRegistrar : IServiceRegistrar {
    /// <summary>
    /// 获取服务名
    /// </summary>
    public static string ServiceName => "Util.ObjectMapping.Infrastructure.AutoMapperServiceRegistrar";

    /// <summary>
    /// 排序号
    /// </summary>
    public int OrderId => 300;

    /// <summary>
    /// 是否启用
    /// </summary>
    public bool Enabled => ServiceRegistrarConfig.IsEnabled( ServiceName );

    /// <summary>
    /// 注册服务
    /// </summary>
    /// <param name="serviceContext">服务上下文</param>
    public Action Register( ServiceContext serviceContext ) {
        var types = serviceContext.TypeFinder.Find<IAutoMapperConfig>();
        var instances = types.Select( type => Reflection.CreateInstance<IAutoMapperConfig>( type ) ).ToList();
        var expression = new MapperConfigurationExpression();
        instances.ForEach( t => t.Config( expression ) );
        var mapper = new ObjectMapper( expression );
        ObjectMapperExtensions.SetMapper( mapper );
        serviceContext.HostBuilder.ConfigureServices( ( context, services ) => {
            services.AddSingleton<IObjectMapper>( mapper );
        } );
        return null;
    }
}

服务注册器配置扩展范例

定义服务注册器配置扩展

在 ServiceRegistrarConfig 扩展特定的启用和禁用方法,并封装服务名.

/// <summary>
/// AutoMapper服务注册器配置扩展
/// </summary>
public static class ServiceRegistrarConfigExtensions {
    /// <summary>
    /// 启用AutoMapper服务注册器
    /// </summary>
    /// <param name="config">服务注册器配置</param>
    public static ServiceRegistrarConfig EnableAutoMapperServiceRegistrar( this ServiceRegistrarConfig config ) {
        ServiceRegistrarConfig.Enable( AutoMapperServiceRegistrar.ServiceName );
        return config;
    }

    /// <summary>
    ///禁用AutoMapper服务注册器
    /// </summary>
    /// <param name="config">服务注册器配置</param>
    public static ServiceRegistrarConfig DisableAutoMapperServiceRegistrar( this ServiceRegistrarConfig config ) {
        ServiceRegistrarConfig.Disable( AutoMapperServiceRegistrar.ServiceName );
        return config;
    }
}

使用服务注册器配置扩展

下面演示禁用 Util.ObjectMapping.Infrastructure.AutoMapperServiceRegistrar 服务注册器.

ServiceRegistrarConfig.Instance.DisableAutoMapperServiceRegistrar();
builder.AsBuild().AddUtil();

应在 AddUtil 方法之前禁用服务注册器.