Отправка большого двоичного объекта с помощью JavaScript

  • Статья

В этой статье показано, как отправить большой двоичный объект с помощью клиентской библиотеки службы хранилища Azure для JavaScript. Вы можете отправлять данные в блочный BLOB-объект из пути к файлу, потока, буфера или текстовой строки. Вы также можете отправлять большие двоичные объекты с тегами индекса.

Предварительные требования

Отправка данных в блочный BLOB-объект

Для отправки данных в блочный BLOB-объект можно использовать любой из следующих методов:

  • upload (непараллее метод отправки)
  • uploadData
  • uploadFile (доступен только в среде выполнения Node.js)
  • uploadStream (доступен только в среде выполнения Node.js)

Каждый из этих методов можно вызвать с помощью объекта BlockBlobClient .

Отправка блочного BLOB-объекта из пути к файлу

В следующем примере передается блочный BLOB-объект из локального пути к файлу:

// containerClient: ContainerClient object
// blobName: string, includes file extension if provided
// localFilePath: fully qualified path and file name
async function uploadBlobFromLocalPath(containerClient, blobName, localFilePath){
  // Create blob client from container client
  const blockBlobClient = containerClient.getBlockBlobClient(blobName);

  await blockBlobClient.uploadFile(localFilePath);
}

Отправка блочного BLOB-объекта из потока

В следующем примере блочный BLOB-объект отправляется путем создания удобочитаемого потока и передачи потока:

// containerClient: ContainerClient object
// blobName: string, includes file extension if provided
// readableStream: Readable stream, for example, a stream returned from fs.createReadStream()
async function uploadBlobFromReadStream(containerClient, blobName, readableStream) {
  // Create blob client from container client
  const blockBlobClient = containerClient.getBlockBlobClient(blobName);

  // Upload data to block blob using a readable stream
  await blockBlobClient.uploadStream(readableStream);
}

Отправка блочного BLOB-объекта из буфера

В следующем примере блочный BLOB-объект отправляется из буфера Node.js:

// containerClient: ContainerClient object
// blobName: string, includes file extension if provided
// buffer: blob contents as a buffer, for example, from fs.readFile()
async function uploadBlobFromBuffer(containerClient, blobName, buffer) {

  // Create blob client from container client
  const blockBlobClient = containerClient.getBlockBlobClient(blobName);

  // Upload buffer
  await blockBlobClient.uploadData(buffer);
}

Отправка блочного BLOB-объекта из строки

В следующем примере передается блочный BLOB-объект из строки:

// containerClient: ContainerClient object
// blobName: string, includes file extension if provided
// fileContentsAsString: blob content
async function uploadBlobFromString(containerClient, blobName, fileContentsAsString){
  // Create blob client from container client
  const blockBlobClient = containerClient.getBlockBlobClient(blobName);

  await blockBlobClient.upload(fileContentsAsString, fileContentsAsString.length);
}

Отправка блочного BLOB-объекта с параметрами конфигурации

При отправке большого двоичного объекта можно определить параметры конфигурации клиентской библиотеки. Эти параметры можно настроить для повышения производительности, повышения надежности и оптимизации затрат. В примерах кода в этом разделе показано, как задать параметры конфигурации с помощью интерфейса BlockBlobParallelUploadOptions и передать эти параметры в качестве параметра в вызов метода отправки.

Указание параметров передачи данных при отправке

Вы можете настроить свойства в BlockBlobParallelUploadOptions , чтобы повысить производительность операций передачи данных. В следующей таблице перечислены свойства, которые можно настроить, а также описание:

Свойство Описание
blockSize Максимальный размер блока для передачи для каждого запроса в рамках операции отправки.
concurrency Максимальное количество параллельных запросов, которые выдаются в любой момент времени в рамках одной параллельной передачи.
maxSingleShotSize Если размер данных меньше или равен этому значению, они отправляются в один блок, а не разбиваются на блоки. Если данные передаются за один снимок, размер блока игнорируется. Значение по умолчанию — 256 МиБ.

В следующем примере кода показано, как задать значения для BlockBlobParallelUploadOptions и включить параметры в рамках вызова метода отправки. Значения, приведенные в примерах, не предназначены для рекомендации. Чтобы правильно настроить эти значения, необходимо учитывать конкретные потребности приложения.

// containerClient: ContainerClient object
// blobName: string, includes file extension if provided
// localFilePath: fully qualified path and file name
async function uploadWithTransferOptions(containerClient, blobName, localFilePath) {
  // Specify data transfer options
  const uploadOptions = {
    blockSize: 4 * 1024 * 1024, // 4 MiB max block size
    concurrency: 2, // maximum number of parallel transfer workers
    maxSingleShotSize: 8 * 1024 * 1024, // 8 MiB initial transfer size
  } 

  // Create blob client from container client
  const blockBlobClient = containerClient.getBlockBlobClient(blobName);

  // Upload blob with index tags
  await blockBlobClient.uploadFile(localFilePath, uploadOptions);
}

Отправка блочного BLOB-объекта с тегами индекса

Теги индекса больших двоичных объектов классифицируют данные в учетной записи хранения с помощью атрибутов тегов типа "ключ-значение". Эти теги автоматически индексируются и представляются в виде многомерного индекса с поддержкой поиска для упрощения нахождения данных.

В следующем примере передается блочный BLOB-объект с тегами индекса, заданными с помощью BlockBlobParallelUploadOptions:

// containerClient: ContainerClient object
// blobName: string, includes file extension if provided
// localFilePath: fully qualified path and file name
async function uploadWithIndexTags(containerClient, blobName, localFilePath) {
  // Specify index tags for blob
  const uploadOptions = {
    tags: {
      'Sealed': 'false',
      'Content': 'image',
      'Date': '2023-06-01',
    }
  }

  // Create blob client from container client
  const blockBlobClient = containerClient.getBlockBlobClient(blobName);

  // Upload blob with index tags
  await blockBlobClient.uploadFile(localFilePath, uploadOptions);
}

Установка уровня доступа к BLOB-объекту при отправке

Вы можете задать уровень доступа blob-объекта при отправке с помощью интерфейса BlockBlobParallelUploadOptions . В следующем примере кода показано, как задать уровень доступа при отправке большого двоичного объекта:

// containerClient: ContainerClient object
// blobName: string, includes file extension if provided
// localFilePath: fully qualified path and file name
async function uploadWithAccessTier(containerClient, blobName, localFilePath) {
  // Specify access tier
  const uploadOptions = {
    tier: 'Cool',
  }

  // Create blob client from container client
  const blockBlobClient = containerClient.getBlockBlobClient(blobName);

  // Upload blob to cool tier
  await blockBlobClient.uploadFile(localFilePath, uploadOptions);
}

Настройка уровня доступа разрешена только для блочных BLOB-объектов. Для блочного BLOB-объекта Hotможно задать уровень доступа , Cool, Coldили Archive. Чтобы задать для уровня доступа значение Cold, необходимо использовать минимальную версию клиентской библиотеки 12.13.0.

Дополнительные сведения об уровнях доступа см. в статье Общие сведения об уровнях доступа.

Ресурсы

Дополнительные сведения об отправке больших двоичных объектов с помощью клиентской библиотеки Хранилище BLOB-объектов Azure для JavaScript см. в следующих ресурсах.

Операции REST API

Пакет Azure SDK для JavaScript содержит библиотеки, которые создаются на основе REST API Azure, что позволяет взаимодействовать с операциями REST API через знакомые парадигмы JavaScript. Методы клиентской библиотеки для отправки больших двоичных объектов используют следующие операции REST API:

Примеры кода

Просмотрите примеры кода из этой статьи (GitHub):

Ресурсы клиентской библиотеки

См. также раздел