为什么仅需在Controller层声明logger即可被下层Service直接调用
Kotlin项目中Controller声明Logger后Service可直接调用的底层原因
这个现象不是Spring或KotlinLogging框架的默认特性,本质是你的项目代码结构符合Kotlin的语法规则导致的,核心原因分三类:
- 最常见的原因:你声明的logger是包级顶层属性
你贴的代码里val logger = KotlinLogging.logger { }写在了@RestController类的外部,也就是kt文件的顶层位置。Kotlin语法中,在类外部、kt文件顶层声明的属性属于包级属性,同一个包下的所有类都可以直接访问该属性,不需要额外声明或注入。
如果你的Service和声明logger的Controller刚好在同一个包下,自然可以直接调用logger对象,和两个类的调用关系没有任何关系。刚好你说的“调用该Service的Controller”和Service处于同一个包,所以你在这个Controller的kt文件顶层加了logger声明后,同包的Service就能直接访问,完全符合这个规则。
示例结构:
package com.xxx.yourpackage // Controller和Service都在这个包下 import ... // 包级顶层属性,同包所有类可直接访问 val logger = KotlinLogging.logger { } @RestController class TestController { // 调用TestService的逻辑 }
同包下的Service:
package com.xxx.yourpackage // 和上面的Controller包名完全一致 class TestService { fun test() { // 因为同包,直接访问顶层的logger属性 logger.info { "test log" } } }
- 次常见原因:项目做了自定义封装
如果你的所有Service都继承了同一个基类,或者项目给Service加了自定义Kotlin扩展,基类/扩展内部会自动获取当前请求调用链上层Controller的logger对象,也会出现这个现象,但这属于项目自定义改造的逻辑,不是通用特性。 - 特殊情况:IDE自动导入了包级属性
你在Controller文件声明的包级logger,可能在你写Service代码时被IDE自动补全添加了对应import语句,即使Service和Controller不同包也能访问,本质还是包级属性的导入访问规则。
注意:这种日志用法不规范,所有通过该logger打印的日志,类名都会显示为声明logger的包对应的类,无法区分日志实际是Service还是Controller打印的,排查问题难度会高很多。规范用法是每个类单独声明自己的类内logger。
内容的提问来源于stack exchange,提问作者nykon
相关产品推荐
相关产品推荐

