准备工作

在Rails应用中使用OSS Ruby SDK，需要在Gemfile中添加以下依赖。

gem 'aliyun-sdk', '~> 0.3.0

然后在使用OSS时引入以下依赖。

require 'aliyun/oss'

与Rails集成

OSS Ruby SDK与Rails集成的流程如下。

1. 创建项目
   1. 安装Rails，然后创建一个oss-manager的Rails应用。

      gem install rails
      rails new oss-manager

      说明 本示例中的oss-manager是OSS的文件管理器，包含列举所有Bucket、按目录层级列举Bucket下所有文件、上传文件和下载文件等功能。
   2. 使用Git管理项目代码。

      cd oss-manager
      git init
      git add .
      git commit -m "init project"

2. 添加SDK依赖
   1. 编辑oss-manager/Gemfile，并加入SDK的依赖。

      gem 'aliyun-sdk', '~> 0.3.0'

   2. 在oss-manager/中执行bundle install。
   3. 保存更改。

      git add .
      git commit -m "add aliyun-sdk dependency"

初始化OSS Client

为了避免在项目中用到OSS Client时都需要初始化，建议在项目中添加一个初始化文件。

# oss-manager/config/initializers/aliyun_oss_init.rb
require 'aliyun/oss'

module OSS
  def self.client
    unless @client
      Aliyun::Common::Logging.set_log_file('./log/oss_sdk.log')

      @client = Aliyun::OSS::Client.new(
        endpoint:
          Rails.application.secrets.aliyun_oss['endpoint'],
        access_key_id:
          Rails.application.secrets.aliyun_oss['access_key_id'],
        access_key_secret:
          Rails.application.secrets.aliyun_oss['access_key_secret']
      )
    end

    @client
  end
end

以上代码可以在SDK的rails/目录下找到。初始化后，可以在项目中方便地使用OSS Client。

buckets = OSS.client.list_buckets

其中endpoint、access_key_id和access_key_secret都保存在oss-manager/conf/secrets.yml中。

development:
  secret_key_base: xxxx
  aliyun_oss:
    endpoint: xxxx
    access_key_id: aaaa
    access_key_secret: bbbb

保存更改。

git add .
git commit -m "add aliyun-sdk initializer"

列举所有的Bucket

您可以按照如下步骤列举所有的Bucket。

1. 用Rails生成管理Bucket的controller。

   rails g controller buckets index

2. 在oss-manager中生成以下文件。
   • app/controller/buckets_controller.rb Buckets相关的逻辑代码
   • app/views/buckets/index.html.erb Buckets相关的展示代码
   • app/helpers/buckets_helper.rb辅助函数
3. 编辑buckets_controller.rb，调用OSS Client将list_buckets的结果存放在@buckets变量中。

   class BucketsController < ApplicationController
     def index
       @buckets = OSS.client.list_buckets
     end
   end

4. 编辑views/buckets/index.html.erb，列举Bucket列表。

   <h1>Buckets</h1>
   <table class="table table-striped">
     <tr>
       <th>Name</th>
       <th>Location</th>
       <th>CreationTime</th>
     </tr>
   
     <% @buckets.each do |bucket| %>
     <tr>
       <td><%= link_to bucket.name, bucket_objects_path(bucket.name) %></td>
       <td><%= bucket.location %></td>
       <td><%= bucket.creation_time.localtime.to_s %></td>
     </tr>
     <% end %>
   </table>

5. 在app/helpers/buckets_helper.rb中定义辅助函数bucket_objects_path。

   module BucketsHelper
     def bucket_objects_path(bucket_name)
       "/buckets/#{bucket_name}/objects"
     end
   end

   以上步骤完成后即可列出所有的Bucket。

   此外，您需要配置Rails的路由，使得在浏览器中输入的地址能够调用正确的逻辑。编辑config/routes.rb时需增加如下内容。

   resources :buckets do
     resources :objects
   end

   在oss-manager/下输入rails s以启动Rails服务器，然后在浏览器中输入http://localhost:3000/buckets/即可查看Bucket列表。

6. 保存更改。

   git add .
   git commit -m "add list buckets feature"

按目录层级列举Bucket下的所有文件

按目录层级列举Bucket下的所有文件的步骤如下。

1. 生成一个管理Object的controller。

   rails g controller objects index

2. 编辑app/controllers/objects_controller.rb。

   class ObjectsController < ApplicationController
     def index
       @bucket_name = params[:bucket_id]
       @prefix = params[:prefix]
       @bucket = OSS.client.get_bucket(@bucket_name)
       @objects = @bucket.list_objects(:prefix => @prefix, :delimiter => '/')
     end
   end

   您可以从URL的参数中获取Bucket名字。您需要添加一个前缀来实现只按目录层级列出Object，然后调用OSS Client的list_objects接口获取文件列表。

   说明 这里获取的是指定前缀下并且以正斜线（/）为分界的文件。具体操作，请参见 管理文件。
3. 编辑app/views/objects/index.html.erb。

   <h1>Objects in <%= @bucket_name %></h1>
   <p> <%= link_to 'Upload file', new_object_path(@bucket_name, @prefix) %></p>
   <table class="table table-striped">
     <tr>
       <th>Key</th>
       <th>Type</th>
       <th>Size</th>
       <th>LastModified</th>
     </tr>
   
     <tr>
       <td><%= link_to '../', with_prefix(upper_dir(@prefix)) %></td>
       <td>Directory</td>
       <td>N/A</td>
       <td>N/A</td>
     </tr>
   
     <% @objects.each do |object| %>
     <tr>
       <% if object.is_a?(Aliyun::OSS::Object) %>
       <td><%= link_to remove_prefix(object.key, @prefix),
               @bucket.object_url(object.key) %></td>
       <td><%= object.type %></td>
       <td><%= number_to_human_size(object.size) %></td>
       <td><%= object.last_modified.localtime.to_s %></td>
       <% else  %>
       <td><%= link_to remove_prefix(object, @prefix), with_prefix(object) %></td>
       <td>Directory</td>
       <td>N/A</td>
       <td>N/A</td>
       <% end  %>
     </tr>
     <% end %>
   </table>

   将文件按目录结构显示的实现逻辑是：

   1. 总是在第一个出现'../'时，指向上级目录。
   2. 对于Common prefix，显示为目录。
   3. 对于Object，显示为文件。

   上面的代码中使用了with_prefix、remove_prefix等辅助函数，这些辅助函数定义在app/helpers/objects_helper.rb中。

   module ObjectsHelper
     def with_prefix(prefix)
       "?prefix=#{prefix}"
     end
   
     def remove_prefix(key, prefix)
       key.sub(/^#{prefix}/, '')
     end
   
     def upper_dir(dir)
       dir.sub(/[^\/]+\/$/, '') if dir
     end
   
     def new_object_path(bucket_name, prefix = nil)
       "/buckets/#{bucket_name}/objects/new/#{with_prefix(prefix)}"
     end
   
     def objects_path(bucket_name, prefix = nil)
       "/buckets/#{bucket_name}/objects/#{with_prefix(prefix)}"
     end
   end

4. 完成之后运行rails s，然后在浏览器中输入地址http://localhost:3000/buckets/my-bucket/objects/即可查看文件列表。
5. 保存更改。

   git add .
   git commit -m "add list objects feature"

下载文件

<td><%= link_to remove_prefix(object.key, @prefix),
        @bucket.object_url(object.key) %></td>

上传文件

添加样式

完整的demo代码请参见OSS Rails Demo。