Skip to content

Commit 6553865

Browse files
committed
修改readme和changelog
Signed-off-by: ForteScarlet <[email protected]>
1 parent 87354d3 commit 6553865

File tree

4 files changed

+46
-3
lines changed

4 files changed

+46
-3
lines changed

.changelog/v3.0.0.preview.9.0.md

+8
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@
88

99
- **`ChatroomMessageEvent`** -> **`ChatRoomMessageEvent`**
1010

11+
## 日志模块
12+
13+
现在只有 `simbot-core``simboot-core` 模块中会携带并传递 `simbot-logger` 模块,
14+
`simboot-core-spring-boot-starter` 模块将会使用 `` 作为默认日志实现。
15+
16+
但是仍有组件可能会携带 `simbot-logger`。这会在未来慢慢优化。如有需要,请考虑排除 `love.forte.simbot:simbot-logger` 模块
17+
并添加所需要的其他 `SLF4J` 框架实现。
18+
1119
## Application实现
1220

1321
`api` 模块所提供的新概念,且 `core``boot``spring-boot-starter` 模块分别提供其各自的默认实现。

apis/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## APIs
2+
3+
Apis模块,提供一些可能贯穿各模块的基础性模块。

apis/simbot-api/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
## API
22

3-
Api模块,提供多平台的基础信息定义与规范,以及一些可能的平台(指聊天机器人平台)下的额外API
3+
Api模块,提供simbot的基础信息定义与规范

apis/simbot-logger/README.md

+34-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,35 @@
1-
## API
1+
## LOGGER
22

3-
Api模块,提供多平台的基础信息定义与规范,以及一些可能的平台(指聊天机器人平台)下的额外API。
3+
Logger模块,提供在simbot环境下默认使用的 [SLF4J API](https://www.slf4j.org/) 日志实现。
4+
5+
`simbot-logger` 提供简易的高性能异步实现,总之会比你使用 `System.out` 要强点儿。
6+
7+
## 日志级别
8+
9+
`simbot-logger` 暂不提供任何配置文件,如果想要调整全局日志等级,添加JVM参数: `simbot.logger.level=LEVEL`
10+
11+
`LEVEL` 可选值为 `org.slf4j.event.Level` 中的枚举值:
12+
13+
- **`ERROR`**
14+
- **`WARN`**
15+
- **`INFO`**
16+
- **`DEBUG`**
17+
- **`TRACE`**
18+
19+
日志级别默认为 `INFO`
20+
21+
示例:
22+
23+
```shell
24+
java -jar foo.jar -Dsimbot.logger.level=DEBUG
25+
```
26+
27+
## 日志处理
28+
29+
`simbot-logger` 对于日志的处理全部交由所有的 `love.forte.simbot.logger.SimbotLoggerProcessor` 实现处理。
30+
需要使用的所有 `love.forte.simbot.logger.SimbotLoggerProcessor` 将会由 `love.forte.simbot.logger.SimbotLoggerProcessorsFactory`
31+
的第一个可用的服务实现来提供。
32+
33+
具体参考上述相关接口的文档注释。
34+
35+
当前环境中未提供任何日志处理实现的时候会默认使用控制台输出处理器。

0 commit comments

Comments
 (0)