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

此页面由 Cloud Translation API 翻译。

ShardListener

public class ShardListener
extends CollectingTestListener implements ISupportGranularResults

java.lang.Object
↳	com.android.tradefed.result.CollectingTestListener
	↳	com.android.tradefed.invoker.ShardListener

用于从调用分片（也称为在多个资源上并行运行的调用分块）收集结果并将其转发给另一个监听器的 ITestInvocationListener。

摘要

公共构造函数
`ShardListener(ITestInvocationListener main)` 创建 `ShardListener`。

公共方法
	`getUnderlyingResultReporter()`
`void`	`invocationEnded(long elapsedTime)` 报告调用已终止，无论是成功终止还是因某种错误条件而终止。
`void`	`invocationFailed(FailureDescription failure)` 由于某些错误条件，报告调用不完整。
`void`	`invocationFailed(Throwable cause)` 由于某些错误条件，报告调用不完整。
`void`	`invocationSkipped(SkipReason reason)` 将调用报告为已跳过
`void`	`invocationStarted(IInvocationContext context)` 报告测试调用的开始。
`void`	`logAssociation(String dataName, LogFile logFile)` 在某些情况下，日志必须与测试用例强相关联，但无法在直接 `testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)` 回调中执行此操作。
`void`	`setSupportGranularResults(boolean enableGranularResults)`
`boolean`	`supportGranularResults()` 如果报告程序支持精细结果，则返回 True；否则返回 False。
`void`	`testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)` 提供测试调用中的关联日志或调试数据。
`void`	`testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)`
`void`	`testModuleEnded()` 报告模块运行结束。
`void`	`testModuleStarted(IInvocationContext moduleContext)` 报告模块运行的开始时间。
`void`	`testRunEnded(long elapsedTime, runMetrics)` 报告测试运行结束。
`void`	`testRunFailed(FailureDescription failure)` 由于 `FailureDescription` 所述的失败，报告测试运行未能完成。
`void`	`testRunFailed(String failureMessage)` 由于出现严重错误，报告测试运行未能完成。
`void`	`testRunStarted(String name, int numTests, int attemptNumber, long startTime)` 报告测试运行的开始。

公共构造函数

ShardListener

public ShardListener (ITestInvocationListener main)

创建 ShardListener。

参数
`main`	`ITestInvocationListener`：应将结果转发到的 `ITestInvocationListener`。为防止与其他 `ShardListener` 发生冲突，此对象在转发结果时会在 `main` 上进行同步。只有在调用分片完成后，系统才会发送结果。

公共方法

getUnderlyingResultReporter

public  getUnderlyingResultReporter ()

返回

invocationEnded

public void invocationEnded (long elapsedTime)

报告调用已终止，无论是成功终止还是因某种错误条件而终止。

将由 TradeFederation 框架自动调用。

参数
`elapsedTime`	`long`：调用的经过时间（以毫秒为单位）

invocationFailed

public void invocationFailed (FailureDescription failure)

由于某些错误条件，报告调用不完整。

将由 TradeFederation 框架自动调用。

参数
`failure`	`FailureDescription`：用于说明失败原因的 `FailureDescription`

invocationFailed

public void invocationFailed (Throwable cause)

由于某些错误条件，报告调用不完整。

将由 TradeFederation 框架自动调用。

参数
`cause`	`Throwable`：失败的 `Throwable` 原因

invocationSkipped

public void invocationSkipped (SkipReason reason)

将调用报告为跳过

参数
`reason`	`SkipReason`

invocationStarted

public void invocationStarted (IInvocationContext context)

报告测试调用的开始。

将由 TradeFederation 框架自动调用。报告程序需要替换此方法才能支持多设备报告。

参数
`context`	`IInvocationContext`：调用相关信息

logAssociation

public void logAssociation (String dataName, 
                LogFile logFile)

在某些情况下，日志必须与测试用例强相关联，但无法在直接 testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) 回调中执行此操作。因此，此回调允许显式提供强关联。

参数
`dataName`	`String`：数据的名称
`logFile`	`LogFile`：之前记录的 `LogFile`，应与测试用例相关联。

setSupportGranularResults

public void setSupportGranularResults (boolean enableGranularResults)

参数
`enableGranularResults`	`boolean`

supportGranularResults

public boolean supportGranularResults ()

如果报告程序支持精细结果，则返回 True；否则返回 False。

返回
`boolean`

testLog

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

提供测试调用中的关联日志或调试数据。

必须在 ERROR(/ITestInvocationListener#invocationFailed(Throwable)) 或 ERROR(/ITestInvocationListener#invocationEnded(long)) 之前调用

TradeFederation 框架会自动调用此方法，提供主机日志和（如果适用）设备 logcat。

参数
`dataName`	`String`：数据的 `String` 描述性名称，例如“device_logcat”。注意：每次调用时，dataName 可能不唯一。即，实现者必须能够处理具有相同 dataName 的多次调用
`dataType`	`LogDataType`：数据的 `LogDataType`
`dataStream`	`InputStreamSource`：数据的 `InputStreamSource`。实现人员应调用 createInputStream 以开始读取数据，并确保在完成后关闭生成的 InputStream。调用方应确保数据源在 testLog 方法完成之前保持存在且可访问。

testLogSaved

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

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

testModuleEnded

public void testModuleEnded ()

报告模块运行结束。

testModuleStarted

public void testModuleStarted (IInvocationContext moduleContext)

报告模块运行的开始时间。此回调与 testModuleEnded() 相关联，在序列中是可选的。它仅在使用模块（基于套件的运行程序）的运行期间使用。

参数
`moduleContext`	`IInvocationContext`：模块的 `IInvocationContext`。

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

报告测试运行结束。

参数
`elapsedTime`	`long`：设备报告的经过时间（以毫秒为单位）
`runMetrics`	：测试运行结束时报告的键值对

testRunFailed

public void testRunFailed (FailureDescription failure)

由于 FailureDescription 所述的失败，报告测试运行未能完成。

参数
`failure`	`FailureDescription`：描述失败及其上下文的 `FailureDescription`。

testRunFailed

public void testRunFailed (String failureMessage)

由于出现严重错误，报告测试运行未能完成。

参数
`failureMessage`	`String`：`String`，用于说明运行失败的原因。

testRunStarted

public void testRunStarted (String name, 
                int numTests, 
                int attemptNumber, 
                long startTime)

报告测试运行的开始。

参数
`name`	`String`：测试运行作业名称
`numTests`	`int`：测试运行中的测试总数
`attemptNumber`	`int`：顺序号，用于标识多次运行同一 runName 的不同尝试。attemptNumber 从 0 开始编号，每次有新的运行时都应递增。例如，如果某个测试进行了 3 次精细重试，则它在同一 runName 下总共应有 4 次运行，并且 attemptNumber 应介于 0 到 3 之间。
`startTime`	`long`：运行开始时间，通过 `System.currentTimeMillis()` 测量