Przekazywanie obiektu blob za pomocą języka TypeScript

Artykuł
08/04/2023

W tym artykule pokazano, jak przekazać obiekt blob przy użyciu biblioteki klienta usługi Azure Storage dla języka JavaScript. Dane można przekazać do blokowego obiektu blob ze ścieżki pliku, strumienia, buforu lub ciągu tekstowego. Można również przekazywać obiekty blob za pomocą tagów indeksu.

Wymagania wstępne

W przykładach w tym artykule założono, że masz już skonfigurowany projekt do pracy z biblioteką klienta Azure Blob Storage dla języka JavaScript. Aby dowiedzieć się więcej na temat konfigurowania projektu, w tym instalowania pakietów, importowania modułów i tworzenia autoryzowanego obiektu klienta do pracy z zasobami danych, zobacz Wprowadzenie do Azure Blob Storage i TypeScript.
Mechanizm autoryzacji musi mieć uprawnienia do wykonywania operacji przekazywania. Aby dowiedzieć się więcej, zobacz wskazówki dotyczące autoryzacji dla następujących operacji interfejsu API REST:
- Wstawianie obiektu blob
- Umieść blok

Przekazywanie danych do blokowego obiektu blob

Do przekazania danych do blokowego obiektu blob można użyć dowolnej z następujących metod:

upload (metoda przekazywania niezrównanego)
Uploaddata
uploadFile (dostępny tylko w środowisku uruchomieniowym Node.js)
uploadStream (dostępny tylko w środowisku uruchomieniowym Node.js)

Każda z tych metod może być wywoływana przy użyciu obiektu BlockBlobClient .

Przekazywanie blokowego obiektu blob ze ścieżki pliku

Poniższy przykład przekazuje blokowy obiekt blob ze ścieżki pliku lokalnego:

async function uploadBlobFromLocalPath(
  containerClient: ContainerClient,
  blobName: string,
  localFilePath: string
): Promise<void> {
  // Create blob client from container client
  const blockBlobClient: BlockBlobClient = containerClient.getBlockBlobClient(blobName);

  await blockBlobClient.uploadFile(localFilePath);
}

Przekazywanie blokowego obiektu blob ze strumienia

Poniższy przykład przekazuje blokowy obiekt blob przez utworzenie czytelnego strumienia i przekazanie strumienia:

async function uploadBlobFromReadStream(
  containerClient: ContainerClient,
  blobName: string,
  readStream: fs.ReadStream
): Promise<void> {
  // Create blob client from container client
  const blockBlobClient: BlockBlobClient = containerClient.getBlockBlobClient(blobName);

  await blockBlobClient.uploadStream(readStream);
}

Przekazywanie blokowego obiektu blob z buforu

Poniższy przykład przekazuje blokowy obiekt blob z bufora Node.js:

async function uploadBlobFromBuffer(
  containerClient: ContainerClient, blobName: string, buffer: Buffer
): Promise<void> {
  // Create blob client from container client
  const blockBlobClient: BlockBlobClient = containerClient.getBlockBlobClient(blobName);

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

Przekazywanie blokowego obiektu blob z ciągu

Poniższy przykład przekazuje blokowy obiekt blob z ciągu:

async function uploadBlobFromString(
  containerClient: ContainerClient,
  blobName: string,
  fileContents: string
): Promise<void> {
  // Create blob client from container client
  const blockBlobClient: BlockBlobClient = containerClient.getBlockBlobClient(blobName);

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

Przekazywanie blokowego obiektu blob przy użyciu opcji konfiguracji

Podczas przekazywania obiektu blob można zdefiniować opcje konfiguracji biblioteki klienta. Te opcje można dostosować, aby zwiększyć wydajność, zwiększyć niezawodność i zoptymalizować koszty. Przykłady kodu w tej sekcji pokazują, jak ustawić opcje konfiguracji przy użyciu interfejsu BlockBlobParallelUploadOptions oraz jak przekazać te opcje jako parametr do wywołania metody przekazywania.

Określanie opcji transferu danych podczas przekazywania

Właściwości można skonfigurować w bloku BlockBlobParallelUploadOptions , aby zwiększyć wydajność operacji transferu danych. W poniższej tabeli wymieniono właściwości, które można skonfigurować, wraz z opisem:

Właściwość	Opis
`blockSize`	Maksymalny rozmiar bloku do przeniesienia dla każdego żądania w ramach operacji przekazywania.
`concurrency`	Maksymalna liczba żądań równoległych, które są wydawane w dowolnym momencie w ramach pojedynczego transferu równoległego.
`maxSingleShotSize`	Jeśli rozmiar danych jest mniejszy lub równy tej wartości, zostanie przekazany w jednym miejscu, a nie podzielony na fragmenty. Jeśli dane są przekazywane w jednym zdjęciu, rozmiar bloku jest ignorowany. Wartość domyślna to 256 MiB.

W poniższym przykładzie kodu pokazano, jak ustawić wartości dla elementu BlockBlobParallelUploadOptions i uwzględnić opcje w ramach wywołania metody przekazywania. Wartości podane w przykładach nie są przeznaczone do zalecenia. Aby prawidłowo dostosować te wartości, należy wziąć pod uwagę konkretne potrzeby aplikacji.

async function uploadWithTransferOptions(
  containerClient: ContainerClient,
  blobName: string,
  localFilePath: string
): Promise<void> {
  // Specify data transfer options
  const uploadOptions: BlockBlobParallelUploadOptions = {
    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: BlockBlobClient = containerClient.getBlockBlobClient(blobName);

  await blockBlobClient.uploadFile(localFilePath, uploadOptions);
}

Przekazywanie blokowego obiektu blob z tagami indeksu

Tagi indeksu obiektów blob kategoryzują dane na koncie magazynu przy użyciu atrybutów tagów klucz-wartość. Te tagi są automatycznie indeksowane i uwidaczniane jako indeks wielowymiarowy z możliwością wyszukiwania w celu łatwego znajdowania danych.

Poniższy przykład przekazuje blokowy obiekt blob z tagami indeksu ustawionymi przy użyciu metody BlockBlobParallelUploadOptions:

async function uploadBlobWithIndexTags(
  containerClient: ContainerClient,
  blobName: string,
  localFilePath: string
): Promise<void> {
  // Specify index tags for blob
  const uploadOptions: BlockBlobParallelUploadOptions = {
    tags: {
      'Sealed': 'false',
      'Content': 'image',
      'Date': '2023-06-01',
    }
  };

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

  await blockBlobClient.uploadFile(localFilePath, uploadOptions);
}

Ustawianie warstwy dostępu obiektu blob podczas przekazywania

Warstwę dostępu obiektu blob można ustawić podczas przekazywania przy użyciu interfejsu BlockBlobParallelUploadOptions . Poniższy przykład kodu pokazuje, jak ustawić warstwę dostępu podczas przekazywania obiektu blob:

async function uploadBlobWithAccessTier(
  containerClient: ContainerClient,
  blobName: string,
  localFilePath: string
): Promise<void> {
  // Upload blob to 'Cool' access tier
  const uploadOptions: BlockBlobParallelUploadOptions = {
    tier: 'Cool'
  };

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

  await blockBlobClient.uploadFile(localFilePath, uploadOptions);
}

Ustawienie warstwy dostępu jest dozwolone tylko dla blokowych obiektów blob. Warstwę dostępu dla blokowego obiektu blob można ustawić na Hot, Cool, Coldlub Archive. Aby ustawić warstwę dostępu na Cold, należy użyć minimalnej wersji biblioteki klienta w wersji 12.13.0.

Aby dowiedzieć się więcej na temat warstw dostępu, zobacz Omówienie warstw dostępu.

Zasoby

Aby dowiedzieć się więcej na temat przekazywania obiektów blob przy użyciu biblioteki klienta Azure Blob Storage dla języków JavaScript i TypeScript, zobacz następujące zasoby.

Operacje interfejsu API REST

Zestaw Azure SDK dla języka JavaScript i TypeScript zawiera biblioteki, które bazują na interfejsie API REST platformy Azure, co umożliwia interakcję z operacjami interfejsu API REST za pomocą znanych paradygmatów językowych. Metody biblioteki klienta do przekazywania obiektów blob używają następujących operacji interfejsu API REST:

Share via