Paperclip 使用教程

Paperclip 使用教程

paperclip Easy file attachment management for ActiveRecord 项目地址: https://gitcode.com/gh_mirrors/pa/paperclip

1. 项目介绍

Paperclip 是一个针对 Ruby on Rails 的文件附件库，用于简化 Active Record 模型中文件的上传和管理。它的设计理念是让设置尽可能简单，并且将文件视为与其他属性类似的处理方式。这意味着文件在上传后不会立即保存到最终位置，也不会在属性设置为 nil 时立即删除，而是在调用 ActiveRecord::Base#save 方法时进行。

2. 项目快速启动

在 Rails 应用中使用 Paperclip 前，首先需要在 Gemfile 中添加 Paperclip 的依赖：

gem 'paperclip', '~> 6.0.0'

然后执行 bundle install 来安装 Paperclip。

接下来，你需要定义一个模型，并且使用 has_attached_file 方法来指定附件：

class User < ApplicationRecord
  has_attached_file :avatar, styles: { medium: "300x300>", thumb: "100x100>" }
  validates_attachment :avatar, presence: true
  validates_attachment_size :avatar, less_than: 5.megabytes
end

在这个例子中，我们创建了一个 User 模型，它有一个名为 avatar 的附件。我们定义了两种样式：medium 和 thumb，用于创建不同尺寸的缩略图。我们还添加了两个验证，确保附件必须存在且大小不超过 5 MB。

在迁移文件中，你需要添加一个列来存储附件的文件名：

class AddAvatarToUsers < ActiveRecord::Migration[6.0]
  def self.up
    has_attached_file :user, :avatar
  end

  def self.down
    remove_attachment :user, :avatar
  end
end

执行迁移命令：

rails db:migrate

现在你的模型已经可以处理文件上传了。

3. 应用案例和最佳实践

• 使用不同的存储引擎：Paperclip 支持多种存储引擎，包括本地文件系统、Amazon S3 等。根据你的需求选择合适的存储引擎。
• 处理文件类型：确保你验证了上传的文件类型，避免上传不安全的文件。
• 动态附件样式：利用 Paperclip 的动态样式功能来根据请求动态生成附件的不同版本。

4. 典型生态项目

• kt-paperclip：这是 Paperclip 的一个维护分支，适用于那些需要继续使用 Paperclip 的项目。

以上就是 Paperclip 的基本使用教程。在实际应用中，你可能还需要根据具体需求调整配置和实现细节。

paperclip Easy file attachment management for ActiveRecord 项目地址: https://gitcode.com/gh_mirrors/pa/paperclip