c# - 如何在 .NET Core 2.1 中使用 String.Create 的示例

Question

有谁知道这个方法是如何使用的？文档有点“轻”!

public static string Create<TState> (int length, TState state, System.Buffers.SpanAction<char,TState> action);

https://learn.microsoft.com/en-us/dotnet/api/system.string.create?view=netcore-2.2

Answer 1

String.Create() method需要三样东西:

1. 决赛length的字符串。您必须事先知道这一点，因为该方法需要它安全为 Span<char> 创建一个内部固定长度缓冲区。用于构造最终字符串的实例。
2. 将成为您的字符串的数据 ( state )。例如，您可能有一个数组缓冲区(例如，通过网络接收的 ascii 整数)，但它可以是任何。这是将被转换成最终字符串的原始数据。 this MSDN article 中有一个例子甚至使用 Random实例。我还看到了一个不完整的示例，用于创建位图图像(可变大小 state 输入)的 base-64 编码哈希值(固定长度)，但遗憾的是我找不到它了。
3. action转换 state 的 lambda 函数进入最终字符串的字符。 Create()方法将调用此函数，传递内部 Span<char>它为字符串和您的 state 创建数据作为参数。

举个很简单的例子，我们可以Create()来自这样的字符数组的字符串:

char[] buffer = {'f', 'o', 'o'};
string result = string.Create(buffer.Length, buffer, (chars, buf) => {
    for (int i=0;i<chars.Length;i++) chars[i] = buf[i];
});

当然是最基本的string(char[]) constructor 也可以在这里工作，但这显示了正确的函数可能是什么样子。或者我们可以映射一个 ascii 数组 int像这样的新字符串的值:

int[] buffer = {102, 111, 111};
string result = string.Create(buffer.Length, buffer, (chars, buf) => {
    for (int i=0;i<chars.Length;i++) chars[i] = (char)buf[i];
});

该函数之所以存在，是因为与传统方法相比，该技术具有一些显着的潜在性能优势。例如，您可以将 Stream 对象直接传递给 String.Create()，而不是将 Stream 读入缓冲区。 (假设您知道最终长度)。这避免了需要分配一个单独的缓冲区，并避免了一轮复制值(stream=>buffer=>string 变成了 stream=>string)。

---

当您调用 string.Create() 时会发生什么是该函数分配一个新字符串，该字符串的大小已经由您的 length 确定争论。这是一个(也是唯一一个)堆分配。因为Create()是字符串类型的成员，它可以访问您和我通常看不到的这个新对象的私有(private)字符串数据。它现在使用此访问权限创建一个内部 Span<char>实例指向新字符串的内部字符数据。

这Span<char>位于堆栈上，但作用于新字符串的堆内存...没有额外的分配，并且一旦 Create() 就完全超出范围函数返回，所以一切都是合法和安全的。因为它基本上是一个有好处的指针，所以几乎没有溢出堆栈的风险，除非你做了其他可怕的错误。

现在Create()调用你的 action函数来完成填充字符串的繁重工作。你的action lambda 可以写入 Span<char> ...在执行 lamdba 期间，字符串并不像您听说的那样不可变!

当 action lamdba 完成，Create()可以返回新的、随时可用的字符串引用。一切都很好:我们最小化了堆分配，保留了类型安全和内存安全； Span<char>无法在任何地方访问，并且堆栈值已经被销毁。我们还根据您的 action 最大限度地减少了缓冲区之间不必要的复制。实现。