Visão geral da API Blobstore para pacotes de serviços legados

A API Blobstore permite que seu aplicativo disponibilize objetos de dados, chamados blobs, que são muito maiores do que o tamanho permitido para objetos no serviço do Datastore. Os blobs são úteis para exibir arquivos grandes, como arquivos de vídeo ou de imagem, e para permitir que os usuários façam upload de arquivos de dados grandes. Blobs são criados fazendo upload de um arquivo através de uma solicitação HTTP. Normalmente, seus aplicativos fazem isso apresentando ao usuário um formulário com um campo de upload de arquivos. Quando o formulário é enviado, o Blobstore cria um blob a partir do conteúdo do arquivo e retorna uma referência opaca ao blob, chamada de chave blob, que você pode usar mais tarde para disponibilizar o blob. O aplicativo pode disponibilizar o valor de blob completo em resposta a uma solicitação do usuário ou pode ler o valor diretamente usando uma interface semelhante a um arquivo de streaming.

Apresentação do Blobstore

O Google App Engine inclui o serviço Blobstore. Com ele, os aplicativos podem disponibilizar objetos de dados, limitados somente pela quantidade de dados que podem ser salvos por upload ou download em uma única conexão HTTP. Esses objetos são chamados de valores do Blobstore ou blobs. Os valores do Blobstore são disponibilizados como respostas de gerenciadores de solicitações e criados como uploads por meio de formulários da Web. Os aplicativos não criam dados de blob diretamente. Na verdade, isso é feito indiretamente por um formulário da Web enviado ou outra solicitação HTTP POST. É possível disponibilizar os valores do Blobstore para o usuário ou acessá-los pelo aplicativo em um stream semelhante a um arquivo usando a API Blobstore.

Para solicitar que um usuário faça upload de um valor do Blobstore, o aplicativo exibe um formulário da Web com um campo de upload de arquivos. O aplicativo gera o URL de ação do formulário chamando a API Blobstore. O navegador do usuário faz upload do arquivo diretamente para o Blobstore por meio do URL gerado. Em seguida, o Blobstore armazena o blob, reescreve a solicitação para conter a chave blob e a transmite para um caminho no aplicativo. Um gerenciador de solicitações nesse caminho do aplicativo pode realizar um processamento extra do formulário.

Para disponibilizar um blob, o aplicativo define um cabeçalho na resposta de saída, e o App Engine substitui a resposta pelo valor do blob.

Os blobs não podem ser modificados depois que são criados, mas é possível excluí-los. Cada blob tem um registro de informações correspondente, no repositório de dados, que fornece detalhes sobre o blob, como a hora de criação e o tipo de conteúdo. Você pode usar a chave blob para buscar registros de informações e consultar as propriedades deles.

Um aplicativo pode ler um valor do Blobstore por vez usando uma chamada de API. O tamanho de cada parte pode ser até o tamanho máximo de um valor de retorno da API. Esse tamanho é um pouco menor que 32 megabytes, representado em Python pela constantegoogle.appengine.ext.blobstore.MAX_BLOB_FETCH_SIZEde dois minutos. Um aplicativo não pode criar nem modificar valores do Blobstore, exceto por meio de arquivos enviados pelo usuário.

Como usar o Blobstore

Os aplicativos podem usar o Blobstore para aceitar arquivos grandes como uploads de usuários e disponibilizar esses arquivos. Os arquivos são chamados de blobs após o upload. Os aplicativos não acessam blobs diretamente. Em vez disso, os aplicativos funcionam com blobs por meio de entidades de informações de blob (link em inglês). representado pela classe BlobInfo ) no Datastore.

O usuário cria um blob enviando um formulário HTML que inclui um ou mais campos de entrada de arquivo. Seu aplicativo chama blobstore.create_upload_url() para receber o destino (ação) desse formulário, passando à função um caminho de URL de um gerenciador no aplicativo. Quando o usuário envia o formulário, o navegador faz o upload dos arquivos especificados diretamente para o Blobstore. O Blobstore grava novamente a solicitação do usuário e armazena os dados do arquivo enviado, substituindo essas informações por uma ou mais chaves blob correspondentes. Depois disso, o Blobstore transmite a solicitação regravada para o gerenciador no caminho de URL fornecido para blobstore.create_upload_url() .

Esse gerenciador pode realizar um processamento adicional com base na chave blob.

O aplicativo pode ler partes de um valor do Blobstore usando uma interface de streaming semelhante a arquivo. Consulte a classe BlobReader.

Como fazer upload de um blob

Para criar e fazer upload de um blob, siga este procedimento:

1. Crie um URL de upload

Chame blobstore.create_upload_url() para criar um URL de upload para o formulário que o usuário preencherá, passando o caminho do aplicativo a ser carregado quando o POST do formulário for preenchido.

upload_url = blobstore.create_upload_url("/upload_photo")

Há uma versão assíncrona, create_upload_url_async(). Ela permite que o código do aplicativo continue em execução enquanto o Blobstore gera o URL de upload.

2. Criar um formulário de upload

O formulário precisa incluir um campo de upload de arquivos, e o enctype do formulário precisa estar definido como multipart/form-data. Quando o usuário envia o formulário, o POST é gerenciado pela API Blobstore, que cria o blob. A API também cria um registro de informações para o blob e o guarda no Datastore. Depois, a solicitação reescrita é encaminhada como uma chave blob para o aplicativo no caminho informado.

3. Implementar o gerenciador de uploads

Nesse gerenciador, você pode armazenar a chave blob com o restante do modelo de dados do seu aplicativo. A chave blob em si permanece acessível a partir da entidade de informações do blob no Datastore. Observe que o blob já estará salvo e as informações do blob estarão no Datastore depois que o usuário tiver enviado o formulário e o gerenciador for chamado. Para evitar que o blob se torne órfão, exclua-o imediatamente se o aplicativo não quiser mantê-lo:

Para todos os aplicativos Flask, todas as chamadas feitas para métodos na classe BlobstoreUploadHandler exigem o request.environ dictionary (solicitação que está sendo importada do módulo flask). Se o aplicativo for um aplicativo DaemonSet sem um framework da Web, use o parâmetro environ no método get_uploads().

Quando o Blobstore reescreve a solicitação do usuário, o corpo das partes MIME dos arquivos enviados é esvaziado e a chave blob é adicionada como cabeçalho da parte MIME. Todos os outros campos e partes do formulário são preservados e passados para o gerenciador de upload. Se não for especificado um tipo de conteúdo, o Blobstore tentará deduzi-lo a partir da extensão do arquivo. Se um tipo de conteúdo não puder ser determinado, o blob recém-criado receberá o tipo de conteúdo application/octet-stream.

Como exibir um blob

Para disponibilizar blobs, você precisa incluir um gerenciador de download de blob como um caminho do aplicativo. O aplicativo exibe um blob definindo um cabeçalho na resposta de saída. Se você usar o Flask, a classe BlobstoreDownloadHandler precisará do dicionário request.environ (solicitação importada do módulo do flask). Se seu aplicativo for um aplicativo WSGI sem uma biblioteca da Web, você usa o parâmetro environ na Métodos send_blob() . Os blobs podem ser exibidos a partir de qualquer URL de aplicativo. Para exibir um blob no seu aplicativo, coloque um cabeçalho especial na resposta que contém a chave blob. O corpo da resposta é substituído pelo conteúdo do blob no App Engine.

Intervalos de bytes do blob

O Blobstore oferece suporte para a exibição de parte de um valor grande em vez do valor inteiro em resposta a uma solicitação. Para exibir um valor parcial, inclua o cabeçalho X-AppEngine-BlobRange na resposta enviada. O valor dele é um intervalo de bytes HTTP padrão. A numeração de bytes é baseada em zeros. Um X-AppEngine-BlobRange em branco instrui a API a ignorar o cabeçalho do intervalo e exibir o blob completo. Veja alguns exemplos de intervalos:

  • 0-499 disponibiliza os primeiros 500 bytes do valor (de 0 a 499, inclusive).
  • 500-999 disponibiliza 500 bytes a partir do byte número 501.
  • 500- disponibiliza todos os bytes a partir do byte número 501 até o fim do valor.
  • -500 disponibiliza os últimos 500 bytes do valor.

Se o intervalo de bytes for válido para o valor do Blobstore, esse sistema enviará um código de status 206 Partial Content e o intervalo de bytes solicitado para o cliente. Se o intervalo não for válido para o valor, o Blobstore enviará 416 Requested Range Not Satisfiable.

O Blobstore não oferece suporte para vários intervalos de bytes em uma única solicitação (por exemplo, 100-199,200-299), estando eles sobrepostos ou não.

Aplicativo de amostra completo

Consulte o exemplo de app Flask no guia API Blobstore para Python 3.

Como usar o serviço Imagens com o Blobstore

O serviço Imagens pode usar um valor do Blobstore como fonte de uma transformação. A imagem fonte pode ter tamanho igual ao tamanho máximo de um valor do Blobstore. O serviço Imagens ainda retorna a imagem transformada para o aplicativo. Dessa forma, a imagem transformada precisa ter menos de 32 MB. Isso é útil para criar miniaturas de fotos grandes enviadas por usuários. Para informações sobre como usar o serviço Imagens com os valores do Blobstore, consulte a Documentação do serviço de imagens.

Como usar a API Blobstore com o Cloud Storage

Você pode usar a API Blobstore para armazenar blobs no Cloud Storage em vez de armazená-los no Blobstore. É preciso configurar um bucket conforme descrito na documentação do Cloud Storage, especificar o bucket e o nome de arquivo no blobstore.create_upload_url gs_bucket_name parâmetro.

No gerenciador de uploads, você precisa processar os FileInfo metadados e armazenam explicitamente o nome do arquivo do Cloud Storage necessário para recuperar o blob posteriormente.

Você também pode disponibilizar objetos do Cloud Storage usando a API Blobstore.

Se você quiser uma solução de armazenamento de objetos mais moderna, considere migrar do Blobstore do App Engine para o Cloud Storage.

Como usar BlobReader

Um aplicativo pode ler dados de valores do Blobstore usando uma interface semelhante a um objeto file do Python. Essa interface pode começar a ler um valor em qualquer posição de byte e usar várias chamadas de serviço e armazenamento em buffer. Dessa forma, um aplicativo pode acessar o tamanho total do valor, desconsiderando o limite do tamanho de uma resposta de chamada de serviço única.

A classe BlobReader pode usar um dos três valores como argumento para o construtor:

O objeto implementa os métodos de arquivo familiares para ler o valor. O aplicativo não pode modificar o valor do Blobstore. Os métodos de arquivo para gravação não são implementados.

# Instantiate a BlobReader for a given Blobstore blob_key.
blob_reader = blobstore.BlobReader(blob_key)

# Instantiate a BlobReader for a given Blobstore blob_key, setting the
# buffer size to 1 MB.
blob_reader = blobstore.BlobReader(blob_key, buffer_size=1048576)

# Instantiate a BlobReader for a given Blobstore blob_key, setting the
# initial read position.
blob_reader = blobstore.BlobReader(blob_key, position=0)

# Read the entire value into memory. This may take a while depending
# on the size of the value and the size of the read buffer, and is not
# recommended for large values.
blob_reader_data = blob_reader.read()

# Write the contents to the response.
self.response.headers["Content-Type"] = "text/plain"
self.response.write(blob_reader_data)

# Set the read position back to 0, then read and write 3 bytes.
blob_reader.seek(0)
blob_reader_data = blob_reader.read(3)
self.response.write(blob_reader_data)
self.response.write("\n")

# Set the read position back to 0, then read and write one line (up to
# and including a '\n' character) at a time.
blob_reader.seek(0)
for line in blob_reader:
    self.response.write(line)

Como fazer solicitações assíncronas

Um aplicativo pode chamar algumas funções do Blobstore que funcionam em segundo plano. O Blobstore realiza a solicitação enquanto o aplicativo faz outras coisas. Para fazer a solicitação, o aplicativo chama uma função assíncrona. Imediatamente, a função retorna um objeto RPC que representa a solicitação. Quando o aplicativo precisar do resultado da solicitação, ele chamará o método get_result() do objeto RPC.

Se o serviço não tiver concluído a solicitação quando o aplicativo chamar get_result(), o método aguardará até que a solicitação seja concluída/alcance o prazo ou ocorra um erro. O método retorna o objeto de resultado ou gera uma exceção se um erro ocorreu durante a realização da solicitação. Por exemplo, este snippet de código:

upload_url = blobstore.create_upload_url('/upload')
slow_operation()
self.response.out.write("""<form action="%s" method="POST"
                           enctype="multipart/form-data">""" % upload_url)

torna-se

upload_url_rpc = blobstore.create_upload_url_async('/upload')
slow_operation()
upload_url = upload_url_rpc.get_result()
self.response.out.write("""<form action="%s" method="POST"
                           enctype="multipart/form-data">""" % upload_url)

Nesse exemplo, o aplicativo executa o código slow_operation() ao mesmo tempo que o Blobstore gera o URL de upload.

Cotas e limites

O espaço usado para os valores do Blobstore contribui para a cota de Dados armazenados (faturáveis). As entidades de informações do blob no armazenamento de dados são contabilizadas dentro dos limites relacionados ao armazenamento de dados. O Cloud Storage é um serviço pago. Você será cobrado de acordo com a tabela de preços desse serviço.

Para mais informações sobre as cotas de segurança do sistema, consulte Cotas.

Além das cotas de segurança do sistema, os seguintes limites são aplicados especificamente ao uso do Blobstore:

  • O tamanho máximo dos dados do Blobstore que podem ser lidos pelo aplicativo com uma chamada de API é de 32 MB.
  • O número máximo de arquivos que pode ser enviado em um único POST de formulário é 500.