.NET Core中Object Pool的多种用法详解

复用,是一个重要的话题,也是我们日常开发中经常遇到的,不可避免的问题。

举个最为简单,大家最为熟悉的例子,数据库连接池,就是复用数据库连接。

那么复用的意义在那里呢?

简单来说就是减少不必要的资源损耗。

除了数据库连接,可能在不同的情景或需求下,还会有很多其他对象需要进行复用,这个时候就会有所谓的 Object Pool(对象池)。

小伙伴们应该也自己实现过类似的功能,或用ConcurrentBag,或用ConcurrentQueue,或用其他方案。

这也里分享一个在微软文档中的实现

How to: Create an Object Pool by Using a ConcurrentBag

当然,在.NET Core中,微软已经帮我们实现了一个简单的Object Pool。

我们只需要添加Microsoft.Extensions.ObjectPool的引用即可使用了。

Microsoft.Extensions.ObjectPool

Microsoft.Extensions.ObjectPool可以说是.NET Core的一个基础类库。

它位于aspnet的Common项目中,类型其他基础模块都有使用相关的功能,也好比Routing项目。

下面就简单看看它的用法。

在开始之前,我们先定义一个可以复用的object

public class Demo { public int Id { get; set; } public string Name { get; set; } public DateTime CreateTimte { get; set; } }

用法1

var defalutPolicy = new DefaultPooledObjectPolicy<Demo>(); //最大可保留对象数量 = Environment.ProcessorCount * 2 var defaultPool = new DefaultObjectPool<Demo>(defalutPolicy); for (int i = 0; i < PoolSize; i++) { item1 = defaultPool.Get(); Console.WriteLine($"#{i+1}-{item1.Id}-{item1.Name}-{item1.CreateTimte}"); }

在创建pool之前,我们要先定义一个Policy。这里直接用自带的DefaultPooledObjectPolicy来构造。

对象池会有一个维护的最大数量,线程数。

通过pool对象的Get方法,从对象池中取出一个对象。

上面代码运行结果

#1-0--01/01/0001 00:00:00
#2-0--01/01/0001 00:00:00
#3-0--01/01/0001 00:00:00
#4-0--01/01/0001 00:00:00
#5-0--01/01/0001 00:00:00
#6-0--01/01/0001 00:00:00
#7-0--01/01/0001 00:00:00
#8-0--01/01/0001 00:00:00

这个结果说明,Object Pool 中的对象都是直接new出来的,并没有对一些属性进行贬值操作,这个时候往往没有太多实际意义。

因为DefaultPooledObjectPolicy本来就是直接new了一个对象出来,很多时候,这并不是我们所期望的!

要想符合我们实际的使用,就要自己定义一个Policy!

下面来看看用法2

用法2

先定义一个Policy,实现 IPooledObjectPolicy 这个接口。T很自然就是我们的Demo类了。

public class DemoPooledObjectPolicy : IPooledObjectPolicy<Demo> { public Demo Create() { return new Demo { Id = 1, Name = "catcher", CreateTimte = DateTime.Now }; } public bool Return(Demo obj) { return true; } }

这里要实现Create和Return两个方法。

见名知义,Create方法就是用来创建Demo对象的,Return方法就是将Demo对象扔回Object Pool的(有借有还)。

然后是用DemoPooledObjectPolicy去替换DefaultPooledObjectPolicy。

var demoPolicy = new DemoPooledObjectPolicy(); var defaultPoolWithDemoPolicy = new DefaultObjectPool<Demo>(demoPolicy,1); //借 item1 = defaultPoolWithDemoPolicy.Get(); //还 defaultPoolWithDemoPolicy.Return(item1); //借,但是不还 item2 = defaultPoolWithDemoPolicy.Get(); Console.WriteLine($"{item1.Id}-{item1.Name}-{item1.CreateTimte}"); Console.WriteLine($"{item2.Id}-{item2.Name}-{item2.CreateTimte}"); Console.WriteLine(item1 == item2); //创建一个新的 item3 = defaultPoolWithDemoPolicy.Get(); Console.WriteLine($"{item3.Id}-{item3.Name}-{item3.CreateTimte}"); Console.WriteLine(item3 == item1);

这里定义了对象池只保留一个对象。

由于从object pool中取出来之后,有一步还回去的操作,所以item1和item2应当是同一个对象。

从object pool中拿出了item2之后,它并没有还回去,所以object pool会基于我们定义的Policy去创建一个新的对象出来。

下面是用法2的输出结果:

1-catcher-09/17/2018 22:32:38
1-catcher-09/17/2018 22:32:38
True
1-catcher-09/17/2018 22:32:38
False

可以看到item1,item2和item3的各个属性是一样的,并且item1和item2确实是同一个对象。item3和item1并不是同一个。

用法3

除了DefaultObjectPool外,还有DefaultObjectPoolProvider也可以创建一个Object Pool。

创建一个Object Pool,一定是离不开Policy的,所以这里还是用了我们自己定义的DemoPooledObjectPolicy。

var defaultProvider = new DefaultObjectPoolProvider(); var policy = new DemoPooledObjectPolicy(); //default maximumRetained is Environment.ProcessorCount * 2 ObjectPool<Demo> pool = defaultProvider.Create(policy); item1 = pool.Get(); pool.Return(item1); item2 = pool.Get(); Console.WriteLine($"{item1.Id}-{item1.Name}-{item1.CreateTimte}"); Console.WriteLine($"{item2.Id}-{item2.Name}-{item2.CreateTimte}"); Console.WriteLine(item1 == item2); item3 = pool.Get(); Console.WriteLine($"{item3.Id}-{item3.Name}-{item3.CreateTimte}"); Console.WriteLine(item3 == item2);

用Provider创建Object Pool时,不能指定保留的最大对象数量,只能用的是默认的Environment.ProcessorCount * 2。

后面的使用,和用法2是一样的。

可以看到item1和item2是同一个对象。从Object Pool中取对象的时候,会取第一个,所以还回去后,再取的话,还是会取到原来的第一个。

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/wdsfgp.html