Rails引擎主题扩展：数据访问、配置及宿主应用识别问题

• 直接调用引擎命名空间模型：主题视图处于引擎的视图上下文，可直接使用 MyEngine::Post.all 这类命名空间模型查询数据。
• 复用控制器实例变量：在引擎控制器中预先查询数据并赋值（如 @posts = MyEngine::Post.recent），主题视图可直接引用这些变量渲染内容。
• 借助引擎Helper方法：在引擎中封装数据获取逻辑为Helper（例如 MyEngine::ThemeHelper#fetch_featured_articles），主题视图通过调用Helper获取格式化后的数据。

主题识别逻辑 #

首先统一主题目录结构规范，要求每个主题必须包含：

• views/：存放主题视图文件
• 可选 assets/：主题专属CSS/JS/图片资源
• 可选 theme.yml：主题元数据（名称、描述、作者等）

接着在引擎中实现主题扫描逻辑，同时覆盖引擎内置主题和宿主自定义主题：

# 引擎lib/my_engine/theme.rb文件
module MyEngine
  class Theme
    def self.available_themes
      # 扫描引擎内置主题
      engine_themes = Dir.glob(MyEngine::Engine.root.join("app/apps/themes/*")).map { |path| File.basename(path) }
      # 扫描宿主应用自定义主题（宿主可在app/themes下新增主题）
      host_themes = Dir.glob(Rails.root.join("app/themes/*")).map { |path| File.basename(path) }
      (engine_themes + host_themes).uniq
    end

    def self.valid_theme?(theme_name)
      available_themes.include?(theme_name)
    end
  end
end

主题配置与启用 #

1. 扩展视图路径：同时加载宿主和引擎的主题视图路径，确保自定义主题优先级高于内置主题：

# 引擎控制器基类中添加
before_action :set_theme_view_paths

def set_theme_view_paths
  current_theme = session[:current_theme] || MyEngine.config.default_theme
  # 校验主题合法性，避免无效路径报错
  if MyEngine::Theme.valid_theme?(current_theme)
    prepend_view_path Rails.root.join("app/themes/#{current_theme}/views")
    prepend_view_path MyEngine::Engine.root.join("app/apps/themes/#{current_theme}/views")
  else
    # 非法主题回退到默认主题
    prepend_view_path MyEngine::Engine.root.join("app/apps/themes/#{MyEngine.config.default_theme}/views")
  end
end

2. 提供引擎配置项：允许宿主在初始化文件中设置默认主题：

# 引擎lib/my_engine/engine.rb文件
module MyEngine
  class Engine < ::Rails::Engine
    config.default_theme = "default"
  end
end

# 宿主应用config/initializers/my_engine.rb文件
MyEngine.configure do |config|
  config.default_theme = "host_custom_default"
end

3. 主题切换接口：在引擎中实现主题切换的控制器动作，处理会话存储：

# 引擎controllers/my_engine/theme_controller.rb文件
module MyEngine
  class ThemeController < ApplicationController
    def switch
      theme_name = params[:theme]
      session[:current_theme] = theme_name if MyEngine::Theme.valid_theme?(theme_name)
      redirect_back fallback_location: root_path
    end
  end
end

4. 宿主应用识别主题：宿主可通过 MyEngine::Theme.available_themes 获取所有可用主题，用于渲染主题选择器；还可读取主题的theme.yml元数据展示更友好的信息：

# 在MyEngine::Theme类中添加元数据读取方法
def self.theme_metadata(theme_name)
  metadata_path = Rails.root.join("app/themes/#{theme_name}/theme.yml")
  metadata_path = MyEngine::Engine.root.join("app/apps/themes/#{theme_name}/theme.yml") unless File.exist?(metadata_path)
  YAML.load_file(metadata_path) if File.exist?(metadata_path)
end

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