C# 11 的这个新特性,我愿称之最强!


前言

在日常开发中我们经常会将JSON、XML、HTML、SQL、Regex等字符串拷贝粘贴到我们的代码中,而这些字符串往往包含很多的引号",我们就必须将所有引号逐个添加转义符进行转义。这个转义十分麻烦,且容易出错,而当我们们需要替换这些字符串时,重新粘贴进来的文本仍需要再次进行转义,简直让人崩溃。

在我的工作中经常会遇到这么一个场景,对于某核心业务的方法,业务执行前一般会进行日志输出参数对象(Json格式),这样可在业务出现故障时追溯到当时的参数值,有利于事后补偿或复现bug等。
假设故障发生了,我从日志中获取了这个参数值的内容如下

{     "kpzdbs": "YJ2",     "jqbh": "499098528334",     "fplxdm": "026",     "fpqqlsh": "ZJBX965525",     "kplx": 0,     "tspz": "00" } 

为复现该问题,在控制台或单元测试中,将该参数定义,并调用MyLogic方法,
C# 11 的这个新特性,我愿称之最强!

可以看到报错的字符串是我直接从日志中拷贝的json粘贴进去的,需要对所有的"进行转义,这是很蛋疼的一个问题,有时候可能需要将很多日志中的对象粘贴进来测试,每次粘贴完还要进行插入转义符号

C# 11 的这个新特性,我愿称之最强!
现在我们不需要这样做了。

新特性之原始字符串

原始字符串文本 是字符串文本的新格式。 原始字符串文本可以包含任意文本,包括空格、新行、嵌入引号和其他特殊字符,而无需转义序列。 原始字符串文本以至少三个双引号开头, (""") 个字符。 它以相同数量的双引号字符结尾。 通常,原始字符串文本在单个行上使用三个双引号来启动字符串,另一行的三个双引号结束字符串。 尾引号和尾引号前面的换行符不包括在最终内容中。详细内容参考这里

使用案例

我使用这一新特性修改上面场景中的代码如下,可以看到,json字符串不做任何转义直接粘贴进来即可。

C# 11 的这个新特性,我愿称之最强!

又比如我需要粘贴一段html,如果没有这新特性,转义那么多引号,你可能会疯吧!!
C# 11 的这个新特性,我愿称之最强!

原始字符串使用需要注意的地方

  • 以至少三个双引号 ( """...""") 开头和结尾,任何数量小于打开原始字符串文字的数量的双引号都被视为内容。
  • 尾引号和尾引号前面的换行符不包括在最终内容中。
  • 原始字符串文本通常在单个行上使用三个双引号来启动字符串,另一行的三个双引号结束字符串。
  • 可以和$(可有多个)内插字符串一起使用,前缀$的数量是指示嵌套代码表达式所需的花括号的数量。如果原始字符串文字以$$为前缀,则将单个大括号视为内容,并且需要两个大括号来指示嵌套代码。就像使用引号一样,您可以添加更多$以允许将更多大括号视为内容。

什么情况下需要超过三个双引号开头

当字符串的内容中包含至少三个"一起出现,你的连续出现"的个数加1(最少三个),就是原始字符串要开头和结尾使用"的个数,所以说不是固定三个"
注意:图中字符串前面的|并不是输入的字符,是编译器的对齐提示。
C# 11 的这个新特性,我愿称之最强!
输出
C# 11 的这个新特性,我愿称之最强!

尾引号和尾引号前面的换行符不包括在最终内容中

如下如,编译器自动以结尾""""前为界限显示出一条竖线,竖线左侧的空格不算作内容。
C# 11 的这个新特性,我愿称之最强!

结尾的三个引号不另起一行行不行

将结尾字符放到内容后面,编译器会提示你将其放到自己的行上
C# 11 的这个新特性,我愿称之最强!
这个可以理解为,在这种情况下可能会引起歧义,编译器不确定你的原始字符串是以下三种的哪一种。

你"""好"""啊 

或(前面有空格)

          你"""好"""啊 

或(换行+前面有空格)

           你"""好"""啊 

如果下面这样,则不会歧义,以箭头指向的竖线为界,左侧空格都不算做内容,右侧空格均算作内容

C# 11 的这个新特性,我愿称之最强!
如果是全在一行也行,因为不会产生歧义。

C# 11 的这个新特性,我愿称之最强!

和内插字符一起使用

这个比较难理解点,$符号的数量也是不固定的,根据你需要连续将多少个花括号作为原始字符
你想要输出的内容没有括号时,属于常规用法,没什么好说的。
C# 11 的这个新特性,我愿称之最强!
如果你想输出下文

    {张三}  

会遇到这个问题的提示
C# 11 的这个新特性,我愿称之最强!
简单理解就是,你需要将一个大括号视作内容,就需要两个$作为前缀,你需要将n个括号是做内容,就需要n + 1$做为前缀,同样内插字符串也需要消耗跟$同样数量的大括号。
因为你要将一个大括号视为内容,所以需要1 + 1 = 2$,同样,内插变量也需要跟$数量一致的括号包裹,所以修改后的代码如下。
C# 11 的这个新特性,我愿称之最强!

如果你想输出的内容是

    {{{{张三 

需要将四个括号视为内容,n = 4, $数量为 4 + 1 = 5,内插变量也需要5和括号包裹。

C# 11 的这个新特性,我愿称之最强!

总结

当我们将带有引号的文本粘贴至编译器中需要进行大量的转义操作,原始字符串特性能很好的解决这个问题,让我们可以愉快进行粘贴这些字符串,但当与内插字符串使用时,尤其是多个大括号场景还是比较难以理解的,好在编译器会提示怎么做,且那种场景都属于及其不常见。

发表评论

相关文章