自 2025 年 3 月 27 日起，我们建议您使用 android-latest-release 而非 aosp-main 构建 AOSP 并为其做出贡献。如需了解详情，请参阅 AOSP 的变更。

此页面由 Cloud Translation API 翻译。

BaseDeviceMetricCollector

public class BaseDeviceMetricCollector
extends Object implements IMetricCollector

java.lang.Object
↳	com.android.tradefed.device.metric.BaseDeviceMetricCollector

已知的直接子类

BugreportzOnFailureCollector、ClangCodeCoverageCollector、CountTestCasesCollector、DebugHostLogOnFailureCollector、FilePullerDeviceMetricCollector、GcovCodeCoverageCollector、JavaCodeCoverageCollector、LogcatOnFailureCollector、ScreenshotOnFailureCollector

BugreportzOnFailureCollector	在测试用例失败时收集 bugreportz。
ClangCodeCoverageCollector	一个 `BaseDeviceMetricCollector`，用于从设备中提取 Clang 代码覆盖率测量结果，并将其记录为测试工件。
CountTestCasesCollector	统计并报告给定 `IRemoteTest` 的测试用例数量。
DebugHostLogOnFailureCollector	在发生测试用例失败时，收集并记录主机端日志的收集器。
FilePullerDeviceMetricCollector	一个 `BaseDeviceMetricCollector`，用于监听来自设备的指标键，并将其作为文件从设备中拉取。
GcovCodeCoverageCollector	一个 `BaseDeviceMetricCollector`，用于从设备中提取 gcov 覆盖率测量结果并将其记录为测试工件。
JavaCodeCoverageCollector	一个 `BaseDeviceMetricCollector`，用于从设备中提取 Java 覆盖率测量结果，并将其记录为测试工件。
LogcatOnFailureCollector	在测试用例失败时捕获并记录 logcat 的收集器。
ScreenshotOnFailureCollector	在测试用例失败时捕获并记录屏幕截图的收集器。

已知的间接子类

FilePullerLogCollector

FilePullerLogCollector 设备端报告的文件的记录器。

IMetricCollector 的基础实现，允许在 onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) 和 ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map)) 上启动和停止收集。

摘要

字段
`public static final String`	`TEST_CASE_EXCLUDE_GROUP_OPTION`
`public static final String`	`TEST_CASE_INCLUDE_GROUP_OPTION`

公共构造函数
`BaseDeviceMetricCollector()`

公共方法
`final`	`getBuildInfos()` 返回调用中可用的 build 信息列表。
`final`	`getDevices()` 返回调用中可用的设备列表。
`File`	`getFileFromTestArtifacts(String fileName)` 从测试工件或模块工件中检索文件，并将其缓存在映射中以供后续调用。
`final ITestInvocationListener`	`getInvocationListener()` 返回我们要将结果转发到的原始 `ITestInvocationListener`。
`final`	`getRealDevices()` 返回 `getDevices()` 列表中的所有非桩设备。
`String`	`getRunName()` 返回触发收集器的测试运行 `mRunName` 的名称。
`ITestInvocationListener`	`init(IInvocationContext context, ITestInvocationListener listener)` 使用当前上下文初始化收集器，以及将结果转发到的目的地。
`final void`	`invocationEnded(long elapsedTime)`
`final void`	`invocationFailed(FailureDescription failure)`
`final void`	`invocationFailed(Throwable cause)`
`final void`	`invocationStarted(IInvocationContext context)` 用于转发的调用监听器
`final boolean`	`isDisabled()` 如果整个对象已停用（同时跳过设置和拆解），则返回 true。
`final void`	`logAssociation(String dataName, LogFile logFile)` 请勿在指标收集器实现中使用。
`void`	`onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)` 当测试用例因假设失败而失败时，回调。
`void`	`onTestEnd(DeviceMetricData testData, currentTestCaseMetrics, TestDescription test)` 测试用例结束时的回调。
`void`	`onTestEnd(DeviceMetricData testData, currentTestCaseMetrics)` 测试用例结束时的回调。
`void`	`onTestFail(DeviceMetricData testData, TestDescription test)` 测试用例失败时的回调。
`void`	`onTestRunEnd(DeviceMetricData runData, currentRunMetrics)` 测试运行结束时的回调。
`void`	`onTestRunFailed(DeviceMetricData testData, FailureDescription failure)`
`void`	`onTestRunStart(DeviceMetricData runData)` 测试运行开始时的回调。
`void`	`onTestStart(DeviceMetricData testData)` 测试用例启动时的回调。
`final void`	`setDisable(boolean isDisabled)` 设置是否应停用对象。
`final void`	`setLogSaver(ILogSaver logSaver)` 请勿在指标收集器实现中使用。
`final void`	`testAssumptionFailure(TestDescription test, String trace)`
`final void`	`testAssumptionFailure(TestDescription test, FailureDescription failure)`
`final void`	`testEnded(TestDescription test, long endTime, testMetrics)`
`final void`	`testEnded(TestDescription test, testMetrics)`
`final void`	`testFailed(TestDescription test, FailureDescription failure)`
`final void`	`testFailed(TestDescription test, String trace)`
`final void`	`testIgnored(TestDescription test)`
`final void`	`testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)`
`final void`	`testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)` 请勿在指标收集器实现中使用。
`final void`	`testModuleEnded()`
`final void`	`testModuleStarted(IInvocationContext moduleContext)`
`final void`	`testRunEnded(long elapsedTime, runMetrics)`
`final void`	`testRunFailed(FailureDescription failure)`
`final void`	`testRunFailed(String errorMessage)`
`final void`	`testRunStarted(String runName, int testCount, int attemptNumber)`
`final void`	`testRunStarted(String runName, int testCount)` 测试运行回调
`final void`	`testRunStarted(String runName, int testCount, int attemptNumber, long startTime)`
`final void`	`testRunStopped(long elapsedTime)`
`final void`	`testStarted(TestDescription test, long startTime)`
`final void`	`testStarted(TestDescription test)` 测试用例回调

字段

TEST_CASE_EXCLUDE_GROUP_OPTION

public static final String TEST_CASE_EXCLUDE_GROUP_OPTION

TEST_CASE_INCLUDE_GROUP_OPTION

public static final String TEST_CASE_INCLUDE_GROUP_OPTION

公共构造函数

BaseDeviceMetricCollector

public BaseDeviceMetricCollector ()

公共方法

getBuildInfos

public final  getBuildInfos ()

返回调用中可用的 build 信息列表。

返回

getDevices

public final  getDevices ()

返回调用中可用的设备列表。

返回

getFileFromTestArtifacts

public File getFileFromTestArtifacts (String fileName)

从测试工件或模块工件中检索文件，并将其缓存在映射中以供后续调用。

参数
`fileName`	`String`：要在工件中查找的文件的名称。

返回
`File`	测试工件或模块工件中的文件。如果找不到文件，则返回 null。

getInvocationListener

public final ITestInvocationListener getInvocationListener ()

返回我们要将结果转发到的原始 ITestInvocationListener。

返回
`ITestInvocationListener`

getRealDevices

public final  getRealDevices ()

返回 getDevices() 列表中的所有非桩设备。

返回

getRunName

public String getRunName ()

返回触发收集器的测试运行 mRunName 的名称。

返回
`String`	mRunName，当前的测试运行名称。

init

public ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

使用当前上下文初始化收集器，以及将结果转发到的目的地。每个实例仅调用一次，并且收集器应更新其内部上下文和监听器。之前，测试运行期间永远不会调用 init。

除非您知道自己在做什么，否则请勿替换。

参数
`context`	`IInvocationContext`：正在进行的调用的 `IInvocationContext`。
`listener`	`ITestInvocationListener`：用于放置结果的 `ITestInvocationListener`。

返回
`ITestInvocationListener`	封装原始监听器的新监听器。

invocationEnded

public final void invocationEnded (long elapsedTime)

参数
`elapsedTime`	`long`

invocationFailed

public final void invocationFailed (FailureDescription failure)

参数
`failure`	`FailureDescription`

invocationFailed

public final void invocationFailed (Throwable cause)

参数
`cause`	`Throwable`

invocationStarted

public final void invocationStarted (IInvocationContext context)

用于转发的调用监听器

参数
`context`	`IInvocationContext`

isDisabled

public final boolean isDisabled ()

如果整个对象已停用（同时跳过设置和拆解），则返回 true。否则为 false。

返回
`boolean`

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

请勿在指标收集器实现中使用。这只是纯粹的转发。

参数
`dataName`	`String`
`logFile`	`LogFile`

onTestAssumptionFailure

public void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

当测试用例因假设失败而失败时，回调。

参数
`testData`	`DeviceMetricData`：用于存储测试用例数据的 `DeviceMetricData`。
`test`	`TestDescription`：正在进行的测试用例的 `TestDescription`。

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics, 
                TestDescription test)

测试用例结束时的回调。现在应该是清理时间了。

参数
`testData`	`DeviceMetricData`：用于存储测试用例数据的 `DeviceMetricData`。将与 `onTestStart(com.android.tradefed.device.metric.DeviceMetricData)` 期间相同的对象。
`currentTestCaseMetrics`	：传递给 `ITestLifeCycleReceiver.testEnded(com.android.tradefed.result.TestDescription, Map)` 的当前指标映射。
`test`	`TestDescription`：正在进行的测试用例的 `TestDescription`。

onTestEnd

public void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics)

测试用例结束时的回调。现在应该是清理时间了。

参数
`testData`	`DeviceMetricData`：用于存储测试用例数据的 `DeviceMetricData`。将与 `onTestStart(com.android.tradefed.device.metric.DeviceMetricData)` 期间相同的对象。
`currentTestCaseMetrics`	：传递给 `ITestLifeCycleReceiver.testEnded(com.android.tradefed.result.TestDescription, Map)` 的当前指标映射。

onTestFail

public void onTestFail (DeviceMetricData testData, 
                TestDescription test)

测试用例失败时的回调。

参数
`testData`	`DeviceMetricData`：用于存储测试用例数据的 `DeviceMetricData`。
`test`	`TestDescription`：正在进行的测试用例的 `TestDescription`。

onTestRunEnd

public void onTestRunEnd (DeviceMetricData runData, 
                 currentRunMetrics)

测试运行结束时的回调。现在应该是清理时间了。

参数
`runData`	`DeviceMetricData`：用于存储运行数据的 `DeviceMetricData`。将与 `onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData)` 期间相同的对象。
`currentRunMetrics`	：传递给 `ITestLifeCycleReceiver.testRunEnded(long, Map)` 的当前指标映射。

onTestRunFailed

public void onTestRunFailed (DeviceMetricData testData, 
                FailureDescription failure)

参数
`testData`	`DeviceMetricData`
`failure`	`FailureDescription`

onTestRunStart

public void onTestRunStart (DeviceMetricData runData)

测试运行开始时的回调。

参数
`runData`	`DeviceMetricData`：用于存储运行数据的 `DeviceMetricData`。

onTestStart

public void onTestStart (DeviceMetricData testData)

测试用例启动时的回调。

参数
`testData`	`DeviceMetricData`：用于存储测试用例数据的 `DeviceMetricData`。

setDisable

public final void setDisable (boolean isDisabled)

设置是否应停用对象。停用表示应跳过设置和拆解步骤。可用于在默认构造函数中默认停用对象。

参数
`isDisabled`	`boolean`：对象应处于的状态。

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

请勿在指标收集器实现中使用。这只是纯粹的转发。

参数
`logSaver`	`ILogSaver`

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

参数
`test`	`TestDescription`
`trace`	`String`

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

参数
`test`	`TestDescription`
`failure`	`FailureDescription`

testEnded

public final void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

参数
`test`	`TestDescription`
`endTime`	`long`
`testMetrics`

testEnded

public final void testEnded (TestDescription test, 
                 testMetrics)

参数
`test`	`TestDescription`
`testMetrics`

testFailed

public final void testFailed (TestDescription test, 
                FailureDescription failure)

参数
`test`	`TestDescription`
`failure`	`FailureDescription`

testFailed

public final void testFailed (TestDescription test, 
                String trace)

参数
`test`	`TestDescription`
`trace`	`String`

testIgnored

public final void testIgnored (TestDescription test)

参数
`test`	`TestDescription`

testLog

public final void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

参数
`dataName`	`String`
`dataType`	`LogDataType`
`dataStream`	`InputStreamSource`

testLogSaved

public final void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

请勿在指标收集器实现中使用。这只是纯粹的转发。

参数
`dataName`	`String`
`dataType`	`LogDataType`
`dataStream`	`InputStreamSource`
`logFile`	`LogFile`

testModuleEnded

public final void testModuleEnded ()

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

参数
`moduleContext`	`IInvocationContext`

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

参数
`elapsedTime`	`long`
`runMetrics`

testRunFailed

public final void testRunFailed (FailureDescription failure)

参数
`failure`	`FailureDescription`

testRunFailed

public final void testRunFailed (String errorMessage)

参数
`errorMessage`	`String`

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

参数
`runName`	`String`
`testCount`	`int`
`attemptNumber`	`int`

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

测试运行回调

参数
`runName`	`String`
`testCount`	`int`

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

参数
`runName`	`String`
`testCount`	`int`
`attemptNumber`	`int`
`startTime`	`long`

testRunStopped

public final void testRunStopped (long elapsedTime)

参数
`elapsedTime`	`long`

testStarted

public final void testStarted (TestDescription test, 
                long startTime)

参数
`test`	`TestDescription`
`startTime`	`long`

testStarted

public final void testStarted (TestDescription test)

测试用例回调

参数
`test`	`TestDescription`