使用ActiveStorage上传至S3时设置AWS标签的简便方法？

我需要在使用ActiveStorage上传文件到AWS S3时设置AWS标签，虽然底层的aws-sdk-s3库支持这个功能，但ActiveStorage自带的S3Service并没有提供相关接口。我自己实现了TaggingS3Service，但这个方案得复制S3Service的代码，还得通过反射访问私有字段，既不优雅也很脆弱，想知道有没有更简便的实现方式。

现有实现方案 #

自定义服务类代码 #

app/services/active_storage/service/tagging_s3_service.rb

require 'active_storage/service/s3_service'
require 'uri'

class ActiveStorage::Service::TaggingS3Service < ActiveStorage::Service::S3Service
  def upload(key, io, checksum: nil, filename: nil, content_type: nil, disposition: nil, custom_metadata: {}, tagging: {}, **)
    instrument :upload, key: key, checksum: checksum do
      content_disposition = content_disposition_with(filename: filename, type: disposition) if disposition && filename

      tagging_str = URI.encode_www_form(tagging) if tagging
      if io.size < multipart_upload_threshold
        upload_with_single_part key, io, checksum: checksum, content_type: content_type, content_disposition: content_disposition, custom_metadata: custom_metadata, tagging_str: tagging_str
      else
        upload_with_multipart key, io, content_type: content_type, content_disposition: content_disposition, custom_metadata: custom_metadata, tagging_str: tagging_str
      end
    end
  end

  def upload_with_single_part(key, io, checksum: nil, content_type: nil, content_disposition: nil, custom_metadata: {}, tagging_str: nil)
    object_for(key).put(
      body: io,
      content_md5: checksum,
      content_type: content_type,
      content_disposition: content_disposition,
      metadata: custom_metadata,
      tagging: tagging_str,
      **upload_options)
    # 注释掉以下代码，因为会触发警告：Cannot find 'BadDigest' for type 'Module<Aws::S3::Errors>'
  # rescue Aws::S3::Errors::BadDigest
  #   raise ActiveStorage::IntegrityError
  end

  def upload_with_multipart(key, io, content_type: nil, content_disposition: nil, custom_metadata: {}, tagging_str: nil)
    part_size = [ io.size.fdiv(MAXIMUM_UPLOAD_PARTS_COUNT).ceil, MINIMUM_UPLOAD_PART_SIZE ].max

    object_for(key).upload_stream(
      content_type: content_type,
      content_disposition: content_disposition,
      part_size: part_size,
      metadata: custom_metadata,
      tagging: tagging_str,
      **upload_options) do |out|
      IO.copy_stream(io, out)
    end
  end
end

配置方式 #

修改config/storage.yml，指定自定义服务：

amazon:
  service: TaggingS3
  # 其他S3配置项（如access_key_id、secret_access_key、bucket等）...

使用方式 #

通过反射访问私有字段传递标签参数：

blob.service.upload(blob.key, file, checksum: blob.checksum, **blob.send(:service_metadata), tagging: { key: "value" })

更优雅的优化实现 #

不用复制S3Service的整段代码，试试用**Ruby模块前置（prepend）**的方式，只扩展需要修改的参数处理逻辑，既能实现标签功能，又避免继承带来的代码冗余和版本兼容问题。

实现代码 #

创建初始化文件config/initializers/active_storage_s3_tagging.rb：

require 'active_storage/service/s3_service'

module ActiveStorage::Service::S3Service::TaggingExtension
  def upload(key, io, checksum: nil, filename: nil, content_type: nil, disposition: nil, custom_metadata: {}, tagging: {}, **options)
    # 将标签转换成S3要求的URL编码格式
    tagging_str = URI.encode_www_form(tagging) if tagging.present?
    
    # 调用原upload方法，把标签参数注入到上传选项中
    super(key, io, checksum: checksum, filename: filename, content_type: content_type, disposition: disposition, custom_metadata: custom_metadata, **options.merge(tagging: tagging_str))
  end

  private

  # 重写单文件上传的参数处理，传递标签
  def upload_with_single_part(key, io, checksum: nil, content_type: nil, content_disposition: nil, custom_metadata: {}, tagging: nil, **options)
    super(key, io, checksum: checksum, content_type: content_type, content_disposition: content_disposition, custom_metadata: custom_metadata, **options.merge(tagging: tagging))
  end

  # 重写分片上传的参数处理，传递标签
  def upload_with_multipart(key, io, content_type: nil, content_disposition: nil, custom_metadata: {}, tagging: nil, **options)
    super(key, io, content_type: content_type, content_disposition: content_disposition, custom_metadata: custom_metadata, **options.merge(tagging: tagging))
  end
end

# 将扩展模块注入到S3Service中
ActiveStorage::Service::S3Service.prepend(ActiveStorage::Service::S3Service::TaggingExtension)

配置方式 #

不需要修改storage.yml，保持原有的S3服务配置即可：

amazon:
  service: S3
  # 其他S3配置项...

使用方式 #

直接在上传时传入tagging参数，无需反射访问私有字段：

# 示例1：创建Blob时直接传入标签
blob = ActiveStorage::Blob.create_after_upload!(
  io: File.open("/path/to/file.jpg"),
  filename: "file.jpg",
  content_type: "image/jpeg",
  service_metadata: { tagging: { "category": "photos", "user_id": "123" } }
)

# 示例2：直接调用upload方法时传入标签
blob.service.upload(blob.key, file, checksum: blob.checksum, tagging: { "category": "documents" })

优势 #

• 无需复制S3Service核心代码，只扩展必要逻辑，代码更简洁
• 避免继承带来的版本兼容问题，Rails更新S3Service时无需同步修改自定义代码
• 去掉反射调用，代码更健壮易维护

内容的提问来源于stack exchange，提问作者Eugen Dück