模块的定义和类型

在silky框架,模块是应用程序用于服务注册、初始化任务、释放资源的单位,被定义为一个程序集。模块具有依赖关系,通过DependsOn特性来确定模块之间的依赖关系。

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

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

例如:

普通模块类

  1. // 普通模块类,启动模块类必须要直接或间接的依赖该模块
  2. [DependsOn(typeof(RpcModule))]
  3. public class CustomModule : SilkyModule
  4. {
  5. }

启动模块类

  1. // 启动模块类,只有该类型的模块才可以被允许在构建服务中被指定为启动模块
  2. [DependsOn(typeof(ZookeeperModule),
  3. typeof(DotNettyTcpModule),
  4. typeof(MessagePackModule),
  5. typeof(RpcProxyModule),
  6. typeof(TransactionTccModule),
  7. typeof(AutoMapperModule)
  8. )]
  9. public class NormHostModule : StartUpModule
  10. {
  11. }

::: tip

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

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

    :::

在模块中注册服务

模块提供了两个服务注册的API,一是通过ServiceCollection实现服务注册,二是通过ContainerBuilder实现服务注册。

通过ServiceCollection实现服务注册

开发者通过重写ConfigureServices方法,可以通过IServiceCollection实现服务注册,例如:

  1. public override void ConfigureServices(IServiceCollection services, IConfiguration configuration)
  2. {
  3. services.AddOptions<RpcOptions>()
  4. .Bind(configuration.GetSection(RpcOptions.Rpc));
  5. services.AddOptions<GovernanceOptions>()
  6. .Bind(configuration.GetSection(GovernanceOptions.Governance));
  7. services.AddOptions<WebSocketOptions>()
  8. .Bind(configuration.GetSection(WebSocketOptions.WebSocket));
  9. services.AddDefaultMessageCodec();
  10. services.AddDefaultServiceGovernancePolicy();
  11. }

通过ContainerBuilder实现服务注册

ContainerBuilderAutofac 提供服务注册的类,开发者可以通过重写RegisterServices方法使用ContainerBuilder提供的API实现服务注册。使用ContainerBuilder注册服务的一个优势是可以注册命名的服务。

  1. protected override void RegisterServices(ContainerBuilder builder)
  2. {
  3. builder.RegisterType<DefaultExecutor>()
  4. .As<IExecutor>()
  5. .InstancePerLifetimeScope()
  6. .AddInterceptors(
  7. typeof(CachingInterceptor)
  8. )
  9. ;
  10. }

使用模块初始化任务

在应用程序启动过程中,开发者可以重写Initialize方法来实现模块的初始化任务。开发者可以通过applicationContext.ServiceProvider属性来解析注册的服务。

  1. public override async Task Initialize(ApplicationContext applicationContext)
  2. {
  3. var serverRouteRegister =
  4. applicationContext.ServiceProvider.GetRequiredService<IServerRegister>();
  5. await serverRouteRegister.RegisterServer();
  6. }

使用模块释放资源

在应用程序正常停止时,通过重写Shutdown方法来实现模块停止时需要执行的方法,例如:释放资源等。

  1. public override async Task Shutdown(ApplicationContext applicationContext)
  2. {
  3. var serverRegister =
  4. applicationContext.ServiceProvider.GetRequiredService<IServerRegister>();
  5. await serverRegister.RemoveSelf();
  6. }

模块的依赖关系

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

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

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

  1. [DependsOn(typeof(ZookeeperModule),
  2. typeof(DotNettyTcpModule),
  3. typeof(MessagePackModule),
  4. typeof(RpcProxyModule),
  5. typeof(TransactionTccModule),
  6. typeof(AutoMapperModule)
  7. )]
  8. public class NormHostModule : StartUpModule
  9. {
  10. }

构建主机时指定启动模块

开发者如果自定义了模块,那么,需要在构建微服务主机时,指定启动模块。

例如:


  1. private static IHostBuilder CreateHostBuilder(string[] args)
  2. {
  3. return Host.CreateDefaultBuilder(args)
  4. .RegisterSilkyServices<NormHostModule>() //指定启动的模块,silky框架约束了该模块类型必须为启动模块类(StartUpModule)
  5. ;
  6. }

一般地,开发者在构建默认主机时,并不需要指定启动模块。构建的默认主机,已经根据构建的主机类型,指定了默认的启动模块。例如,使用ConfigureSilkyWebHostDefaults构建silky主机时,已经指定了DefaultWebHostModule作为其中模块。

如果开发者有自定义模块时,同时也需要自定义一个启动模块,通过该启动模块依赖开发者自定义的模块和 silky 框架定义的模块,达到服务注册和初始化任务的目的。

例如:

  1. [DependsOn(typeof(ZookeeperModule),
  2. typeof(DotNettyTcpModule),
  3. typeof(MessagePackModule),
  4. typeof(RpcProxyModule),
  5. typeof(TransactionTccModule),
  6. typeof(AutoMapperModule),
  7. typeof(CustomModule),
  8. )]
  9. public class CustomStartHostModule : StartUpModule
  10. {
  11. }

为了方便开发者,silky框架根据构建主机的类型,已经创建了多种启动模块,该类型的启动模块已经定义好了该模块必须的依赖的模块:

  1. 通过web主机构建微服务应用的WebHostModule模块
  2. 通过通用主机构建微服务应用的GeneralHostModule模块
  3. 构建websocket服务主机的应用的WebSocketHostModule模块
  4. 构建只能作为服务消费者网关应用的GatewayHostModule模块

开发者可以选择继承如上的启动模块,并且配置Host主机提供API就可以构建相应的主机。

开源地址

在线文档

silky微服务模块的更多相关文章

  1. silky微服务简介

    代理主机 silky微服务定义了三种类型的代理主机,开发者可以根据需要选择合适的silky代理主机托管微服务应用.代理主机定义了一个Startup模块,该模块给出了使用该种类型主机所必须依赖的模块. ...

  2. silky微服务业务主机简介

    目录 主机的概念 通用主机 web主机 业务主机类型 使用web主机构建微服务应用 使用通用主机构建微服务应用 构建具有websocket能力的微服务应用 构建网关 开源地址 在线文档 主机的概念 s ...

  3. silky微服务框架的服务治理介绍

    目录 服务治理的概念 服务注册与发现 负载均衡 超时 故障转移(失败重试) 熔断保护(断路器) 限流 RPC限流 HTTP限流 1. 添加配置 2. 注册服务 3.启用 AspNetCoreRateL ...

  4. Silky微服务框架之服务引擎

    构建服务引擎 在注册Silky微服务应用一节中,我们了解到在ConfigureServices阶段,通过IServiceCollection的扩展方法AddSilkyServices<T> ...

  5. maven 聚合工程 用spring boot 搭建 spring cloud 微服务 模块式开发项目

    项目的简单介绍: 项目采用maven聚合工程 用spring boot 搭建 spring cloud的微服务 模块式开发 项目的截图: 搭建开始: 能上图 我少打字 1.首先搭建maven的聚合工程 ...

  6. silky微服务框架服务注册中心介绍

    目录 服务注册中心简介 服务元数据 主机名称(hostName) 服务列表(services) 终结点 时间戳 使用Zookeeper作为服务注册中心 使用Nacos作为服务注册中心 使用Consul ...

  7. Silky微服务框架之模块

    模块的定义 Silky是一个包括多个nuget包构成的模块化的框架,每个模块将程序划分为一个个小的结构,在这个结构中有着自己的逻辑代码和自己的作用域,不会影响到其他的结构. 模块类 一般地,一个模块的 ...

  8. silky微服务快速开始

    项目介绍 Silky框架旨在帮助开发者在.net平台下,通过简单代码和配置快速构建一个微服务开发框架. Silky 通过 .net core的主机来托管微服务应用.通过 Asp.Net Core 提供 ...

  9. (子文章)Spring Boot搭建两个微服务模块

    目录 1. 创建工程和user-service模块 1.1 创建空工程 1.2 在空工程里新建Module 2. 配置文件 2.1 pom.xml 2.2 application.yml 3. 代码 ...

随机推荐

  1. bzoj4025-二分图【线段树分治,并查集】

    正题 题目链接:https://darkbzoj.tk/problem/4025 题目大意 \(n\)个点\(m\)条边,每条边会在一个\(T\)以内的时间段内出现,对于任意一个\(T\)以内的时刻求 ...

  2. Css预编译(Sass&&Less)

    目录 Less与Sass是css的预处理技术 而CoffeeScript.TypeScript则是javascript的预处理技术. Less与Sass是css的预处理技术 而CoffeeScript ...

  3. openlayer 4326与3857坐标互转之Java版

    public class Transform { private static final double PI = Math.PI; private static final double merca ...

  4. redux搭配react-redux进行跨组件通信开发

    Redux API 作用 createStore 用于创建一个store对象 bindActionCreators 用于简化操作,不用开发者手动触发dispatch React-redux API 作 ...

  5. Xcode相关

    Xcode相关的路径 Provisioning Profiles存放路径:~/Library/MobileDevice/Provisioning Profiles 所有模拟器(包括历史模拟器):~/L ...

  6. 题解 CF1119H Tripe题解

    题目传送门 题目大意 给出\(n,t,x,y,z\),值域\(\le 2^t\),给出\(n\)个三元组\((a_i,b_i,c_i)\),表示有\(x\)个\(a_i\),\(y\)个\(b_i\) ...

  7. bzoj2242,洛谷2485----SDOI2011计算器(exgcd,qsm,bsgs模板)

    就是一道模板题! 这里再强调一下 BSGS 考虑方程\(a^x = b \pmod p\) 已知a,b,p\((2 \le p\le 10^9)\),其中p为质数,求x的最小正整数解 解法: 注意到如 ...

  8. TCC分布式事务的实现原理

    目录 一.写在前面 二.业务场景介绍 三.进一步思考 四.落地实现TCC分布式事务 (1)TCC实现阶段一:Try (2)TCC实现阶段二:Confirm (3)TCC实现阶段三:Cancel 五.总 ...

  9. 2.2 DDD Layers & Clean Architecture DDD分层和简洁架构

    DDD Layers & Clean Architecture DDD分层和简洁架构 There are four fundamental layers of a Domain Driven ...

  10. vue3.x全局$toast、$message、$loading等js插件

    有时候我们需要使用一些类似toast,messge.loading这些跟js交互很频繁的插件,vue3.x这类插件的定义跟vue2.x插件稍大,而且相对变得复杂了一点点. 第一种.需要时创建,用完移除 ...