Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/headless-knight/ultratool
一款致力于简单易用、减少重复代码的工具库，提供丰富的扩展方法、工具类、工具函数等，帮助开发者提高开发效率，让您的开发速度更快更流畅
https://github.com/headless-knight/ultratool
collection csharp datetime dotnet exception linq pool utility
Last synced: 2 days ago
JSON representation
一款致力于简单易用、减少重复代码的工具库，提供丰富的扩展方法、工具类、工具函数等，帮助开发者提高开发效率，让您的开发速度更快更流畅
- Host: GitHub
- URL: https://github.com/headless-knight/ultratool
- Owner: headless-knight
- License: mit
- Created: 2024-10-23T17:31:51.000Z (15 days ago)
- Default Branch: main
- Last Pushed: 2024-11-02T11:30:22.000Z (5 days ago)
- Last Synced: 2024-11-02T11:45:52.050Z (5 days ago)
- Topics: collection, csharp, datetime, dotnet, exception, linq, pool, utility
- Language: C#
- Homepage: https://www.nuget.org/packages/UltraTool
- Size: 121 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UltraTool
一款致力于简单易用、减少重复代码的工具库，提供丰富的扩展方法、工具类、工具函数等，帮助开发者提高开发效率，让您的开发速度更快更流畅。
## 安装使用
```shell
dotnet add package UltraTool
```
接下来，您就可以在代码中使用UltraTool的所有功能了。
## 功能介绍
此工具库目前仍在持续开发中，功能与文档正在持续补全更新中。
* [池化数组](#池化数组)
* [异常构建器](#异常构建器)
* [集合](#集合)
* [非标准库类型](#非标准库类型)
* [列表拓展](#列表拓展)
* [字典拓展](#字典拓展)
* [随机](#随机)
* [任务](#任务)
### 池化数组
池化数组为工具库提供的一个基于数组池封装的数组类型，利用数组池，可以减少内存的申请和释放，从而提高性能。
以下是基本使用方法：
```csharp
// 创建一个容量为100的池化数组
var array = PooledArray.Get(100);
// 之后操作与数组基本相同
// 赋值
array[0] = 1;
// 获取索引0的值
var value = array[0];
// 为了让数组正确归还到池中，需要您在恰当的时机调用Dispose方法归还数组到池中
array.Dispose();
// 您可以显式调用Dispose方法，也可以使用using语句块，以释放资源
// 您也可以自己创建数组池作为池使用，并且可以指定归还数组时是否清空数组内容
// 创建数组池
var pool = ArrayPool.Create();
// 通过自定义的池创建一个容量为100的池化数组，并且在归还时清空数组内容
var array2 = PooledArray.Get(100, pool, true);
```
### 异常构建器
异常构建器是工具库提供的一个快速构建异常的辅助类，调用Dispose方法时，若有异常信息则会自动抛出异常，可以用于一些需要进行规则检查并抛出异常的场景。
```csharp
// 如下场景，如果TestMethod执行过程中AddError被调用了
// 则在退出方法时会抛出异常并附带错误信息
public void TestMethod(int x)
{
// 创建一个异常构建器
using var builder = ExceptionBuilder.CreateDefault("测试异常构建");
if (x < 0)
{
builder.AddError("x不能小于0");
}
if (x % 2 != 0)
{
builder.AddError("x不能为奇数");
}
if (x == 2)
{
builder.AddError("x不能为2");
}
}
```
### 集合
### 非标准库类型
此库提供了部分标准库未提供的集合类型：
1. ConcurrentHashSet
线程安全的HashSet，内部使用HashSet实现，通过读写锁ReaderWriterLockSlim对HashSet进行读写保护。
2. ConcurrentList
线程安全的List，内部使用List实现，通过读写锁ReaderWriterLockSlim对HashSet进行读写保护。
3. Deque
Deque是一个双端队列，内部使用环形数组实现，支持在队列头和队列尾添加和删除元素。操作示例如下：
```csharp
var deque = new Deque();
// 在队列头添加元素
deque.EnqueueFirst(1);
// 在队列尾添加元素
deque.EnqueueLast(2);
// 获取队列头元素
var first = deque.PeekFirst();
// 获取队列尾元素
var last = deque.PeekLast();
// 移除队列头元素
deque.DequeueFirst();
// 移除队列尾元素
deque.DequeueLast();
```
4. SingleLinkedList
SingleLinkedList是一个单链表，支持在链表头、链表尾以及指定节点后添加和删除元素。操作示例如下：
```csharp
var list = new SingleLinkedList();
// 添加元素为头节点
list.AddFirst(1);
// 添加元素为尾节点
list.AddLast(2);
// 在指定节点后添加元素
list.AddAfter(list.First, 3);
// 移除指定节点后的节点
list.RemoveAfter(list.First);
```
### 列表拓展
以下为此库提供的部分列表类型的拓展方法：
1. 判断索引是否合法
```csharp
var list = new List { 1, 2, 3, 4, 5 };
// 返回true
list.IsValidIndex(2);
// 返回false
list.IsValidIndex(5);
// 判断是否为非法索引，返回true
list.IsInvalidIndex(-1);
```
2. 获取指定索引位置的元素
```csharp
var list = new List { 1, 2, 3, 4, 5 };
// 获取索引2的元素，返回true，value为3
list.TryGetValue(2, out var value);
// 获取索引5的元素，返回false，value为default(int)
list.TryGetValue(5, out var value);
// 获取指定索引的元素，获取不到则返回默认值
// 索引5没有元素，因此返回100
list.GetValueOrDefault(5, 100);
```
3. 批量添加元素
```csharp
IList list = new List();
list.AddRange(new[] { 1, 2, 3 });
```
4. 删除元素
```csharp
var list = new List { 1, 2, 3, 4, 5 };
// 删除列表第一个元素
list.RemoveFirst();
// 删除列表最后一个元素
list.RemoveLast();
// 尝试删除列表中第一个匹配的元素，匹配不到返回false
list.TryRemoveFirst(x => x == 3, out var removedFirst);
// 尝试删除列表中从后往前匹配的第一个元素，匹配不到返回false
list.TryRemoveLast(x => x == 5, out var removedLast);
```
5. 交换元素位置
```csharp
var list = new List { 1, 2, 3, 4, 5 };
// 交换索引1和索引3的位置
list.Swap(1, 3);
```
6. 打乱列表顺序
```csharp
var list = new List { 1, 2, 3, 4, 5 };
// 打乱顺序
list.Shuffle();
```
7. 查找索引
```csharp
IList list = new List() { 1, 1, 3, 3, 5 };
// 查找列表中第一个匹配的元素，匹配不到返回-1
var index = list.IndexOf(3);
// 查找列表中从后往前匹配的第一个元素，匹配不到返回-1
var index2 = list.LastIndexOf(5);
// 查找列表中所有匹配的元素索引
var indexes = list.IndexesOf();
// 按条件查找列表中第一个匹配的元素，匹配不到返回-1
var index3 = list.FindIndex(x => x == 3);
// 按条件查找列表中从后往前匹配的第一个元素，匹配不到返回-1
var index4 = list.FindLastIndex(x => x == 5);
// 按条件查找列表中所有匹配的元素索引
var indexes2 = list.FindIndexes(x => x == 3);
```
8. 查找元素
```csharp
IList list = new List() { 1, 1, 3, 3, 5 };
// 尝试查找列表中第一个匹配的元素，匹配不到返回false
list.TryFindFirst(x => x == 3, out var found);
// 尝试查找列表中从后往前匹配的第一个元素，匹配不到返回false
list.TryFindLast(x => x == 5, out var found2);
```
9. 排序
```csharp
var list = new List { 5, 3, 1, 4, 2 };
// 插入排序
list.InsertionSort();
// 快速排序
list.QuickSort();
// 归并排序
list.MergeSort();
```
### 字典拓展
以下为此库提供的部分字典类型的拓展方法：
1. 获取或添加
```csharp
var dict = new Dictionary();
// 获取或添加，如果key不存在，则添加键值对
dict.GetOrAdd(1, "one");
// 也可以指定委托生成值，入参为key
dict.GetOrAdd(2, args => $"{args}");
```
2. 获取或创建
```csharp
var dict = new Dictionary>();
// 获取或创建，如果key不存在，则创建一个值并添加键值对，字典的Value类型必须提供无参构造函数
dict.GetOrCreate(1);
```
3. 交换键值
```csharp
var dict = new Dictionary() { { 1, "one" }, { 2, "two" } };
// 交换键值，将1和2的值互换
dict.Swap(1, 2);
```
4. 打乱键值
```csharp
var dict = new Dictionary() { { 1, "one" }, { 2, "two" } };
// 打乱所有的键值对映射
dict.Shuffle();
```
### 随机
以下为此库提供的部分随机拓展方法：
1. 获取随机元素
```csharp
var random = new Random();
var list = new List { 1, 2, 3, 4, 5 };
// 获取列表中一个随机元素
var value = random.NextItem(list);
```
2. 获取多个随机元素
```csharp
var random = new Random();
var list = new List { 1, 2, 3, 4, 5 };
// 放回抽取多个随机元素，即可能重复抽取同一个元素，此处为获取3个
var values = random.NextItemsSelection(list, 3);
// 不放回抽取多个随机元素，每次只能抽取一个元素，此处为获取3个
var values2 = random.NextItemsSample(list, 3);
```
3. 带权重抽取
```csharp
var random = new Random();
// 键为元素，值为权重
var itemWeight = new Dictionary() { { 1, 10 }, { 2, 5 }, { 3, 2 } };
var item = random.NextWeighted(itemWeight);
```
4. 带权重抽取多个
```csharp
var random = new Random();
// 键为元素，值为权重
var itemWeight = new Dictionary() { { 1, 10 }, { 2, 5 }, { 3, 2 } };
// 放回抽取多个元素，即可能重复抽取同一个元素，此处为获取3个
var items = random.NextWeightedSelection(itemWeight, 3);
// 不放回抽取多个元素，每次只能抽取一个元素，此处为获取3个
var items2 = random.NextWeightedSample(itemWeight, 3);
```
### 任务
此库提供了部分对Task和ValueTask的拓展方法，以简化使用。
1. 获取任务结果
```csharp
Task task = Task.FromResult(1);
var result = task.GetResult();
ValueTask valueTask = new ValueTask(1);
var result2 = valueTask.GetResult();
```
2. 忽略任务结果异常
```csharp
Task task = Task.FromException(new Exception());
// 忽略任务的结果和异常
task.IgnoreResult();
// 只忽略异常，此方法仍然返回Task
await task.IgnoreException();
// 上述任务抛出异常时都会被忽略，避免线程崩溃。
// 如果需要打印异常信息，可以订阅异常事件，TaskHelper.IgnoreExceptionCaught
TaskHelper.IgnoreExceptionCaught += (exception) => Console.WriteLine(exception.Message);
```
3. 等待多个任务完成
```csharp
Task task1 = Task.FromResult(1);
Task task2 = Task.FromResult(2);
// 等待两个任务并获取结果
var (result1, result2) = await TaskHelper.AwaitAll(task1, task2);
```