LogFileSaver

public class LogFileSaver
extends Object

java.lang.Object
↳	com.android.tradefed.result.LogFileSaver

---

用于将日志数据保存到文件中的 ITestInvocationListener 辅助程序

摘要

公共构造函数
LogFileSaver(IBuildInfo buildInfo, File rootDir) 创建 LogFileSaver。
LogFileSaver(IBuildInfo buildInfo, File rootDir, Integer logRetentionDays) 创建 LogFileSaver。
LogFileSaver(File rootDir) 备选的 LogFileSaver 构造函数，只会将给定目录用作日志存储目录。

公共方法
File	createCompressedLogFile(String dataName, LogDataType origDataType) 创建一个空文件以存储压缩的日志数据。
OutputStream	createGZipLogStream(File logFile) 创建输出流以将 GZIP 压缩的数据写入文件
InputStream	createInputStreamFromFile(File logFile) 用于创建输入流以读取给定日志文件内容的辅助方法 TODO：考虑将此方法移至其他位置。
File	getFileDir() 获取用于存储文件的目录。
	getInvocationLogPathSegments()
File	saveAndGZipLogData(String dataName, LogDataType dataType, InputStream dataStream) 将日志数据保存并压缩到 gzip 文件（如有必要）
File	saveAndGZipLogFile(String dataName, LogDataType dataType, File fileToLog) 将日志数据保存并压缩到 gzip 文件（如有必要）
File	saveLogData(String dataName, LogDataType dataType, InputStream dataStream) 将日志数据保存到文件中
File	saveLogDataRaw(String dataName, String ext, InputStream dataStream) 将原始数据保存到文件中
File	saveLogFile(String dataName, LogDataType dataType, File fileToLog) 保存指定的日志文件

公共构造函数

LogFileSaver

public LogFileSaver (IBuildInfo buildInfo, 
                File rootDir)

创建 LogFileSaver。

在 rootDir/branch/build_id/uniqueDir 中构建唯一的文件系统目录

参数
buildInfo	IBuildInfo：IBuildInfo
rootDir	File：根文件系统路径

LogFileSaver

public LogFileSaver (IBuildInfo buildInfo, 
                File rootDir, 
                Integer logRetentionDays)

创建 LogFileSaver。

在 rootDir/branch/build_id/testTag/uniqueDir 中构建唯一的文件系统目录

如果目录创建失败，则使用临时目录。

参数
buildInfo	IBuildInfo：IBuildInfo
rootDir	File：根文件系统路径
logRetentionDays	Integer：如果提供，系统会将“.retention”文件写入日志目录，其中包含等于当前时间 + logRetentionDays 的时间戳。外部清理脚本可以使用此文件来确定何时删除日志目录。

LogFileSaver

public LogFileSaver (File rootDir)

一个备选的 LogFileSaver 构造函数，只会将给定目录用作日志存储目录。

公共方法

createCompressedLogFile

public File createCompressedLogFile (String dataName, 
                LogDataType origDataType)

创建一个空文件以存储压缩的日志数据。

参数
dataName	String：要存储的数据的 String 描述性名称。
origDataType	LogDataType：要存储的 LogDataType 的类型

返回
File	ERROR(/File)

抛出
	如果无法创建日志文件

createGZipLogStream

public OutputStream createGZipLogStream (File logFile)

创建输出流以将 GZIP 压缩的数据写入文件

参数
logFile	File：要写入的 ERROR(/File)

返回
OutputStream	ERROR(/OutputStream) 来压缩数据并将其写入文件。 此数据流

抛出
	如果无法生成数据流

createInputStreamFromFile

public InputStream createInputStreamFromFile (File logFile)

用于创建输入流以读取给定日志文件内容的辅助方法

TODO：考虑将此方法移至其他位置。目前放置在此处，以便此类的用户进行模拟。

参数
logFile	File：要读取的 ERROR(/File)

返回
InputStream	一个缓冲的 ERROR(/InputStream) 来读取文件数据。调用方必须在完成时调用此流

抛出
	如果无法生成数据流

getFileDir

public File getFileDir ()

获取用于存储文件的目录。

返回
File	ERROR(/File) 目录

getInvocationLogPathSegments

public  getInvocationLogPathSegments ()

返回
	唯一的调用日志路径片段。

saveAndGZipLogData

public File saveAndGZipLogData (String dataName, 
                LogDataType dataType, 
                InputStream dataStream)

将日志数据保存并压缩到 gzip 文件（如有必要）

参数
dataName	String：数据的 String 描述性名称。
dataType	LogDataType：文件的 LogDataType。日志数据（即 LogDataType.isCompressed() 为 true）
dataStream	InputStream：数据的 ERROR(/InputStream)。

返回
File	生成的数据的文件

抛出
	如果无法生成日志文件

saveAndGZipLogFile

public File saveAndGZipLogFile (String dataName, 
                LogDataType dataType, 
                File fileToLog)

将日志数据保存并压缩到 gzip 文件（如有必要）

参数
dataName	String：数据的 String 描述性名称。
dataType	LogDataType：文件的 LogDataType。日志数据为 a（即 LogDataType.isCompressed() 为 true）
fileToLog	File：要保存的 ERROR(/File)

返回
File	生成的数据的文件

抛出
	如果无法生成日志文件

saveLogData

public File saveLogData (String dataName, 
                LogDataType dataType, 
                InputStream dataStream)

将日志数据保存到文件

参数
dataName	String：数据的 String 描述性名称。
dataType	LogDataType：文件的 LogDataType。
dataStream	InputStream：数据的 ERROR(/InputStream)。

返回
File	生成的数据的文件

抛出
	如果无法生成日志文件

saveLogDataRaw

public File saveLogDataRaw (String dataName, 
                String ext, 
                InputStream dataStream)

将原始数据保存到文件

参数
dataName	String：数据的 String 描述性名称。
ext	String：日期的扩展
dataStream	InputStream：数据的 ERROR(/InputStream)。

返回
File	生成的数据的文件

抛出
	如果无法生成日志文件

saveLogFile

public File saveLogFile (String dataName, 
                LogDataType dataType, 
                File fileToLog)

保存指定的日志文件

参数
dataName	String：数据的 String 描述性名称。
dataType	LogDataType：文件的 LogDataType。
fileToLog	File：要记录的 ERROR(/File)

返回
File	生成的数据的文件

抛出
	如果无法生成日志文件