.net 中的 StringBuilder 和 TextWriter 区别介绍

最近闲来之余，看了一些开源的类库，看到有些类库喜欢用 TextWriter 类来记录相关的字符串数据，感到比较好奇，为啥不用 StringBuilder 类对象。于是在网上搜索了一番，总结了相关笔记。

StringBuilder 类

在 .net 中,字符串作为一种基本的数据类型，通常在一个程序中同一个字符串只维护一个副本。也就是说，通过直接给定字符串值的字符串引用会引用到相同数据上。这种处理的好处在于它能够减少字符串所占用的内存空间，不需要为多个同样的字符串开辟多次空间。在C#中 string 类型是一个不变量，给字符串引用赋予新值并不会改变对应内存中的数据，而是设置引用为新字符串位置。

在平时，这种处理逻辑能够大大减少字符串所占用的内存空间，但有的时候，也会起一些反效果，典型的例子就是在一些构造字符串的操作时所生成的中间字符串数据。举个例子：

string[] words = {"Nice ", "to ", "meet ", "you."};
string sentence = "";
for(i = 0;i < words.Length; i++)
{
  sentence += words[i];
}

这是一个很简单的字符串组装功能，它将给定的单词拼接成一个句子，我们希望的是直接拼接成最后的结果，但这段代码除了生成最终句子外，先前的临时也会生成出来。也就是说，"Nice "、"Nice to "、"Nice to meet "以及最后字符串"Nice to meet you."会随着一次次循环迭代全部构造出来。但实际上，对于我们来说只需要最后句子即可，中间部分完全不需要。为此，我们需要新的方式来避免无意义的开销。

StringBuilder 类就是一种动态灵活地构造字符串的方法。这种构造字符串的好处在于，它能够避免构造中间字符串结果，转而直接生成最终的字符串数据。按照上面的例子，稍作修改就能得到一个性能更加优异的版本，在该版本下只有最后的句子字符串才会被生成。

string[] words = {"Nice ", "to ", "meet ", "you."};
StringBuilder sentenceBuilder = new StringBuilder();
for(i = 0;i < words.Length; i++)
{
  sentenceBuilder.Append(words[i]);
}
string setence = sentenceBuilder.ToString();

至于 StringBuilder 类的原理，我个人猜测是该类中维护一个char型列表，然后动态地修改数组元素，达到每次拼接时不会生成字符串的目的，只有当显式调用命令生成时，才会生成。不过，因为能力有限，我还不知道怎么在runtime这个开源库中找 StringBuilder 的实现。

TextWriter 类

TextWriter 是一个抽象类，按照微软官方给出的描述，该类指的是可以编写一个有序字符系列的编写器。嗯，字都认识，但是这句话感觉就不像是人说的。实际上，我个人对这个类的理解是它是一个写入器。换句话来说， TextWriter 描述了一个写入的过程，但具体写什么？向哪里写入？这不是这个抽象类所关心的话题，而是由其子类所负责。

.net中常用内置的一些子类：

• StreamWriter ：这个类相信很多人都熟悉，当需要向文件中写入数据时，往往通过该类写入数据
• StringWriter ：今天本文所需要研究的对象，向字符串写入
• HttpWriter ： 向网络流中写入数据

StringWriter 类作为 TextWriter 的一个继承类，按照MSDN给出的解释是，用于将信息写入字符串的 TextWriter 类对象，这个类看起来和 StringBuilder 类所做的功能差不多，那么为什么在 .net 中设计两个不同类做同一个功能呢？翻了下相关资料，只能说这两个类是不同设计思路下的产物。 StringBuilder 是一种灵活构建字符串的类，它不会产生额外的临时字符串，而 StringWriter 则将字符串数据作为一种写入的目的地，从这个角度来看，确实也是一种必要的实现。

比如说，有一个函数，它专门是将字符串数据记录下来，具体点，可以想像为日志记录器将日志信息记录到某个地方。这样的情况下，我们提供两个输入参数， TextWriter 类对象表明是一个写入器， message 描述一个日志信息，那么记录数据只需要这样写就可以了：

public void WriteData(TextWriter writer, string message)
{
  writer.Write(message);
}

这样一来，如果将信息记录到某个文件中，只要这样写：

using var file = new FileStream("./log.txt", FileAccess.Write);
using var writer = new StreamWriter(file);
WriteData(writer, "hello");

如果想将信息记录到某个变量中，就是这样：

var writer = new StringBuilder();
WriteData(writer, "hello");
data = writer.ToString();

总结

总的来说，如果只是单纯使用字符串而不涉及到修改字符串值时，直接使用string类型即可。如果需求是更加专注构造某种字符串数据，那么使用 StringBuilder 是一个比较好的选择。如果需求强调的是将某种格式的字符串数据写入到某个介质中，使用 TextWriter 对应的继承类会更好，更符合封装的思想，且不需要过多关注数据是怎么写入的，只要将需要写入的数据传入到其中即可。