实现步骤:
一、添加依赖文件
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions><!-- 去掉springboot默认配置 -->
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<!-- log4j2相关 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
<!-- log4j2相关 -->
<!--AOP相关-->
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>1.9.19</version>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjtools</artifactId>
<version>1.9.19</version>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.9.19</version>
</dependency>
<dependency>
<groupId>aopalliance</groupId>
<artifactId>aopalliance</artifactId>
<version>1.0</version>
</dependency>
<!--Spring和AspectJ整合中间件-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aspects</artifactId>
<version>6.0.9</version>
</dependency>
<!--AOP相关-->
二、添加配置文件
<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status,这个用于设置log4j2自身内部的信息输出,可以不设置,当设置成trace时,你会看到log4j2内部各种详细输出-->
<!--monitorInterval:Log4j能够自动检测修改配置 文件和重新配置本身,设置间隔秒数-->
<configuration status="WARN" monitorInterval="1800">
<Properties>
<!-- 日志默认存放的位置,这里设置为项目根路径下,也可指定绝对路径 -->
<!-- ${web:rootDir}是web项目根路径,java项目没有这个变量,需要删掉,否则会报异常 -->
<property name="basePath">log4j2Logs</property>
<!-- <property name="basePath">${web:rootDir}/log4j2Logs</property>-->
<!-- <property name="basePath">d:/qfxSpringMVCMybaitsDemoLogs</property> -->
<!-- 控制台默认输出格式,"%-5level":日志级别,"%l":输出完整的错误位置,是小写的L,因为有行号显示,所以影响日志输出的性能 -->
<property name="console_log_pattern">%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %l - %m%n</property>
<!-- 日志文件默认输出格式,不带行号输出(行号显示会影响日志输出性能);%C:大写,类名;%M:方法名;%m:错误信息;%n:换行 -->
<property name="log_pattern">%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %C.%M - %m%n</property>
<!-- 日志默认切割的最小单位 -->
<property name="every_file_size">20MB</property>
<!-- 日志默认输出级别 -->
<property name="output_log_level">DEBUG</property>
<!-- 日志默认存放路径(所有级别日志) -->
<property name="rolling_fileName">${basePath}/all.log</property>
<!-- 日志默认压缩路径,将超过指定文件大小的日志,自动存入按"年月"建立的文件夹下面并进行压缩,作为存档 -->
<property name="rolling_filePattern">${basePath}/%d{yyyy-MM}/all-%d{yyyy-MM-dd}-%i.log.gz</property>
<!-- 日志默认同类型日志,同一文件夹下可以存放的数量,不设置此属性则默认为7个 -->
<property name="rolling_max">50</property>
<!-- Info日志默认存放路径(Info级别日志) -->
<property name="info_fileName">${basePath}/info.log</property>
<!-- Info日志默认压缩路径,作为存档 -->
<property name="info_filePattern">${basePath}/%d{yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log.gz</property>
<!-- Info日志默认同一文件夹下可以存放的数量,不设置此属性则默认为7个 -->
<property name="info_max">10</property>
<!-- Warn日志默认存放路径(Warn级别日志) -->
<property name="warn_fileName">${basePath}/warn.log</property>
<!-- Warn日志默认压缩路径,作为存档 -->
<property name="warn_filePattern">${basePath}/%d{yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log.gz</property>
<!-- Warn日志默认同一文件夹下可以存放的数量,不设置此属性则默认为7个 -->
<property name="warn_max">10</property>
<!-- Error日志默认存放路径(Error级别日志) -->
<property name="error_fileName">${basePath}/error.log</property>
<!-- Error日志默认压缩路径,作为存档 -->
<property name="error_filePattern">${basePath}/%d{yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log.gz</property>
<!-- Error日志默认同一文件夹下可以存放的数量,不设置此属性则默认为7个 -->
<property name="error_max">10</property>
<!-- 控制台显示的日志最低级别 -->
<property name="console_print_level">DEBUG</property>
</Properties>
<!--定义appender -->
<appenders>
<!-- 用来定义输出到控制台的配置 -->
<Console name="Console" target="SYstem_OUT">
<!-- 设置控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
<ThresholdFilter level="${console_print_level}" onMatch="ACCEPT" onMismatch="DENY"/>
<!-- 设置输出格式,不设置默认为:%m%n -->
<PatternLayout pattern="${console_log_pattern}"/>
</Console>
<!-- 打印root中指定的level级别以上的日志到文件 -->
<RollingFile name="RollingFile" fileName="${rolling_fileName}" filePattern="${rolling_filePattern}">
<PatternLayout pattern="${log_pattern}"/>
<SizeBasedTriggeringPolicy size="${every_file_size}"/>
<!-- 设置同类型日志,如果不设置此属性则默认存放7个文件 -->
<DefaultRolloverStrategy max="${rolling_max}"/>
</RollingFile>
<!-- 打印INFO级别的日志到文件 -->
<RollingFile name="InfoFile" fileName="${info_fileName}" filePattern="${info_filePattern}">
<PatternLayout pattern="${log_pattern}"/>
<SizeBasedTriggeringPolicy size="${every_file_size}"/>
<DefaultRolloverStrategy max="${info_max}"/>
<Filters>
<ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/>
<ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
</Filters>
</RollingFile>
<!-- 打印WARN级别的日志到文件 -->
<RollingFile name="WarnFile" fileName="${warn_fileName}" filePattern="${warn_filePattern}">
<PatternLayout pattern="${log_pattern}"/>
<SizeBasedTriggeringPolicy size="${every_file_size}"/>
<DefaultRolloverStrategy max="${warn_max}"/>
<Filters>
<ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL"/>
<ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/>
</Filters>
</RollingFile>
<!-- 打印ERROR级别的日志到文件 -->
<RollingFile name="ErrorFile" fileName="${error_fileName}" filePattern="${error_filePattern}">
<PatternLayout pattern="${log_pattern}"/>
<SizeBasedTriggeringPolicy size="${every_file_size}"/>
<DefaultRolloverStrategy max="${error_max}"/>
<Filters>
<ThresholdFilter level="FATAL" onMatch="DENY" onMismatch="NEUTRAL"/>
<ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
</Filters>
</RollingFile>
</appenders>
<!--然后定义logger,只有定义了logger并引入的appender,appender才会生效-->
<loggers>
<!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
<logger name="org.springframework" level="INFO"/>
<logger name="org.mybatis" level="INFO"/>
<!-- 设置对打印sql语句的支持 -->
<logger name="java.sql" level="debug" additivity="false">
<appender-ref ref="Console"/>
</logger>
<!--建立一个默认的root的logger-->
<root level="${output_log_level}">
<appender-ref ref="RollingFile"/>
<appender-ref ref="Console"/>
<appender-ref ref="InfoFile"/>
<appender-ref ref="WarnFile"/>
<appender-ref ref="ErrorFile"/>
</root>
</loggers>
</configuration>
log4j2测试:
@Slf4j
public class DemoTest {
public static void main(String[] args) {
log.info("info");
log.error("error");
log.warn("warn");
log.debug("debug");
}
}
运行后会在项目文件夹下自动创建出<property name="basePath">log4j2Logs</property>
**log4j2Logs文件夹 **
三、封装日志类
@Getter
@Setter
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class LogBean {
private String who;
private LocalDateTime time;
private String ip;
private String done;
private String params;
private Object result;
@Override
public String toString() {
return JsonUtil.obj2String(this);
}
}
四、测试
public interface Demo {
public int fun();
}
public class DemoImpl implements Demo {
@Override
public int fun(){
System.out.println("业务……");
return 3;
}
}
- 创建AOP类
@Aspect
@Component
public class AopDemo {
//前置增强
//对com.wego.service包及其子包下的,任意类,任意方法名,任意参数,任意返回值,进行功能增强
@Before("execution(* com.wego.service..*.*(..))")
public void before(JoinPoint joinPoint){
String s = joinPoint.getTarget().getClass().getName()
+ "."
+ joinPoint.getSignature().getName()
+"()";
System.out.println("日志:开始执行方法....." +s);
}
//后置增强
@After("execution(* com.wego.service..*.*(..))")
public void after(JoinPoint joinPoint){
String s = joinPoint.getTarget().getClass().getName()
+ "."
+ joinPoint.getSignature().getName()
+"()";
System.out.println("日志:方法执行结束....." +s);
}
//返回值增强
@AfterReturning(value = "execution(* com.wego.service..*.*(..))" ,returning = "res")
public void returning(Integer res){
System.out.println("返回值增强 "+res);
}
@AfterThrowing(value = "execution(* com.wego.service..*.*(..))",throwing = "ex")
public void throwing(Exception ex){
System.out.println("异常增强 "+ex);
}
//环绕增强
@Around("execution(* com.wego.service..*.*(..))")
public Object around(ProceedingJoinPoint joinPoint) {
System.out.println("前置增强");
Object result = null;
try {
result = joinPoint.proceed();
System.out.println("返回值增强" + result);
} catch (Throwable e) {
System.out.println("异常增强 " + e);
} finally {
System.out.println("后置增强");
}
return result;
}
}
- 单元测试
@ExtendWith(SpringExtension.class)
@ContextConfiguration({"/spring-context.xml", "/spring-mybatis.xml"})
public class DemoTest {
@Autowired
private Demo demo;
@Test
void fun(){
demo.fun();
}
}
示例02:基于AOP的Controller层统一日志
创建Aop类
@Slf4j
@Aspect
@Component
public class LogAspect {
/**
* 切入点:设置方法会在com.wego.controller包及其子包下的、任意访问控制修饰符修饰的、返回值为任意类型的、包含任何多个参数的、任意方法、执行之前执行
*/
@Pointcut("execution(* com.wego.controller..*.*(..))")
public void fun() {
}
/**
* 环绕通知
* 第一个参数可以定义为org.aspectj.lang.ProceedingJoinPoint类型
* @param joinPoint
* @return
* @throws Throwable
*/
@Around("fun()")
public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
Object result = null;
//取得类名和方法名
final String fullMethodName = getFullMethodName(joinPoint);
//相当于前置通知
log.info(fullMethodName+"方法开始执行");
Object[] args= joinPoint.getArgs();
log.info("参数信息为:{} ",args);
try {
result = joinPoint.proceed();
log.info("结果为:{}"+result);
} catch (Throwable ex) {
//相当于异常抛出后通知
StackTraceElement stackTraceElement= ex.getStackTrace()[ex.getStackTrace().length-1];
log.error ("{}方法的{}行",fullMethodName,stackTraceElement.getLineNumber()+"抛出异常");
log.error("异常信息为:{} ",ex.fillInStackTrace().toString());
throw ex;
}finally{
//相当于最终通知
log.info(fullMethodName+"方法执行结束");
}
return result;
}
private String getFullMethodName(JoinPoint joinPoint) {
return joinPoint.getTarget().getClass().getName()
+ "."
+ joinPoint.getSignature().getName()
+"()";
}
}
运行测试