教程：在 Android 应用中调用受保护的 Web API

适用于： 员工租户 外部租户（了解详细信息）

这是本教程系列中的第三个教程，介绍如何使用 Microsoft Entra 外部 ID 调用受保护的 Web API。

在本教程中，你将：

• 调用受保护的 Web API

先决条件

工作人员租户配置

• 教程：使用 Microsoft 标识平台向 Android 应用添加登录

外部租户配置

• 教程：使用 Microsoft 标识平台向 Android 应用添加登录

• 公开至少一个范围（委托权限）和一个应用角色（应用程序权限）（例如 ToDoList.Read）的 API 注册。 按照在示例 Android 移动应用中调用 API 的说明，获取受保护的正常运行的 ASP.NET Core Web API（如果尚未这样做）。 请确保完成以下步骤：

  • 注册 Web API 应用程序
  • 配置 API 范围
  • 配置应用角色
  • 配置可选声明
  • 克隆或下载示例 Web API
  • 配置并运行示例 Web API

调用受保护的 Web API

工作人员租户配置

1. 在“appsrc>mainjava>com.example(你的应用名称)”中。>> 创建以下 Android 片段：

   • MSGraphRequestWrapper 的

2. 打开 MSGraphRequestWrapper.java ，并将代码替换为以下代码片段，以使用 MSAL 提供的令牌调用Microsoft图形 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，开发人员在其中设置其 Web API 的 URL，以及 scopes，开发人员在其中追加其 Web 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 对象维护用于处理 HTTP 请求的 OkHttpClient 实例。 若要使用 OkHttpClient，需要将依赖项 implementation 'com.squareup.okhttp3:okhttp:4.9.0' 添加到 Android Gradle 文件。

   确保包含 import 语句。 Android Studio 应该会自动为你添加 import 语句。

测试你的应用

构建应用并将其部署到测试设备或模拟器。 你应该能够登录并获取 Microsoft Entra ID 的令牌。

相关内容

• 场景：调用网页 API 的移动应用程序
• 复杂方案的代码示例