用於網際網路連線的 Wi-Fi Suggestion API

搭載 Android 10 (API 級別 29) 以上版本的裝置可讓應用程式新增網路憑證,以便自動連線至 Wi-Fi 存取點。您可以使用 WifiNetworkSuggestion 提供建議連線的網路。平台最終會根據應用程式和其他來源的輸入內容,選擇要接受的存取點。

Android 11 (API 級別 30) 以上版本:

  • 該架構會強制執行 EAP-SIM Enterprise 建議 (EAP-SIM、EAP-AKA、EAP-AKA-PRIME) 的擁有權要求;這類建議僅供電信業者簽署的應用程式使用。
  • 如需電信業者簽署應用程式提供的建議,架構會自動為其指派與該應用程式電信業者簽署對應的電信業者 ID。如果從裝置中移除對應的 SIM 卡,這類建議就會自動停用。

Android 12 (API 級別 31) 以上版本:

  • 非永久的 MAC 隨機化功能可以定期重新隨機化隨機化 MAC 位址,藉此啟用額外的隱私功能。使用 setMacRandomizationSetting 指定網路的隨機程度。

  • isPasspointTermsAndConditionsSupported()條款及細則Passpoint 功能,可讓您在網路部署項目中,透過安全的 Passpoint 網路,取代不安全的網頁認證入口。在必須接受條款及細則的情況下,使用者會看到通知。如果應用程式建議受條款及細則管制的 Passpoint 網路,就必須先呼叫這個 API,確保裝置支援這項功能。如果裝置不支援這項功能,將無法連線至這個網路,因此系統必須建議使用替代或舊版網路。

  • isDecoratedIdentitySupported():對具有前置字串裝飾的網路進行驗證時,網路運算子可以更新網路存取 ID (NAI),透過 AAA 網路中的多個 Proxy 執行明確轉送 (詳情請參閱 RFC 7542)。

    Android 12 會實作這項功能,以符合 PPS-MO 擴充功能的 WBA 規格。如果應用程式建議的 Passpoint 網路需要經過裝飾的身分,您必須先呼叫這個 API,以確保裝置支援此功能。如果裝置不支援這項功能,則系統不會裝飾身分識別,網路驗證可能會失敗。

如要建立 Passpoint 建議,應用程式必須使用 PasspointConfigurationCredentialHomeSp 類別。這些類別說明的 Passpoint 設定檔,請參閱 Wi-Fi Alliance Passpoint 規範

下列程式碼範例說明如何提供開放、WPA2、1 WPA3 網路和一個 Passpoint 網路的憑證:

Kotlin

val suggestion1 = WifiNetworkSuggestion.Builder()
        .setSsid("test111111")
        .setIsAppInteractionRequired(true) // Optional (Needs location permission)
        .build();

val suggestion2 = WifiNetworkSuggestion.Builder()
        .setSsid("test222222")
        .setWpa2Passphrase("test123456")
        .setIsAppInteractionRequired(true) // Optional (Needs location permission)
        .build();

val suggestion3 = WifiNetworkSuggestion.Builder()
        .setSsid("test333333")
        .setWpa3Passphrase("test6789")
        .setIsAppInteractionRequired(true) // Optional (Needs location permission)
        .build();

val passpointConfig = PasspointConfiguration(); // configure passpointConfig to include a valid Passpoint configuration
val suggestion4 = WifiNetworkSuggestion.Builder()
        .setPasspointConfig(passpointConfig)
        .setIsAppInteractionRequired(true) // Optional (Needs location permission)
        .build();

val suggestionsList = listOf(suggestion1, suggestion2, suggestion3, suggestion4);

val wifiManager = context.getSystemService(Context.WIFI_SERVICE) as WifiManager;

val status = wifiManager.addNetworkSuggestions(suggestionsList);
if (status != WifiManager.STATUS_NETWORK_SUGGESTIONS_SUCCESS) {
    // do error handling here
}

// Optional (Wait for post connection broadcast to one of your suggestions)
val intentFilter = IntentFilter(WifiManager.ACTION_WIFI_NETWORK_SUGGESTION_POST_CONNECTION);

val broadcastReceiver = object : BroadcastReceiver() {
    override fun onReceive(context: Context, intent: Intent) {
        if (!intent.action.equals(WifiManager.ACTION_WIFI_NETWORK_SUGGESTION_POST_CONNECTION)) {
            return;
        }
        // do post connect processing here
    }
};
context.registerReceiver(broadcastReceiver, intentFilter);

Java

final WifiNetworkSuggestion suggestion1 =
  new WifiNetworkSuggestion.Builder()
  .setSsid("test111111")
  .setIsAppInteractionRequired(true) // Optional (Needs location permission)
  .build();

final WifiNetworkSuggestion suggestion2 =
  new WifiNetworkSuggestion.Builder()
  .setSsid("test222222")
  .setWpa2Passphrase("test123456")
  .setIsAppInteractionRequired(true) // Optional (Needs location permission)
  .build();

final WifiNetworkSuggestion suggestion3 =
  new WifiNetworkSuggestion.Builder()
  .setSsid("test333333")
  .setWpa3Passphrase("test6789")
  .setIsAppInteractionRequired(true) // Optional (Needs location permission)
  .build();

final PasspointConfiguration passpointConfig = new PasspointConfiguration();
// configure passpointConfig to include a valid Passpoint configuration

final WifiNetworkSuggestion suggestion4 =
  new WifiNetworkSuggestion.Builder()
  .setPasspointConfig(passpointConfig)
  .setIsAppInteractionRequired(true) // Optional (Needs location permission)
  .build();

final List<WifiNetworkSuggestion> suggestionsList =
  new ArrayList<WifiNetworkSuggestion> {{
    add(suggestion1);
    add(suggestion2);
    add(suggestion3);
    add(suggestion4);
  }};

final WifiManager wifiManager =
  (WifiManager) context.getSystemService(Context.WIFI_SERVICE);

final int status = wifiManager.addNetworkSuggestions(suggestionsList);
if (status != WifiManager.STATUS_NETWORK_SUGGESTIONS_SUCCESS) {
// do error handling here…
}

// Optional (Wait for post connection broadcast to one of your suggestions)
final IntentFilter intentFilter =
  new IntentFilter(WifiManager.ACTION_WIFI_NETWORK_SUGGESTION_POST_CONNECTION);

final BroadcastReceiver broadcastReceiver = new BroadcastReceiver() {
  @Override
  public void onReceive(Context context, Intent intent) {
    if (!intent.getAction().equals(
      WifiManager.ACTION_WIFI_NETWORK_SUGGESTION_POST_CONNECTION)) {
      return;
    }
    // do post connect processing here...
  }
};
context.registerReceiver(broadcastReceiver, intentFilter);

應用程式首次提出建議後,系統會立即通知使用者。通知類型取決於裝置上執行的 Android 版本:

  • 在 Android 11 (API 級別 30) 以上版本中,如果應用程式是在前景執行,使用者會看到對話方塊;如果應用程式在背景執行,則會看到通知。
  • 在 Android 10 (API 級別 29) 中,無論應用程式是在前景或背景執行,使用者都會看到通知。

當平台連線至其中一個網路建議時,設定會顯示文字,將網路連線歸因於對應的建議工具應用程式。

處理使用者中斷連線的情況

如果使用者在連線至 Wi-Fi 挑選器時,明確中斷與其中一個網路建議的連線,則只要該網路仍在範圍內,系統就會忽略該網路。在這段期間,即使應用程式移除並重新新增與網路對應的網路建議,系統也不會將該網路視為自動連線。如果使用者使用 Wi-Fi 挑選器明確連線至先前已中斷連線的網路,系統會立即將該網路視為自動連線。

變更應用程式的核准狀態

使用者拒絕網路建議通知後,系統會移除應用程式中的 CHANGE_WIFI_STATE 權限。使用者之後可以前往 Wi-Fi 控制選單 (依序點選「設定」>「應用程式和通知」>「特殊應用程式存取權」>「Wi-Fi 控制項」>「App name」) 授予這項核准。