Java 版 Blobstore API 概览

注意:建议您考虑使用 Google Cloud Storage 来存储 Blob 数据,而非 Blobstore。

借助 Blobstore API,您的应用可以提供称为 blob 的数据对象,这些数据对象的大小远超过 Datastore 服务允许的对象大小上限。Blob 对于提供大型文件(如视频或图片文件)非常有用,并且支持用户上传大型数据文件。Blob 的创建方法是通过 HTTP 请求上传文件。通常,您的应用会通过向用户提供带有文件上传字段的表单来完成此操作。在提交表单后,Blobstore 根据该文件的内容创建一个 blob,并返回对该 blob 的不透明引用,称为“blob 键”,您此后可使用该键提供 blob。应用可以响应用户请求提供完整的 Blob 值,也可以使用类流文件接口直接读取值。

Blobstore 简介

Google App Engine 包含 Blobstore 服务,借助此服务,应用提供的数据对象仅受可通过单个 HTTP 连接上传或下载的数据量限制。这些对象称为“Blobstore 值”或“blob”。 Blobstore 值作为请求处理程序的响应提供,以通过网络表单上传内容的方式创建。应用不会直接创建 blob 数据;相反,blob 是通过所提交网络表单或其他 HTTP POST 请求间接创建的。借助 Blobstore API,Blobstore 值可以提供给用户,也可以由应用在类文件流中访问。

为了提示用户上传 Blobstore 值,应用将提供带有文件上传字段的网络表单。应用通过调用 Blobstore API 来生成表单的操作网址。用户的浏览器通过所生成的网址将文件直接上传到 Blobstore。然后,Blobstore 存储 blob,重写请求使其包含 blob 键,并将其传递给应用中的一个路径。位于应用中该路径的请求处理程序可以执行其他表单处理。

为了提供 blob,您的应用将为传出响应设置标头,并且 App Engine 会使用 blob 值替换该响应。

Blob 一旦创建便无法修改,但可以删除。每个 blob 都具有相应的 blob 信息记录(存储在数据存储区中),该记录提供有关 blob 的详细信息(例如,创建时间和内容类型)。您可以使用 blob 键提取 blob 信息记录以及查询其属性。

应用可以使用 API 调用一次读取 Blobstore 值的一部分。读取部分的大小最多可达到 API 返回值的大小上限。此大小略小于 32 兆字节,在 Java 中由常量 com.google.appengine.api.blobstore.BlobstoreService.MAX_BLOB_FETCH_SIZE 表示。应用只能通过用户上传的文件来创建或修改 Blobstore 值。

使用 Blobstore

应用可以使用 Blobstore 来接收用户上传的较大文件并提供这些文件。文件上传后,将称为 blob。应用不直接访问 blob,而是通过数据存储区中的 Blob 信息实体(由 BlobInfo 类表示)处理 Blob

用户通过提交包含一个或多个文件输入字段的 HTML 表单来创建 blob。您的应用将 blobstoreService.createUploadUrl() 设置为此表单的目标(操作),并将应用中处理程序的网址路径传递给函数。当用户提交表单时,用户的浏览器会将指定文件直接上传到 Blobstore。Blobstore 重写用户的请求,存储上传的文件数据,用一个或多个相应的 blob 键替换已上传的文件数据,然后将重写后的请求传递到位于您提供给 blobstoreService.createUploadUrl() 的网址路径的处理程序。该处理程序会根据 blob 键进行额外的处理。

应用可以使用类文件流式接口读取 Blobstore 值的片段。请参阅 BlobstoreInputStream 类。

上传 Blob

要创建和上传 blob,请执行以下步骤:

1. 创建上传网址

调用 blobstoreService.createUploadUrl 为用户将要填写的表单创建上传网址,在完成表单的 POST 后,传递要加载的应用路径。

<body>
    <form action="<%= blobstoreService.createUploadUrl("/upload") %>" method="post" enctype="multipart/form-data">
        <input type="file" name="myFile">
        <input type="submit" value="Submit">
    </form>
</body>

请注意,这是作为 JSP 创建的上传表单的示例。

2. 创建上传表单

表单必须包含文件上传字段,并且表单的 enctype 必须设置为 multipart/form-data。当用户提交表单时,POST 由创建 blob 的 Blobstore API 处理。该 API 还会为 blob 创建信息记录,并将该记录存储在数据存储区中,然后将重写后的请求传递到应用中作为 blob 键的指定路径。

3. 实现上传处理程序

在此处理程序中,您可以将 blob 键与应用数据模型的其他部分存储在一起。Blob 键本身仍然可以通过数据存储区中的 blob 信息实体进行访问。请注意,用户提交表单并调用处理程序后,即已保存 blob,并且 blob 信息已添加到数据存储区中。如果您的应用不想保留 blob,您应立即删除 blob 以防止其成为孤立文件:

在以下代码中,getUploads 返回一组已上传的 blob。Map 对象是一个列表,它将上传字段的名称与其包含的 blob 相关联。

Map<String, List<BlobKey>> blobs = blobstoreService.getUploads(req);
List<BlobKey> blobKeys = blobs.get("myFile");

if (blobKeys == null || blobKeys.isEmpty()) {
    res.sendRedirect("/");
} else {
    res.sendRedirect("/serve?blob-key=" + blobKeys.get(0).getKeyString());
}

当 Blobstore 重写用户的请求时,上传文件的 MIME 部分将清空其正文,并且 blob 键会添加为 MIME 部分标头。所有其他表单字段和部分都会予以保留,并传递给上传处理程序。如果您没有指定内容类型,Blobstore 会尝试根据文件扩展名推断内容类型。如果无法确定内容类型,则会为新建的 blob 分配内容类型 application/octet-stream

传送 Blob

为了提供 blob,您必须以应用中路径的形式包含 blob 下载处理程序。此处理程序应该将所需 blob 的 blob 键传递给 blobstoreService.serve(blobKey, res);。在此示例中,blob 键会作为网址参数 (req.getParameter('blob-key')) 传递给下载处理程序。在实际操作中,下载处理程序可通过您选择的任意方式获取 blob 键,例如,通过其他方法或用户操作。

public void doGet(HttpServletRequest req, HttpServletResponse res)
    throws IOException {
        BlobKey blobKey = new BlobKey(req.getParameter("blob-key"));
        blobstoreService.serve(blobKey, res);

Blob 可以通过任何应用网址提供。要提供您应用中的 blob,您需要在包含 blob 键的响应中放置特殊标头。App Engine 会将响应正文替换为 blob 内容。

Blob 字节范围

在响应请求时,Blobstore 支持提供大型值的一部分,而不提供完整的值。要提供部分值,请将 X-AppEngine-BlobRange 标头包含在传出响应中。其值是标准的 HTTP 字节范围。字节编号从零开始。空白 X-AppEngine-BlobRange 指示 API 忽略范围标头,提供完整的 blob。示例范围包括:

  • 0-499 提供值的前 500 个字节(字节 0 到 499,含边界值)。
  • 500-999 提供从第 501 个字节开始的 500 个字节。
  • 500- 提供从第 501 个字节开始到值结束的所有字节。
  • -500 提供值的最后 500 个字节。

如果字节范围对 Blobstore 值有效,Blobstore 会向客户端发送 206 Partial Content 状态代码和所请求的字节范围。如果范围对该值无效,Blobstore 会发送 416 Requested Range Not Satisfiable

Blobstore 不支持单个请求中的多个字节范围(例如,100-199,200-299 ),不论字节范围是否重叠都是如此。

完整的示例应用

在以下示例应用中,应用的主网址会加载要求用户上传文件的表单,而且上传处理程序会立即调用下载处理程序来提供数据。这样做的目的是简化示例应用。在实际操作中,您可能不会使用主网址来请求上传数据,也不会立即提供您刚上传的 blob。

// file Upload.java

import java.io.IOException;
import java.util.List;
import java.util.Map;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.google.appengine.api.blobstore.BlobKey;
import com.google.appengine.api.blobstore.BlobstoreService;
import com.google.appengine.api.blobstore.BlobstoreServiceFactory;

public class Upload extends HttpServlet {
    private BlobstoreService blobstoreService = BlobstoreServiceFactory.getBlobstoreService();

    @Override
    public void doPost(HttpServletRequest req, HttpServletResponse res)
        throws ServletException, IOException {

        Map<String, List<BlobKey>> blobs = blobstoreService.getUploads(req);
        List<BlobKey> blobKeys = blobs.get("myFile");

        if (blobKeys == null || blobKeys.isEmpty()) {
            res.sendRedirect("/");
        } else {
            res.sendRedirect("/serve?blob-key=" + blobKeys.get(0).getKeyString());
        }
    }
}

// file Serve.java

import java.io.IOException;

import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.google.appengine.api.blobstore.BlobKey;
import com.google.appengine.api.blobstore.BlobstoreService;
import com.google.appengine.api.blobstore.BlobstoreServiceFactory;

public class Serve extends HttpServlet {
    private BlobstoreService blobstoreService = BlobstoreServiceFactory.getBlobstoreService();

    @Override
    public void doGet(HttpServletRequest req, HttpServletResponse res)
        throws IOException {
            BlobKey blobKey = new BlobKey(req.getParameter("blob-key"));
            blobstoreService.serve(blobKey, res);
        }
}

// file index.jsp

<%@ page import="com.google.appengine.api.blobstore.BlobstoreServiceFactory" %>
<%@ page import="com.google.appengine.api.blobstore.BlobstoreService" %>

<%
    BlobstoreService blobstoreService = BlobstoreServiceFactory.getBlobstoreService();
%>

<html>
    <head>
        <title>Upload Test</title>
    </head>
    <body>
        <form action="<%= blobstoreService.createUploadUrl("/upload") %>" method="post" enctype="multipart/form-data">
            <input type="text" name="foo">
            <input type="file" name="myFile">
            <input type="submit" value="Submit">
        </form>
    </body>
</html>

// web.xml

<?xml version="1.0" encoding="utf-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://java.sun.com/xml/ns/javaee"
   xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
   xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
   http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" version="2.5">

  <servlet>
    <servlet-name>Upload</servlet-name>
    <servlet-class>Upload</servlet-class>
  </servlet>

  <servlet>
    <servlet-name>Serve</servlet-name>
    <servlet-class>Serve</servlet-class>
  </servlet>

  <servlet-mapping>
    <servlet-name>Upload</servlet-name>
    <url-pattern>/upload</url-pattern>
  </servlet-mapping>

  <servlet-mapping>
    <servlet-name>Serve</servlet-name>
    <url-pattern>/serve</url-pattern>
  </servlet-mapping>

</web-app>

将图片服务与 Blobstore 结合使用

图片服务可以将 Blobstore 值作为转换的源数据。源图片的大小可以达到 Blobstore 值的大小上限。图片服务仍然将转换后的图片返回给应用,因此转换后的图片必须小于 32 兆字节。这对于针对用户上传的较大照片创建缩略图非常有用。

有关将图片服务与 Blobstore 值结合使用的信息,请参阅图片服务文档

将 Blobstore API 与 Google Cloud Storage 结合使用

您可以使用 Blobstore API 将 blob 存储到 Cloud Storage 中,而不是存储到 Blobstore 中。您需要按 Google Cloud Storage 文档中所述设置存储分区,还需要在 BlobstoreService createUploadUrl 中指定存储分区和文件名,并在 UploadOptions 参数中指定存储分区名称。在上传处理程序中,您需要处理返回的 FileInfo 元数据,并明确存储后续检索 Blob 所需的 Google Cloud Storage 文件名。

您还可以使用 Blobstore API 传送 Cloud Storage 对象。

以下代码段显示了如何执行此操作。此示例是用于获取请求中存储分区名称和对象名称的请求处理程序的一部分。它使用提供的存储分区和对象名称创建 Blobstore 服务,并使用该服务为 Google Cloud Storage 创建 Blob 键:

BlobstoreService blobstoreService = BlobstoreServiceFactory.getBlobstoreService();
BlobKey blobKey = blobstoreService.createGsBlobKey(
    "/gs/" + fileName.getBucketName() + "/" + fileName.getObjectName());
blobstoreService.serve(blobKey, resp);

配额和限制

Blobstore 值中的空格会占用存储的数据量(计费)配额。数据存储区中的 Blob 信息实体会计入数据存储区相关的限制。请注意,Google Cloud Storage 是付费使用服务;您需要按照 Cloud Storage 价格表支付费用。

如需详细了解系统范围的安全配额,请参阅配额

除系统范围的安全配额外,以下限制特别适用于 Blobstore 的使用:

  • 应用单次调用 API 可读取的 Blobstore 数据的大小上限为 32 兆字节。
  • 单个表单 POST 中可以上传的文件数量上限为 500。
此页内容是否有用?请给出您的反馈和评价:

发送以下问题的反馈:

此网页
Java 版 App Engine 标准环境