lms框架模块详解

模块的定义

一般地,开发者如果想要在一个自定义的程序集(包)中注册相关的服务，或者在应用初始化或停止时执行一段自定义的代码，那么您可能需要将该程序集(包)定义为一个模块。

lms框架存在两种类型的模块:

1. 开发者通过继承LmsModule就可以定义一个普通模块类;
2. 也可以通过继承StartUpModule定义一个服务注册启动模块类。

例如:

// 普通类型模块类
public class CustomHostModule : LmsModule
{
}

// 启动模块类，只有该类型的模块才可以被允许在构建服务中被指定为启动模块
[DependsOn(typeof(ZookeeperModule),
        typeof(DotNettyTcpModule),
        typeof(MessagePackModule),
        typeof(RpcProxyModule),
        typeof(TransactionTccModule),
        typeof(AutoMapperModule)
)]
public class NormHostModule : StartUpModule
{
}

::: tip

1. 开发者想要执行一个模块,需要在微服务时指定该模块,或是通过DependsOn特性直接或是间接的依赖该模块。

2. 只有启动模块类才可以在服务服务注册时指定该模块为注册的启动模块。
   
   :::

模块的依赖关系

lms框架的模块通过DependsOn特性指定模块的依赖关系,lms框架支持通过直接或是间接的依赖模块。例如: NormHostModule模块依赖了DotNettyTcpModule模块,DotNettyTcpModule模块依赖了RpcModule模块,微服务注册时指定NormHostModule为启动模块。那么根据模块依赖关系,RpcModule模块会被应用加载,并先于DotNettyTcpModule和NormHostModule执行服务注册方法和初始化方法。

开发者只需要通过DependsOn特性在类直接就可以指定该模块依赖的模块,在应用启动过程中,会根据模块的依赖关系进行排序。并完成服务注册方法和指定的初始化方法。

例如,NormHostModule的模块依赖关系如下所示:

    [DependsOn(typeof(ZookeeperModule),
        typeof(DotNettyTcpModule),
        typeof(MessagePackModule),
        typeof(RpcProxyModule),
        typeof(TransactionTccModule),
        typeof(AutoMapperModule)
    )]
    public class NormHostModule : StartUpModule
    {
    }

微服务注册时指定启动模块

在构建微服务时,需要指定启动的模块。

例如:

private static IHostBuilder CreateHostBuilder(string[] args)
{
    return Host.CreateDefaultBuilder(args)
            .RegisterLmsServices<NormHostModule>() //指定启动的模块，lms框架约束了该模块类型必须为启动模块类(StartUpModule)
        ;
}

一般地,开发者可以根据微服务类型选择注册lms框架默认的模块,lms框架提供如下三个服务启动模块(NormHostModule、WebHostModule、WsHostModule),lms框架给定的默认启动模块会帮用户指定该类型的微服务应用需要依赖哪些模块。

开发者如果需要自定义模块,那么，相应的,开发者需要在模块依赖关系中声明依赖该模块。所以,一般地,如果您需要自定义模块,那么相应的,您可能需要自定义服务注册启动模块。

您可以通过继承StartUpModule或是继承该lms框架提供的默认启动服务模块(NormHostModule、WebHostModule、WsHostModule),定义您的启动模块,并在您定义的启动模块中依赖您的自定义模块。

例如:

[DependsOn(typeof(ZookeeperModule),
        typeof(DotNettyTcpModule),
        typeof(MessagePackModule),
        typeof(RpcProxyModule),
        typeof(TransactionTccModule),
        typeof(AutoMapperModule),
        typeof(CustomHostModule),
)]
public class CustomNormHostModule : StartUpModule
{
}

// 或是

[DependsOn(typeof(CustomHostModule)
)] // 模块的依赖关系也会被继承
public class CustomNormHostModule : NormHostModule
{
}

使用ContainerBuilder 注册服务

在定义的模块中,开发者可以通过重写RegisterServices方法,通过ContainerBuilder对象进行服务注册。

例如：

protected override void RegisterServices(ContainerBuilder builder)
{
    builder.RegisterType<MessagePackTransportMessageDecoder>().AsSelf().AsImplementedInterfaces().InstancePerDependency();
    builder.RegisterType<MessagePackTransportMessageEncoder>().AsSelf().AsImplementedInterfaces().InstancePerDependency();
}

应用初始化方法和停止方法

开发者可以通过重新自定义模块的Initialize方法在微服务应用启动时该模块指定的代码,通过重写Shutdown方法在应用停止时执行该模块指定的代码。

public virtual Task Initialize([NotNull]ApplicationContext applicationContext)
{
    // 微服务应用执行时,指定该端代码
    return Task.CompletedTask;
}

public virtual Task Shutdown([NotNull]ApplicationContext applicationContext)
{
    // 微服务应用停止时,指定该端代码
    return Task.CompletedTask;
}