- 前言
- Java项目中日志引入与实现
- 开启日志
- 日志实现
- 系统日志
- 操作日志
- 相关文章
一个项目中日志是必不可少的功能,在开发、测试、部署、线上等环境下,日志可以帮助开发人员对程序的执行、问题排除带来帮助。
而日志又分为系统日志和操作日志:
- 系统日志是为了了解应用程序的执行过程,比如请求日志、在if…else…等进行了哪个分支、在某一行代码对信息进行打印输出,通过日志信息帮助开发人员了解系统的执行
- 操作日志一般是给用户看的,比如订单的创建中间的步骤,目前进度到了哪里、或者是对一些信息做了新增或修改;这样子对操作日志的可读性有一定要求
那么在系统中如何实现呢?最简单操作日志的就是使用log.info("用户{} 将收货地址‘{}’ 修改为 ‘{}’ ", userId, oldAddr, newAddr);将修改记录进行输出。这里对修改信息进行了收集,但对于代码而言增加了代码可读性的负担,或者说侵入性。到了要进行日志输出时就需要调用log.xxx(xxxx);,有什么办法可以解决呢?
Java项目中日志引入与实现 开启日志比较常用的日志Log4j、Log4j2、Logbak,在SpringBoot中使用门面模式对不同的日志进行支持
SpringBoot项目中导入starter依赖时,默认使用Logback日志。它使用门面模式Slf4j来做制定了日志功能接口,具体使用的日志只需要实现功能,就可以做到无缝切换
maven依赖:
org.springframework.boot spring-boot-starter
springboot默认使用logback,这里也就使用logback进行讲解,首先是配置文件
# 日志默认是info级别, 可以对特定的路径指定日志等级
logging:
level:
com.zsl.service.dao: debug
log配置文件名:
| Logging System | Customization |
|---|---|
| Logback | logback-spring.xml, logback-spring.groovy, logback.xml, or logback.groovy |
| Log4j2 | log4j2-spring.xml or log4j2.xml |
| JDK (Java Util Logging) | logging.properties |
自定义配置 ‘logback-spring.xml’:
日志实现 系统日志logback debug ${CONSOLE_LOG_PATTERN} UTF-8 ${log.path}/debug.log %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n UTF-8 ${log.path}/debug-%d{yyyy-MM-dd}.%i.log 1000MB 15 debug ACCEPT DENY ${log.path}/info.log %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n UTF-8 ${log.path}/info-%d{yyyy-MM-dd}.%i.log 1000MB 15 info ACCEPT DENY ${log.path}/warn.log %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n UTF-8 ${log.path}/warn-%d{yyyy-MM-dd}.%i.log 1000MB 15 warn ACCEPT DENY ${log.path}/error.log %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n UTF-8 ${log.path}/error-%d{yyyy-MM-dd}.%i.log 100MB 1 ERROR ACCEPT DENY ${log.path}/all.log %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n UTF-8 ${log.path}/all-%d{yyyy-MM-dd}.%i.log 1000MB 15 DEBUG DENY ACCEPT
系统日志,为了了解执行过程,采用Interceptor的形式对请求进行日志收集,对于配置的执行过程,可以使用log.info()进行日志输出。
目前只实现了雏形后续每天会不断完善
包结构:
这里使用interceptor实现:
package com.zsl.custombox.log.core.interceptor;
import com.zsl.custombox.common.util.SecurityContextHolder;
import com.zsl.custombox.common.util.ServletUtil;
import com.zsl.custombox.common.model.log.SystemLogContext;
import com.zsl.custombox.common.util.SystemLogContextHolder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
public class AccessLogInterceptor implements HandlerInterceptor {
private final Logger log = LoggerFactory.getLogger(this.getClass());
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
// 创建全局日志记录上下文 todo 获取数据(实现工具类)
SystemLogContext systemLogContext = new SystemLogContext()
.setUserId(SecurityContextHolder.getAuth().getUserId())
.setRequestNo(0L)// 可以使用雪花算法获取64位唯一id
.setIp(ServletUtil.getIp())
.setUri(request.getRequestURI())
.setMethod(request.getMethod())
.setStartTime(new Date(System.currentTimeMillis()));
// 存储全局日志记录上下文
SystemLogContextHolder.set(systemLogContext);
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
SystemLogContext systemLogContext = SystemLogContextHolder.get();
systemLogContext.setRespTime(System.currentTimeMillis() - systemLogContext.getStartTime().getTime());
// format log
StringBuilder requestStr = new StringBuilder();
List
日志记录全局上下文:
package com.zsl.custombox.common.model.log;
import lombok.Data;
import lombok.experimental.Accessors;
import java.util.Date;
import java.util.Map;
@Data
@Accessors(chain = true)
public class SystemLogContext {
// =========================== request data ===========================
// 用户id(匿名为0)
private Long userId;
// 请求号码,保证请求调用时请求号不变
private Long requestNo;
// ip地址
private String ip;
// 统一资源接口uri
private String uri;
// 参数
// private String params;
// 请求方法(GET、POST...)
private String method;
// 请求时间
private Date startTime;
// =========================== response data ===========================
// 响应时间
private Long respTime;
// 响应码
private Integer respCode;
// 响应信息
private String respMsg;
// 响应体
// private String respBody;
}
日志记录上下文工具类:
package com.zsl.custombox.log.core.util;
import com.zsl.custombox.log.core.model.LogRecordContext;
public class LogRecordContextHolder {
private static final ThreadLocal LOG_RECORD_CONTEXT = new ThreadLocal<>();
public static LogRecordContext get() {
return LOG_RECORD_CONTEXT.get();
}
public static void set(LogRecordContext logRecordContext) {
LOG_RECORD_CONTEXT.set(logRecordContext);
}
public static void clear() {
LOG_RECORD_CONTEXT.remove();
}
}
自动配置类:
package com.zsl.custombox.log.config;
import com.zsl.custombox.log.core.interceptor.AccessLogInterceptor;
import com.zsl.custombox.log.core.model.logrecord.LogRecordOperationSource;
import com.zsl.custombox.log.core.service.record.DefaultLogRecordServiceImpl;
import com.zsl.custombox.log.core.service.record.ILogRecordService;
import com.zsl.custombox.log.core.service.function.DefaultFunctionServiceImpl;
import com.zsl.custombox.log.core.service.function.IFunctionService;
import com.zsl.custombox.log.core.service.function.IParseFunction;
import com.zsl.custombox.log.core.service.function.ParseFunctionFactory;
import com.zsl.custombox.log.core.service.operator.DefaultOperatorGetServiceImpl;
import com.zsl.custombox.log.core.service.operator.IOperatorGetService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import java.util.List;
@Configuration
public class LogAutoConfiguration implements WebMvcConfigurer {
// ========================== 拦截器 ==========================
@Bean
public AccessLogInterceptor accessLogInterceptor() {
return new AccessLogInterceptor();
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(this.accessLogInterceptor());
}
// ========================== 操作日志容器 ==========================
// 处理注解信息操作源
@Bean
public LogRecordOperationSource logRecordOperationSource () {
return new LogRecordOperationSource();
}
// 自定义函数
@Bean
@ConditionalOnMissingBean(IFunctionService.class)
public IFunctionService functionService(ParseFunctionFactory parseFunctionFactory) {
return new DefaultFunctionServiceImpl(parseFunctionFactory);
}
@Bean
public ParseFunctionFactory parseFunctionFactory(@Autowired List list) {
return new ParseFunctionFactory(list);
}
@Bean
@ConditionalOnMissingBean(IParseFunction.class)
public IParseFunction defaultParseFunction() {
return new IParseFunction() {
@Override
public String functionName() {
return null;
}
@Override
public String apply(String value) {
return null;
}
};
}
// 持久化
@Bean
@ConditionalOnMissingBean(ILogRecordService.class)
public ILogRecordService logRecordService() {
return new DefaultLogRecordServiceImpl();
}
// 操作人
@Bean
@ConditionalOnMissingBean(IOperatorGetService.class)
public IOperatorGetService operatorGetService() {
return new DefaultOperatorGetServiceImpl();
}
}
操作日志
使用AOP+注解的方式,进行操作日志:
@Aspect
@Component
public class LogRecordAspect {
private final Logger log = LoggerFactory.getLogger(this.getClass());
@Autowired
ILogRecordService logRecordService;
@Autowired
IFunctionService functionService;
LogRecordValueParser logRecordValueParser = new LogRecordValueParser(new LogRecordExpressionEvaluator(), functionService);
@Around("@annotation(com.zsl.custombox.log.core.annotation.LogRecord)")
public Object logRecord(ProceedingJoinPoint point) throws Throwable {
return execute(point, point.getTarget().getClass(), ((MethodSignature) point.getSignature()).getMethod(), point.getArgs());
}
private Object execute(ProceedingJoinPoint point, Class> targetClass, Method method, Object[] args) throws Throwable {
Object ret = null;
LogRecordContext.putEmptySpan();
MethodExceptionResult exceptionResult = new MethodExceptionResult(true, null, "");
// 拆分注解信息存储为List等待执行
// 执行List中自定义函数
String spEL = getAnnotation(method).content();
try {
ret = point.proceed();
} catch (Throwable throwable) {
exceptionResult = new MethodExceptionResult(false, throwable, throwable.getMessage());
}
// 解析List中SpEL
try {
// 存储日志
if (Strings.isNotBlank(spEL)) {
recordExecute(ret, method, args, spEL, targetClass,
exceptionResult.isSuccess(), exceptionResult.getErrorMsg());
}
} catch (Throwable t) {
log.error("记录操作日志失败,不影响业务执行!", t);
} finally {
// 清理 Context
LogRecordContext.clear();
}
// 执行失败将异常抛出
if (!exceptionResult.isSuccess()) {
throw exceptionResult.getThrowable();
}
return ret;
}
private void recordExecute(Object ret, Method method, Object[] args, String spEL, Class> targetClass, boolean success, String errorMsg) {
// 创建上下文
EvaluationContext evaluationContext = logRecordValueParser.createEvaluationContext(method, args, ret, errorMsg);
// 获取评估后expressionString
String expression = logRecordValueParser.getExpression(spEL, new AnnotatedElementKey(method, targetClass), evaluationContext);
// 持久化操作日志
logRecordService.record(new com.zsl.custombox.log.core.model.logrecord.LogRecord(expression));
}
private Method getMethod(ProceedingJoinPoint point) {
return ((MethodSignature) point.getSignature()).getMethod();
}
private LogRecord getAnnotation(Method method) {
LogRecord annotation = method.getAnnotation(LogRecord.class);
return annotation;
}
}
例:
public class XxxxServiceImpl {
@LogRecord(content = "'修改用户名为' + #userParam.username")
public int updateUser(UserParam userParam) {
return mapper.updateUser(userParam);
}
}
最终记录操作日志:修改用户名为xxx
这个只是简易版,后续会完善注解解析,期待的效果 " 用户xxx 修改用户名 ‘aaa’ 为 ‘bbb’ "
后续会将使用SpEL实现日志项目完善提交到Github中,欢迎关注~
https://github.com/zsl0/costom_box
实战!日志打印的15个好建议
如何优雅地记录操作日志?



