上传文件

上传本地文件

通过Bucket#put_object接口，并指定:file参数来上传一个本地文件到OSS。

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  endpoint: 'endpoint',
  access_key_id: 'AccessKeyId', access_key_secret: 'AccessKeySecret')

bucket = client.get_bucket('my-bucket')
bucket.put_object('my-object', :file => 'local-file')
            

流式上传

如果要上传的文件太大，或者一次性上传耗时太长，您可以通过流式上传的方式，一次处理部分内容，直到完成整个文件的上传。

通过Bucket#put_object接口，并指定block参数将流式生成的内容上传到OSS：

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  endpoint: 'endpoint',
  access_key_id: 'AccessKeyId', access_key_secret: 'AccessKeySecret')

bucket = client.get_bucket('my-bucket')
bucket.put_object('my-object') do |stream|
  100.times { |i| stream << i.to_s }
end
            

断点续传上传

断点续传上传将要上传的文件分成若干个分片（Part）分别上传，所有分片都上传完成后，将所有分片合并成完整的文件，完成整个文件的上传。

通过Bucket#resumable_upload接口实现断点续传上传，包含以下参数：

• key上传到OSS的Object名字。
• file待上传的本地文件路径。
• opts可选项，主要包括：
  • :cpt_file指定checkpoint文件的路径。如果不指定，则默认是本地文件同目录下的file.cpt，其中file是本地文件的名字。
  • :disable_cpt如果指定为true，则上传过程中不会记录上传进度，上传失败后也无法进行续传。
  • :part_size指定每个分片的大小，默认为4MB。
  • &block如果调用时传递了block，则上传进度会由block来处理。

以下代码用于断点续传上传：

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  endpoint: 'endpoint',
  access_key_id: 'AccessKeyId', access_key_secret: 'AccessKeySecret')

bucket = client.get_bucket('my-bucket')
bucket.resumable_upload('my-object', 'local-file') do |p|
  puts "Progress: #{p}"
end

bucket.resumable_upload(
  'my-object', 'local-file',
  :part_size => 100 * 1024, :cpt_file => '/tmp/x.cpt') { |p|
  puts "Progress: #{p}"
}
            

追加上传

通过Bucket#append_object来上传可追加的文件。调用该接口时需要指定文件追加的position，首次追加操作的position必须为0，后续追加操作的position是Object的当前大小。

• 文件不存在时，调用append_object会创建一个可追加的文件。
• 文件存在时，调用append_object会向文件末尾追加内容。

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  endpoint: 'endpoint',
  access_key_id: 'AccessKeyId', access_key_secret: 'AccessKeySecret')

bucket = client.get_bucket('my-bucket')
# 创建可追加的文件
bucket.append_object('my-object', 0) {}

# 向文件末尾追加内容
next_pos = bucket.append_object('my-object', 0) do |stream|
  100.times { |i| stream << i.to_s }
end
next_pos = bucket.append_object('my-object', next_pos, :file => 'local-file-1')
next_pos = bucket.append_object('my-object', next_pos, :file => 'local-file-2')
            

上传回调

使用put_object上传文件时指定了上传回调，并将此次上传的Bucket和Object信息添加在body中。如果应用服务器收到这个回调，则表明文件已成功上传到OSS了。

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  endpoint: 'endpoint',
  access_key_id: 'AccessKeyId', access_key_secret: 'AccessKeySecret')

bucket = client.get_bucket('my-bucket')

callback = Aliyun::OSS::Callback.new(
  url: 'http://10.101.168.94:1234/callback',
  query: {user: 'put_object'},
  body: 'bucket=${bucket}&object=${object}'
)

begin
  bucket.put_object('files/hello', file: '/tmp/x', callback: callback)
rescue Aliyun::OSS::CallbackError => e
  puts "Callback failed: #{e.message}"
end
            

resumable_upload的调用方法与put_object类似。

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  endpoint: 'endpoint',
  access_key_id: 'AccessKeyId', access_key_secret: 'AccessKeySecret')

bucket = client.get_bucket('my-bucket')

callback = Aliyun::OSS::Callback.new(
  url: 'http://10.101.168.94:1234/callback',
  query: {user: 'put_object'},
  body: 'bucket=${bucket}&object=${object}'
)

begin
  bucket.resumable_upload('files/hello', '/tmp/x', callback: callback)
rescue Aliyun::OSS::CallbackError => e
  puts "Callback failed: #{e.message}"
end