Phoenix LiveView 中 HEEx 模板的 phx-no-curly-interpolation 特性解析

在 Phoenix LiveView 1.0.1 版本中，HEEx 模板引擎引入了一个新的特性：花括号自动插值。这个特性虽然方便，但在某些特殊场景下可能会带来问题，特别是当我们需要在模板中直接展示包含花括号的代码片段时。

问题背景

在开发 Web 应用时，我们经常需要在页面上展示一些代码示例，特别是 JavaScript 代码。这些代码中通常会包含大量的花括号，例如对象字面量、函数体等。在 LiveView 1.0.1 之前，这些花括号会被 HEEx 模板引擎原样输出，不会进行任何特殊处理。

然而，从 LiveView 1.0.1 开始，HEEx 引入了花括号自动插值功能，这意味着模板引擎会尝试解析花括号中的内容作为 Elixir 表达式。这一变化虽然提高了模板的灵活性，但也带来了新的挑战：当我们确实需要原样输出花括号时，就会遇到编译错误。

解决方案：phx-no-curly-interpolation

LiveView 提供了 phx-no-curly-interpolation 属性来解决这个问题。当我们在 HTML 元素上添加这个属性时，该元素及其子元素中的所有花括号都会被当作普通文本处理，不会被解析为 Elixir 表达式。

使用中的注意事项

虽然 phx-no-curly-interpolation 属性非常有用，但在使用时需要注意一个关键细节：如果在标记区域内使用了传统的 EEx 插值语法 <%= %>，那么该标记区域的花括号解析行为会被重置，后续的花括号又会被当作 Elixir 表达式处理。

这个行为可以通过以下示例来说明：

def render(assigns) do
  ~H"""
  <pre phx-no-curly-interpolation>
    // 这部分花括号会被原样输出: { }
    const obj = { key: "value" };
    
    // 使用 EEx 插值
    const domain = '<%= @domain %>';
    
    // 这部分花括号又会被解析为 Elixir 表达式，导致错误
    const { prop } = obj;
  </pre>
  """
end

推荐的解决方案

当我们需要在 phx-no-curly-interpolation 区域内同时使用 EEx 插值和保留花括号时，可以采用以下两种方法：

1. 分段处理：将需要插值的部分和包含花括号的部分分开处理

2. 显式转义花括号：对于必须出现在插值后的花括号，使用 <%= "{" %> 的形式进行转义

def render(assigns) do
  ~H"""
  <div class="code-sample">
    <pre phx-no-curly-interpolation>
      window.addEventListener('message', event => {
        if (event.origin !== '<%= @domain %>') return;

        const <%= "{" %>prop1, prop2} = event.data;
        console.log(prop1, prop2);
      });
    </pre>
  </div>
  """
end

最佳实践

1. 尽量将需要插值的部分放在代码块的开始或结束位置，减少中间插值的需要
2. 对于复杂的代码展示，考虑使用专门的代码高亮组件
3. 在必须混合使用插值和花括号时，确保对每个可能被误解的花括号进行显式转义
4. 对于大量需要展示的代码，可以考虑将其存储在单独的文本文件中，通过 File.read/1 读取后直接输出

总结

Phoenix LiveView 的 phx-no-curly-interpolation 特性为展示代码片段提供了便利，但开发者需要了解其与 EEx 插值语法交互时的特殊行为。通过合理的分段处理和必要的转义，我们可以轻松地在模板中同时使用动态内容和静态代码展示。理解这一机制有助于开发者更高效地构建包含代码示例的文档型页面或教程类应用。