.NET Core 3.0之深入源码理解ObjectPool（二）
写在前面
前文主要介绍了ObjectPool的一些理论基础，本文主要从源码角度理解Microsoft.Extensions.ObjectPool是如何实现的。下图为其三大核心组件图：
核心组件
ObjectPool
ObjectPool是一个泛型抽象类，里面只有两个抽象方法，Get和Return。它从底层定义了最一般的接口。
- Get方法用于从对象池获取到可用对象，如果对象不可用则创建对象并返回出来
- Return方法用户将对象返回到对象池
源码如下：
1: public abstract class ObjectPool<T> where T : class
2: {
3: /// <summary>
4: /// Gets an object from the pool if one is available, otherwise creates one.
5: /// </summary>
6: /// <returns>A <typeparamref name="T"/>.</returns>
7: public abstract T Get();
8:
9: /// <summary>
10: /// Return an object to the pool.
11: /// </summary>
12: /// <param name="obj">The object to add to the pool.</param>
13: public abstract void Return(T obj);
14: }
ObjectPoolProvider
ObjectPoolProvider也是抽象类，其内部内置了一个已经实现的Create泛型方法以及一个抽象Create方法，这代表两种ObjectPool的创建方式，一个是基于默认策略的，一个是基于用户自定义策略的。
1: public abstract class ObjectPoolProvider
2: {
3: /// <summary>
4: /// Creates an <see cref="ObjectPool"/>.
5: /// </summary>
6: /// <typeparam name="T">The type to create a pool for.</typeparam>
7: public ObjectPool<T> Create<T>() where T : class, new()
8: {
9: return Create<T>(new DefaultPooledObjectPolicy<T>());
10: }
11:
12: /// <summary>
13: /// Creates an <see cref="ObjectPool"/> with the given <see cref="IPooledObjectPolicy{T}"/>.
14: /// </summary>
15: /// <typeparam name="T">The type to create a pool for.</typeparam>
16: public abstract ObjectPool<T> Create<T>(IPooledObjectPolicy<T> policy) where T : class;
17: }
IPooledObjectPolicy
这个接口是一个泛型接口，用于提供一种策略来管理对象池中的对象，同样也有两个方法，Create和Return。
- Create方法用于创建相关类型实例
- Return方法用于将已经使用好的对象放回到对象池的时候进行逻辑处理，包括对象的状态重置以及是否能够放回到对象池
1: public interface IPooledObjectPolicy<T>
2: {
3: /// <summary>
4: /// Create a <typeparamref name="T"/>.
5: /// </summary>
6: /// <returns>The <typeparamref name="T"/> which was created.</returns>
7: T Create();
8:
9: /// <summary>
10: /// Runs some processing when an object was returned to the pool. Can be used to reset the state of an object and indicate if the object should be returned to the pool.
11: /// </summary>
12: /// <param name="obj">The object to return to the pool.</param>
13: /// <returns><code>true</code> if the object should be returned to the pool. <code>false</code> if it's not possible/desirable for the pool to keep the object.</returns>
14: bool Return(T obj);
15: }
该接口有一个实现PooledObjectPolicy，这是一个抽象类，内部有两个抽象方法：
1: public abstract class PooledObjectPolicy<T> : IPooledObjectPolicy<T>
2: {
3: public abstract T Create();
4:
5: public abstract bool Return(T obj);
6: }
实现机制
其内部实现逻辑较为简单，充分考虑到了一般实现、对象追踪、对象释放等场景的使用方式。
以下为其逻辑图：
DefaultObjectPool
DefaultObjectPool实现了ObjectPool，其内部维护了一个结构体类型的私有数组，用于存储相关对象。该数组的大小在构造函数中定义，其实际大小为输入值减去1（默认情况下，其值为逻辑处理器数量的两倍）主要是因为DefaultObjectPool单独将首项定义了出来。
以下为DefaultObjectPool中Get和Return的实现：
1: public override T Get()
2: {
3: var item = _firstItem;
4: if (item == null || Interlocked.CompareExchange(ref _firstItem, null, item) != item)
5: {
6: var items = _items;
7: for (var i = 0; i < items.Length; i++)
8: {
9: item = items[i].Element;
10: if (item != null && Interlocked.CompareExchange(ref items[i].Element, null, item) == item)
11: {
12: return item;
13: }
14: }
15:
16: item = Create();
17: }
18:
19: return item;
20: }
21:
22: public override void Return(T obj)
23: {
24: if (_isDefaultPolicy || (_fastPolicy?.Return(obj) ?? _policy.Return(obj)))
25: {
26: if (_firstItem != null || Interlocked.CompareExchange(ref _firstItem, obj, null) != null)
27: {
28: var items = _items;
29: for (var i = 0; i < items.Length && Interlocked.CompareExchange(ref items[i].Element, obj, null) != null; ++i)
30: {
31: }
32: }
33: }
34: }
通过源码可以知道这两个方法大量使用了Interlocked.CompareExchange：
1: public static int CompareExchange(2: ref int location1,3: int value,4: int comparand5: )
比较location1与comparand，如果不相等，什么都不做；如果location1与comparand相等，则用value替换location1的值。无论比较结果相等与否，返回值都是location1中原有的值。
Interlocked.CompareExchange的使用确保了线程安全性。
DefaultObjectPoolProvider
DefaultObjectPoolProvider实现了ObjectPoolProvider，该类重写了Create方法并返回ObjectPool对象。该类还定义了MaximumRetained属性，默认情况下，其值为逻辑处理器数量的两倍。
其源码如下，比较简单：
1: public class DefaultObjectPoolProvider : ObjectPoolProvider
2: {
3: /// <summary>
4: /// The maximum number of objects to retain in the pool.
5: /// </summary>
6: public int MaximumRetained { get; set; } = Environment.ProcessorCount * 2;
7:
8: /// <inheritdoc/>
9: public override ObjectPool<T> Create<T>(IPooledObjectPolicy<T> policy)
10: {
11: if (policy == null)
12: {
13: throw new ArgumentNullException(nameof(policy));
14: }
15:
16: if (typeof(IDisposable).IsAssignableFrom(typeof(T)))
17: {
18: return new DisposableObjectPool<T>(policy, MaximumRetained);
19: }
20:
21: return new DefaultObjectPool<T>(policy, MaximumRetained);
22: }
23: }
其中DisposableObjectPool是DefaultObjectPool类的派生类，这个类也实现了IDisposable，用于创建可手动释放的ObjectPool对象。
其相关代码如下：
1: public void Dispose()
2: {
3: _isDisposed = true;
4:
5: DisposeItem(_firstItem);
6: _firstItem = null;
7:
8: ObjectWrapper[] items = _items;
9: for (var i = 0; i < items.Length; i++)
10: {
11: DisposeItem(items[i].Element);
12: items[i].Element = null;
13: }
14: }
15:
16: private void DisposeItem(T item)
17: {
18: if (item is IDisposable disposable)
19: {
20: disposable.Dispose();
21: }
22: }
DefaultPooledObjectPolicy
该类继承了PooledObjectPolicy，实现也非常简单。
不过值得注意的是，PooledObjectPolicy还有一个实现StringBuilderPooledObjectPolicy，这个类从命名上看就知道是基于StringBuilder的。其内部默认定义了StringBuilder的大小以及初始化容量。并确定了超出容量后，将不允许归还对象。
在我们自定义PooledObjectPolicy的时候，可以参考这段实现去扩展新的PooledObjectPolicy对象。
我们看一下源码：
1: public class StringBuilderPooledObjectPolicy : PooledObjectPolicy<StringBuilder>
2: {
3: public int InitialCapacity { get; set; } = 100;
4:
5: public int MaximumRetainedCapacity { get; set; } = 4 * 1024;
6:
7: public override StringBuilder Create()
8: {
9: return new StringBuilder(InitialCapacity);
10: }
11:
12: public override bool Return(StringBuilder obj)
13: {
14: if (obj.Capacity > MaximumRetainedCapacity)
15: {
16: // Too big. Discard this one.
17: return false;
18: }
19:
20: obj.Clear();
21: return true;
22: }
23: }
对象追踪
该库内部定义了LeakTrackingObjectPool和LeakTrackingObjectPoolProvider用于追踪对象状态。
- LeakTrackingObjectPoolProvider会根据构造函数传入的ObjectPoolProvider类型对象，创建LeakTrackingObjectPool实例。
- LeakTrackingObjectPool内部定义了ConditionalWeakTable<T, Tracker>类型的数组，MSDN的解释是使编译器可以将对象字段动态附加到托管对象，这个对象会自动维护内部的键值对，而不会一直使其停留在内存中。
Tracker是LeakTrackingObjectPool的内部类，其目的是为了方便我们对对象本身进行维护跟踪，其定义如下：
1: private class Tracker : IDisposable
2: {
3: private readonly string _stack;
4: private bool _disposed;
5:
6: public Tracker()
7: {
8: _stack = Environment.StackTrace;
9: }
10:
11: public void Dispose()
12: {
13: _disposed = true;
14: GC.SuppressFinalize(this);
15: }
16:
17: ~Tracker()
18: {
19: if (!_disposed && !Environment.HasShutdownStarted)
20: {
21: Debug.Fail($"{typeof(T).Name} was leaked. Created at: {Environment.NewLine}{_stack}");
22: }
23: }
24: }
.NET Core 3.0之深入源码理解ObjectPool（二）的更多相关文章
- .NET Core 3.0之深入源码理解HttpClientFactory(二)
写在前面 上一篇文章讨论了通过在ConfigureServices中调用services.AddHttpClient()方法,并基于此进一步探讨了DefaultHttpClientFactory是 ...
- .NET Core 3.0之深入源码理解Host(二)
写在前面 停了近一个月的技术博客,随着正式脱离996的魔窟,接下来也正式恢复了.本文从源码角度进一步讨论.NET Core 3.0 中关于Host扩展的一些技术点,主要讨论Long Run Pro ...
- .NET Core 3.0之深入源码理解ObjectPool（一）
写在前面 对象池是一种比较常用的提高系统性能的软件设计模式,它维护了一系列相关对象列表的容器对象,这些对象可以随时重复使用,对象池节省了频繁创建对象的开销. 它使用取用/归还的操作模式,并重复执行这些 ...
- .NET Core 3.0之深入源码理解Configuration(二)
文件型配置基本内容 上一篇文章讨论了Configuration的几个核心对象,本文继续讨论Configuration中关于文件型配置的相关内容.相比较而言,文件型配置的使用场景更加广泛,用户自定义 ...
- .NET Core 3.0之深入源码理解Startup的注册及运行
原文:.NET Core 3.0之深入源码理解Startup的注册及运行 写在前面 开发.NET Core应用,直接映入眼帘的就是Startup类和Program类,它们是.NET Core应用程 ...
- .NET Core 3.0之深入源码理解Configuration(一)
Configuration总体介绍 微软在.NET Core里设计出了全新的配置体系,并以非常灵活.可扩展的方式实现.从其源码来看,其运行机制大致是,根据其Source,创建一个Builder实例,并 ...
- .NET Core 3.0之深入源码理解Kestrel的集成与应用(一)
写在前面 ASP.NET Core 的 Web 服务器默认采用Kestrel,这是一个基于libuv(一个跨平台的基于Node.js异步I/O库)的跨平台.轻量级的Web服务器. 在开始之前,先回 ...
- .NET Core 3.0之深入源码理解Kestrel的集成与应用(二)
前言 前一篇文章主要介绍了.NET Core继承Kestrel的目的.运行方式以及相关的使用,接下来将进一步从源码角度探讨.NET Core 3.0中关于Kestrel的其他内容,该部分内容,我们 ...
- .NET Core 3.0之深入源码理解HealthCheck（一）
写在前面 我们的系统可能因为正在部署.服务异常终止或者其他问题导致系统处于非健康状态,这个时候我们需要知道系统的健康状况,而健康检查可以帮助我们快速确定系统是否处于正常状态.一般情况下,我们会提供公开 ...
随机推荐
- ORA-08102异常重现及恢复
现象: 在表上面新建主键报ORA-08102的异常: SQL> alter table t add primary key(id); alter table t add primary key( ...
- 使用Spreadsheet导出表格时，设置样式
$spreadsheet = new Spreadsheet();// 初始化 $spreadsheet->createSheet();// 添加一个sheet ...
- Django模板语言 标签整理
Django模板语言 标签 内置标签引用 1. autoescape 控制自动转义是否可用. 这种标签带有任何 on 或 off 作为参数的话,他将决定转义块内效果. 该标签会以一个endautoes ...
- VM虚拟机，如何放大虚拟机屏幕，如何导出虚拟机ovf
放大屏幕:,第一打开虚拟机,第二在需要放大的虚拟机上安装VMware tools 第三步查看>自动调节大小>自适应客户机.这样就可以放大屏幕了. 没有放大的屏幕 找到安装VMware ...
- 【Django】中间件，csrf，缓存，信号
中间件(middleware) 描述:Middlewares 是修改 Django request 或者 response 对象的钩子. 在django中,中间件其实就是一个类,在请求到来和结束后,d ...
- 一个低级错误引发Netty编码解码中文异常
前言 最近在调研Netty的使用,在编写编码解码模块的时候遇到了一个中文字符串编码和解码异常的情况,后来发现是笔者犯了个低级错误.这里做一个小小的回顾. 错误重现 在设计Netty的自定义协议的时候, ...
- 【Python】机器学习之单变量线性回归练习（计算Cost Function）
注:练习来自于吴恩达机器学习 翻译后的题目: 你是一个餐厅的老板,你想在其他城市开分店,所以你得到了一些数据(数据在本文最下方),数据中包括不同的城市人口数和该城市带来的利润.第一列是城市的人口数,第 ...
- 怎样实现给DEDE5.7的栏目增加栏目图片
前两天用DEDE做二次开发的时候,遇到一个问题,领导让给每个栏目增加一个栏目图片的功能,网上找了些东西,结合自己实际做的时候的方法,下面详细描述下具体的实现方式(只测试了V5.7版本,对低版本是否适用 ...
- Vue躬行记（1）——数据绑定
Vue.js的核心是通过基于HTML的模板语法声明式地将数据绑定到DOM结构中,即通过模板将数据显示在页面上,如下所示. <div id="container">{{c ...
- IDEA 学习笔记之 Java项目开发深入学习（1）
Java项目开发深入学习(1): 定义编译输出路径: 继承以上工程配置 重新定义新的项目编译路径 添加source目录:点击添加,再点击移除: 编译项目: 常用快捷键总结: Ctrl+Space 代码 ...