silky微服务业务主机简介

主机的概念
- 通用主机
- web主机
业务主机类型
开源地址
在线文档

主机的概念

silky的主机与.net的主机概念一致。是封装应用资源的对象,用于托管应用和管理应用的生命周期。

通用主机

如果用于托管普通的业务应用,该微服务模块本身并不需要对直接对集群外部提供访问入口。那么,您可以使用.net的通用主机注册silky服务框架。.net的通用主机无法提供http请求,也无法配置http的请求管道(即:中间件)。

在注册silky框架后,silky框架会注册dotnetty的服务监听者,并会暴露rpc端口号。但是由于silky框架的安全机制,集群外部并不允许通过tcp协议通过rpc端口号直接访问该微服务模块的应用接口。

web主机

如果您需要访问该服务模块的应用接口,您必须要通过.net的web主机注册silky框架,并配置silky框架的请求管道。这样,web构建的主机通过引用某个微服务的应用接口项目(包)，通过应用接口的代理与微服务集群内部实现rpc通信。

业务主机类型

silky微服务框架提供了多种类型的业务主机,开发者可以选择合适的主机来托管应用服务。

使用web主机构建微服务应用

使用web主机构建的silky应用具有如下特性:

提供http服务和RPC服务,暴露http端口和RPC端口
可以作为外部流量的入口,集群外部通过http服务访问微服务应用集群
作为RPC服务提供者,通过RPC框架与其他微服务进行通信

一般地,如果我们希望该服务应用既可以作为RPC服务提供者,也希望外部能够直接通过http协议访问应用,那么我们就可以通过web主机构建微服务应用。这样的方式适用于将微服务应用拆分给不同的团队进行开发,开发者也无需要额外的构建网关,就可以访问微服务应用服务。

使用web主机构建Silky微服务应用只需要开发者安装Silky.Agent.Host包后,在Main()方法中通过Host提供的APIConfigureSilkyWebHostDefaults即可。开发者需要指定Startup类,在Startup中注册服务和配置http中间件。

namespace Silky.Sample

{

    using Microsoft.Extensions.Hosting;

    using System.Threading.Tasks;

    class Program

    {

        public static async Task Main(string[] args)

        {

            await CreateHostBuilder(args).Build().RunAsync();

        }

        private static IHostBuilder CreateHostBuilder(string[] args)

        {

            return Host.CreateDefaultBuilder(args)

                    .ConfigureSilkyWebHostDefaults(webBuilder => webBuilder.UseStartup<Startup>());

        }

    }

}

当然,我们也可以在构建主机的时候,另外指定启动模块:

namespace Silky.Sample

{

    using Microsoft.Extensions.Hosting;

    using System.Threading.Tasks;

    class Program

    {

        public static async Task Main(string[] args)

        {

            await CreateHostBuilder(args).Build().RunAsync();

        }

        private static IHostBuilder CreateHostBuilder(string[] args)

        {

            return Host.CreateDefaultBuilder(args)

                    .ConfigureSilkyWebHost<DemoModule>(webBuilder => webBuilder.UseStartup<Startup>());

        }

    }

}

自定义的启动模块DemoModule需要继承WebHostModule,开发者可以在自定义的启动模块中,定义应用启动和停止需要执行的业务方法和配置服务注册,也可以依赖开发者扩展的自定义模块。

    // 依赖开发者自定义的模块

    // [DependsOn(typeof("UserDefinedModule"))]

    public class DemoModule : WebHostModule

    {

        public override Task Initialize(ApplicationContext applicationContext)

        {

            // 开发者可以定义应用程序启动时执行的业务方法

            return Task.CompletedTask;

        }

        public override Task Shutdown(ApplicationContext applicationContext)

        {

            // 开发者可以定义应用程序停止时执行的业务方法

            return Task.CompletedTask;d

        }

        public override void ConfigureServices(IServiceCollection services, IConfiguration configuration)

        {

            // 开发者可以配置服务注册,作用与Startup类ConfigureServices一致

        }

        protected override void RegisterServices(ContainerBuilder builder)

        {

            // 开发者可以通过 Autofac 的ContainerBuilder注册服务,

            // 例如: IServiceCollection无法注册命名服务,ContainerBuilder支持注册命名服务

        }

    }

在启动类Startup类中配置服务注册和中间件:

 public class Startup

    {

        public Startup(IConfiguration configuration)

        {

            Configuration = configuration;

        }

        public IConfiguration Configuration { get; }

        public void ConfigureServices(IServiceCollection services)

        {

            services

                .AddSilkyHttpCore()

                .AddResponseCaching()

                .AddHttpContextAccessor()

                .AddRouting()

                .AddSilkyIdentity()

                .AddSilkyMiniProfiler()

                .AddSwaggerDocuments();

        }

        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)

        {

            if (env.IsDevelopment())

            {

                app.UseDeveloperExceptionPage();

                app.UseSwaggerDocuments();

                app.UseMiniProfiler();

            }

            app.UseRouting();

            app.UseResponseCaching();

            app.UseSilkyWebSocketsProxy();

            app.UseSilkyIdentity();

            app.UseSilkyHttpServer();

            app.UseEndpoints(endpoints =>

            {

                endpoints.MapSilkyRpcServices();

            });

        }

    }

这样,我们就可以得到一个既可以提供http服务,也作为rpc服务提供者的应用。

使用通用主机构建微服务应用

使用通用主机构建的silky应用具有如下特性:

只提供RPC服务,不提供http服务,微服务集群外部无法直接访问应用
可以通过网关或是具有http服务的应用间接的访问该微服务提供的服务

一般地,如果只是作为普通的业务应用,只需要作为RPC服务提供者,服务内部通过RPC框架进行通信,并不需要对外提供http服务,在这样的情况下,我们考虑使用通用主机构建微服务应用。

开发者在安装Silky.Agent.Host包后,在Main()方法中通过Host提供的APIConfigureSilkyGeneralHostDefaults即可通过通用主机构建silky微服务应用。

namespace Silky.Sample

{

    using Microsoft.Extensions.Hosting;

    using System.Threading.Tasks;

    class Program

    {

        public static async Task Main(string[] args)

        {

            await CreateHostBuilder(args).Build().RunAsync();

        }

        private static IHostBuilder CreateHostBuilder(string[] args) =>

            Host.CreateDefaultBuilder(args)

                .ConfigureSilkyGeneralHostDefaults();

    }

}

同样地,我们也可以在构建主机的时候,另外指定启动模块:

namespace Silky.Sample

{

    using Microsoft.Extensions.Hosting;

    using System.Threading.Tasks;

    class Program

    {

        public static async Task Main(string[] args)

        {

            await CreateHostBuilder(args).Build().RunAsync();

        }

        private static IHostBuilder CreateHostBuilder(string[] args) =>

            Host.CreateDefaultBuilder(args)

                .ConfigureSilkyGeneralHost<DemoModule>();

    }

}

在这里,我们需要自定义的启动模块DemoModule需要继承GeneralHostModule,开发者可以在自定义的启动模块中,定义应用启动和停止需要执行的业务方法和配置服务注册,也可以依赖开发者扩展的自定义模块。

  // [DependsOn(typeof("UserDefinedModule"))]

    public class DemoModule : GeneralHostModule

    {

        public override Task Initialize(ApplicationContext applicationContext)

        {

            // 开发者可以定义应用程序启动时执行的业务方法

            return Task.CompletedTask;

        }

        public override Task Shutdown(ApplicationContext applicationContext)

        {

            // 开发者可以定义应用程序停止时执行的业务方法

            return Task.CompletedTask;

        }

        public override void ConfigureServices(IServiceCollection services, IConfiguration configuration)

        {

            // 开发者可以配置服务注册,作用与Startup类ConfigureServices一致

        }

        protected override void RegisterServices(ContainerBuilder builder)

        {

            // 开发者可以通过 Autofac 的ContainerBuilder注册服务,

            // 例如: IServiceCollection无法注册命名服务,ContainerBuilder支持注册命名服务

        }

    }

::: warning 注意

与web主机构建微服务应用自定义启动模块继承的基类不同,但是作用和使用上一致

:::

通用主机构建的微服务应用,不提供HTTP服务,所有也无需(也没有必要)配置http中间件。但是,开发者可以通过继承IConfigureService来配置服务的注册,从而自身服务注册,或是引入第三方组件。

    public class ConfigureService : IConfigureService

    {

        public void ConfigureServices(IServiceCollection services, IConfiguration configuration)

        {

            services.AddSilkyCaching()

                .AddSilkySkyApm()

                .AddMessagePackCodec();

            services.AddDatabaseAccessor(

                options => { options.AddDbPool<DefaultContext>(); },

                "Demo.Database.Migrations");

             // 可以通过服务注册引入第三方组件,例如:CAP,MassTransit等

        }

    }

构建具有websocket能力的微服务应用

具有websocket服务能力的微服务应用除了能够提供RPC服务,还可以提供websocket服务。

提供RPC服务,也提供WebSocket服务
可以通过网关的websocket代理中间件与该微服务的websocket服务进行握手

开发者在安装Silky.Agent.Host包后,在Main()方法中通过Host提供的APIConfigureSilkyGeneralHostDefaults即可通过通用主机构建支持websocket服务的微服务应用。

namespace Silky.Sample

{

    using Microsoft.Extensions.Hosting;

    using System.Threading.Tasks;

    class Program

    {

        public static async Task Main(string[] args)

        {

            await CreateHostBuilder(args).Build().RunAsync();

        }

        private static IHostBuilder CreateHostBuilder(string[] args) =>

            Host.CreateDefaultBuilder(args)

                .ConfigureSilkyWebSocketDefaults();

    }

}

同样地,我们也可以在构建主机的时候,另外指定启动模块:

namespace Silky.Sample

{

    using Microsoft.Extensions.Hosting;

    using System.Threading.Tasks;

    class Program

    {

        public static async Task Main(string[] args)

        {

            await CreateHostBuilder(args).Build().RunAsync();

        }

        private static IHostBuilder CreateHostBuilder(string[] args) =>

            Host.CreateDefaultBuilder(args)

                .ConfigureSilkyWebSocket<DemoModule>();

    }

}

在这里,我们需要自定义的启动模块DemoModule需要继承WebSocketHostModule,开发者可以在自定义的启动模块中,定义应用启动和停止需要执行的业务方法和配置服务注册,也可以依赖开发者扩展的自定义模块。

// [DependsOn(typeof("UserDefinedModule"))]

    public class DemoModule : WebSocketHostModule

    {

        public override Task Initialize(ApplicationContext applicationContext)

        {

            // 开发者可以定义应用程序启动时执行的业务方法

            return Task.CompletedTask;

        }

        public override Task Shutdown(ApplicationContext applicationContext)

        {

            // 开发者可以定义应用程序停止时执行的业务方法

            return Task.CompletedTask;

        }

        public override void ConfigureServices(IServiceCollection services, IConfiguration configuration)

        {

            // 开发者可以配置服务注册,作用与Startup类ConfigureServices一致

        }

        protected override void RegisterServices(ContainerBuilder builder)

        {

            // 开发者可以通过 Autofac 的ContainerBuilder注册服务,

            // 例如: IServiceCollection无法注册命名服务,ContainerBuilder支持注册命名服务

        }

    }

::: warning 注意

与web主机构建微服务应用自定义启动模块继承的基类不同,但是作用和使用上一致

:::

构建具有websocket能力的服务,实现应用服务接口的类需要继承WsAppServiceBase。在与前端建立会话后,就可以通过SessionManager向前端发送消息。

    public class TestAppService : WsAppServiceBase, ITestAppService

    {

        private readonly ILogger<TestAppService> _logger;

        public TestAppService(ILogger<TestAppService> logger)

        {

            _logger = logger;

        }

        protected override void OnOpen()

        {

            base.OnOpen();

            _logger.LogInformation("websocket established a session");

        }

        protected override void OnMessage(MessageEventArgs e)

        {

            _logger.LogInformation(e.Data);

        }

        protected override void OnClose(CloseEventArgs e)

        {

            base.OnClose(e);

            _logger.LogInformation("websocket disconnected");

        }

    }

前端需要通过网关的websocket代理中间件，与具体的websocket服务实例建立会话时,需要满足如下要求:

需要通过请求头或是qString参数指定bussinessId，通过该值使用哈希算法,路由到具体的websocket服务实例。
为保证每次都能够路由到同一个websocket服务实例,websocket服务对应的网关实例只能有一个。
该网关必须要引用websocket服务代理中间件。

// 需要在网关的Configure()配置websocket代理中间件

app.UseSilkyWebSocketsProxy();

::: warning 注意

开发者可以考虑,普通业务服务对应一组网关应用(支持部署多个实例),websocket应用对应一组网关应用(只允许一个服务实例)

:::

构建网关

这里,网关的作用只是作为集群流量的入口,将http请求转发到集群内部,交个各个微服务应用的服务进行处理,并不作为rpc服务提供者。也就是说,这里构建的网关只能作为服务消费者。

只提供http服务,作为集群流量入口
不提供RPC服务,不可以作为rpc服务提供者

::: warning 注意

网关与web主机构建业务主机的区别在于,网关只能作为服务消费者,转发外部的http请求,而后者除了具有转发http请求的能力之外,还能作为RPC服务提供者。

:::

开发者在安装Silky.Agent.Host包后,在Main()方法中通过Host提供的APIConfigureSilkyGatewayDefaults即可通过通用主机构建支持websocket服务的微服务应用。

namespace Silky.Sample

{

    using Microsoft.Extensions.Hosting;

    using System.Threading.Tasks;

    class Program

    {

        public static async Task Main(string[] args)

        {

            await CreateHostBuilder(args).Build().RunAsync();

        }

    private static IHostBuilder CreateHostBuilder(string[] args) =>

            Host.CreateDefaultBuilder(args)

                .ConfigureSilkyGatewayDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); });

    }

}

当然,也可以自定义启动模块,只需要将自定义的启动模块DemoModule继承的基类修改为GatewayHostModule:

namespace Silky.Sample

{

    using Microsoft.Extensions.Hosting;

    using System.Threading.Tasks;

    class Program

    {

        public static async Task Main(string[] args)

        {

            await CreateHostBuilder(args).Build().RunAsync();

        }

    private static IHostBuilder CreateHostBuilder(string[] args) =>

            Host.CreateDefaultBuilder(args)

                .ConfigureSilkyGateway<DemoModule>(webBuilder => { webBuilder.UseStartup<Startup>(); });

    }

}

开源地址

github: https://github.com/liuhll/silky
gitee: https://gitee.com/liuhll2/silky

在线文档

http://docs.silky-fk.com/