javascript - Google Closure Compiler 如何处理引号(字符串文字)？

Question

问题“Google Closure Compiler 如何处理引号(字符串文字)？”也可以改写为:

• 为什么 Closure 用双引号替换/交换单引号？
• Closure 如何决定使用何种引用格式/样式？
• (如何)我可以更改此(默认)行为？

注意 1:这个问题不是关于为什么 Closure(或其他一些压缩器)选择更喜欢双引号(如 here 和 here 所问)。

注意 2:这个问题不是关于单引号和双引号的讨论，但是了解 GCC 对我们的代码做了什么(以及为什么)是相当有用的!

Answer 1

经常说(或问为什么)Google Closure Compiler (GCC) 用双引号替换单引号(即使 compilation_level 设置为 WHITESPACE_ONLY !!!):

示例 xmp_1.js:

alert('Hello world!');           // output: alert("Hello world!");

然而……这只是“真相”的一半，因为:

示例 xmp_2.js:

alert('Hello "world"!');         // output: alert('Hello "world"!');
                                 //  *NOT*: alert("Hello \"world\"!");

GCC 本质上是一个“您的原始 javascript” 到“更小(更高效)的 javascript” 的翻译器:因此它不会“盲目地”用双引号替换单引号引号，但尝试选择“最佳引号字符”(毕竟.. 主要目标之一是“缩小”脚本)。

来自源代码 ( CompilerOptions.java ) 和 this issue-report人们可以了解到:

If the string contains more single quotes than double quotes then the compiler will wrap the string using double quotes and vice versa.
If the string contains no quotes or an equal number of single and double quotes, then the compiler will default to using double quotes.

像这个例子 xmp_3.js:

alert('Hello "w\'orld"!');       // output: alert('Hello "w\'orld"!');
alert('Hello "w\'o\'rld"!');     //         alert("Hello \"w'o'rld\"!");

请注意上面的 xmp_3 如何导致使用 ' 和 " 作为外引号的“混合”输出:最佳选择后跟默认值(当它没有没关系)。

如何将默认双引号更改/覆盖为单引号？

事实证明，在一些严肃的合法现实世界案例中，默认使用单引号会更好。如 issue 836 中所述(自 2012 年 10 月 8 日起)以上引用:

The FT web app (app.ft.com) and the Economist app for Playbook deliver JavaScript updates to the client along with other resources by transmitting them as part of a JSON-encoded object. JSON uses double quotes natively, so all the double quotes in the compiled JavaScript need to be escaped. This inflates the size of the FT web app's JS by about 20kB when transmitting a large update.

该问题的记者带来了一份礼物:一个补丁，添加了选项 prefer_single_quotes 以将默认引号字符从双引号更改为单引号。

这个问题得到了足够的重视，以至于项目成员 Santos 考虑将默认的双引号更改为单引号(“看看是否有人提示”)。两次(也在记者/补丁贡献者表示他将其作为一个选项实现后，它不会产生任何向后兼容性后果，因为“有人可能出于某些奇怪的原因依赖用双引号输出的字符串”)。

然而，大约一周后补丁被接受 (r2258)，又一周后重新设计 (r2257) 并且在 2012 年 10 月 30 日，Santos 报告说现在可以通过以下方式启用该选项:
--formatting=SINGLE_QUOTES
(所以除了 PRETTY_PRINT 和 PRINT_INPUT_DELIMITER 之外的第三个选项用于 formatting-key)。
(注意:在当前的源代码中，目前仍然可以找到对“prefer_single_quotes”的大量引用。)

用法:
如果您(下载并)使用(本地 java)应用程序:

java -jar compiler.jar --js xmp_1.js --formatting SINGLE_QUOTES你会看到:alert('Hello world!'); 现在编译为 alert('Hello world!');

但是，在撰写本文时，位于 http://closure-compiler.appspot.com 的编译器服务 API 和 UI(最有可能使用该 API) , 不要不接受这第三个(新的，虽然已经存在一年)格式化选项:SINGLE_QUOTES 并且会抛出一个错误:
17:未知的格式选项 single_quotes。

(再次)挖掘源代码后，似乎(我不是 Java 专家)这是因为 jscomp/webservice/common/Protocol.java只接受旧的 PRETTY_PRINT 和 PRINT_INPUT_DELIMITER

 * All the possible values for the FORMATTING key.
 */
public static enum FormattingKey implements ProtocolEnum {
  PRETTY_PRINT("pretty_print"),
  PRINT_INPUT_DELIMITER("print_input_delimiter"),
  ;

如果此选项在 API 和/或 UI 中可用，我将更新此答案。

希望这可以帮助并节省一些时间，因为谷歌可以找到关于 SINGLE_QUOTES 的唯一文档和引用目前在这一期 836 和源代码中的一些评论中。现在它对 SO 有一些解释(我期望它)。