如何为Rails 5在线学习应用添加SCORM包支持？

我之前帮朋友搞定过Rails集成SCORM的需求，给你梳理一套落地的步骤，跟着走就能搞定：

目前Rails生态里常用的有两个靠谱的Gem：

• scorm_ruby：轻量型，专注于SCORM包的解析和基础跟踪逻辑，适合快速集成
• scorm_engine：功能更全，支持SCORM 1.2/2004、xAPI等标准，适合复杂场景

以scorm_ruby为例，先在Gemfile里添加：

gem 'scorm_ruby'
gem 'rubyzip' # 用来解压SCORM zip包

然后执行bundle install完成安装。

首先得让用户能上传SCORM的zip包，推荐用Rails自带的Active Storage来处理文件上传：

1. 先配置Active Storage（执行rails active_storage:install然后迁移数据库）
2. 在你的课程模型（比如Lesson）里关联附件：

class Lesson < ApplicationRecord
  has_one_attached :scorm_package
  has_many :scorm_trackings, dependent: :destroy
end

3. 上传后需要解压zip包到可访问的目录，写个方法处理：

# 在Lesson模型里添加
def extract_scorm_content
  return unless scorm_package.attached?

  # 创建专属存储目录，避免冲突
  content_dir = Rails.root.join('public', 'scorm_content', id.to_s)
  FileUtils.mkdir_p(content_dir)

  # 解压zip包
  Zip::File.open(scorm_package.download) do |zip_file|
    zip_file.each do |entry|
      target_path = content_dir.join(entry.name)
      entry.extract(target_path) unless File.exist?(target_path)
    end
  end

  # 把解压后的路径存到数据库，方便后续调用
  update(scorm_content_path: content_dir.to_s)
end

可以用Sidekiq把这个解压操作放到后台执行，避免阻塞用户请求。

SCORM包的所有关键信息都在imsmanifest.xml里，用scorm_ruby可以轻松解析：

# 在Lesson模型的回调或者后台任务里执行
def parse_scorm_manifest
  return unless scorm_content_path.present?

  scorm_package = ScormRuby::Package.new(scorm_content_path)
  manifest = scorm_package.manifest

  # 提取课程标题、启动URL等核心信息存到数据库
  update(
    title: manifest.title,
    scorm_version: manifest.version,
    launch_url: manifest.resources.first.href
  )
end

这样你就能在页面里直接调用这些字段，比如展示课程标题、生成启动链接。

SCORM的跟踪逻辑是前端（SCORM内容）通过JS API和后端通信，需要做两部分：

1. 前端桥接SCORM API：在嵌入SCORM内容的页面里，引入SCORM API封装库，当用户的学习状态变化（比如完成模块、更新成绩），调用后端的接口提交数据。
2. 后端接收跟踪数据：创建一个ScormTrackingsController来处理：

class ScormTrackingsController < ApplicationController
  before_action :set_lesson

  def update
    @tracking = @lesson.scorm_trackings.find_or_initialize_by(user_id: current_user.id)
    @tracking.update!(tracking_params)
    render json: { status: :success }
  end

  private

  def set_lesson
    @lesson = Lesson.find(params[:lesson_id])
  end

  def tracking_params
    params.permit(:completion_status, :success_status, :score_raw, :last_accessed_at)
  end
end

然后在路由里添加：

resources :lessons do
  resources :scorm_trackings, only: [:update]
end

把解压后的SCORM内容通过iframe嵌入到页面里，注意路径要正确：

<!-- 在课程展示页面的erb里 -->
<div class="scorm-container">
  <iframe 
    src="<%= "/scorm_content/#{@lesson.id}/#{@lesson.launch_url}" %>" 
    width="100%" 
    height="700px"
    frameborder="0"
  ></iframe>
</div>

生产环境如果用云存储（比如S3），需要把解压后的内容上传到S3，然后生成公开访问的URL，替换上面的本地路径。

• SCORM版本兼容：SCORM 1.2和2004的API有差异，测试时要覆盖两种版本的包
• 清理临时文件：如果用本地存储，定时清理不再使用的SCORM内容目录，避免磁盘占用过大
• 跨域问题：如果SCORM内容里的JS需要和后端通信，要配置Rails的CORS（用rack-cors Gem）
• 性能优化：大的SCORM包解压、解析都放到后台任务处理，不要阻塞用户请求

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