在 Rails 项目中解决 js-routes 与 Sprockets 的兼容性问题

问题背景

在 Rails 项目中，当从 js-routes 1.4.9 升级到 2.3.5 版本时，如果仍在使用 Sprockets 和 Webpacker 这样的传统资源管道，可能会遇到浏览器控制台报错"Uncaught SyntaxError: Unexpected token 'export'"的问题。这是由于新版 js-routes 默认生成了 ESM 模块导出语句，而传统资源管道并不支持这种现代 JavaScript 模块语法。

根本原因分析

这个问题的核心在于配置未正确加载。在开发环境中使用 webpack-dev-server 时，Rails 初始化程序没有被加载，导致 js-routes 使用了默认配置（生成 ESM 模块代码），而不是预期的全局变量方式。

解决方案详解

1. 正确配置 js-routes

首先，我们需要在 Rails 初始化程序中正确配置 js-routes：

# config/initializers/js_routes.rb

JsRoutes.setup do |config|
  config.module_type = nil  # 禁用模块导出
  config.namespace = "Routes"  # 使用全局变量
  config.file = "../../app/assets/javascripts/mampf_routes.js"  # 指定输出文件
end

关键配置说明：

• module_type: nil 表示不生成任何模块导出代码
• namespace: "Routes" 将路由挂载到全局变量 Routes 上
• file 指定生成的 JavaScript 文件路径

2. 确保开发环境正确生成路由文件

在开发环境中，webpack-dev-server 不会自动加载 Rails 环境，因此需要手动触发路由生成：

# bin/webpack-dev-server (在 require "webpacker" 之前添加)

puts "启动 webpack-dev-server 前重新编译 js-routes"
require 'rake'
require_relative '../config/application'
Rails.application.load_tasks
Rake::Task["js:routes"].invoke

3. 确保生产环境预编译正常工作

在 Rakefile 中添加任务依赖，确保生产环境预编译时也会生成路由文件：

# Rakefile 末尾添加

task "assets:precompile" => "js:routes"

4. 引入生成的路由文件

在 application.js 中引入生成的路由文件：

//= require mampf_routes

5. 忽略生成的文件

将生成的路由文件添加到 .gitignore 中：

# .gitignore
app/assets/javascripts/mampf_routes.js

替代方案：使用 Webpacker ERB Loader

如果希望保持动态生成路由的方式，可以使用 Webpacker ERB Loader。需要注意的是，官方文档中的配置可能需要调整：

// config/webpack/loaders/erb.js

module.exports = {
  rules: [
    {
      test: /\.erb$/,
      enforce: "pre",
      loader: "rails-erb-loader",
    },
  ],
};

最佳实践建议

1. 环境一致性：确保开发、测试和生产环境使用相同的 js-routes 生成方式
2. 缓存处理：在修改配置后，记得清除缓存（rake tmp:cache:clear）
3. 升级路径：考虑逐步迁移到现代前端构建工具（如 Vite 或 esbuild）
4. 性能考量：对于大型项目，路由文件可能会很大，可以考虑按需加载

通过以上配置，可以在保持传统资源管道的同时，顺利使用新版本的 js-routes 功能，为后续前端架构升级奠定基础。