框架的核心日志组件是log4j2,定义了日志格式,日志文件、及日志滚动文件的路径。
配置文件如下:
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="INFO" schema="Log4J-V2.0.xsd" packages="org.go.framework.core.log">
<!-- ===================================================================== -->
<!-- Appenders -->
<!-- ===================================================================== -->
<Appenders>
<!-- 控制台输出 -->
<Console name="Console" target="SYSTEM_OUT" >
<PatternLayout pattern="%d{DEFAULT} %level{length=5} [%tid] [%logger] MsgId[${ctx:MsgId}] %m%n"/>
</Console>
<!-- 日志文件-->
<RollingRandomAccessFile name="All"
fileName="${sys:sys.trc}trc/all_${sys:application.name}.log"
filePattern="/data/log-elk/%d{dd}/all_${sys:application.name}_%d{yyyy-MM-dd}.log" immediateFlush="false">
<PatternLayout pattern="%d{DEFAULT} %level{length=5} [%thread-%tid] Class=[%logger] MsgId[${ctx:MsgId}] PhoneNum[${ctx:GIGOLD_USR_MOBILE}] ProjectName[${sys:application.name}] %m%n"/>
<Policies>
<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
</Policies>
</RollingRandomAccessFile>
<!-- 重写规则 -->
<GigoldRewrite name="ALLRewrite">
<AppenderRef ref="All"/>
<AppenderRef ref="Console"/>
<GigoldMapRewritePolicy/>
</GigoldRewrite>
<!-- 所有日志 end-->
</Appenders>
<!-- ===================================================================== -->
<!-- Loggers -->
<!-- ===================================================================== -->
<Loggers>
<Root>
<AppenderRef ref="ALLRewrite" />
</Root>
</Loggers>
</Configuration>
控制台输出会输出在wrapper.log中。在服务器环境应该尽量屏蔽控制台输出,而输出在trc文件上。
其中控制台或者文件是否输出日志,可以由server.properties中的属性来控制
分别是log.console.trigger和log.routing.trigger属性
关键代码
private void dynamicConsole(GigoldRewrit rewrite) {
if (!Boolean
.valueOf(getProperty(LOG_CONSOLE_TRIGGER) != null ? getProperty(LOG_CONSOLE_TRIGGER)
: Boolean.FALSE.toString())) {
rewrite.removeAppenders(CONSOLE);// 移除控制台日志
}
}
private void dynamicFileAppender(GigoldRewrit rewrite) {
if (!Boolean
.valueOf(getProperty(LOG_ROUTING_TRIGGER) != null ? getProperty(LOG_ROUTING_TRIGGER)
: Boolean.FALSE.toString())) {
rewrite.removeAppenders(ROUTING);// 移除路由日志
}
}
框架日志输出的几个类:RPCLogger,ITFLogger,WebLogger等。
框架日志中几个重要的参数:
参数名 | 说明 |
---|---|
ProjectName | 顾名思义,项目名称 |
gid | 会话的SessionId,就是常说的sid |
MsgId | 请求Id,链接各个服务日志的关键。从请求建立到后续依次访问的服务都会使用这个MsgId并输出在日志文件中。 |
如果我们在项目中需要进行日志记录,推荐是继承org.go.framework.service.AbstractService这样的类,而非是在类中定义这样的日志实例:
private static Logger log = LogManager.getLogger(UserController.class.getName());
写日志时推荐以下的作法:
info("当前登录用户是:{}", userId);
不推荐的作法:
info("当前登录用户是:" + userId);
因为如果当前日志级别不需要打印时,后者需要进行一次字符串的计算,而前者不需要。