使用 Java 和 OAuth 2.0 连接到 Google 通讯录

Question

我在使用 OAuth 2.0 通过 Java 连接到 Google Contacts API 时遇到问题。经过大量搜索，我已经达到了可以连接的地步，但在最终过程中收到错误消息。

我做了以下事情：

1) 通过 Google 的开发者控制台为该项目创建了一个 OAuth 2.0 服务帐户。

2) 按照我在https://developers.google.com/identity/protocols/OAuth2ServiceAccount 找到的“将域范围内的权限委派给服务帐户”的步骤，我已将在上面步骤#1 中创建的服务帐户的客户端ID 授权给https://www.google.com/m8/feeds/ 的范围联系人（读/写）。

3) 这是我根据其他成员帖子的代码：

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.gdata.client.contacts.ContactsService;

import java.io.IOException;
import java.security.GeneralSecurityException;
import java.util.Arrays;

public class Connector {
private static ContactsService contactService = null;
private static HttpTransport httpTransport;

private static final String APPLICATION_NAME = "MyProject";
private static final String SERVICE_ACCOUNT_EMAIL = "service-account-email-address@developer.gserviceaccount.com";
private static final java.util.List<String> SCOPE = Arrays.asList("https://www.google.com/m8/feeds");

private Connector() {
    // explicit private no-args constructor
}

public static ContactsService getInstance() {
    if (contactService == null) {
        try {
            contactService = connect();
        } catch (GeneralSecurityException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    return contactService;
}

private static ContactsService connect() throws GeneralSecurityException, IOException {
    httpTransport = GoogleNetHttpTransport.newTrustedTransport();

    java.io.File p12File = new java.io.File("MyProject.p12");

    // @formatter:off
    GoogleCredential credential = new GoogleCredential.Builder()
                                                    .setTransport(httpTransport)
                                                    .setJsonFactory(JacksonFactory.getDefaultInstance())
                                                    .setServiceAccountId(SERVICE_ACCOUNT_EMAIL)
                                                    .setServiceAccountScopes(SCOPE)
                                                    .setServiceAccountPrivateKeyFromP12File(p12File)
                                                    .setServiceAccountUser("user@example.com")
                                                    .build();
    // @formatter:on

    if (!credential.refreshToken()) {
        throw new RuntimeException("Failed OAuth to refresh the token");
    }

    ContactsService myService = new ContactsService(APPLICATION_NAME);
    myService.setOAuth2Credentials(credential);

    return myService;
}
}

理论上，我相信这应该是可行的。但是，当执行 credential.refreshToken() 时，我收到错误：

com.google.api.client.auth.oauth2.TokenResponseException: 403 Forbidden
{
  "error" : "access_denied",
  "error_description" : "Requested client not authorized."
}

如果我删除 setServiceAccountUser("user@example.com")，我会收到错误消息 com.google.gdata.util。 ServiceForbiddenException：无法请求属于其他用户的联系人。我相信我需要保留 setServiceAccountUser(...) 但无法通过令牌响应异常。

我不确定从这里去哪里。

感谢您提供的任何建议或帮助。

Answer 1

对于任何感兴趣或遇到与我相同的问题的人，我遇到了这个link，它解决了这个问题。主要问题是我需要使用的范围末尾的“/”。它需要添加到我的代码中以匹配我为服务帐户 API 访问提供的范围。

我的最终代码：

HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
JsonFactory jsonFactory = JacksonFactory.getDefaultInstance();

String APPLICATION_NAME = "MyProject";
String SERVICE_ACCOUNT_EMAIL = "my-service-account@developer.gserviceaccount.com";
java.io.File p12File = new java.io.File("MyProject.p12");

GoogleCredential credential = new GoogleCredential.Builder()                                                                    
      .setTransport(httpTransport)                                                     
      .setJsonFactory(jsonFactory)                                                   
      .setServiceAccountId(SERVICE_ACCOUNT_EMAIL)   
      .setServiceAccountScopes(
            Collections.singleton("https://www.google.com/m8/feeds/"))                                                          
      .setServiceAccountPrivateKeyFromP12File(p12File)                                                  
      .setServiceAccountUser("user@example.com")
      .build();

if (!credential.refreshToken()) {
    throw new RuntimeException("Failed OAuth to refresh the token");
}

ContactsService service = new ContactsService(APPLICATION_NAME);
service.setOAuth2Credentials(credential);

Query gQuery = new Query(new java.net.URL("https://www.google.com/m8/feeds/groups/user@example.com/full"));
gQuery.setMaxResults(32767);
ContactGroupFeed groupFeed = service.query(gQuery, ContactGroupFeed.class);

for (ContactGroupEntry group : groupFeed.getEntries()) {
    System.out.println("group: " + group.getTitle().getPlainText());

    Query cQuery = new Query(new java.net.URL("https://www.google.com/m8/feeds/contacts/user@example.com/full"));
    cQuery.setMaxResults(32767);
    String grpId = group.getId();
    cQuery.setStringCustomParameter("group", grpId);
    ContactFeed feed = service.query(cQuery, ContactFeed.class);

    for (ContactEntry contact : feed.getEntries()) {
        System.out.println("name: " + contact.getTitle().getPlainText());
    }
}

Answer 2

您似乎正在使用来自 OAuth2 的授权码流程（阅读更多in this nice post）。

在这种情况下，在您已经执行的步骤（在 Google 控制台中注册您的应用 + 注册您的应用以访问联系人 API）之后，您的应用将需要：

1. 向用户提供授权 URL：用户将单击并授予您的应用读取所需数据的权限。
2. 授予用户权限后，您将收到authorization code。
3. 使用此authorization code，您将通过token 进行交换。
4. 现在，拿着token，调用Google Contacts API。

用户 Java 库

我的建议是使用流行的 Java 库来为您处理所有这些流程。

两个流行的库是：

• Google OAuth2 API Libraries for Java：专注于 Google OAuth2 API；

• Apache Oitu：Java 中的 OAuth/OAuth2 协议实现。它还涵盖了其他“OAuth 系列”相关的实现，例如 JWT、JWS 和 OpenID Connect。

两者都支持 Maven。

另一种可能的解决方案是使用广泛的地址簿服务，例如 CloudSponge.com，它提供 Java API 并支持其他流行来源，以防您计划的不仅仅是 Gmail。