用 \" 在字符串中插入双引号时，出现语法错误：; expected but string constant found。

1
2
3
4

// good
s"color=$color"
// bad!!!
s"color=\"$color\""  // <- notice this weird syntax highlight

tl;dr

这不是 bug 而是 feature ！（至少是明确 won’t fix 的 bug）

冷知识

  • 形如 "..." 的字符串字面量（加上转义字符）可以表示所有的字符串
  • 形如 """...""" 的字符串不能表示 """
  • 使用插值器之后，形如 s"..." 的字符串和形如 s"""...""" 的字符串都无法表示所有的字符串

正确的插入方式：

1
2
3
4

val color = "#0000ff"
s"""color="$color""""
// or
s"color=${'"'}$color${'"'}"

以上2个表达式的值均为 color="#0000ff" 。

当然，还可以用 + 运算符拼接多个字符串（如 "color=\"" + color + "\"" ），这种解决方案不在本文的讨论范围内。

引号导致的其它问题

下面看一个来自 GitHub issue 的例子。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

scala> val a="42"
a: String = 42

scala> "a=\"$a\""
res33: String = a="$a"    // ok

scala> s"a=\"$a\""
<console>:1: error: ';' expected but string literal found.
       s"a=\"$a\""
                ^         // oops

scala> s"a=\'$a\'"
res34: String = a='42'    // ok with \'

scala> """a=\"$a\""""
res35: String = a=\"$a\"  // escape not interpreted, ok

scala> s"""a=\"$a\""""
res36: String = a="42"    // escape interpreted, should it ?

通过上面的若干用例，我们可以得出结论：

  1. 在不用插值器的时候，\" 可以正常被转换为双引号。
  2. 使用了 s 插值器之后，再使用 \" ，编译器就会报错。
  3. 单引号 \' 可以在插值器中使用。
  4. 在使用 """ 声明的字符串中，可以直接使用 " ， \" 会被识别为2个字符。

RTFM

在 SIP-11 中， id"string content" 这样的字符串被称为 processed string （准确地说， string content 可以是 standard - " 类型，也可以是 multi-line - """ 类型）。

按照上面手册中的定义，编译器在遇到

1
2
3

id"text_0${expr_1}text_1...${expr_n}text_n"
// or
id"""text_0${expr_1}text_1...${expr_n}text_n"""

时，会将其替换为

1

StringContext("""text_0""", ..., """text_n""").id(expr_1, ..., expr_n)

SIP-11 中提到：

Inside a processed literal none of the usual escape characters are interpreted (except for unicode escapes) no matter whether the string literal is normal (enclosed in single quotes) or multi-line (enclosed in triple quotes). Instead, there is are two new forms of dollar sign escape. The most general form encloses an expression in ${ and }, i.e. ${expr}.

大意是说， processed literal 中除 unicode 转义字符外，其余所有的转义字符都不会被替换。另外，这里的 ${ 和 } 可以视为新的转义字符。

SIP-11 在 Standard String Interpolation 一节还提到，字符串插值器 s 返回的字符串为

1
2

// scala.StringContext("""text_0""", ..., """text_n""").s(expr_1, ..., expr_n)
esc("""text_0""") + (expr_1) + esc("""text_1""") + ... + (expr_n) + esc("""text_n""")

此处的 esc(str) 代表将字符串 str 中的转义字符替换为对应的符号。

所以，如果 esc 在这里把 \" 替换为 " 的话，替换后的代码中可能出现语法错误，比如

1
2
3
4
5
6
7
8

val a = 10
s" \"\"\" $a" // expected to be string """10

// then
esc(""" \"\"\" """) + (10)
// and then
""" """ """ + 10
// something bad could happen

在手册的定义中， StringContext 接受的字符串不含转义字符，插值器需要自己进行转义字符替换的工作。这样定义的好处是，可以实现一个这样的正则表达式插值器：它不识别转义字符，从而书写正则表达式时不必考虑诸如 ' 需要写为 \' 的问题。同时，标准的插值器 s 和 f 等可以正常处理转义字符。

参考资料