教學課程：在Android應用程式中呼叫受保護的Web API

適用於：具有白色複選標記符號的 Workforce 租使用者 外部租使用者（深入瞭解）

這是教學課程系列中的第三個教學課程，會引導您使用 Microsoft Entra External ID 來呼叫受保護的 Web API。

在本教學課程中，您將：

• 呼叫受保護的 Web API

先決條件

Workforce 租戶設定

• 教學課程：使用 Microsoft 身分驗證平台將登入功能新增至 Android 應用

外部租戶配置

• 教學課程：使用Microsoft身分識別平臺將登入新增至Android應用程式

• 公開至少一個範圍（委派許可權）和一個應用程式角色（應用程式許可權）的 API 註冊，例如 ToDoList.Read。 如果您尚未這麼做，請遵循範例 Android 行動應用程式中的 呼叫 API 的指示， 讓功能受保護的 ASP.NET Core Web API。 請確定您完成下列步驟：

  • 註冊 Web API 應用程式
  • 設定 API 範圍
  • 設定應用程式角色
  • 設定選擇性宣告
  • 複製或下載範例 Web API
  • 設定和執行範例 Web API

呼叫受保護的 Web API

Workforce 租戶配置

1. 在 應用程式中>src>main>java>com.example（您的應用程式名稱）。 建立下列 Android 片段：

   • MSGraphRequestWrapper

2. 開啟 MSGraphRequestWrapper.java，並以下列代碼段取代程式代碼，以使用 MSAL 提供的令牌呼叫 Microsoft Graph API：

    package com.azuresamples.msalandroidapp;
   
    import android.content.Context;
    import android.util.Log;
   
    import androidx.annotation.NonNull;
   
    import com.android.volley.DefaultRetryPolicy;
    import com.android.volley.Request;
    import com.android.volley.RequestQueue;
    import com.android.volley.Response;
    import com.android.volley.toolbox.JsonObjectRequest;
    import com.android.volley.toolbox.Volley;
   
    import org.json.JSONObject;
   
    import java.util.HashMap;
    import java.util.Map;
   
    public class MSGraphRequestWrapper {
        private static final String TAG = MSGraphRequestWrapper.class.getSimpleName();
   
        // See: https://docs.microsoft.com/en-us/graph/deployments#microsoft-graph-and-graph-explorer-service-root-endpoints
        public static final String MS_GRAPH_ROOT_ENDPOINT = "https://graph.microsoft.com/";
   
        /**
         * Use Volley to make an HTTP request with
         * 1) a given MSGraph resource URL
         * 2) an access token
         * to obtain MSGraph data.
         **/
        public static void callGraphAPIUsingVolley(@NonNull final Context context,
                                                   @NonNull final String graphResourceUrl,
                                                   @NonNull final String accessToken,
                                                   @NonNull final Response.Listener<JSONObject> responseListener,
                                                   @NonNull final Response.ErrorListener errorListener) {
            Log.d(TAG, "Starting volley request to graph");
   
            /* Make sure we have a token to send to graph */
            if (accessToken == null || accessToken.length() == 0) {
                return;
            }
   
            RequestQueue queue = Volley.newRequestQueue(context);
            JSONObject parameters = new JSONObject();
   
            try {
                parameters.put("key", "value");
            } catch (Exception e) {
                Log.d(TAG, "Failed to put parameters: " + e.toString());
            }
   
            JsonObjectRequest request = new JsonObjectRequest(Request.Method.GET, graphResourceUrl,
                    parameters, responseListener, errorListener) {
                @Override
                public Map<String, String> getHeaders() {
                    Map<String, String> headers = new HashMap<>();
                    headers.put("Authorization", "Bearer " + accessToken);
                    return headers;
                }
            };
   
            Log.d(TAG, "Adding HTTP GET to Queue, Request: " + request.toString());
   
            request.setRetryPolicy(new DefaultRetryPolicy(
                    3000,
                    DefaultRetryPolicy.DEFAULT_MAX_RETRIES,
                    DefaultRetryPolicy.DEFAULT_BACKOFF_MULT));
            queue.add(request);
        }
    }
   

外部租戶配置

1. 若要從 Android 應用程式呼叫 Web API 以存取外部資料或服務，請從在 MainActivity 類別中建立隨附對象開始。 隨附物件應該包含下列程式代碼：

   companion object {
       private const val WEB_API_BASE_URL = "" // Developers should set the respective URL of their web API here
       private const val scopes = "" // Developers should append the respective scopes of their web API.
   }
   

   伴隨對象定義了兩個私有常數：WEB_API_BASE_URL，開發人員在此設定其網絡API的URL，以及scopes，開發人員在此附加其網絡API的具體 scopes。

2. 若要處理存取 Web API 的程式，請使用下列程式代碼：

   private fun accessWebApi() {
       CoroutineScope(Dispatchers.Main).launch {
           binding.txtLog.text = ""
           try {
               if (WEB_API_BASE_URL.isBlank()) {
                   Toast.makeText(this@MainActivity, getString(R.string.message_web_base_url), Toast.LENGTH_LONG).show()
                   return@launch
               }
               val apiResponse = withContext(Dispatchers.IO) {
                   ApiClient.performGetApiRequest(WEB_API_BASE_URL, accessToken)
               }
               binding.txtLog.text = getString(R.string.log_web_api_response)  + apiResponse.toString()
           } catch (exception: Exception) {
               Log.d(TAG, "Exception while accessing web API: $exception")
   
               binding.txtLog.text = getString(R.string.exception_web_api) + exception
           }
       }
   }
   

   程式碼會在主要調度器中啟動協程。 它會從清除文字記錄開始。 然後，它會檢查 Web API 基底 URL 是否空白;如果是，則會顯示快顯通知訊息並傳回。 接下來，它會使用背景線程中提供的存取令牌，對 Web API 執行 GET 要求。

   收到 API 回應之後，它會使用響應內容來更新文字記錄檔。 如果此程式期間發生任何例外狀況，則會記錄例外狀況，並以對應的錯誤訊息更新文字記錄檔。

   在程式碼中，我們指定回呼函式時使用名為 performGetApiRequest()的函式。 函式應該具有下列程式代碼：

   object ApiClient {
       private val client = OkHttpClient()
   
       fun performGetApiRequest(WEB_API_BASE_URL: String, accessToken: String?): Response {
           val fullUrl = "$WEB_API_BASE_URL/api/todolist"
   
           val requestBuilder = Request.Builder()
                   .url(fullUrl)
                   .addHeader("Authorization", "Bearer $accessToken")
                   .get()
   
           val request = requestBuilder.build()
   
           client.newCall(request).execute().use { response -> return response }
       }
   }
   

   程式代碼有助於對 Web API 提出 GET 要求。 主要方法是 performGetApiRequest()，它會採用 Web API 基底 URL 和存取令牌作為參數。 在此方法中，它會將 /api/todolist 附加至基底 URL，以建構完整的 URL。 然後，它會使用適當的標頭建置 HTTP 要求，包括具有存取令牌的授權標頭。

   最後，它會使用OkHttp的 newCall() 方法來同步執行要求，並傳回回應。 ApiClient 物件會維護 OkHttpClient 實例來處理 HTTP 要求。 若要使用 OkHttpClient，您必須將相依性 implementation 'com.squareup.okhttp3:okhttp:4.9.0' 新增至 Android Gradle 檔案。

   請確保您有包含匯入語句。 Android Studio 應該會自動包含匯入語句。

測試您的應用程式

建置應用程式並將其部署至測試裝置或模擬器。 您應該能夠登入並取得Microsoft Entra 識別碼的令牌。

相關內容

• 案例：呼叫 Web API 的行動應用程式
• 複雜案例的程式代碼範例