將 Google 登入功能整合至您的 Android 應用程式

如要將 Google 登入整合至 Android 應用程式,請設定 Google 登入,然後在應用程式的版面配置中新增啟動登入流程的按鈕。

事前準備

設定 Google API 控制台專案及設定 Android Studio 專案

設定 Google 登入和 GoogleSignInClient 物件

  1. 請在登入活動的 onCreate 方法內設定 Google 登入,使其要求應用程式所需的使用者資料。例如,如要設定 Google 登入以要求使用者 ID 和基本設定檔資訊,請建立使用 DEFAULT_SIGN_IN 參數的 GoogleSignInOptions 物件。如要同時要求使用者電子郵件地址,請使用 requestEmail 選項建立 GoogleSignInOptions 物件。

    // Configure sign-in to request the user's ID, email address, and basic
    // profile. ID and basic profile are included in DEFAULT_SIGN_IN.
    GoogleSignInOptions gso = new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN)
            .requestEmail()
            .build();

    如果需要要求其他範圍來存取 Google API,請使用 requestScopes 指定。為獲得最佳使用者體驗,請只在登入時要求應用程式盡可能減少運作所需的範圍。請僅在必要時要求任何其他範圍,以便使用者在執行動作時查看同意畫面。請參閱要求其他範圍

  2. 然後在登入活動的 onCreate 方法中,使用您指定的選項建立 GoogleSignInClient 物件。

    // Build a GoogleSignInClient with the options specified by gso.
    mGoogleSignInClient = GoogleSignIn.getClient(this, gso);

檢查現有的已登入使用者

在活動的 onStart 方法中,檢查使用者是否已透過 Google 帳戶登入應用程式。

// Check for existing Google Sign In account, if the user is already signed in
// the GoogleSignInAccount will be non-null.
GoogleSignInAccount account = GoogleSignIn.getLastSignedInAccount(this);
updateUI(account);

如果 GoogleSignIn.getLastSignedInAccount 傳回 GoogleSignInAccount 物件 (而非 null),使用者已透過 Google 登入您的應用程式。據此更新使用者介面,也就是隱藏登入按鈕、啟動主要活動,或是任何可能適合您應用程式的內容。

如果 GoogleSignIn.getLastSignedInAccount 傳回 null,代表使用者尚未透過 Google 登入您的應用程式。更新使用者介面,顯示 Google 登入按鈕。

將 Google 登入按鈕新增至應用程式

  1. 標準 Google 登入按鈕 在應用程式版面配置中新增 SignInButton

    <com.google.android.gms.common.SignInButton
     android:id="@+id/sign_in_button"
     android:layout_width="wrap_content"
     android:layout_height="wrap_content" />
    
  2. 選用:如果您使用預設的登入按鈕圖形 (而非自行提供登入按鈕資產),請使用 setSize 方法自訂按鈕的大小。

    // Set the dimensions of the sign-in button.
    SignInButton signInButton = findViewById(R.id.sign_in_button);
    signInButton.setSize(SignInButton.SIZE_STANDARD);
    
  3. 在 Android 活動 (例如,在 onCreate 方法中) 中註冊按鈕的 OnClickListener,使用者點按後:

    findViewById(R.id.sign_in_button).setOnClickListener(this);
    

開始登入流程

  1. 登入帳戶選擇工具的圖片在活動的 onClick 方法中,使用 getSignInIntent 方法建立登入意圖,並使用 startActivityForResult 啟動意圖,藉此處理登入按鈕的輕觸事件。

    @Override
    public void onClick(View v) {
        switch (v.getId()) {
            case R.id.sign_in_button:
                signIn();
                break;
            // ...
        }
    }
    
    private void signIn() {
        Intent signInIntent = mGoogleSignInClient.getSignInIntent();
        startActivityForResult(signInIntent, RC_SIGN_IN);
    }

    啟動意圖時,系統會提示使用者選取要登入的 Google 帳戶。如果您要求的範圍超過 profileemailopenid,系統也會提示使用者授予要求的資源的存取權。

  2. 使用者登入後,即可在活動的 onActivityResult 方法中取得使用者的 GoogleSignInAccount 物件。

    @Override
    public void onActivityResult(int requestCode, int resultCode, Intent data) {
        super.onActivityResult(requestCode, resultCode, data);
    
        // Result returned from launching the Intent from GoogleSignInClient.getSignInIntent(...);
        if (requestCode == RC_SIGN_IN) {
            // The Task returned from this call is always completed, no need to attach
            // a listener.
            Task<GoogleSignInAccount> task = GoogleSignIn.getSignedInAccountFromIntent(data);
            handleSignInResult(task);
        }
    }

    GoogleSignInAccount 物件內含有關已登入使用者的資訊,例如使用者名稱。

    private void handleSignInResult(Task<GoogleSignInAccount> completedTask) {
        try {
            GoogleSignInAccount account = completedTask.getResult(ApiException.class);
    
            // Signed in successfully, show authenticated UI.
            updateUI(account);
        } catch (ApiException e) {
            // The ApiException status code indicates the detailed failure reason.
            // Please refer to the GoogleSignInStatusCodes class reference for more information.
            Log.w(TAG, "signInResult:failed code=" + e.getStatusCode());
            updateUI(null);
        }
    }

    您也可以使用 getEmail 取得使用者的電子郵件地址,以及使用者的 Google ID (用於用戶端) 和 getId,以及使用 getIdToken 的使用者 ID 權杖。如果您需要將目前登入的使用者傳遞至後端伺服器,請將 ID 權杖傳送至後端伺服器,然後在伺服器上驗證權杖。