Symfony 5：控制器内放置长字符串是否为最佳实践？

直接结论：控制器中直接嵌入长文本字符串绝非良好实践，尤其是你担心的多语言翻译场景，这种写法会给后续维护带来极大困扰。

为什么这种写法不好？ #

• 违反关注点分离原则：控制器的核心职责是处理业务逻辑和请求响应，文本展示（包括提示消息）属于视图层或国际化范畴，混写会让控制器代码臃肿，职责混乱。
• 多语言维护成本极高：如果后续要支持多语言，你需要逐个遍历所有控制器查找硬编码的字符串，不仅效率低，还容易遗漏或改错。
• 格式调整不便：示例中把HTML标签（<b>、<br>）直接写在PHP字符串里，后续要调整消息样式时，必须修改控制器代码，不符合MVC的职责划分。

Symfony中的最优解决方案：使用翻译组件 #

Symfony自带的翻译组件完美解决这个问题，步骤如下：

1. 创建翻译资源文件
   在项目根目录的translations文件夹下，为每种语言创建对应的翻译文件（支持yaml、json、php等格式），将消息按键值对存储，并支持占位符和HTML格式。

示例messages.en.yaml：

register.success_message: |
  Congratulations %user%! You are now a part of growing <b>Symf</b> community! <br>
  An activation link to <b>%email%</b> was <u>not</u> sent because mailing is not implemented. 
  &nbsp <small>(...yet)</small>

示例messages.zh.yaml：

register.success_message: |
  恭喜你，%user%！你现在已经加入不断壮大的<b>Symf</b>社区啦！<br>
  由于邮件功能尚未实现，激活链接并未发送到你的邮箱<b>%email%</b>。
  &nbsp <small>（敬请期待）</small>

2. 在控制器中调用翻译服务
   使用Symfony控制器自带的trans()方法，传入翻译键名和占位符参数，再传递给addFlash：

class RegisterController extends AbstractController
{
    public function index()
    {
        if ($form->isSubmitted() && $form->isValid()) {
            // ... 处理用户注册逻辑

            $this->addFlash(
                'info',
                $this->trans('register.success_message', [
                    '%user%' => $user->getUsername(), // 根据实际User类的方法调整
                    '%email%' => $user->getEmail()
                ])
            );
        }

        // ... 渲染视图等逻辑
    }
}

3. 模板中正确渲染带HTML的消息
   如果翻译文本包含HTML标签，在Twig模板渲染flash消息时，需要使用raw过滤器避免HTML被自动转义：

{% for message in app.flashes('info') %}
    <div class="alert alert-info">{{ message|raw }}</div>
{% endfor %}

额外建议 #

就算暂时不需要多语言支持，把所有文本抽离到翻译文件也是值得的：

• 可以统一管理网站所有提示文本，修改时无需改动业务逻辑代码；
• 便于后续快速扩展多语言，无需重构大量控制器代码；
• 让控制器代码更简洁，专注于核心逻辑。

内容的提问来源于stack exchange，提问作者Kacper