Added warn code note in LoggerFactory

This commit is contained in:
2022-09-30 23:30:01 +08:00
parent 1107145460
commit f9743f75be
3 changed files with 48 additions and 4 deletions

View File

@@ -157,6 +157,12 @@ val inMemoryData: HashSet<YukiLoggerData>
> 当前全部已记录的日志数据。 > 当前全部已记录的日志数据。
::: danger
获取到的日志数据在 Hook APP (宿主) 及模块进程中是相互隔离的。
:::
### contents <span class="symbol">- field</span> ### contents <span class="symbol">- field</span>
```kotlin:no-line-numbers ```kotlin:no-line-numbers
@@ -173,6 +179,12 @@ val contents: String
如果当前没有已记录的日志会返回空字符串。 如果当前没有已记录的日志会返回空字符串。
::: danger
获取到的日志数据在 Hook APP (宿主) 及模块进程中是相互隔离的。
:::
### clear <span class="symbol">- method</span> ### clear <span class="symbol">- method</span>
```kotlin:no-line-numbers ```kotlin:no-line-numbers
@@ -187,6 +199,12 @@ fun clear()
> 清除全部已记录的日志。 > 清除全部已记录的日志。
::: danger
获取到的日志数据在 Hook APP (宿主) 及模块进程中是相互隔离的。
:::
你也可以直接获取 [inMemoryData](#inmemorydata-field) 来清除。 你也可以直接获取 [inMemoryData](#inmemorydata-field) 来清除。
### saveToFile <span class="symbol">- method</span> ### saveToFile <span class="symbol">- method</span>
@@ -209,7 +227,7 @@ fun saveToFile(fileName: String)
::: danger ::: danger
文件读写权限取决于当前宿主已获取的权限。 文件读写权限取决于当前宿主、模块已获取的权限。
::: :::

View File

@@ -149,6 +149,12 @@ val inMemoryData: HashSet<YukiLoggerData>
> 当前全部已记录的日志数据。 > 当前全部已记录的日志数据。
::: danger
获取到的日志数据在 Hook APP (宿主) 及模块进程中是相互隔离的。
:::
### contents <span class="symbol">- field</span> ### contents <span class="symbol">- field</span>
```kotlin:no-line-numbers ```kotlin:no-line-numbers
@@ -165,6 +171,12 @@ val contents: String
如果当前没有已记录的日志会返回空字符串。 如果当前没有已记录的日志会返回空字符串。
::: danger
获取到的日志数据在 Hook APP (宿主) 及模块进程中是相互隔离的。
:::
### clear <span class="symbol">- method</span> ### clear <span class="symbol">- method</span>
```kotlin:no-line-numbers ```kotlin:no-line-numbers
@@ -181,6 +193,12 @@ fun clear()
你也可以直接获取 [inMemoryData](#inmemorydata-field) 来清除。 你也可以直接获取 [inMemoryData](#inmemorydata-field) 来清除。
::: danger
获取到的日志数据在 Hook APP (宿主) 及模块进程中是相互隔离的。
:::
### saveToFile <span class="symbol">- method</span> ### saveToFile <span class="symbol">- method</span>
```kotlin:no-line-numbers ```kotlin:no-line-numbers
@@ -201,7 +219,7 @@ fun saveToFile(fileName: String)
::: danger ::: danger
文件读写权限取决于当前宿主已获取的权限。 文件读写权限取决于当前宿主、模块已获取的权限。
::: :::

View File

@@ -131,13 +131,19 @@ class YukiLoggerData internal constructor(
*/ */
object YukiHookLogger { object YukiHookLogger {
/** 当前全部已记录的日志数据 */ /**
* 当前全部已记录的日志数据
*
* - ❗获取到的日志数据在 Hook APP (宿主) 及模块进程中是相互隔离的
*/
val inMemoryData = HashSet<YukiLoggerData>() val inMemoryData = HashSet<YukiLoggerData>()
/** /**
* 获取当前日志文件内容 * 获取当前日志文件内容
* *
* 如果当前没有已记录的日志会返回空字符串 * 如果当前没有已记录的日志会返回空字符串
*
* - ❗获取到的日志数据在 Hook APP (宿主) 及模块进程中是相互隔离的
* @return [String] * @return [String]
*/ */
val contents: String val contents: String
@@ -157,6 +163,8 @@ object YukiHookLogger {
* 清除全部已记录的日志 * 清除全部已记录的日志
* *
* 你也可以直接获取 [inMemoryData] 来清除 * 你也可以直接获取 [inMemoryData] 来清除
*
* - ❗获取到的日志数据在 Hook APP (宿主) 及模块进程中是相互隔离的
*/ */
fun clear() = inMemoryData.clear() fun clear() = inMemoryData.clear()
@@ -167,7 +175,7 @@ object YukiHookLogger {
* *
* 日志文件会追加到 [fileName] 的文件结尾 - 若文件不存在会自动创建 * 日志文件会追加到 [fileName] 的文件结尾 - 若文件不存在会自动创建
* *
* - ❗文件读写权限取决于当前宿主已获取的权限 * - ❗文件读写权限取决于当前宿主、模块已获取的权限
* @param fileName 完整文件名 - 例如 /data/data/.../files/xxx.log * @param fileName 完整文件名 - 例如 /data/data/.../files/xxx.log
* @throws ErrnoException 如果目标路径不可写 * @throws ErrnoException 如果目标路径不可写
*/ */