Orleans 知多少 | 3. Hello Orleans
1. 引言
是的,Orleans v3.0.0 已经发布了,并已经完全支持 .NET Core 3.0。所以,Orleans 系列是时候继续了,抱歉,让大家久等了。万丈高楼平地起,这一节我们就先来了解下Orleans的基本使用。
2. 模板项目讲解
在上一篇文章中,我们了解到Orleans 作为.NET 分布式框架,其主要包括三个部分:Client、Grains、Silo Host(Server)。因此,为了方便讲解,创建如下的项目结构进行演示:
这里有几点需要说明:
Orleans.Grains:类库项目,用于定义Grain的接口以及实现,需要引用
Microsoft.Orleans.CodeGenerator.MSBuild
和Microsoft.Orleans.Core.Abstractions
NuGet包。Orleans.Server:控制台项目,为 Silo 宿主提供宿主环境,需要引用
Microsoft.Orleans.Server
和Microsoft.Extensions.Hosting
NuGet包,以及Orleans.Grains
项目。Orleans.Client:控制台项目,用于演示如何借助Orleans Client建立与Orleans Server的连接,需要引用
Microsoft.Orleans.Client
和Microsoft.Extensions.Hosting
NuGet包,同时添加Orleans.Grains
项目引用。
3. 第一个Grain
Grain作为Orleans的第一公民,以及Virtual Actor的实际代言人,想吃透Orleans,那Grain就是第一道坎。先看一个简单的Demo,我们来模拟统计网站的实时在线用户。在 Orleans.Grains
添加 ISessionControl
接口,主要用户登录状态的管理。
public interface ISessionControlGrain : IGrainWithStringKey
{ Task Login(string userId); Task Logout(string userId); Task<int> GetActiveUserCount();
}
可以看见Grain的定义很简单,只需要指定继承自IGrain的接口就好。这里面继承自 IGrainWithStringKey
,说明该Grain 的Identity Key(身份标识)为 string
类型。同时需要注意的是Grain 的方法申明,返回值必须是:Task、Task、ValueTask。紧接着定义 SessionControlGrain
来实现 ISessionControlGrain
接口。
public class SessionControlGrain : Grain, ISessionControlGrain
{ private List<string> LoginUsers { get; set; } = new List<string>(); public Task Login(string userId) { //获取当前Grain的身份标识(因为ISessionControlGrain身份标识为string类型,GetPrimaryKeyString()); var appName = this.GetPrimaryKeyString(); LoginUsers.Add(userId); Console.WriteLine($"Current active users count of {appName} is {LoginUsers.Count}"); return Task.CompletedTask; } public Task Logout(string userId) { //获取当前Grain的身份标识 var appName = this.GetPrimaryKey(); LoginUsers.Remove(userId); Console.WriteLine($"Current active users count of {appName} is {LoginUsers.Count}"); return Task.CompletedTask; } public Task<int> GetActiveUserCount() { return Task.FromResult(LoginUsers.Count); }
}
实现也很简单,Grain的实现要继承自 Grain
基类。代码中我们定义了一个 List<string>
集合用于保存登录用户。
4. 第一个Silo Host(Server)
定义一个Silo用于暴露Grain提供的服务,在 Orleans.Server.Program
中添加以下代码用于启动Silo Host。
static Task Main(string[] args)
{ Console.Title = typeof(Program).Namespace; // define the cluster configuration return Host.CreateDefaultBuilder() .UseOrleans((builder) => { builder.UseLocalhostClustering() .AddMemoryGrainStorageAsDefault() .Configure<ClusterOptions>(options => { options.ClusterId = "Hello.Orleans"; options.ServiceId = "Hello.Orleans"; }) .Configure<EndpointOptions>(options => options.AdvertisedIPAddress = IPAddress.Loopback) .ConfigureApplicationParts(parts => parts.AddApplicationPart(typeof(ISessionControlGrain).Assembly).WithReferences()); } ) .ConfigureServices(services => { services.Configure<ConsoleLifetimeOptions>(options => { options.SuppressStatusMessages = true; }); }) .ConfigureLogging(builder => { builder.AddConsole(); }) .RunConsoleAsync();
}
Host.CreateDefaultBuilder()
:创建泛型主机提供宿主环境。UseOrleans
:用来配置Oleans。UseLocalhostClustering()
:用于在开发环境下指定连接到本地集群。Configure<ClusterOptions>
:用于指定连接到那个集群。Configure<EndpointOptions>
:用于配置silo与silo、silo与client之间的通信端点。开发环境下可仅指定回环地址作为集群间通信的IP地址。ConfigureApplicationParts()
:用于指定暴露哪些Grain服务。
以上就是开发环境下,Orleans Server的基本配置。对于详细的配置也可以先参考Orleans Server Configuration。后续也会有专门的一篇文章来详解。
5. 第一个Client
客户端的定义也很简单,主要是创建 IClusterClient
对象建立于Orleans Server的连接。因为 IClusterClient
最好能在程序启动之时就建立连接,所以可以通过继承 IHostedService
来实现。在 Orleans.Client
中定义 ClusterClientHostedService
继承自 IHostedService
。
public class ClusterClientHostedService : IHostedService
{ public IClusterClient Client { get; } private readonly ILogger<ClusterClientHostedService> _logger; public ClusterClientHostedService(ILogger<ClusterClientHostedService> logger, ILoggerProvider loggerProvider) { _logger = logger; Client = new ClientBuilder() .UseLocalhostClustering() .Configure<ClusterOptions>(options => { options.ClusterId = "Hello.Orleans"; options.ServiceId = "Hello.Orleans"; }) .ConfigureLogging(builder => builder.AddProvider(loggerProvider)) .Build(); } public Task StartAsync(CancellationToken cancellationToken) { var attempt = 0; var maxAttempts = 100; var delay = TimeSpan.FromSeconds(1); return Client.Connect(async error => { if (cancellationToken.IsCancellationRequested) { return false; } if (++attempt < maxAttempts) { _logger.LogWarning(error, "Failed to connect to Orleans cluster on attempt {@Attempt} of {@MaxAttempts}.", attempt, maxAttempts); try { await Task.Delay(delay, cancellationToken); } catch (OperationCanceledException) { return false; } return true; } else { _logger.LogError(error, "Failed to connect to Orleans cluster on attempt {@Attempt} of {@MaxAttempts}.", attempt, maxAttempts); return false; } }); } public async Task StopAsync(CancellationToken cancellationToken) { try { await Client.Close(); } catch (OrleansException error) { _logger.LogWarning(error, "Error while gracefully disconnecting from Orleans cluster. Will ignore and continue to shutdown."); } }
}
代码讲解:
1.构造函数中通过借助 ClientBuilder()
来初始化 IClusterClient
。其中 UseLocalhostClustering()
用于连接到开发环境中的localhost 集群。并通过 Configure<ClusterOptions>
指定连接到哪个集群。(需要注意的是,这里的ClusterId必须与Orleans.Server中配置的保持一致。
Client = new ClientBuilder() .UseLocalhostClustering() .Configure<ClusterOptions>(options => { options.ClusterId = "Hello.Orleans"; options.ServiceId = "Hello.Orleans"; }) .ConfigureLogging(builder => builder.AddProvider(loggerProvider)) .Build();
2. 在 StartAsync
方法中通过调用 Client.Connect
建立与Orleans Server的连接。同时定义了一个重试机制。
紧接着我们需要将 ClusterClientHostedService
添加到Ioc容器,添加以下代码到 Orleans.Client.Program
中:
static Task Main(string[] args)
{ Console.Title = typeof(Program).Namespace; return Host.CreateDefaultBuilder() .ConfigureServices(services => { services.AddSingleton<ClusterClientHostedService>(); services.AddSingleton<IHostedService>(_ => _.GetService<ClusterClientHostedService>()); services.AddSingleton(_ => _.GetService<ClusterClientHostedService>().Client); services.AddHostedService<HelloOrleansClientHostedService>(); services.Configure<ConsoleLifetimeOptions>(options => { options.SuppressStatusMessages = true; }); }) .ConfigureLogging(builder => { builder.AddConsole(); }) .RunConsoleAsync();
}
对于 ClusterClientHostedService
,并没有选择直接通过 services.AddHostedService<T>
的方式注入,是因为我们需要注入该服务中提供的 IClusterClient
(单例),以供其他类去消费。
紧接着,定义一个 HelloOrleansClientHostedService
用来消费定义的 ISessionControlGrain
。
public class HelloOrleansClientHostedService : IHostedService
{ private readonly IClusterClient _client; private readonly ILogger<HelloOrleansClientHostedService> _logger; public HelloOrleansClientHostedService(IClusterClient client, ILogger<HelloOrleansClientHostedService> logger) { _client = client; _logger = logger; } public async Task StartAsync(CancellationToken cancellationToken) { // 模拟控制台终端用户登录 await MockLogin("Hello.Orleans.Console"); // 模拟网页终端用户登录 await MockLogin("Hello.Orleans.Web"); } /// <summary> /// 模拟指定应用的登录 /// </summary> /// <param name="appName"></param> /// <returns></returns> public async Task MockLogin(string appName) { //假设我们需要支持不同端登录用户,则只需要将项目名称作为身份标识。 //即可获取一个代表用来维护当前项目登录状态的的单例Grain。 var sessionControl = _client.GetGrain<ISessionControlGrain>(appName); ParallelLoopResult result = Parallel.For(0, 10000, (index) => { var userId = $"User-{index}"; sessionControl.Login(userId); }); if (result.IsCompleted) { //ParallelLoopResult.IsCompleted 只是返回所有循环创建完毕,并不保证循环的内部任务创建并执行完毕 //所以,此处手动延迟5秒后再去读取活动用户数。 await Task.Delay(TimeSpan.FromSeconds(5)); var activeUserCount = await sessionControl.GetActiveUserCount(); _logger.LogInformation($"The Active Users Count of {appName} is {activeUserCount}"); } } public Task StopAsync(CancellationToken cancellationToken) { _logger.LogInformation("Closed!"); return Task.CompletedTask; ; }
}
代码讲解:这里定义了一个 MockLogin
用于模拟不同终端10000个用户的并发登录。
通过构造函数注入需要的
IClusterClient
。通过指定Grain接口以及身份标识,就可以通过Client 获取对应的Grain,进而消费Grain中暴露的方法。
varsessionControl=_client.GetGrain<ISessionControlGrain>(appName);
这里需要注意的是,指定的身份标识为终端应用的名称,那么在整个应用生命周期内,将有且仅有一个代表这个终端应用的Grain。使用
Parallel.For
模拟并发ParallelLoopResult.IsCompleted
只是返回所有循环任务创建完毕,并不代表循环的内部任务执行完毕。
6. 启动第一个 Orleans 应用
先启动 Orleans.Server
:再启动 Orleans.Client
:
从上面的运行结果来看,模拟两个终端10000个用户的并发登录,最终输出的活动用户数量均为10000个。回顾整个实现,并没有用到诸如锁、并发集合等避免并发导致的线程安全问题,但却输出正确的期望结果,这就正好说明了Orleans强大的并发控制特性。
public class SessionControlGrain : Grain, ISessionControlGrain
{ // 未使用并发集合 private List<string> LoginUsers { get; set; } = new List<string>(); public Task Login(string userId) { //获取当前Grain的身份标识(因为ISessionControlGrain身份标识为string类型,GetPrimaryKeyString()); var appName = this.GetPrimaryKeyString(); LoginUsers.Add(userId);//未加锁 Console.WriteLine($"Current active users count of {appName} is {LoginUsers.Count}"); return Task.CompletedTask; } ....
}
7. 小结
通过简单的演示,想必你对Orleans的编程实现有了基本的认知,并体会到其并发控制的强大之处。这只是简单的入门演练,Orleans很多强大的特性,后续再结合具体场景进行详细阐述。源码已上传至GitHub:Hello.Orleans
Orleans 知多少 | 3. Hello Orleans相关推荐
- Orleans 知多少 | .NET Core 分布式云计算框架(转)
作者:『圣杰』 出处:http://www.cnblogs.com/sheng-jie/ Orleans 知多少 | .NET Core 分布式框架 引言 公司物联网项目集成Orleans以支持高并发 ...
- Orleans 知多少 | Orleans 中文文档上线
Orleans 简介 Orleans是一个跨平台框架,用于构建健壮,可扩展的分布式应用程序 Orleans建立在.NET开发人员生产力的基础上,并将其带入了分布式应用程序的世界,例如云服务.Orlea ...
- Orleans 知多少 | 2. 核心概念一览
Orleans 术语解读 上面这张图中包含了Orleans中的几个核心概念: Grain Silo Orleans Cluster Orleans Client 从这张图,我们应该能理清他们之间的关系 ...
- .NET分布式框架 | Orleans 知多少
引言 公司物联网项目集成Orleans以支持高并发的分布式业务,对于Orleans也是第一次接触,本文就分享下个人对Orleans的理解. 这里先抛出自己的观点:Orleans 是一个支持有状态云生应 ...
- Orleans例子再进一步
步骤 现在我想再添加一个方法,到IGrains项目内,这个方法里面有个延迟3秒,然后返回一个Task<string>.就叫做DelayedMsg吧,如下图所示: 我调用了这个Delayed ...
- .net core 微服务通讯组件Orleans的使用与配置
Orleans非常好用 并且支持.net core 社区也非常活跃 Orleans2.0+在国内的教程偏少 多数是1.5版本的教程 在这里写上四篇Orleans教程 目录 1.Orleans的入门教程 ...
- Orleans 3.0 为我们带来了什么
原文:https://devblogs.microsoft.com/dotnet/orleans-3-0/ 作者:Reuben Bond,Orleans首席软件开发工程师 翻译:艾心 这是一篇来自Or ...
- Orleans MultiClient 多个Silo复合客户端
介绍 Orleans.MultiClient 是一个 Orleans 复合客户端,只需要简单配置就可以简单高效连接和请求 Orleans 服务. Orleans.MultiClient 可以轻松连接多 ...
- Orleans解决并发之痛(五):Web API
通过前面几篇文章的介绍,可能会疑问怎么在实际开发中调用Grain,之前Demo的Client都是基于控制台应用程序,实际开发下可能是基于Web Form.Web API.MVC......,由于一时短 ...
最新文章
- kindeditor用法
- Cartographer安装
- numpy.sum详解
- Linux命令-磁盘管理(二)
- 计算机兴趣班记录,计算机兴趣班活动记录.doc
- 零基础自学python-零基础如何自学Python并且找到工作,其实也就这3点,4点
- WCF Data Service 创建OData服务
- Mysql之事务与视图
- 华为手机计算机代码大全,华为手机指令代码大全,你想要了解的功能都在这里!...
- 几种比较和谐的文字背景颜色搭配
- cad2016批量修改相关字体,统一文字样式
- python开发单片机仿真软件_开源电子电路仿真模拟软件,加油国产芯片
- 自己动手写java虚拟机(第一话)
- Moniter和Lock
- 春林文件批量改名系统
- 双十一,一群金融大脑去了趟苏州!
- 最小公倍数用c语言,如何用C语言求最小公倍数。。。
- magento mysql4-install_MAGENTO与表,数据字段的对应关系
- SUST OJ 1671: 数字拼图
- 模拟ic流片经验分享
热门文章
- easy html5 - Jquery mobile
- 《划时代-51单片机C语言全新教程》-第四章 工程创建与深入 概览
- solidworks小金球_如何在没有电缆的情况下传送第77届年度金球奖
- 从零开始React项目架构(四)
- WPF中设置了WindowStyle=None后,窗口仍然有边框的解决方法
- 利用win7的applocker功能来有组织的阻止相关软件运行
- 系统安全防护之UNIX下***检测方法
- 使用基于Roslyn的编译时AOP框架来解决.NET项目的代码复用问题
- WPF XAML 为项目设置全局样式
- System.Drawing.Common workaround in .NET6