在 Java 项目中，日志记录是开发中的一个重要部分，用于跟踪系统运行状态、排查问题以及记录重要事件。在定义日志记录器时，经常会遇到一些写法上的选择，比如 Logger 的作用域、是否使用静态变量，以及如何命名变量。本篇文章将深入探讨这三种常见写法的优缺点及适用场景。
文章目录
1. 常见的 Logger 定义方式
以下是三种常见的 Logger 定义方式：
1.1 使用 private static final 并指定类名
private static final Logger LOGGER = LoggerFactory.getLogger(xxx.class);
- 使用类名作为日志记录器的上下文，通常推荐的写法。
- 定义为 static 表明这是类级别的日志记录器，不随实例化变化。
- final 确保引用不会被重新赋值。
优点：
性能最佳。日志记录器在类加载时只初始化一次，减少运行时开销。
清晰直观，日志记录器的名称与当前类绑定。
是多数 Java 开发团队的最佳实践，符合常见编码规范。
缺点：
只能在当前类中使用，如果子类需要日志功能，需要重新定义自己的日志记录器。
1.2 使用 private final 并指定类名
private final Logger LOGGER = LoggerFactory.getLogger(xxx.class);
- 非静态变量，意味着每次创建类实例时都会初始化日志记录器。
- 定义为 final，但生命周期与类实例绑定。
优点：
如果日志需要绑定到类的实例，而非类本身（极少见），可以考虑这种方式。
适用于极少数特定需求，比如动态代理或依赖注入。
缺点：
每次实例化都会重新创建日志记录器，性能开销大，通常不推荐。
不符合日志记录器与类绑定的惯例，大多数团队不会采用。
1.3 使用 this.getClass() 动态获取类名
private static final Logger LOGGER = LoggerFactory.getLogger(this.getClass());
- 动态获取当前类的名称作为日志记录器的上下文。
- 通常在基类中定义，以便子类可以复用同一个代码逻辑而获取自己的类名。
优点：
基类定义日志记录器时，子类无需重复声明，减少代码冗余。
动态适配子类的名称，方便统一管理日志输出。
缺点：
this.getClass() 是运行时操作，性能稍差。
如果子类与基类日志内容强耦合，可能导致调试困难。
2. Logger 定义中的其他考量
2.1 Logger 的命名：大写还是小写？
- 推荐使用全大写（如
LOGGER），符合static final常量的命名规范。 - 小写（如
logger）虽然可以使用，但在团队合作中可能造成代码风格不一致的问题。
2.2 Logger 的访问修饰符：private 还是 protected？
1、private：
日志记录器是类的内部实现细节，通常不需要对子类暴露，推荐使用 private。
每个类有自己的日志记录器，便于区分日志来源。
2、 protected：在需要共享日志记录器的场景下（如基类和子类高度相关），可以考虑使用 protected。
使用时要小心，避免子类滥用父类日志记录器，造成日志内容混乱。
3. 推荐的最佳实践
- 从性能、可读性和维护性出发，推荐如下写法：
private static final Logger LOGGER = LoggerFactory.getLogger(xxx.class);
- 符合日志记录器与类绑定的习惯。
- 性能最佳，日志记录器只初始化一次。
- 明确日志来源，便于日志排查和维护。
- 特殊场景：如果存在父类与子类共享日志逻辑的需求，可以使用
this.getClass()动态适配子类名称，但需要权衡性能和复杂性。
4. 总结
- 首选：
private static final配合类名，既高效又清晰。 - 少用： 非静态日志记录器，性能较差，且不符合日志记录器设计惯例。
- 慎用： 动态获取类名的日志记录器，适合特殊场景如父类通用日志逻辑。
在实际开发中，遵循团队规范并结合具体需求进行选择，始终以可读性、性能和可维护性为优先。