少用 string.Format

Posted 2020-11-28 gangzhucoll

如果你使用的是 C# 6.0 及其以上版本的话我建议你使用新增的 内插字符串 这个功能。这个功能可以更好的帮助开发人员设置字符串格式。下面我们就来看一下为什么要少用 string.Format 而要多用内插字符串，以及内插字符串的优缺点。
String.Format 在 C# 6.0 以前我们会经常用到这个，优点在这里我就不一一阐述了，这里我们主要说一下它的缺点。

1. 开发人员必须对生成的字符串进行测试和验证，才能发现其中出现的问题；
2. 替换操作是根据格式字符串中序号来完成的，但是编译器并不会验证格式字符串待替换序号数量和参数的个数是否相等，因此在程序运行时就会报错，提示参数个数与待替换序号数量不匹配；

3. 参数顺序需要和待替换序号的顺序一致，但是开发人员不太容易看出参数顺序是否和待替换序号的顺序是否一致；
   上述三种问题在出现后虽然可以修复，但是会花费一定的时间来解决，因此在 C# 6.0 及其以上版本中我们可以使用内插字符串来替代 String
   tring 。内插字符串可以让我们写出易于阅读的代码，编译器也可以用它实现完备的静态类型检查机制，进而降低出错的机率，并且它还提供了丰富的语法是我们可以使用合适的方法来生成字符串。下面我们就来看一下内插字符串。

   零、内插字符串

4. 语法
   内插字符串的语法很简单，只需要在字符串前面加上 $ ，然后把表达式写在字符串中的 {} 之间即可。例如：

   Console.WriteLine($"喵叔教你写优秀的 {Language} 代码！");

5. 讲解
   这种形式的代码方便了开发人员阅读也很容易验证字符串是否符合预期，并且因为表达式都写在了字符串中，因此避免了参数数量和待替换部分数量不匹配的问题。字符串的内插机制是通过库代码来实现的，这与 String.Format 方法类似，在必要的时候该机制会把变量从其他类型转换为 string 类型，例如：

   Console.WriteLine($"我有 {number} 辆车");

   这里需要注意的是如果在内插字符串中出现了装箱操作并且代码运行的很频繁，那么就会产生严重的性能问题，这时我们就需要自己把参数转换为字符串，避免在字符串内插操作中进行装箱。我们将上面的代码段改一下，就可以避免字符串内插操作装箱的问题了。

   Console.WriteLine($"我有 {number.ToString()} 辆车");

   Tip：字符串内插操作所生成的代码会调用一个参数为 params 的对象数组的格式化方法。

   当我们需要对字符产进行进一步处理时，或者把表达式返回的对象格式化时，我们可以用到标准格式说明符，如果需要实现这个功能只需要要在表达式后面加上冒号，并把格式说明符写在冒号右侧。

   Console.WriteLine($"圆周率 {Math.PI:F2} ");

   讲到这里有部分读者一定会发现一个问题，如果在内插字符串中使用条件表达式的话该怎么使用呢？这个问题 C# 开发人员已经为我们想到了，当我们使用条件表达式时，C# 会把它理解成格式化说明。要解决这个问题我们只需要将整个表达式括起来即可，例如：

   Console.WriteLine($"我今年 {age} 岁，是 {(age>=18?"成年人":"未成年人")}");

   我们在开发过程中也会经常用到 null 合并运算符与 null 条件运算符来处理可能存在的缺失值，这两种运算符在内插字符串中同样适用：

   Console.WriteLine($"我的名字叫 ：{user?.Name??"名字丢失"}");

   内插字符串的强大之处还在于我们可以在其中使用 LINQ 查询来创建内容，并且 LINQ 查询操作本身也可以利用内插字符串来调整查询结果的格式：

   var message = $@"您当前注册的手机号有：{phones.Select(p=>$@"{p.ToString()}").Aggregate((c,a)=>$@"{c}{Environment.NewLine}{a}")}"

   这里有两点非常关键的内容需要注意，内插字符串本身会解析成普通的字符串，如果用它来创建 SQL 语句是不会生成参数化查询的因此这种方式产生的 SQL 并不安全。如果需要在内插字符串中使用流程控制语句的话，就必须把流程控制逻辑写在方法里，让后在内插字符串中调用这个方法。

   本文由博客一文多发平台 OpenWrite 发布！ 更多文章请扫码关注公众号：“喵叔呦”