為配合主幹穩定開發模型，並確保生態系統的平台穩定性，我們將於 2026 年起，在第 2 季和第 4 季將原始碼發布至 AOSP。如要建構及貢獻 AOSP，建議使用 android-latest-release，而非 aosp-main。android-latest-release 資訊清單分支版本一律會參照推送至 AOSP 的最新版本。詳情請參閱「Android 開放原始碼計畫變更」一文。

UiAutomatorRunner

public class UiAutomatorRunner
extends Object implements IRemoteAndroidTestRunner

java.lang.Object
↳	com.android.tradefed.testtype.UiAutomatorRunner

在裝置上執行 UI Automator 測試，並回報結果。 UI Automator 測試是專用的測試執行器，用於執行採用 UI Automator 架構的 UI 自動化測試。裝置上的測試執行器會模擬檢測測試輸出格式，因此 ddmlib 和 TF 中的現有剖析程式碼可以重複使用。基本上，這是這個指令的包裝函式： adb shell uiautomator runtest (jar files) -e class (test classes) ...

摘要

公用建構函式
`UiAutomatorRunner(IDevice remoteDevice, String[] jarPaths, String runnerPath)` 建立 UiAutomatorRunner，用於執行 UI 自動化測試

公用方法
`void`	`addBooleanArg(String name, boolean value)` 在檢測指令中新增布林值引數。
`void`	`addInstrumentationArg(String name, String value)` 新增要納入檢測指令的引數。
`void`	`cancel()` 要求取消這項測試執行作業。
`IRemoteAndroidTestRunner.CoverageOutput`	`getCoverageOutputType()` 傳回執行器產生的測試涵蓋範圍類型。
`String`	`getPackageName()` 傳回最後新增的 Java 類別的套件名稱
`String`	`getRunnerName()` 傳回預設 UiAutomatorTestRunner 類別名稱
`void`	`removeInstrumentationArg(String name)` 移除先前新增的引數。
`void`	`run(ITestRunListener... listeners)` 執行這項測試。
`void`	`run( listeners)` 執行這項測試。
`void`	`setAdditionalTestOutputLocation(String additionalTestDataPath)` 設定要複製到主機的其他測試輸出內容位置，然後再解除安裝測試應用程式。
`void`	`setClassName(String className)` 設定為只執行這個類別中的測試。必須在「run」之前呼叫。
`void`	`setClassNames(String[] classNames)` 設定為只執行所提供類別中的測試。必須在「run」之前呼叫。
`void`	`setCoverage(boolean coverage)` Sets this code coverage mode of this test run.
`void`	`setCoverageReportLocation(String arg0)` 設定產生的涵蓋範圍報表位置。
`void`	`setDebug(boolean debug)` 設定這項測試執行的偵錯模式。
`void`	`setIgnoreSighup(boolean value)` 在 uiautomator 中設定選項，忽略 SIGHUP。
`void`	`setLogOnly(boolean logOnly)` 將這項測試執行作業設為僅記錄模式，並略過測試執行作業。
`void`	`setMaxTimeToOutputResponse(long timeout, TimeUnit unit)` 設定在裝置上執行測試的殼層指令輸出內容之間，允許的最長時間。
`void`	`setMaxTimeout(long maxTimeout, TimeUnit unit)` 設定完成插碼作業的時間上限。
`void`	`setMaxtimeToOutputResponse(int maxTimeToOutputResponse)` 這個方法已淘汰。請改用 `setMaxTimeToOutputResponse(long, TimeUnit)`。
`void`	`setMethodName(String className, String testName)` 設定為僅執行指定的測試方法。必須在「run」之前呼叫。
`void`	`setRunName(String runName)` 設定要向 `ITestRunListener` 上的 `run()` 回報的自訂執行名稱如未指定，則會使用套件名稱
`void`	`setTestCollection(boolean b)` 將這個測試執行作業設為測試收集模式。
`void`	`setTestPackageName(String packageName)` 設定為執行指定套件中的所有測試。必須在「run」之前呼叫。
`void`	`setTestSize(IRemoteAndroidTestRunner.TestSize size)` 設定為僅執行指定大小的測試。

受保護的方法
`String`	`getRunCommand()`
`String`	`getRunnerPath()`

公用建構函式

UiAutomatorRunner

public UiAutomatorRunner (IDevice remoteDevice, 
                String[] jarPaths, 
                String runnerPath)

建立 UiAutomatorRunner，用於執行 UI 自動化測試

參數
`remoteDevice`	`IDevice`：要互動的遠端裝置，例如執行測試、收集結果等
`jarPaths`	`String`：UI Automator 測試案例所在的 JAR 檔案路徑；路徑必須是絕對路徑，或與裝置上的 /data/local/tmp/ 相對
`runnerPath`	`String`：要使用的替代 uiautomator 執行器，可能是 `null`，在此情況下會使用預設值

公用方法

addBooleanArg

public void addBooleanArg (String name, 
                boolean value)

在檢測指令中新增布林引數。

參數
`name`	`String`：插樁套件引數的名稱
`value`	`boolean`：引數的值

addInstrumentationArg

public void addInstrumentationArg (String name, 
                String value)

在檢測指令中加入引數。

必須在「run」之前呼叫。如果已提供具有指定名稱的引數，系統會覆寫其值。

參數
`name`	`String`：插樁套件引數的名稱
`value`	`String`：引數的值

cancel

public void cancel ()

要求取消這次測試。

getCoverageOutputType

public IRemoteAndroidTestRunner.CoverageOutput getCoverageOutputType ()

傳回執行器產生的測試涵蓋範圍類型。詳情請參閱CoverageOutput。

傳回
`IRemoteAndroidTestRunner.CoverageOutput`

getPackageName

public String getPackageName ()

傳回最後新增的 Java 類別的套件名稱

傳回
`String`

getRunnerName

public String getRunnerName ()

傳回預設的 UiAutomatorTestRunner 類別名稱

傳回
`String`

removeInstrumentationArg

public void removeInstrumentationArg (String name)

移除先前新增的引數。

參數
`name`	`String`：要移除的檢測套件引數名稱

得分

public void run (ITestRunListener... listeners)

執行這項測試。

ERROR(/#run(Collection)) 的便利方法。

參數
`listeners`	`ITestRunListener`：監聽測試結果

擲回
`AdbCommandRejectedException`
`ShellCommandUnresponsiveException`
`TimeoutException`

得分

public void run ( listeners)

執行這項測試。

參數
`listeners`	：測試結果的監聽器集合

擲回
`AdbCommandRejectedException`
`ShellCommandUnresponsiveException`
`TimeoutException`

setAdditionalTestOutputLocation

public void setAdditionalTestOutputLocation (String additionalTestDataPath)

設定要複製到主機的其他測試輸出內容位置，然後再解除安裝測試應用程式。例如產生的基準報表。

參數
`additionalTestDataPath`	`String`

setClassName

public void setClassName (String className)

設定為只執行這個類別中的測試。必須在「run」之前呼叫。

參數
`className`	`String`：完整類別名稱 (例如 x.y.z)

setClassNames

public void setClassNames (String[] classNames)

設定為只執行所提供類別中的測試。必須在「run」之前呼叫。

如果提供多個類別，則需要支援多個類別引數語法的 InstrumentationTestRunner。

參數
`classNames`	`String`：完整類別名稱陣列 (例如 x.y.z)

setCoverage

public void setCoverage (boolean coverage)

設定本次測試執行的程式碼涵蓋範圍模式。

參數
`coverage`	`boolean`

setCoverageReportLocation

public void setCoverageReportLocation (String arg0)

設定產生的涵蓋範圍報表位置。

參數
`arg0`	`String`

setDebug

public void setDebug (boolean debug)

設定這項測試執行的偵錯模式。如果為 true，Android 測試執行器會等待偵錯工具附加完成，再繼續執行測試。

參數
`debug`	`boolean`

setIgnoreSighup

public void setIgnoreSighup (boolean value)

在 uiautomator 中設定選項，忽略 SIGHUP。

參數
`value`	`boolean`：如果設為 true，則忽略信號

setLogOnly

public void setLogOnly (boolean logOnly)

將這項測試執行作業設為僅記錄模式，並略過測試執行作業。

參數
`logOnly`	`boolean`

setMaxTimeToOutputResponse

public void setMaxTimeToOutputResponse (long timeout, 
                TimeUnit unit)

設定在裝置上執行測試的殼層指令輸出內容之間，允許的最長時間。

這樣一來，如果測試卡住且永遠無法完成，就能設定逾時時間。這與連線的正常逾時不同。

預設不會指定逾時時間。

參數
`timeout`	`long`：指令在沒有任何回應的情況下，允許的最長時間。如果值為 0，方法會無限期等待指令輸出內容 (直到 `receiver` 取消執行)，且絕不會擲回。
`unit`	`TimeUnit`：非零 `maxTimeToOutputResponse` 和 `maxTimeout` 值的單位。

setMaxTimeout

public void setMaxTimeout (long maxTimeout, 
                TimeUnit unit)

設定完成插碼作業的時間上限。

這樣一來，如果測試卡住且永遠無法完成，就能設定逾時時間。這與連線的正常逾時不同。

預設不會指定逾時時間。

參數
`maxTimeout`	`long`：指令在沒有任何回應的情況下，允許的最長時間。如果值為 0，方法會無限期等待指令輸出內容 (直到 `receiver` 取消執行)，且絕不會擲回。
`unit`	`TimeUnit`：非零 `maxTimeToOutputResponse` 和 `maxTimeout` 值的單位。

setMaxtimeToOutputResponse

public void setMaxtimeToOutputResponse (int maxTimeToOutputResponse)

這個方法已淘汰。
請改用 setMaxTimeToOutputResponse(long, TimeUnit)。

參數
`maxTimeToOutputResponse`	`int`

setMethodName

public void setMethodName (String className, 
                String testName)

設定為僅執行指定的測試方法。必須在「run」之前呼叫。

參數
`className`	`String`：完整類別名稱 (例如 x.y.z)
`testName`	`String`：方法名稱

setRunName

public void setRunName (String runName)

設定要向 ITestRunListener 上的 run() 回報的自訂執行名稱

如未指定，則會使用套件名稱

setTestCollection

public void setTestCollection (boolean b)

將這項測試執行作業設為測試收集模式。若為 true，系統會略過測試執行作業，並設定成功收集測試所需的適當執行器引數。

參數
`b`	`boolean`

setTestPackageName

public void setTestPackageName (String packageName)

設定為執行指定套件中的所有測試。必須在「run」之前呼叫。

參數
`packageName`	`String`：完整套件名稱 (例如 x.y.z)

setTestSize

public void setTestSize (IRemoteAndroidTestRunner.TestSize size)

設定為僅執行指定大小的測試。必須在「run」之前呼叫。

參數
`size`	`IRemoteAndroidTestRunner.TestSize`：要執行的 `TestSize`。

受保護的方法

getRunCommand

protected String getRunCommand ()

傳回
`String`

getRunnerPath

protected String getRunnerPath ()

傳回
`String`