
google drive api的认证基于oauth 2.0协议,这是一种开放标准,允许第三方应用程序在不获取用户密码的情况下,安全地访问用户在服务提供商(如google)上的资源。在自动化场景中,理解访问令牌(access token)和刷新令牌(refresh token)的区别至关重要。
标准的OAuth 2.0授权流程如下:
为了实现自动化,我们需要在首次认证时获取并持久化存储刷新令牌。这要求在OAuth流程中进行特定的配置。
在使用Google API Client Library for PHP时,以下两个配置项至关重要:
以下代码片段展示了如何在PHP中进行初始认证,获取并存储刷新令牌。我们通常将认证逻辑分离为两个部分:一个用于发起认证请求,另一个用于处理回调并保存令牌。
立即学习“PHP免费学习笔记(深入)”;
auth_init.php (发起认证请求)
<?php
require_once __DIR__ . '/vendor/autoload.php';
session_start();
$client = new Google_Client();
$client->setApplicationName('Google Drive API PHP Quickstart');
// 设置回调URI,必须与Google Cloud Console中配置的授权重定向URI一致
$client->setRedirectUri('http://localhost/auth_callback.php');
$client->setScopes(Google_Service_Drive::DRIVE);
// 加载您的凭据文件 (client_secret.json)
$client->setAuthConfig('credentials.json');
// 关键:请求刷新令牌
$client->setAccessType('offline');
// 关键:强制用户选择账户并同意授权,以确保获取刷新令牌
$client->setPrompt('select_account consent');
// 如果有授权码,处理回调
if (isset($_GET['code'])) {
$client->authenticate($_GET['code']);
$accessToken = $client->getAccessToken();
// 检查是否包含刷新令牌
if (isset($accessToken['refresh_token'])) {
// 将完整的访问令牌数组(包含refresh_token)保存到文件
file_put_contents('token.json', json_encode($accessToken));
echo "认证成功,刷新令牌已保存。";
} else {
echo "认证成功,但未获取到刷新令牌。请确保 setAccessType('offline') 和 setPrompt('consent') 已设置。";
}
// 重定向以清除URL中的授权码
$redirect = 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'];
header('Location: ' . filter_var($redirect, FILTER_SANITIZE_URL));
exit();
}
// 如果没有有效的访问令牌,则显示认证链接
if (!$client->getAccessToken()) {
$authUrl = $client->createAuthUrl();
echo "<a href='$authUrl'>点击此处进行Google账户授权</a>";
} else {
// 如果已经有访问令牌(例如,从token.json加载的),则显示已认证信息
// 实际项目中,这里通常是业务逻辑的入口
echo "您已认证成功。";
// 示例:显示当前令牌信息
$token = json_decode(file_get_contents('token.json'), true);
echo "<pre>";
print_r($token);
echo "</pre>";
}
?>auth_callback.php (处理回调)
通常,auth_init.php 已经包含了处理回调的逻辑,通过 setRedirectUri 指向自身,或者指向一个专门的回调处理页面。如果您的回调URI指向一个单独的文件(如原始问题中的callback.php),其核心逻辑应是接收code参数,然后用它来交换令牌并保存。
<?php
// auth_callback.php (如果需要单独的回调文件)
require_once __DIR__ . '/vendor/autoload.php';
$client = new Google_Client();
$client->setApplicationName('Google Drive API PHP Quickstart');
$client->setRedirectUri('http://localhost/auth_callback.php'); // 必须与发起认证的URI一致
$client->setScopes(Google_Service_Drive::DRIVE);
$client->setAuthConfig('credentials.json');
$client->setAccessType('offline');
$client->setPrompt('select_account consent');
if (isset($_GET['code'])) {
$authCode = $_GET['code'];
try {
// 使用授权码交换访问令牌和刷新令牌
$accessToken = $client->fetchAccessTokenWithAuthCode($authCode);
// 验证是否获取到刷新令牌
if (isset($accessToken['refresh_token'])) {
// 将完整的令牌信息(包括刷新令牌)保存到持久存储
// 建议保存为JSON格式,包含access_token, expires_in, refresh_token, created等
file_put_contents('token.json', json_encode($accessToken));
echo "认证成功,刷新令牌已保存到 token.json。";
} else {
echo "认证成功,但未获取到刷新令牌。请检查Google Cloud Console配置和 setAccessType('offline') 设置。";
}
// 可选:重定向到主应用页面,清除URL中的授权码
header('Location: http://localhost/your_main_app_page.php');
exit();
} catch (Exception $e) {
echo "认证失败: " . $e->getMessage();
}
} else {
echo "未接收到授权码。";
}
?>持久化存储刷新令牌
在上述代码中,我们使用 file_put_contents('token.json', json_encode($accessToken)); 将完整的$accessToken数组保存到token.json文件。这个数组通常包含access_token、expires_in、refresh_token和created等信息。refresh_token是我们需要长期保存的关键。
一旦刷新令牌被保存,您的自动化程序就可以在无人干预的情况下,使用它来获取新的访问令牌。
以下是一个模拟自动化文件上传的PHP脚本,它会尝试从token.json加载令牌,并在必要时使用刷新令牌获取新的访问令牌。
<?php
require_once __DIR__ . '/vendor/autoload.php';
$client = new Google_Client();
$client->setApplicationName('Google Drive API PHP Quickstart');
// 这里不需要设置 RedirectUri 或 Scopes,因为我们不进行新的用户授权流程
$client->setAuthConfig('credentials.json');
$tokenPath = 'token.json'; // 存储令牌的文件路径
try {
// 1. 尝试从文件加载已保存的令牌
if (file_exists($tokenPath)) {
$accessToken = json_decode(file_get_contents($tokenPath), true);
$client->setAccessToken($accessToken);
} else {
throw new Exception("令牌文件 '{$tokenPath}' 不存在。请先进行初始认证。");
}
// 2. 检查访问令牌是否过期,如果过期则使用刷新令牌获取新令牌
if ($client->isAccessTokenExpired()) {
if (isset($accessToken['refresh_token'])) {
echo "访问令牌已过期,正在尝试使用刷新令牌获取新令牌...\n";
$client->fetchAccessTokenWithRefreshToken($accessToken['refresh_token']);
// 获取新令牌后,更新本地存储的令牌文件,确保包含最新的访问令牌和刷新令牌(如果刷新时也更新了)
file_put_contents($tokenPath, json_encode($client->getAccessToken()));
echo "新访问令牌已获取并保存。\n";
} else {
throw new Exception("访问令牌已过期,但未找到刷新令牌。需要重新进行用户认证。");
}
}
// 3. 确保客户端已设置有效的访问令牌
if (!$client->getAccessToken()) {
throw new Exception("无法获取有效的访问令牌。");
}
// 4. 执行Google Drive API操作(例如:上传文件)
$service = new Google_Service_Drive($client);
$fileMetadata = new Google_Service_Drive_DriveFile([
'name' => 'My Automated Upload.txt',
'parents' => ['YOUR_FOLDER_ID'] // 可选:指定上传到的文件夹ID
]);
$content = "This is a test file uploaded automatically on " . date('Y-m-d H:i:s');
$mimeType = 'text/plain';
$file = $service->files->create($fileMetadata, [
'data' => $content,
'mimeType' => $mimeType,
'uploadType' => 'multipart'
]);
printf("文件 '%s' (ID: %s) 已成功上传。\n", $file->getName(), $file->getId());
} catch (Exception $e) {
echo "操作失败: " . $e->getMessage() . "\n";
echo "请确保 'credentials.json' 正确配置,且已执行初始认证并保存了 'token.json'。\n";
}
?>注意事项:
通过正确理解并利用Google OAuth 2.0的刷新令牌机制,您可以为您的Google Drive自动化项目构建一个稳定、无需人工干预的认证流程。关键在于在初始授权时请求并持久化存储刷新令牌,并在后续操作中利用它来自动刷新访问令牌。遵循本文提供的代码示例和注意事项,将帮助您实现高效可靠的Google Drive API集成。
以上就是Google Drive API PHP自动化:实现长期无感认证与文件上传的详细内容,更多请关注php中文网其它相关文章!
PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号