文章目录
- 1、导入依赖
- 2、配置文件logback-spring.xml
- 3、使用AOP做日志
- 3.1、自定义注解
- 3.2、自定义aop切面
- 4、在controller方法上添加注解
- 5、使用@Slf4j
- 6、最终参考效果
之前看过logback的配置方法，今天整理spring的知识的时候，又看到了aop，想着把他两个弄起来，打印在控制台的信息，比较好看，顺便也能写在日志文件中，我也不知道这样做好不好，反正是做个小记录！
1、导入依赖
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
2、配置文件logback-spring.xml
修改路径、日志文件名啥的，然后将该配置文件放到resources目录下
<!--
configuration 有三个属性：
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration>
<include resource="org/springframework/boot/logging/logback/defaults.xml" />
<!-- <!– 定义日志文件名称 –>-->
<!-- <property name="APP_NAME" value="codecatlog" />-->
<!-- 定义日志文件的路径 -->
<property name="LOG_PATH" value="${user.dir}/logs" />
<!-- 定义日志的文件名 -->
<property name="LOG_FILE" value="${LOG_PATH}/log_name.log" />
<!-- 滚动记录日志，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->
<appender name="APPLICATION"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 指定日志文件的名称 -->
<file>${LOG_FILE}</file>
<!--
当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责触发滚动。
-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--
滚动时产生的文件的存放位置及文件名称
%d{yyyy-MM-dd}：按天进行日志滚动
%i：当文件大小超过maxFileSize时，按照i进行文件滚动
-->
<fileNamePattern>${LOG_FILE}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!--
可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，
且maxHistory是7，则只保存最近7天的文件，删除之前的旧文件。
注意，删除旧文件时，那些为了归档而创建的目录也会被删除。
-->
<maxHistory>7</maxHistory>
<!--
当日志文件超过maxFileSize指定的大小时，根据上面提到的%i进行日志文件滚动
注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，
必须配置timeBasedFileNamingAndTriggeringPolicy
-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>50MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 日志输出格式： -->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
</layout>
</appender>
<!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<!--
日志输出格式：
%d表示日期时间，%green 绿色
%thread表示线程名，%magenta 洋红色
%-5level：级别从左显示5个字符宽度 %highlight 高亮色
%logger{36} 表示logger名字最长36个字符，否则按照句点分割 %yellow 黄色
%msg：日志消息
%n是换行符
-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%green(%d{yyyy-MM-dd HH:mm:ss.SSS}) [%magenta(%thread)] %highlight(%-5level) %yellow(%logger{36}): %msg%n</pattern>
</layout>
</appender>
<!--
root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，
要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。
-->
<root level="info">
<appender-ref ref="CONSOLE" />
<appender-ref ref="APPLICATION" />
</root>
</configuration>
<!-- 定义日志文件的路径 -->
<property name="LOG_PATH" value="${user.dir}/logs" />
<!-- 定义日志的文件名 -->
<property name="LOG_FILE" value="${LOG_PATH}/log_name.log" />
可以修改这两个东西，可以通过下面的方法看看路径啥的是否正确
public static void main(String[] args) {
System.out.println(System.getProperty("user.dir"));
}
3、使用AOP做日志
3.1、自定义注解
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface WebLog {
}
3.2、自定义aop切面
@Aspect
@Component
public class WebLogAspect {
private final static Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
// 下面这个com.customInterface.WebLog要修改成你对应自定义注解的路径
@Pointcut("@annotation(com.customInterface.WebLog)")
public void webLog() {}
@Before("webLog()")
public void doBefore(JoinPoint joinPoint) throws JsonProcessingException {
ServletRequestAttributes requestAttributes
= (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = requestAttributes.getRequest();
// 打印请求相关参数
logger.info("========================================== Start ==========================================");
// 打印请求 url
logger.info("URL : {}", request.getRequestURL().toString());
// 打印 Http method
logger.info("HTTP Method : {}", request.getMethod());
// 打印调用 controller 的全路径以及执行方法
logger.info("Class Method : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
// 打印请求的 IP
logger.info("IP : {}", request.getRemoteAddr());
// 打印请求入参
logger.info("Request Args : {}",new ObjectMapper().writeValueAsString(joinPoint.getArgs()));
}
@After("webLog()")
public void doAfter(){
// 结束后打个分隔线，方便查看
logger.info("=========================================== End ===========================================");
}
@Around("webLog()")
public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
//开始时间
long startTime = System.currentTimeMillis();
Object result = proceedingJoinPoint.proceed();
// 打印出参
logger.info("Response Args : {}", new ObjectMapper().writeValueAsString(result));
// 执行耗时
logger.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime);
return result;
}
}
4、在controller方法上添加注解
public class testController{
@Autowired
private Test test;
@PostMapping("/test")
@WebLog()
public ResponseVO test(@RequestBody TestPojo test){
return test.test(test);
}
}
类似这样
5、使用@Slf4j
在类上导入@Slf4j，然后使用log.info();去替代System.out.println();
6、最终参考效果
跑在ubuntu上的程序
控制台打印：
日志文件
成功记录！
