Wi-Fi 掃描總覽

您可以使用 WifiManager API 提供的 Wi-Fi 掃描功能,取得裝置中顯示的 Wi-Fi 存取點清單。

Wi-Fi 掃描程序

掃描程序包含三個步驟:

  1. SCAN_RESULTS_AVAILABLE_ACTION 註冊廣播監聽器。系統會在掃描要求完成時呼叫廣播事件監聽器,提供成功/失敗狀態。如果是搭載 Android 10 (API 級別 29) 以上版本的裝置,則平台或其他應用程式在裝置上執行的所有 Wi-Fi 掃描作業都會傳送到這項廣播訊息。應用程式可以透過廣播,被動監聽裝置上的所有掃描完成,而不必進行本身掃描。

  2. 使用 WifiManager.startScan() 要求掃描。請務必檢查方法的傳回狀態,因為呼叫可能會因為下列其中一個原因而失敗:

    • 由於短時間內掃描的掃描過多,掃描要求可能會受到限制。
    • 裝置處於閒置狀態,因此掃描功能已停用。
    • Wi-Fi 硬體回報掃描失敗。
  3. 使用 WifiManager.getScanResults() 取得掃描結果。傳回的掃描結果是最新更新的結果,如果目前的掃描作業尚未完成或成功,可能來自先前的掃描作業。這表示如果在收到成功的 SCAN_RESULTS_AVAILABLE_ACTION 廣播之前呼叫這個方法,可能會取得較舊的掃描結果。

以下程式碼範例說明如何實作這些步驟:

Kotlin

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

val wifiScanReceiver = object : BroadcastReceiver() {

  override fun onReceive(context: Context, intent: Intent) {
    val success = intent.getBooleanExtra(WifiManager.EXTRA_RESULTS_UPDATED, false)
    if (success) {
      scanSuccess()
    } else {
      scanFailure()
    }
  }
}

val intentFilter = IntentFilter()
intentFilter.addAction(WifiManager.SCAN_RESULTS_AVAILABLE_ACTION)
context.registerReceiver(wifiScanReceiver, intentFilter)

val success = wifiManager.startScan()
if (!success) {
  // scan failure handling
  scanFailure()
}

....

private fun scanSuccess() {
  val results = wifiManager.scanResults
  ... use new scan results ...
}

private fun scanFailure() {
  // handle failure: new scan did NOT succeed
  // consider using old scan results: these are the OLD results!
  val results = wifiManager.scanResults
  ... potentially use older scan results ...
}

Java

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

BroadcastReceiver wifiScanReceiver = new BroadcastReceiver() {
  @Override
  public void onReceive(Context c, Intent intent) {
    boolean success = intent.getBooleanExtra(
                       WifiManager.EXTRA_RESULTS_UPDATED, false);
    if (success) {
      scanSuccess();
    } else {
      // scan failure handling
      scanFailure();
    }
  }
};

IntentFilter intentFilter = new IntentFilter();
intentFilter.addAction(WifiManager.SCAN_RESULTS_AVAILABLE_ACTION);
context.registerReceiver(wifiScanReceiver, intentFilter);

boolean success = wifiManager.startScan();
if (!success) {
  // scan failure handling
  scanFailure();
}

....

private void scanSuccess() {
  List<ScanResult> results = wifiManager.getScanResults();
  ... use new scan results ...
}

private void scanFailure() {
  // handle failure: new scan did NOT succeed
  // consider using old scan results: these are the OLD results!
  List<ScanResult> results = wifiManager.getScanResults();
  ... potentially use older scan results ...
}

限制

Android 8.0 (API 級別 26) 推出了有關權限的限制,以及允許的 Wi-Fi 掃描頻率。

為了提升網路效能、安全性和電池續航力,Android 9 (API 級別 28) 限制了權限要求,並進一步限制掃描 Wi-Fi 的頻率。

權限

Android 8.0 和 Android 8.1:

如要成功呼叫 WifiManager.getScanResults(),您必須具備以下任何權限:

如果呼叫的應用程式不具備任何上述權限,呼叫會失敗並顯示 SecurityException

或者,在搭載 Android 8.0 (API 級別 26) 以上版本的裝置上,您可以使用 CompanionDeviceManager 代表應用程式掃描附近的隨附裝置,而不需要位置存取權。如要進一步瞭解這個選項,請參閱「隨附裝置配對」。

Android 9:

如要成功呼叫 WifiManager.startScan(),則「所有」都必須符合下列「所有」條件:

Android 10 (API 級別 29) 以上版本:

如要成功呼叫 WifiManager.startScan(),則「所有」都必須符合下列「所有」條件:

  • 如果應用程式指定的是 Android 10 (API 級別 29) SDK 或以上版本,則應用程式具備 ACCESS_FINE_LOCATION 權限。
  • 如果應用程式指定的 SDK 版本低於 Android 10 (API 級別 29),則應用程式須具備 ACCESS_COARSE_LOCATIONACCESS_FINE_LOCATION 權限。
  • 應用程式擁有 CHANGE_WIFI_STATE 權限。
  • 裝置上已啟用定位服務 (在「設定」 >「位置」下)。

為成功呼叫 WifiManager.getScanResults(),請確認符合下列「所有」條件:

  • 如果應用程式指定的是 Android 10 (API 級別 29) SDK 或以上版本,則應用程式具有 ACCESS_FINE_LOCATION 權限。
  • 如果應用程式指定的 SDK 版本低於 Android 10 (API 級別 29),則應用程式具備 ACCESS_COARSE_LOCATIONACCESS_FINE_LOCATION 權限。
  • 應用程式擁有 ACCESS_WIFI_STATE 權限。
  • 裝置上已啟用定位服務 (在「設定」 >「位置」下)。

如果發出呼叫的應用程式不符合上述所有要求,呼叫就會失敗,並顯示 SecurityException

節流

下列限制適用於使用 WifiManager.startScan() 掃描的頻率。

Android 8.0 和 Android 8.1:

每個背景應用程式可在 30 分鐘內掃描一次。

Android 9:

每個前景應用程式可在 2 分鐘內掃描 4 次。這能讓您在短時間內大量掃描。

所有背景應用程式合併的單位可在 30 分鐘內掃描一次。

Android 10 以上版本:

也適用 Android 9 的節流限制。新增一個開發人員選項,可關閉本機測試的節流功能 (位於「Developer Options」>「Networking」>「Wi-Fi scanning throtling」)。