通过 Java 轻松访问 Google API
![](https://developers.google.cn/static/api-client-library/java/images/banner-java-3.png?authuser=6&%3Bhl=uk&hl=uk)
适用于 Java 的 Google API 客户端库提供所有 Google API 通用的功能,例如 HTTP 传输、错误处理、身份验证、JSON 解析、媒体下载/上传和批处理。该库包含一个强大的 OAuth 2.0 库,它具有一致的界面;轻量级且高效的 XML 和 JSON 数据模型(支持任何数据架构);以及对协议缓冲区的支持。
要使用 Google 的 Java 版客户端库调用 Google API,您需要为要访问的 Google API 生成 Java 库。这些生成的库包含核心 google-api-java-client 库以及特定于 API 的信息(如根网址)。这些 API 还包含在 API 上下文中表示实体且有助于在 JSON 对象和 Java 对象之间进行转换的类。
要使用 Google 的 Java 版客户端库调用 Google API,您需要为要访问的 Google API 生成 Java 库。这些生成的库包含核心 google-api-java-client 库以及特定于 API 的信息(如根网址)。这些 API 还包含在 API 上下文中表示实体且有助于在 JSON 对象和 Java 对象之间进行转换的类。
Java 版 Google API 客户端库的亮点
调用 Google API 非常简单
您可以通过适用于 Java 的 Google API 客户端库,使用 Google 服务生成的专用库来调用 Google API。(要查找为 Google API 生成的客户端库,请参阅支持的 Google API 列表。)下例使用 Java 版 Calendar API 客户端库调用 Google 日历 API:
// Show events on user's calendar. View.header("Show Calendars"); CalendarList feed = client.calendarList().list().execute(); View.display(feed);
该库简化了批量处理和媒体上传/下载操作
该库提供了用于批处理、媒体上传和媒体下载的辅助程序类。此库简化了身份验证
该库包含一个功能强大的身份验证库,可减少处理 OAuth 2.0 所需的代码量。有时,只需要几行就可以了。例如:
/** Authorizes the installed application to access user's protected data. */ private static Credential authorize() throws Exception { // load client secrets GoogleClientSecrets clientSecrets = GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(CalendarSample.class.getResourceAsStream("/client_secrets.json"))); // set up authorization code flow GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow.Builder( httpTransport, JSON_FACTORY, clientSecrets, Collections.singleton(CalendarScopes.CALENDAR)).setDataStoreFactory(dataStoreFactory) .build(); // authorize return new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user"); }
该库在 Google App Engine 上运行
App Engine 专用帮助程序可快速处理经过身份验证的 API 调用,而无需担心用代码交换令牌。
例如:
例如:
@Override protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException { AppIdentityCredential credential = new AppIdentityCredential(Arrays.asList(UrlshortenerScopes.URLSHORTENER)); Urlshortener shortener = new Urlshortener.Builder(new UrlFetchTransport(), new JacksonFactory(), credential) .build(); UrlHistory history = shortener.URL().list().execute(); ... }
该库可在 Android 4.4 或更高版本上运行。
适用于 Java 的 Google 客户端库专用 Android 帮助程序类已与 Android AccountManager 充分集成。例如:
@Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); // Google Accounts credential = GoogleAccountCredential.usingOAuth2(this, Collections.singleton(TasksScopes.TASKS)); SharedPreferences settings = getPreferences(Context.MODE_PRIVATE); credential.setSelectedAccountName(settings.getString(PREF_ACCOUNT_NAME, null)); // Tasks client service = new com.google.api.services.tasks.Tasks.Builder(httpTransport, jsonFactory, credential) .setApplicationName("Google-TasksAndroidSample/1.0").build(); }
安装简单
如果您未使用生成的库,则可以直接从下载页面下载适用于 Java 的 Google API 客户端库的二进制文件,也可以使用 Maven 或 Gradle。如需使用 Maven,请将以下行添加到 pom.xml 文件中:
如需使用 Gradle,请将以下代码行添加到 build.gradle 文件中:
<project> <dependencies> <dependency> <groupId>com.google.api-client</groupId> <artifactId>google-api-client</artifactId> <version>1.32.1</version> </dependency> </dependencies> </project>
如需使用 Gradle,请将以下代码行添加到 build.gradle 文件中:
repositories { mavenCentral() } dependencies { compile 'com.google.api-client:google-api-client:1.32.1' }如需详细了解如何安装和设置 Java 版 Google API 客户端库,请参阅下载和设置说明。
受支持的环境
适用于 Java 的 Google API 客户端库支持以下 Java 环境:
- Java 7 或更高版本、标准 (SE) 和企业 (EE)。
- Google App Engine。
- Android 4.4 或更高版本 - 但如果所需的 Google 服务有可用的 Google Play 服务库,请使用该库,而不是该库。Google Play 库将为您提供最佳的性能和体验。