Java API自动化:获取Google OAuth 2.0访问令牌的正确姿势

夏丽吖_5914

夏丽吖_5914

2025-11-27

744人浏览

原创

Java API自动化:获取Google OAuth 2.0访问令牌的正确姿势

本文详细介绍了在java api自动化中获取google oauth 2.0访问令牌的正确方法。针对直接使用`googlecredentials.builder`获取令牌的常见误区,文章阐述了应采用google授权码流程(authorization code flow),通过加载客户端密钥、配置授权流并进行用户授权来获取包含访问令牌的`credential`对象。内容涵盖必要的maven依赖、示例代码及最佳实践,旨在帮助开发者高效安全地实现google服务集成。

理解Google OAuth 2.0授权流程

在进行API自动化时,尤其当需要访问受用户保护的Google资源(如Gmail、Calendar等)时,直接通过客户端ID和密钥构造GoogleCredentials并不能直接获取可用的访问令牌。这是因为GoogleCredentials.Builder主要用于服务账户(Service Account)授权或需要直接交换刷新令牌的场景,而不适用于需要用户交互授权的OAuth 2.0授权码流程(Authorization Code Flow)。

正确的做法是遵循OAuth 2.0标准,引导用户完成授权过程,从而获得一个授权码,再用此授权码交换访问令牌和刷新令牌。对于Java应用程序,Google提供了相应的客户端库来简化这一过程。

必要的Maven依赖

为了实现Google OAuth 2.0授权码流程,我们需要引入以下Maven依赖:

<dependencies><!-- Google HTTP Client Library for Java --><dependency><groupid>com.google.api-client</groupid><artifactid>google-api-client</artifactid><version>1.30.10</version></dependency><!-- Google OAuth Client Library for Java --><dependency><groupid>com.google.oauth-client</groupid><artifactid>google-oauth-client</artifactid><version>1.30.6</version></dependency><!-- Google OAuth Client Library for Java (Jetty for local server receiver) --><dependency><groupid>com.google.oauth-client</groupid><artifactid>google-oauth-client-jetty</artifactid><version>1.30.6</version></dependency><!-- Jackson 2 for JSON parsing --><dependency><groupid>com.google.api-client</groupid><artifactid>google-api-client-jackson2</artifactid><version>1.30.10</version></dependency><!-- Optional: If you need specific Google API services, e.g., Calendar --><!-- <dependency>
        <groupId>com.google.apis</groupId>
        <artifactId>google-api-services-calendar</artifactId>
        <version>v3-rev20230628-2.0.0</version>
    </dependency> --></dependencies>

注意: 依赖版本应保持兼容性,建议查阅Google官方文档获取最新推荐版本。google-auth-library-oauth2-http通常用于服务账户或更底层的凭据管理,在用户授权流程中并非必需,因此在上述依赖中已移除。

实现Google授权码流程

获取Google访问令牌的核心在于构建GoogleAuthorizationCodeFlow并执行授权。以下是详细步骤及示例代码:

1. 准备客户端密钥

出于安全考虑和代码整洁性,强烈建议将客户端ID和客户端密钥存储在一个独立的JSON文件中,而不是硬编码在源代码中。这个文件通常命名为client_secrets.json,并放置在项目的资源目录下。

Java开发手册免费版
Java开发手册免费版

Java 开发规约速查手册,覆盖命名、异常、并发、数据库等 7 大维度核心规范。

下载

src/main/resources/client_secrets.json 示例:

{
  "web": {
    "client_id": "YOUR_CLIENT_ID.apps.googleusercontent.com",
    "project_id": "your-project-id",
    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
    "token_uri": "https://oauth2.googleapis.com/token",
    "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
    "client_secret": "YOUR_CLIENT_SECRET",
    "redirect_uris": [
      "http://localhost:8888/Callback"
    ],
    "javascript_origins": [
      "http://localhost:8888"
    ]
  }
}

重要提示:

  • client_id 和 client_secret 需要从Google Cloud Console中创建OAuth 2.0客户端ID凭据获得。
  • redirect_uris 是Google授权服务器在用户完成授权后重定向回应用程序的URL。对于桌面应用程序,通常使用http://localhost:port,并由LocalServerReceiver捕获。对于Web应用程序,应填写实际的回调URL。

2. 构建授权流程并获取凭据

以下Java代码演示了如何使用GoogleAuthorizationCodeFlow来获取用户授权并获得Credential对象:

package com.example.googleauth;

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.client.util.store.FileDataStoreFactory;

import java.io.File;
import java.io.IOException;
import java.io.InputStreamReader;
import java.security.GeneralSecurityException;
import java.util.Collections;
import java.util.List;

public class GoogleTokenGenerator {

    /** 应用程序名称,用于标识用户代理。 */
    private static final String APPLICATION_NAME = "Google API Automation Tool";

    /** JSON工厂,用于解析JSON。 */
    private static final JsonFactory JSON_FACTORY = JacksonFactory.getDefaultInstance();

    /** HTTP传输,用于所有API请求。 */
    private static HttpTransport HTTP_TRANSPORT;

    /** 存储用户凭据的目录。 */
    private static final File DATA_STORE_DIR = new File(System.getProperty("user.home"), ".credentials/google-api-automation");

    /** 数据存储工厂。 */
    private static FileDataStoreFactory DATA_STORE_FACTORY;

    static {
        try {
            HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
            DATA_STORE_FACTORY = new FileDataStoreFactory(DATA_STORE_DIR);
        } catch (GeneralSecurityException | IOException e) {
            System.err.println("Error initializing HTTP transport or data store: " + e.getMessage());
            System.exit(1);
        }
    }

    /**
     * 授权已安装的应用程序访问用户的受保护数据。
     * @param scopes 应用程序请求的OAuth范围。
     * @return 包含访问令牌和刷新令牌的凭据对象。
     * @throws IOException 如果加载客户端密钥或授权过程中发生I/O错误。
     * @throws GeneralSecurityException 如果HTTP传输初始化失败。
     */
    public static Credential authorize(List<string> scopes) throws IOException, GeneralSecurityException {
        // 1. 加载客户端密钥
        // 从资源文件 client_secrets.json 加载客户端ID和客户端密钥
        GoogleClientSecrets clientSecrets = GoogleClientSecrets.load(
                JSON_FACTORY,
                new InputStreamReader(GoogleTokenGenerator.class.getResourceAsStream("/client_secrets.json")));

        // 2. 设置授权码流程
        GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow.Builder(
                HTTP_TRANSPORT,
                JSON_FACTORY,
                clientSecrets,
                scopes) // 指定应用程序请求的权限范围
                .setDataStoreFactory(DATA_STORE_FACTORY) // 存储用户凭据,以便下次无需重新授权
                .setAccessType("offline") // 请求刷新令牌
                .build();

        // 3. 执行授权
        // 对于桌面应用程序,使用LocalServerReceiver在本地启动一个服务器来接收授权回调
        // 授权成功后,凭据将被存储在DATA_STORE_DIR指定的目录下
        LocalServerReceiver receiver = new LocalServerReceiver.Builder().setPort(8888).build();
        return new AuthorizationCodeInstalledApp(flow, receiver).authorize("user");
    }

    public static void main(String[] args) {
        try {
            // 定义所需的权限范围,例如访问用户的日历
            // 更多范围请参考:https://developers.google.com/identity/protocols/oauth2/scopes
            List<string> scopes = Collections.singletonList("https://www.googleapis.com/auth/calendar.readonly");

            // 执行授权,获取凭据
            Credential credential = authorize(scopes);

            // 检查凭据是否成功获取
            if (credential != null && credential.getAccessToken() != null) {
                System.out.println("成功获取Google访问令牌。");
                System.out.println("Access Token: " + credential.getAccessToken());

                // 如果需要,可以获取刷新令牌
                if (credential.getRefreshToken() != null) {
                    System.out.println("Refresh Token: " + credential.getRefreshToken());
                } else {
                    System.out.println("未获取到刷新令牌。请确保授权时设置了'offline'访问类型。");
                }

                // 使用凭据进行API调用...
                // 例如:
                // Calendar service = new Calendar.Builder(HTTP_TRANSPORT, JSON_FACTORY, credential)
                //     .setApplicationName(APPLICATION_NAME)
                //     .build();
                // EventList events = service.events().list("primary").execute();
                // System.out.println("Upcoming events: " + events.getItems().size());

            } else {
                System.out.println("未能获取到Google访问令牌。");
            }
        } catch (IOException | GeneralSecurityException e) {
            System.err.println("授权过程中发生错误: " + e.getMessage());
            e.printStackTrace();
        }
    }
}</string></string>

代码解析:

  1. APPLICATION_NAME: 应用程序的名称,用于Google的API监控和用户代理标识。
  2. JSON_FACTORY: 使用JacksonFactory来处理JSON数据。
  3. HTTP_TRANSPORT: 使用GoogleNetHttpTransport创建安全的HTTP传输层。
  4. DATA_STORE_DIR 和 DATA_STORE_FACTORY: 这些用于存储用户授权后获得的凭据(包括访问令牌和刷新令牌)。当用户首次授权后,凭据会被存储在本地文件系统中,后续运行时,如果凭据未过期,应用程序可以直接从这里加载,无需用户再次授权。
  5. authorize(List scopes) 方法:
    • 加载客户端密钥: GoogleClientSecrets.load() 方法从client_secrets.json文件中读取客户端ID和密钥。
    • 构建授权码流程: GoogleAuthorizationCodeFlow.Builder 用于配置授权流程。
      • HTTP_TRANSPORT 和 JSON_FACTORY:HTTP传输和JSON解析器。
      • clientSecrets:从JSON文件加载的客户端密钥。
      • scopes:指定应用程序请求的Google API权限范围(例如,https://www.googleapis.com/auth/calendar.readonly)。
      • setDataStoreFactory():设置凭据存储,使得刷新令牌可以被保存和复用。
      • setAccessType("offline"):关键步骤,请求一个刷新令牌。如果没有这个设置,通常只能获得一个短期的访问令牌,一旦过期就需要用户重新授权。
    • 执行授权: AuthorizationCodeInstalledApp 是一个用于已安装应用程序的辅助类。它会:
      • 在本地启动一个HTTP服务器(通过LocalServerReceiver,默认端口8888)。
      • 打开用户的浏览器,导航到Google授权页面。
      • 用户在浏览器中完成授权后,Google会将授权码重定向到本地服务器。
      • AuthorizationCodeInstalledApp 捕获授权码,并使用它向Google交换访问令牌和刷新令牌,然后返回一个Credential对象。
  6. main 方法: 演示如何调用authorize方法,并打印获得的访问令牌和刷新令牌。

注意事项与最佳实践

  • OAuth 2.0 范围 (Scopes):仔细选择您的应用程序所需的权限范围。请求不必要的权限可能会降低用户授权的意愿。
  • 刷新令牌 (Refresh Token):通过setAccessType("offline")获取的刷新令牌可以用来在访问令牌过期后,无需用户再次交互即可获取新的访问令牌。GoogleAuthorizationCodeFlow和Credential对象会负责自动刷新。
  • 凭据存储 (Data Store):FileDataStoreFactory将凭据存储在用户主目录下的特定文件夹中。在生产环境中,可能需要更安全的存储方式,例如加密存储或数据库存储。
  • Web 应用程序:如果您的应用程序是Web应用,则LocalServerReceiver不适用。您需要配置一个实际的重定向URI,并在您的Web应用程序中实现一个回调端点来处理Google的授权响应。
  • 错误处理:在实际应用中,需要对IOException和GeneralSecurityException等异常进行更健壮的处理,例如提供用户友好的错误消息或日志记录。
  • Google Cloud Console配置:确保在Google Cloud Console中创建的OAuth 2.0客户端ID类型正确(例如,“桌面应用”或“Web应用”),并且重定向URI与您代码中的配置一致。

总结

通过遵循Google OAuth 2.0授权码流程,并利用Google Java客户端库提供的GoogleAuthorizationCodeFlow,开发者可以安全、高效地在Java API自动化项目中获取和管理Google访问令牌。避免直接使用不适合用户授权场景的API,理解并正确配置授权流程是成功的关键。同时,遵循将客户端密钥外部化、合理管理权限范围和凭据存储等最佳实践,能够显著提升应用程序的安全性和可维护性。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

2375

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

3942

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

1296

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

4579

7

Java Maven专题
Java Maven专题

本专题聚焦 Java 主流构建工具 Maven 的学习与应用,系统讲解项目结构、依赖管理、插件使用、生命周期与多模块项目配置。通过企业管理系统、Web 应用与微服务项目实战,帮助学员全面掌握 Maven 在 Java 项目构建与团队协作中的核心技能。

2025.09.15

4840

19

Java Maven/Gradle 构建与依赖管理合集
Java Maven/Gradle 构建与依赖管理合集

系统讲解 Java 项目构建工具的使用与进阶配置,涵盖 Maven 的 POM 文件结构、生命周期(clean/compile/package/install/deploy)与插件机制、依赖范围(compile/provided/test/runtime)与传递依赖管理、多模块聚合与继承、私有 Nexus 仓库发布,以及 Gradle 的 Groovy / Kotlin DSL 语法、Task 自定义与增量构建、依赖版本目录(Versi

2026.05.09

409

25

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.02

7679

3

java中calendar类的用法
java中calendar类的用法

Java Video类是JavaFX库中的一个类,用于创建和操作视频对象。它提供了方法来加载、播放、暂停、停止和控制视频的音量、速度和循环等属性。想了解更多Java中类的相关内容,可以阅读本专题下面的文章。

2024.02.29

1975

7

登录token无效
登录token无效

登录token无效解决方法:1、检查token的有效期限,如果token已经过期,需要重新获取一个新的token;2、检查token的签名,如果签名不正确,需要重新获取一个新的token;3、检查密钥的正确性,如果密钥不正确,需要重新获取一个新的token;4、使用HTTPS协议传输token,建议使用HTTPS协议进行传输 ;5、使用双因素认证,双因素认证可以提高账户的安全性。

2023.09.14

15746

6

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.6万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.8万人学习