класс ActiveStorage::Blob
Объект Active Storage Blob
Объект blob — это запись, содержащая метаданные о файле и ключ, указывающий местоположение этого файла в сервисе. Blobs можно создать двумя способами:
-
До загрузки файла на сервер в сервис, с помощью
create_and_upload!. Для этой операции должен быть доступен перематываемыйioс содержимым файла на сервере. -
До непосредственной загрузки файла клиентом в сервис, с помощью
create_before_direct_upload!.
Первый вариант не требует интеграции с JavaScript на стороне клиента и может быть использован любым другим серверным сервисом, работающим с файлами. Второй вариант быстрее, так как вы не используете собственный сервер как точку для загрузки, и может работать с развертываниями, такими как Heroku, которые не предоставляют большого объёма дискового пространства.
Blobs предназначены для неизменяемости, если говорить о ссылке на конкретный файл. Вы можете обновлять метаданные blob в последующем, но не следует обновлять ключ или изменять загруженный файл. Если вам нужно создать производный файл или изменить blob, просто создайте новый blob и удалите старый.
Константы
- MINIMUM_TOKEN_LENGTH
Публичные методы класса
# File activestorage/app/models/active_storage/blob.rb, line 145
def compose(blobs, key: nil, filename:, content_type: nil, metadata: nil)
raise ActiveRecord::RecordNotSaved, "All blobs must be persisted." if blobs.any?(&:new_record?)
content_type ||= blobs.pluck(:content_type).compact.first
new(key: key, filename: filename, content_type: content_type, metadata: metadata, byte_size: blobs.sum(&:byte_size)).tap do |combined_blob|
combined_blob.compose(blobs.pluck(:key))
combined_blob.save!
end
end Объединяет несколько blob в один «составной» blob.
# File activestorage/app/models/active_storage/blob.rb, line 96
def create_and_upload!(key: nil, io:, filename:, content_type: nil, metadata: nil, service_name: nil, identify: true, record: nil)
create_after_unfurling!(key: key, io: io, filename: filename, content_type: content_type, metadata: metadata, service_name: service_name, identify: identify).tap do |blob|
blob.upload_without_unfurling(io)
end
end Создаёт новый экземпляр blob и затем загружает содержимое указанного io в сервис. Экземпляр blob будет сохранён перед началом загрузки, чтобы избежать перезаписи загрузки из-за коллизий ключей. При указании типа содержимого, используйте identify: false для отключения автоматического определения типа содержимого.
# File activestorage/app/models/active_storage/blob.rb, line 107 def create_before_direct_upload!(key: nil, filename:, byte_size:, checksum:, content_type: nil, metadata: nil, service_name: nil, record: nil) create! key: key, filename: filename, byte_size: byte_size, checksum: checksum, content_type: content_type, metadata: metadata, service_name: service_name end
Возвращает сохранённый blob без загрузки файла в сервис. Этот blob будет указывать на ключ, где ещё нет файла. Он предназначен для совместного использования с загрузкой на стороне клиента, которая сначала создаст blob для генерации подписанной URL-адреса для загрузки. Эта подписанная URL-адреса указывает на ключ, сгенерированный blob. После отправки формы с использованием прямой загрузки, blob можно связать с нужной записью, используя подписанный идентификатор.
# File activestorage/app/models/active_storage/blob.rb, line 69 def find_signed(id, record: nil, purpose: :blob_id) super(id, purpose: purpose) end
Вы можете использовать подписанный идентификатор blob для ссылки на него на стороне клиента, не боясь подделки. Это особенно полезно для прямых загрузок, когда клиентской стороне необходимо сослаться на blob, который был создан до самой загрузки при отправке формы.
Подписанный идентификатор также используется для создания стабильных URL-адресов для blob через контроллер Blobs.
# File activestorage/app/models/active_storage/blob.rb, line 77 def find_signed!(id, record: nil, purpose: :blob_id) super(id, purpose: purpose) end
Работает как find_signed, но будет генерировать исключение ActiveSupport::MessageVerifier::InvalidSignature если signed_id истек, имеет несоответствие цели, предназначен для другой записи или был изменён. Также будет генерировать исключение ActiveRecord::RecordNotFound если по валидному подписанному идентификатору не удаётся найти запись.
# File activestorage/app/models/active_storage/blob.rb, line 116 def generate_unique_secure_token(length: MINIMUM_TOKEN_LENGTH) SecureRandom.base36(length) end
Для предотвращения проблем с регистронезависимыми файловыми системами, особенно в сочетании с базами данных, которые рассматривают индексы как регистрозависимые, все ключи blob будут содержать только буквы алфавита base-36 в нижнем регистре. Для сохранения того же или более высокого уровня энтропии, что и в кодировании base-58, используемом в has_secure_token, количество используемых байтов увеличено до 28 с стандартных 24.
# File activestorage/app/models/active_storage/blob.rb, line 38
scope :unattached, -> { where.missing(:attachments) }
Возвращает blob, которые не прикреплены ни к одной записи.
Методы экземпляра общедоступного доступа
# File activestorage/app/models/active_storage/blob.rb, line 32 has_many :attachments
Возвращает связанные экземпляры ActiveStorage::Attachment.
# File activestorage/app/models/active_storage/blob.rb, line 213
def audio?
content_type.start_with?("audio")
end Возвращает true, если тип содержимого этого объекта blob находится в диапазоне аудио, например, audio/mpeg.
# File activestorage/app/models/active_storage/blob.rb, line 199
def custom_metadata
self[:metadata][:custom] || {}
end # File activestorage/app/models/active_storage/blob.rb, line 203 def custom_metadata=(metadata) self[:metadata] = self[:metadata].merge(custom: metadata) end
# File activestorage/app/models/active_storage/blob.rb, line 323
def delete
service.delete(key)
service.delete_prefixed("variants/#{key}/") if image?
end Удаляет файлы на сервисе, связанные с объектом blob. Это следует делать только в том случае, если объект blob также будет удален, или у вас будет существовать мёртвая ссылка. В большинстве случаев рекомендуется использовать методы purge и purge_later.
# File activestorage/app/models/active_storage/blob.rb, line 283 def download(&block) service.download key, &block end
Загружает файл, связанный с этим объектом blob. Если блок не задан, весь файл читается в память и возвращается. Это потребует значительного объёма оперативной памяти для очень больших файлов. Если блок задан, загрузка происходит потоком и возвращается частями.
# File activestorage/app/models/active_storage/blob.rb, line 288 def download_chunk(range) service.download_chunk key, range end
Загружает часть файла, связанного с этим объектом blob.
# File activestorage/app/models/active_storage/blob.rb, line 195 def filename ActiveStorage::Filename.new(self[:filename]) end
Возвращает экземпляр ActiveStorage::Filename имени файла, позволяющий получить имя файла без расширения, расширение и безопасную для использования в URL-адресах версию имени файла.
# File activestorage/app/models/active_storage/blob.rb, line 208
def image?
content_type.start_with?("image")
end Возвращает true, если тип содержимого этого объекта blob находится в диапазоне изображений, например, image/png.
# File activestorage/app/models/active_storage/blob.rb, line 187 def key # We can't wait until the record is first saved to have a key for it self[:key] ||= self.class.generate_unique_secure_token(length: MINIMUM_TOKEN_LENGTH) end
Возвращает ключ, указывающий на файл на сервисе, связанный с этим объектом blob. Ключ имеет формат безопасного токена из Rails в нижнем регистре. Например: xtapjjcjiudrlk3tmwyjgpuobabd. Данный ключ не предназначен для прямого отображения пользователю. Всегда ссылайтесь на объекты blob, используя signed_id или проверенную форму ключа.
# File activestorage/app/models/active_storage/blob.rb, line 305
def open(tmpdir: nil, &block)
service.open(
key,
checksum: checksum,
verify: !composed,
name: [ "ActiveStorage-#{id}-", filename.extension_with_delimiter ],
tmpdir: tmpdir,
&block
)
end Загружает blob в временный файл на диске. Возвращает временный файл.
Имя временного файла начинается с ActiveStorage- и идентификатора объекта blob. Его расширение соответствует расширению объекта blob.
По умолчанию временный файл создается в Dir.tmpdir. Чтобы создать его в другом каталоге, передайте tmpdir:.
blob.open(tmpdir: "/path/to/tmp") do |file| # ... end
Временный файл автоматически закрывается и удаляется после выполнения данного блока.
Вызывает исключение ActiveStorage::IntegrityError, если загруженные данные не соответствуют контрольной сумме объекта blob.
# File activestorage/app/models/active_storage/blob.rb, line 331 def purge destroy delete if previously_persisted? rescue ActiveRecord::InvalidForeignKey end
Удаляет запись объекта blob и затем удаляет файл на сервисе. Это рекомендуемый способ удаления ненужных объектов blob. Обратите внимание, что удаление файла с сервиса инициирует HTTP-соединение с сервисом, которое может быть медленным или недоступным, поэтому этот метод не следует использовать внутри транзакции или в обратных вызовах. Используйте purge_later вместо этого.
# File activestorage/app/models/active_storage/blob.rb, line 339 def purge_later ActiveStorage::PurgeJob.perform_later(self) end
Добавляет в очередь ActiveStorage::PurgeJob для вызова purge. Это рекомендуемый способ удаления объектов blob из транзакции, обратного вызова Active Record или в любой другой ситуации реального времени.
# File activestorage/app/models/active_storage/blob.rb, line 344 def service services.fetch(service_name) end
Возвращает экземпляр сервиса, который может быть настроен глобально или по каждому вложению.
# File activestorage/app/models/active_storage/blob.rb, line 243 def service_headers_for_direct_upload service.headers_for_direct_upload key, filename: filename, content_type: content_type, content_length: byte_size, checksum: checksum, custom_metadata: custom_metadata end
Возвращает Hash заголовков для запросов service_url_for_direct_upload.
# File activestorage/app/models/active_storage/blob.rb, line 238 def service_url_for_direct_upload(expires_in: ActiveStorage.service_urls_expire_in) service.url_for_direct_upload key, expires_in: expires_in, content_type: content_type, content_length: byte_size, checksum: checksum, custom_metadata: custom_metadata end
Возвращает URL-адрес, который может быть использован для прямой загрузки файла для данного объекта blob на сервис. Этот URL-адрес предназначен для кратковременного использования в целях безопасности и генерируется только по запросу со стороны клиентской JavaScript-стороны, ответственной за выполнение загрузки.
# File activestorage/app/models/active_storage/blob.rb, line 179 def signed_id(purpose: :blob_id, expires_in: nil, expires_at: nil) super end
Возвращает подписанный идентификатор для этого объекта blob, подходящий для использования на стороне клиента без опасений подделки.
# File activestorage/app/models/active_storage/blob.rb, line 223
def text?
content_type.start_with?("text")
end Возвращает true, если тип содержимого этого объекта blob находится в диапазоне текста, например, text/plain.
# File activestorage/app/models/active_storage/blob.rb, line 260 def upload(io, identify: true) unfurl io, identify: identify upload_without_unfurling io end
Загружает io в службу на key для этого блока. Блоки предназначены для неизменяемости, поэтому вы не должны использовать этот метод после того, как файл уже был загружен в блок. Если вы хотите создать производный блок, создайте новый блок на основе старого.
Перед загрузкой мы вычисляем контрольную сумму, которая отправляется в службу для проверки целостности транзита. Если контрольная сумма не соответствует полученной службой, будет вызвано исключение. Мы также измеряем размер io и сохраняем его в byte_size в записи блока. Тип контента автоматически извлекается из io , если вы не укажете content_type и не передадите identify как false.
Обычно вам не нужно вызывать этот метод напрямую. Используйте метод класса create_and_upload! вместо этого. Если вы все же используете этот метод напрямую, убедитесь, что используете его с постоянным Blob, иначе данные другого блока могут быть перезаписаны в службе.
# File activestorage/app/models/active_storage/blob.rb, line 231
def url(expires_in: ActiveStorage.service_urls_expire_in, disposition: :inline, filename: nil, **options)
service.url key, expires_in: expires_in, filename: ActiveStorage::Filename.wrap(filename || self.filename),
content_type: content_type_for_serving, disposition: forced_disposition_for_serving || disposition, **options
end Возвращает URL блока в службе. Это возвращает постоянный URL для общедоступных файлов и возвращает краткосрочный URL для частных файлов. Частные файлы подписаны и не предназначены для публичного использования. Вместо этого URL должен быть показан только как переадресация со стабильного, возможно, аутентифицированного URL. Скрытие URL за переадресацией также позволяет вам изменять службы без обновления всех URL.
# File activestorage/app/models/active_storage/blob.rb, line 218
def video?
content_type.start_with?("video")
end Возвращает true, если тип контента этого блока находится в диапазоне видео, например, video/mp4.
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.