Hướng dẫn bắt đầu nhanh về Java

Phần bắt đầu nhanh giải thích cách thiết lập và chạy một ứng dụng gọi API Google Workspace.

Các hướng dẫn nhanh về Google Workspace sử dụng thư viện ứng dụng API để xử lý một số thông tin chi tiết về quy trình xác thực và uỷ quyền. Bạn nên sử dụng thư viện ứng dụng cho các ứng dụng của riêng mình. Phần bắt đầu nhanh này sử dụng phương pháp xác thực đơn giản phù hợp với môi trường thử nghiệm. Đối với môi trường phát hành công khai, bạn nên tìm hiểu về quy trình xác thực và uỷ quyền trước khi chọn thông tin xác thực truy cập phù hợp với ứng dụng của mình.

Tạo một ứng dụng dòng lệnh Java để gửi yêu cầu đến Directory API.

Mục tiêu

• Thiết lập môi trường.
• Thiết lập mẫu.
• Chạy mẫu.

Điều kiện tiên quyết

• Java 1.8 trở lên.
• Gradle 7.0 trở lên.
• Một dự án trên Google Cloud.

• Một miền Google Workspace đã bật quyền truy cập API.
• Một Tài khoản Google trong miền đó có đặc quyền quản trị.

Thiết lập môi trường

Để hoàn tất hướng dẫn nhanh này, hãy thiết lập môi trường của bạn.

Bật API

Trước khi sử dụng API của Google, bạn cần bật các API đó trong một dự án Google Cloud. Bạn có thể bật một hoặc nhiều API trong một dự án Google Cloud.

• Trong Google Cloud Console, hãy bật Directory API.

  Bật API

Định cấu hình màn hình xin phép bằng OAuth

Nếu bạn đang sử dụng một dự án Google Cloud mới để hoàn tất hướng dẫn nhanh này, hãy định cấu hình màn hình đồng ý OAuth và thêm chính bạn làm người dùng thử nghiệm. Nếu bạn đã hoàn tất bước này cho dự án trên Cloud, hãy chuyển sang phần tiếp theo.

1. Trong Google Cloud Console, hãy chuyển đến Trình đơn > API và dịch vụ > Màn hình đồng ý OAuth.

   Chuyển đến màn hình xin phép bằng OAuth

2. Đối với Loại người dùng, hãy chọn Nội bộ, sau đó nhấp vào Tạo.
3. Hoàn tất biểu mẫu đăng ký ứng dụng, sau đó nhấp vào Lưu và tiếp tục.

4. Hiện tại, bạn có thể bỏ qua bước thêm phạm vi và nhấp vào Lưu và tiếp tục. Trong tương lai, khi tạo một ứng dụng để sử dụng bên ngoài tổ chức Google Workspace, bạn phải thay đổi Loại người dùng thành Bên ngoài, sau đó thêm các phạm vi uỷ quyền mà ứng dụng của bạn yêu cầu.

5. Xem lại thông tin tóm tắt về việc đăng ký ứng dụng. Để chỉnh sửa, hãy nhấp vào Chỉnh sửa. Nếu quá trình đăng ký ứng dụng có vẻ ổn, hãy nhấp vào Quay lại trang tổng quan.

Uỷ quyền thông tin xác thực cho ứng dụng trên máy tính

Để xác thực người dùng cuối và truy cập vào dữ liệu người dùng trong ứng dụng, bạn cần tạo một hoặc nhiều mã ứng dụng khách OAuth 2.0. Mã ứng dụng khách được dùng để xác định một ứng dụng với máy chủ OAuth của Google. Nếu ứng dụng của bạn chạy trên nhiều nền tảng, bạn phải tạo một mã ứng dụng riêng cho mỗi nền tảng.

1. Trong Google Cloud Console, hãy chuyển đến Trình đơn > API và dịch vụ > Thông tin xác thực.

   Chuyển đến phần Thông tin xác thực

2. Nhấp vào Tạo thông tin xác thực > Mã ứng dụng OAuth.
3. Nhấp vào Loại ứng dụng > Ứng dụng dành cho máy tính.
4. Trong trường Name (Tên), hãy nhập tên cho thông tin xác thực. Tên này chỉ xuất hiện trong Google Cloud Console.
5. Nhấp vào Tạo. Màn hình ứng dụng khách OAuth đã tạo sẽ xuất hiện, hiển thị Mã ứng dụng khách và Mã xác thực ứng dụng khách mới.
6. Nhấp vào OK. Thông tin xác thực mới tạo sẽ xuất hiện trong phần Mã ứng dụng khách OAuth 2.0.
7. Lưu tệp JSON đã tải xuống dưới dạng credentials.json và di chuyển tệp đó vào thư mục đang hoạt động.

Chuẩn bị không gian làm việc

1. Trong thư mục đang hoạt động, hãy tạo một cấu trúc dự án mới:

   gradle init --type basic
   mkdir -p src/main/java src/main/resources 
   

2. Trong thư mục src/main/resources/, hãy sao chép tệp credentials.json mà bạn đã tải xuống trước đó.

3. Mở tệp build.gradle mặc định rồi thay thế nội dung của tệp đó bằng mã sau:

   adminSDK/directory/quickstart/build.gradle

   Xem trên GitHub
   apply plugin: 'java'
   apply plugin: 'application'
   
   mainClassName = 'AdminSDKDirectoryQuickstart'
   sourceCompatibility = 11
   targetCompatibility = 11
   version = '1.0'
   
   repositories {
       mavenCentral()
   }
   
   dependencies {
       implementation 'com.google.api-client:google-api-client:2.0.0'
       implementation 'com.google.oauth-client:google-oauth-client-jetty:1.34.1'
       implementation 'com.google.apis:google-api-services-admin-directory:directory_v1-rev20220919-2.0.0'
   }

Thiết lập mẫu

1. Trong thư mục src/main/java/, hãy tạo một tệp Java mới có tên khớp với giá trị mainClassName trong tệp build.gradle.

2. Đưa mã sau vào tệp Java mới:

   adminSDK/directory/quickstart/src/main/java/AdminSDKDirectoryQuickstart.java

   Xem trên GitHub
   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.javanet.NetHttpTransport;
   import com.google.api.client.json.JsonFactory;
   import com.google.api.client.json.gson.GsonFactory;
   import com.google.api.client.util.store.FileDataStoreFactory;
   import com.google.api.services.directory.Directory;
   import com.google.api.services.directory.DirectoryScopes;
   import com.google.api.services.directory.model.User;
   import com.google.api.services.directory.model.Users;
   import java.io.FileNotFoundException;
   import java.io.IOException;
   import java.io.InputStream;
   import java.io.InputStreamReader;
   import java.security.GeneralSecurityException;
   import java.util.Collections;
   import java.util.List;
   
   public class AdminSDKDirectoryQuickstart {
     /**
      * Application name.
      */
     private static final String APPLICATION_NAME = "Google Admin SDK Directory API Java Quickstart";
     /**
      * Global instance of the JSON factory.
      */
     private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
     /**
      * Directory to store authorization tokens for this application.
      */
     private static final String TOKENS_DIRECTORY_PATH = "tokens";
   
     /**
      * Global instance of the scopes required by this quickstart.
      * If modifying these scopes, delete your previously saved tokens/ folder.
      */
     private static final List<String> SCOPES =
         Collections.singletonList(DirectoryScopes.ADMIN_DIRECTORY_USER_READONLY);
     private static final String CREDENTIALS_FILE_PATH = "/credentials.json";
   
     /**
      * Creates an authorized Credential object.
      *
      * @param HTTP_TRANSPORT The network HTTP Transport.
      * @return An authorized Credential object.
      * @throws IOException If the credentials.json file cannot be found.
      */
     private static Credential getCredentials(final NetHttpTransport HTTP_TRANSPORT)
         throws IOException {
       // Load client secrets.
       InputStream in = AdminSDKDirectoryQuickstart.class.getResourceAsStream(CREDENTIALS_FILE_PATH);
       if (in == null) {
         throw new FileNotFoundException("Resource not found: " + CREDENTIALS_FILE_PATH);
       }
       GoogleClientSecrets clientSecrets =
           GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(in));
   
       // Build flow and trigger user authorization request.
       GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow.Builder(
           HTTP_TRANSPORT, JSON_FACTORY, clientSecrets, SCOPES)
           .setDataStoreFactory(new FileDataStoreFactory(new java.io.File(TOKENS_DIRECTORY_PATH)))
           .setAccessType("offline")
           .build();
       LocalServerReceiver receiver = new LocalServerReceiver.Builder().setPort(8888).build();
       return new AuthorizationCodeInstalledApp(flow, receiver).authorize("user");
     }
   
     public static void main(String... args) throws IOException, GeneralSecurityException {
       // Build a new authorized API client service.
       final NetHttpTransport HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
       Directory service =
           new Directory.Builder(HTTP_TRANSPORT, JSON_FACTORY, getCredentials(HTTP_TRANSPORT))
               .setApplicationName(APPLICATION_NAME)
               .build();
   
       // Print the first 10 users in the domain.
       Users result = service.users().list()
           .setCustomer("my_customer")
           .setMaxResults(10)
           .setOrderBy("email")
           .execute();
       List<User> users = result.getUsers();
       if (users == null || users.size() == 0) {
         System.out.println("No users found.");
       } else {
         System.out.println("Users:");
         for (User user : users) {
           System.out.println(user.getName().getFullName());
         }
       }
     }
   }

Chạy mẫu

1. Chạy mẫu:

   gradle run
   

2. Lần đầu tiên chạy mẫu, bạn sẽ được nhắc uỷ quyền truy cập:
   1. Nếu bạn chưa đăng nhập vào Tài khoản Google, hãy đăng nhập khi được nhắc. Nếu bạn đã đăng nhập vào nhiều tài khoản, hãy chọn một tài khoản để sử dụng cho việc uỷ quyền.
   2. Nhấp vào Chấp nhận.

   Ứng dụng Java của bạn sẽ chạy và gọi Directory API.

   Thông tin uỷ quyền được lưu trữ trong hệ thống tệp, vì vậy, lần tiếp theo bạn chạy mã mẫu, bạn sẽ không được nhắc uỷ quyền.

Các bước tiếp theo

• Khắc phục sự cố xác thực và uỷ quyền
• Hướng dẫn dành cho nhà phát triển về Directory API
• Tài liệu tham khảo về Directory API
• Tài liệu về Ứng dụng API của Google cho Java
• Tài liệu Javadoc về Directory API