开发者指南：Java

重要提示：这是此页面的旧版本。要查看最新版本，请使用左侧导航栏中的链接。

Blogger Data API 可让客户端应用以 Google Data API Feed 的形式查看和更新 Blogger 内容。

您的客户端应用可以使用 Blogger Data API 创建新的博文、修改或删除现有博文，以及查询符合特定条件的博文。

除了提供有关 Blogger Data API 功能的一些背景信息外，本文档还提供了使用 Java 客户端库进行基本 Data API 交互的示例。如果您有兴趣详细了解该库使用的基础协议，请参阅本开发者指南的“协议”部分。

目录

1. 观众群
2. 开始使用
   1. 创建 Blogger 账号
   2. 运行示例代码
3. 在 Blogger 服务中进行身份验证
   1. AuthSub 代理身份验证
   2. Dialogflow 用户名/密码身份验证
4. 检索博客列表
5. 创建帖子
   1. 发布博文
   2. 创建博文草稿
6. 检索帖子
   1. 检索所有博文
   2. 使用查询参数检索博文
7. 更新帖子
8. 删除帖子
9. 备注
   1. 创建评论
   2. 检索评论
   3. 删除评论

观众群

本文面向的是想要编写可与 Blogger 进行交互的 Java 客户端应用的程序员。

本文档假定您已了解 Google Data API 协议背后的一般概念。

如需了解客户端库提供的类和方法的参考信息，请参阅 Java 客户端库 API 参考文档。如需查看一般的 Blogger Data API 参考信息，请参阅协议参考指南。

使用入门

如需有关设置客户端库的帮助，请参阅入门指南。

Java 客户端库需要 Java 1.5。下载客户端库后，您就可以在 java/lib/gdataclient-1.0.jar 文件中找到开始工作所需的类。

创建 Blogger 账号

您可能需要注册 Blogger 账号才能进行测试。Blogger 使用的是 Google 帐号，因此，如果您已拥有 Google 帐号，就大功告成了。

运行示例代码

Java 客户端库发行版中的 gdata/java/sample/blogger/BloggerClient.java 目录下提供了一个完整运行的示例客户端，其中包含本文档中所示的所有示例代码。构建和执行说明包含在 README.txt 文件的同一目录中。

该示例客户端会对提供的博客执行多项操作，以演示如何使用 Blogger Data API。

如需将本文档中的示例编译到您自己的代码中，您需要以下 import 语句：

import com.google.gdata.client.*;
import com.google.gdata.data.*;
import com.google.gdata.util.*;
import java.io.IOException;
import java.net.URL;

在 Blogger 服务中进行身份验证

您可以使用 Blogger 数据 API 访问公开和私有 Feed。公开 Feed 不需要任何身份验证，但会处于只读状态。如果您想修改博客，您的客户端需要先进行身份验证，然后才能请求不公开 Feed。它可以使用以下两种方法之一进行身份验证：AuthSub 代理身份验证或 ClientLogin 用户名/密码身份验证。

如需全面详细地了解使用 Google Data API 进行身份验证的信息，请参阅身份验证文档。

本文档后续部分中的大多数示例都假定您拥有经过身份验证的 GoogleService 对象。

AuthSub 代理身份验证

需要向 Google 帐号验证用户身份的 Web 应用会使用 AuthSub 代理身份验证。网站运营商和客户端代码无权访问 Blogger 用户的用户名和密码；相反，客户端会获取特殊的 AuthSub 令牌，允许客户端代表特定用户执行操作。如需了解详情，请参阅 AuthSub 文档。

用户首次访问您的应用时，尚未通过身份验证。在这种情况下，您需要显示一些信息和一个链接，将用户定向到某个 Google 页面，以验证您对访问其博客的请求进行身份验证。Java 客户端库提供了一个生成 Google 网页网址的函数。以下代码会检索 AuthSubRequest 页面的网址：

String next = "http://www.example.com/welcome.html";
String scope = "http://www.blogger.com/feeds/";
boolean secure = false;
boolean session = true;
String authSubLogin = AuthSubUtil.getRequestUrl(next, scope, secure, session);

getRequestUrl 方法采用以下参数（与 AuthSubRequest 处理程序使用的查询参数对应）：

下一个

Google 应在完成身份验证后将用户重定向到的网页的网址。

范围

表示应用正在请求令牌以访问 Blogger Feed。使用的范围字符串是 http://www.blogger.com/feeds/（当然，是经过网址编码的）。

安全

指示客户端是否请求安全令牌。

session

指示返回的令牌是否可以交换为可多次使用的（会话）令牌。

上面的示例展示了一个未请求安全令牌（secure 的值为 false）的调用。生成的请求网址可能如下所示：

https://www.google.com/accounts/AuthSubRequest?scope=http%3A%2F%2Fwww.blogger.com%2Ffeeds%2F&session=1&secure=0&next=http%3A%2F%2Fwww.example.com%2Fwelcome.html

用户可通过链接访问 Google 网站，并对自己的 Google 帐号进行身份验证。

用户进行身份验证后，AuthSub 系统会将用户重定向到您在 AuthSub 请求网址的 next 查询参数中指定的网址。AuthSub 系统会在该网址上附加一个身份验证令牌，作为 token 查询参数的值。例如：

http://www.example.com/welcome.html?token=yourAuthToken

此令牌值代表一个单次使用的 AuthSub 令牌。在此示例中，由于指定了 session = true，因此可通过调用 AuthSubSessionToken 服务将此令牌交换为 AuthSub 会话令牌，如下所示，其中 urlFromAuthSub 是 AuthSub 将令牌附加到的网址：

String token = AuthSubUtil.getTokenFromReply(urlFromAuthSub);
String sessionToken = AuthSubUtil.exchangeForSessionToken(token, null);

也就是说，您将一次性令牌与 null（对于未注册模式）或私钥（对于注册模式）一起传递给 exchangeForSessionToken 方法，AuthSub 接口会返回一个会话令牌。如需详细了解已注册的应用和私钥，请参阅 AuthSub 文档的“对请求进行签名”部分。

然后，您的应用就可以在与 Blogger 的后续互动中使用会话令牌了。如需指示 Java 客户端库随每个请求自动发送会话令牌，请调用 GoogleService 对象的 setAuthSubToken 方法：

GoogleService.setAuthSubToken(sessionToken, null);

此后，客户端库会自动随每个请求发送令牌。

ClientLogin 用户名/密码身份验证

如果您的客户端是独立的单用户“已安装”客户端（例如桌面应用），请使用 ClientLogin 身份验证。只需在您的 GoogleService 对象上调用 setUserCredentials 方法，即可对与 Blogger 的所有后续互动进行身份验证：

GoogleService myService = new GoogleService("blogger", "exampleCo-exampleApp-1");
myService.setUserCredentials("[e-mail]", "secretPassword");

在上面的代码段中，我们将两个参数传递给 GoogleService 构造函数。第一个参数是我们要与之互动的服务的名称第二个参数是应用的名称，格式为 companyName-applicationName-versionID。

要详细了解 ClientLogin 身份验证（包括示例请求和响应），请参阅为已安装的应用进行身份验证文档。

注意：给定会话中的所有请求应使用相同的令牌；不要为每个 Blogger 请求获取新的令牌。

注意：如 ClientLogin 文档中所述，身份验证请求可能会失败并请求进行人机识别系统质询。如果您希望 Google 发出并处理人机识别系统质询，请将用户发送到 https://www.google.com/accounts/DisplayUnlockCaptcha?service=blogger（而不是 ClientLogin 文档中提供的人机识别系统处理网址）。

检索博客列表

Blogger 数据 API 提供了一个列出特定用户的博客的 Feed；该 Feed 称为“元 Feed”。

以下示例代码使用经过身份验证的 GoogleService 对象检索元 Feed，然后输出每个博客的标题。

public static void printUserBlogs(GoogleService myService)
    throws ServiceException, IOException {

  // Request the feed
  final URL feedUrl = new URL("http://www.blogger.com/feeds/default/blogs");
  Feed resultFeed = myService.getFeed(feedUrl, Feed.class);

  // Print the results
  System.out.println(resultFeed.getTitle().getPlainText());
  for (int i = 0; i < resultFeed.getEntries().size(); i++) {
    Entry entry = resultFeed.getEntries().get(i);
    System.out.println("\t" + entry.getTitle().getPlainText());
  }
}

请记下 getFeed 方法使用的网址。这是默认的元 Feed 网址；它会返回当前已验证用户的博客列表。如需访问其他用户的 Feed，您可以在元 Feed 网址中用用户的 ID 来代替 default。用户的 ID 是用户个人资料网址末尾的数字字符串。

创建帖子

使用 Blogger Data API，您可以创建和发布新的博客条目，以及创建条目的草稿。

注意：目前不支持为帖子设置自定义作者。所有新帖子都会显示为由当前经过身份验证的用户创建的。

发布博文

您可以使用 Java 客户端库发布新的博客条目。

首先，创建一个 Entry 对象来表示这篇博文。然后，您可以设置博文的标题、内容和其他属性。最后，使用 GoogleService 对象插入博文。以下示例展示了如何发布新博文：

public static Entry createPost(
    GoogleService myService, String blogID, String title,
    String content, String userName)
    throws ServiceException, IOException {
  // Create the entry to insert
  Entry myEntry = new Entry();
  myEntry.setTitle(new PlainTextConstruct(title));
  myEntry.setContent(new PlainTextConstruct(content));

  // Ask the service to insert the new entry
  URL postUrl = new URL("http://www.blogger.com/feeds/" + blogID + "/posts/default");
  return myService.insert(postUrl, myEntry);
}

insert 方法将服务的发布网址作为参数。然后，该方法会返回 Blogger 存储的条目。返回的条目就是您发送的条目，但它还包含 Blogger 添加的各种元素，例如博文 ID。

如果您的请求由于某种原因失败，Blogger 可能会返回其他状态代码。有关状态代码的信息，请参阅 Google Data API 协议参考文档。

创建博文草稿

草稿帖子的创建方式与公开帖子相同，但您需要设置 Entry 对象的 draft 属性。您可以添加突出显示的行，将上述博文作为草稿创建：

public static Entry createPost(GoogleService myService, String blogId,
    String title, String content, String userName,
    Boolean isDraft)
    throws ServiceException, IOException {
  // Create the entry to insert
  Entry myEntry = new Entry();
  myEntry.setTitle(new PlainTextConstruct(title));
  myEntry.setContent(new PlainTextConstruct(content));
  myEntry.setDraft(isDraft);

  // Ask the service to insert the new entry
  URL postUrl = new URL("http://www.blogger.com/feeds/" + blogID + "/posts/default");
  return myService.insert(postUrl, myEntry);
}

您可以检索现有的草稿博文，将草稿属性设置为 false，然后更新该博文，从而将其转换为已发布的博文草稿。我们将在后面两个部分中介绍如何检索和更新帖子。

检索帖子

以下部分介绍了如何检索博文列表（无论是否使用查询参数）。

您可以在不进行身份验证的情况下查询 Blogger 公开 Feed。因此，您无需调用 setUserCredentials 方法或执行 AuthSub 身份验证，即可检索公开博客中的博文。

检索所有博客帖子

如需检索用户的博文，请调用用于检索博客元 Feed 的相同 getFeed 方法，但这次要发送博文 Feed 网址：

public static void printAllPosts(
    GoogleService myService, String blogId)
    throws ServiceException, IOException {
  // Request the feed
  URL feedUrl = new URL("http://www.blogger.com/feeds/" + blogID + "/posts/default");
  Feed resultFeed = myService.getFeed(feedUrl, Feed.class);

  // Print the results
  System.out.println(resultFeed.getTitle().getPlainText());
  for (int i = 0; i < resultFeed.getEntries().size(); i++) {
    Entry entry = resultFeed.getEntries().get(i);
    System.out.println("\t" + entry.getTitle().getPlainText());
  }
  System.out.println();
}

使用查询参数检索博文

利用 Blogger Data API，您可以请求一组符合指定条件的条目，例如，请求在给定日期范围内发布或更新的博文。为此，您可以创建一个 Query 对象并将其传递给 GoogleService.getQuery 方法。

例如，如需发送日期范围查询，请使用 Query 对象的 setPublishedMin 和 setPublishedMax 方法。以下代码段会输出在给定开始时间和结束时间之间发布的每篇博文的标题：

public static void printDateRangeQueryResults(
    GoogleService myService, String blogId,
    DateTime startTime, DateTime endTime)
    throws ServiceException, IOException {
  // Create query and submit a request
  URL feedUrl = new URL("http://www.blogger.com/feeds/" + blogID + "/posts/default");
  Query myQuery = new Query(feedUrl);
  myQuery.setPublishedMin(startTime);
  myQuery.setPublishedMax(endTime);
  Feed resultFeed = myService.query(myQuery, Feed.class);

  // Print the results
  System.out.println(resultFeed.getTitle().getPlainText() +
      " posts between " + startTime + " and " + endTime);
  for (int i = 0; i < resultFeed.getEntries().size(); i++) {
    Entry entry = resultFeed.getEntries().get(i);
    System.out.println("\t" + entry.getTitle().getPlainText());
    System.out.println("\t" + entry.getUpdated().toStringRfc822());
  }
  System.out.println();
}

请注意，Query 对象是使用用于检索帖子的同一帖子 Feed 网址构建的。

Blogger Data API 支持以下 Query 方法：

addCategoryFilter

指定类别（也称为标签）以过滤 Feed 结果。例如，http://www.blogger.com/feeds/blogID/posts/default/-/Fritz/Laurie 会返回同时带有 Fritz 和 Laurie 标签的条目。

setMaxResults

设置要返回的最大条目数。

setPublishMin、setPublishMax

设置参赛作品发布日期。

setStartIndex

设置要检索的第一个结果的索引（从 1 开始，用于分页）。

setUpdatedMin、setUpdatedMax

设置条目更新日期的下限。除非 orderby 参数设置为 updated，否则系统会忽略这些查询参数。

注意：orderby 查询参数目前没有 setter 方法。不过，如果需要进行此设置，您仍然可以使用 Query.addCustomParameter() 方法。

如需详细了解查询参数，请参阅 Blogger Data API 参考指南和 Google Data API 参考指南。

正在更新帖子

如需更新现有博文，请先检索要更新的条目，对其进行修改，再使用 update 方法将其发送到 Blogger。以下代码段会修改博客条目的标题，并假设您已从服务器中检索到该条目。

public static Entry updatePostTitle(
    GoogleService myService, Entry entryToUpdate, String newTitle)
    throws ServiceException, IOException {
  entryToUpdate.setTitle(new PlainTextConstruct(newTitle));
  URL editUrl = new URL(entryToUpdate.getEditLink().getHref());
  return myService.update(editUrl, entryToUpdate);
}

上述代码会返回一个 Entry，其中包含整个更新后的博文。如需更新任何其他属性，只需在调用 update 之前在 Entry 对象中进行设置即可。

注意：目前不支持修改与帖子关联的作者数据。

正在删除帖子

如需删除某个博文，请将该博文的修改网址传递给 GoogleService 对象的 delete 方法，如下所示：

public static void deletePost(
    GoogleService myService, String editLinkHref)
    throws ServiceException, IOException {
  URL deleteUrl = new URL(editLinkHref);
  myService.delete(deleteUrl);
}

注释

Blogger Data API 允许创建、检索和删除评论。不支持更新注释（网页界面中也不支持更新）。

创建评论

如需发布评论，请创建一个 Entry 对象并按如下方式插入该对象：

public static Entry createComment(
    GoogleService myService, String blogID, String postId,
    String commentText)
    throws ServiceException, IOException {
  // Build the comment feed URI
  String commentsFeedUri = "http://www.blogger.com/feeds/" + blogID + "/" + postId + "/comments/default";
  URL feedUrl = new URL(commentsFeedUri);

  // Create a new entry for the comment and submit it to the GoogleService
  Entry myEntry = new Entry();
  myEntry.setContent(new PlainTextConstruct(commentText));
  return myService.insert(feedUrl, myEntry);
}

注意：目前，您只能在经过身份验证的用户所拥有的博客上发表评论。

注意：目前不支持为评论设置自定义作者。所有新评论都会显示为由当前经过身份验证的用户创建的。

正在检索评论

您可以从特定帖子的评论 Feed 网址检索该帖子的评论：

public static void printAllComments(
    GoogleService myService, String blogID, String postId)
    throws ServiceException, IOException {
  // Build comment feed URI and request comments on the specified post
  String commentsFeedUri = "http://www.blogger.com/feeds/" + blogID + "/" + postId + "/comments/default";
  URL feedUrl = new URL(commentsFeedUri);
  Feed resultFeed = myService.getFeed(feedUrl, Feed.class);

  // Display the results
  System.out.println(resultFeed.getTitle().getPlainText());
  for (int i = 0; i < resultFeed.getEntries().size(); i++) {
    Entry entry = resultFeed.getEntries().get(i);
    System.out.println("\t" +
        ((TextContent) entry.getContent()).getContent().getPlainText());
    System.out.println("\t" + entry.getUpdated().toStringRfc822());
  }
  System.out.println();
}

或者，您可以使用博客的评论 Feed 网址获取所有博文的评论：

http://www.blogger.com/feeds/blogID/comments/default

正在删除评论

如需删除某条评论，请将该评论的修改网址传递给 GoogleService 对象的 delete 方法，如下所示：

public static void deleteComment(GoogleService myService, String editLinkHref)
    throws ServiceException, IOException {
  URL deleteUrl = new URL(editLinkHref);
  myService.delete(deleteUrl);
}

返回页首