Rails 动态生成数据库视图对应REST API路由与控制器方案咨询

完全可以通过元编程实现动态注册路由、生成对应模型和控制器逻辑，无需每次新增视图手动修改代码，具体实现步骤如下：

1. 动态获取外部数据库视图列表 #

首先可以在Rails初始化阶段查询外部Postgres的视图元数据，过滤出需要对外暴露的视图（比如前缀为View_的业务视图），代码可以放在初始化文件中：

# config/initializers/dynamic_view_config.rb
# 初始化时先判断数据库连接正常，避免启动报错
DYNAMIC_VIEW_LIST = if ExternalRecord.connection.active?
  # 查询所有View_开头的视图，转换为下划线格式的接口名
  ExternalRecord.connection.execute(<<~SQL).to_a.pluck('table_name')
    SELECT table_name 
    FROM information_schema.views 
    WHERE table_schema = 'public' AND table_name LIKE 'View\_%'
  SQL
else
  []
end.map do |view_table_name|
  # 把View_Leases转换为leases，作为接口路径和标识
  {
    table_name: view_table_name,
    api_name: view_table_name.delete_prefix('View_').underscore.pluralize
  }
end.freeze

2. 动态生成ActiveRecord模型 #

不需要手动为每个视图创建模型类，通过元编程批量生成：

# 接上面的初始化文件代码
DYNAMIC_VIEW_LIST.each do |view_config|
  # 生成驼峰式类名，比如leases对应Api::Lease
  model_class_name = view_config[:api_name].singularize.camelize
  # 跳过已存在的模型，兼容自定义逻辑的老视图
  next if Api.const_defined?(model_class_name)

  # 动态创建模型类，继承ExternalRecord，自动绑定表名
  model_class = Class.new(ExternalRecord) do
    self.table_name = view_config[:table_name]
  end
  Api.const_set(model_class_name, model_class)
end

3. 实现通用控制器，复用查询逻辑 #

不需要为每个视图单独创建控制器，实现一个通用控制器处理所有视图的查询请求：

# app/controllers/api/v1/generic_views_controller.rb
class Api::V1::GenericViewsController < Api::V1::ApplicationController
  # 全局参数校验，所有视图接口都需要鉴权参数
  param :authentication_token, String, "Token for authentication", required: true
  param :q, Hash, "Ransack查询条件", required: false
  param :page, Integer, "分页页码", required: false
  param :per_page, Integer, "每页条数，最大10000", required: false

  def index
    # 从路由参数获取当前请求的视图标识，找到对应的模型类
    view_api_name = params[:view_name]
    model_class = "Api::#{view_api_name.singularize.camelize}".constantize

    # 执行查询、分页，逻辑和原有控制器一致
    result = model_class.ransack(params[:q]).result.page(params[:page]).per([params[:per_page]&.to_i || 1000, 10000].min)
    render json: result.to_json
  end
end

4. 动态注册路由 #

直接在路由文件中遍历视图列表批量注册接口，不需要手动维护数组：

# config/routes.rb
Rails.application.routes.draw do
  namespace :api do
    namespace :v1 do
      # 原有自定义路由放在前面，优先级高于动态路由
      # resources :your_custom_routes

      # 动态注册所有视图的接口
      DYNAMIC_VIEW_LIST.each do |view_config|
        get view_config[:api_name], to: 'generic_views#index', defaults: { view_name: view_config[:api_name] }
      end
    end
  end
end

注意事项 #

• 安全过滤：可以在查询视图列表时增加白名单过滤，避免敏感视图被意外暴露，也可以设置权限控制不同角色可访问的视图范围
• 缓存优化：可以将视图列表做缓存处理，不用每次Rails启动都查数据库，新增视图后调用缓存刷新接口即可生效，无需重启服务
• 兼容扩展：如果某个视图需要自定义查询逻辑，只要手动创建对应模型和控制器，原有路由优先级高于动态路由，不会影响现有业务
• 性能控制：通用控制器中限制了单页最大条数，避免恶意请求拉取全量数据导致服务压力过大

内容的提问来源于stack exchange，提问作者opensource-developer