服务器之家：专注于VPS、云服务器配置技术及软件下载分享
分类导航

PHP教程|ASP.NET教程|Java教程|ASP教程|编程技术|正则表达式|C/C++|IOS|C#|Swift|Android|VB|R语言|JavaScript|易语言|vb.net|

服务器之家 - 编程语言 - Java教程 - SpringBoot使用AOP统一日志管理的方法详解

SpringBoot使用AOP统一日志管理的方法详解

2022-12-02 17:35Java分享客栈 Java教程

这篇文章主要为大家分享一个干货：超简洁SpringBoot使用AOP统一日志管理，文中的示例代码讲解详细，感兴趣的小伙伴快跟随小编一起学习学习吧

前言

请问今天您便秘了吗？程序员坐久了真的会便秘哦，如果偶然点进了这篇小干货，就麻烦您喝杯水然后去趟厕所一边用左手托起对准嘘嘘，一边用右手滑动手机看完本篇吧。

实现

本篇AOP统一日志管理写法来源于国外知名开源框架JHipster的AOP日志管理方式

1、引入依赖

?
1
2
3
4
5
<!-- spring aop -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

2、定义logback配置

1）dev、test环境的spring-web包定义日志级别为INFO，项目包定义日志级别为DEBUG；

2）prod环境的spring-web包定义日志级别为ERROR，项目包定义日志级别为INFO；

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml" />
    <logger name="org.springframework.web" level="INFO"/>
    <logger name="org.springboot.sample" level="TRACE" />
 
    <springProfile name="dev,test">
        <logger name="org.springframework.web" level="INFO"/>
        <logger name="org.springboot.sample" level="INFO" />
        <logger name="com.example.aoplog" level="DEBUG" />
    </springProfile>
 
    <springProfile name="prod">
        <logger name="org.springframework.web" level="ERROR"/>
        <logger name="org.springboot.sample" level="ERROR" />
        <logger name="com.example.aoplog" level="INFO" />
    </springProfile>
 
</configuration>

3、编写切面类

1）springBeanPointcut()：单独定义的spring框架切入点；

2）applicationPackagePointcut()：单独定义的项目包切入点；

3）logAfterThrowing()：1和2定义的切入点抛出异常时日志格式及显示内容；

4）logAround()：1和2定义的切入点方法进入和退出时日志格式及显示内容。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
package com.example.aoplog.logging;
 
import com.example.aoplog.constants.GloablConstants;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import org.springframework.stereotype.Component;
 
import java.util.Arrays;
 
/**
 * <p>
 * AOP统一日志管理 切面类
 * </p>
 *
 * @author 福隆苑居士，公众号：【Java分享客栈】
 * @since 2022/5/5 21:57
 */
@Aspect
@Component
public class LoggingAspect {
 
    private final Logger log = LoggerFactory.getLogger(this.getClass());
 
    private final Environment env;
 
    public LoggingAspect(Environment env) {
        this.env = env;
    }
 
    /**
    * 匹配spring框架的repositories、service、rest端点的切面
     */
    @Pointcut("within(@org.springframework.stereotype.Repository *)" +
        " || within(@org.springframework.stereotype.Service *)" +
        " || within(@org.springframework.web.bind.annotation.RestController *)")
    public void springBeanPointcut() {
        // 方法为空，因为这只是一个切入点，实现在通知中。
    }
 
    /**
    * 匹配我们自己项目的repositories、service、rest端点的切面
     */
    @Pointcut("within(com.example.aoplog.repository..*)"+
        " || within(com.example.aoplog.service..*)"+
        " || within(com.example.aoplog.controller..*)")
    public void applicationPackagePointcut() {
        // 方法为空，因为这只是一个切入点，实现在通知中。
    }
 
    /**
     * 记录方法抛出异常的通知
     *
     * @param joinPoint join point for advice
     * @param e exception
     */
    @AfterThrowing(pointcut = "applicationPackagePointcut() && springBeanPointcut()", throwing = "e")
    public void logAfterThrowing(JoinPoint joinPoint, Throwable e) {
 
       // 判断环境，dev、test or prod
        if (env.acceptsProfiles(Profiles.of(GloablConstants.SPRING_PROFILE_DEVELOPMENT, GloablConstants.SPRING_PROFILE_TEST))) {
            log.error("Exception in {}.{}() with cause = '{}' and exception = '{}'", joinPoint.getSignature().getDeclaringTypeName(),
                joinPoint.getSignature().getName(), e.getCause() != null? e.getCause() : "NULL", e.getMessage(), e);
 
        } else {
            log.error("Exception in {}.{}() with cause = {}", joinPoint.getSignature().getDeclaringTypeName(),
                joinPoint.getSignature().getName(), e.getCause() != null? e.getCause() : "NULL");
        }
 
    }
 
    /**
     * 在方法进入和退出时记录日志的通知
     *
     * @param joinPoint join point for advice
     * @return result
     * @throws Throwable throws IllegalArgumentException
     */
    @Around("applicationPackagePointcut() && springBeanPointcut()")
    public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {
 
        if (log.isDebugEnabled()) {
            log.debug("Enter: {}.{}() with argument[s] = {}", joinPoint.getSignature().getDeclaringTypeName(),
                joinPoint.getSignature().getName(), Arrays.toString(joinPoint.getArgs()));
        }
        try {
            Object result = joinPoint.proceed();
            if (log.isDebugEnabled()) {
                log.debug("Exit: {}.{}() with result = {}", joinPoint.getSignature().getDeclaringTypeName(),
                    joinPoint.getSignature().getName(), result);
            }
            return result;
        } catch (IllegalArgumentException e) {
            log.error("Illegal argument: {} in {}.{}()", Arrays.toString(joinPoint.getArgs()),
                joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
 
            throw e;
        }
 
    }
 
}

4、测试

1）写个service

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
package com.example.aoplog.service;
 
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
 
/**
 * <p>
 * AOP统一日志管理测试服务
 * </p>
 *
 * @author 福隆苑居士，公众号：【Java分享客栈】
 * @since 2022/5/5 21:57
 */
@Service
@Slf4j
public class AopLogService {
 
   public String test(Integer id) {
      return "传入的参数是：" + id;
   }
}

2）写个controller

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package com.example.aoplog.controller;
 
import com.example.aoplog.service.AopLogService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
/**
 * <p>
 * 测试接口
 * </p>
 *
 * @author 福隆苑居士，公众号：【Java分享客栈】
 * @since 2022/4/30 11:43
 */
@RestController
@RequestMapping("/api")
@Slf4j
public class TestController {
 
   private final AopLogService aopLogService;
 
   public TestController(AopLogService aopLogService) {
      this.aopLogService = aopLogService;
   }
 
   @GetMapping("/test/{id}")
   public ResponseEntity<String> test(@PathVariable("id") Integer id) {
      return ResponseEntity.ok().body(aopLogService.test(id));
   }
}

3）设置环境

这里我试试dev，prod自己试听见没？不服一拳打哭你哦！

?
1
2
3
4
5
6
7
server:
  port: 8888
 
# 环境：dev-开发 test-测试 prod-生产
spring:
  profiles:
    active: dev

4）效果

不解释了自己看

SpringBoot使用AOP统一日志管理的方法详解

试试异常情况，手动加个异常。

?
1
2
3
4
5
6
7
8
9
@Service
@Slf4j
public class AopLogService {
 
   public String test(Integer id) {
      int i = 1/0;
      return "传入的参数是：" + id;
   }
}

效果

SpringBoot使用AOP统一日志管理的方法详解

到此这篇关于SpringBoot使用AOP统一日志管理的方法详解的文章就介绍到这了,更多相关SpringBoot AOP日志管理内容请搜索服务器之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持服务器之家！

原文链接：https://mp.weixin.qq.com/s/Agrj2pHwW2TK1Z_wr7ghPw

  • 日志
  • 管理
  • AOP
  • springboot

    • 延伸 · 阅读

    精彩推荐
    • Java教程spring boot自定义log4j2日志文件的实例讲解

      spring boot自定义log4j2日志文件的实例讲解

      下面小编就为大家分享一篇spring boot自定义log4j2日志文件的实例讲解，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...

      秉空杯初心9352021-02-24
    • Java教程Java 面向对象之继承篇详解原理与特点

      Java 面向对象之继承篇详解原理与特点

      继承是java面向对象编程技术的一块基石，因为它允许创建分等级层次的类。继承就是子类继承父类的特征和行为，使得子类对象（实例）具有父类的实例域...

      执久呀4842022-02-27
    • Java教程SpringBoot配置加载,各配置文件优先级对比方式

      SpringBoot配置加载,各配置文件优先级对比方式

      这篇文章主要介绍了SpringBoot配置加载,各配置文件优先级对比方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐...

      IT_faquir3802021-12-06
    • Java教程Java正则表达式易错知识点汇总

      Java正则表达式易错知识点汇总

      这篇文章主要总结Java正则表达式易错知识，对易错知识点进行分类整理，帮助大家更好的学习Java正则表达式，感兴趣的小伙伴们可以参考一下 ...

      leizhimin4642020-03-11
    • Java教程使用SpringCloudAlibaba整合Dubbo

      使用SpringCloudAlibaba整合Dubbo

      这篇文章主要介绍了使用SpringCloudAlibaba整合Dubbo，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教...

      user20258402022-02-15
    • Java教程详解Spring中使用@within与@target的区别

      详解Spring中使用@within与@target的区别

      这篇文章主要介绍了Spring中使用@within与@target的一些区别,本文通过项目案例给大家详细分析，给大家介绍的非常详细，代码简单易懂，需要的朋友可以参考...

      It''''s my code life.8542021-12-28
    • Java教程SpringMVC上传文件的两种方法

      SpringMVC上传文件的两种方法

      这篇文章主要为大家详细介绍了SpringMVC上传文件的两种方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下...

      残缺的孤独10362021-02-07
    • Java教程浅谈 JDBC 元数据

      浅谈 JDBC 元数据

      这篇文章主要介绍了JDBC元数据的相关内容，涉及一些获取数据源各种信息的方法，具有一定参考价值，需要的朋友可以了解下。...

      Infaraway5622021-01-12
    最近更新
    编辑推荐
    阅读排行
    热门标签
    501 　 406 　 415 　 2000 　 1433 　 401 　 204 　 330 　 选择排序法 　 随机抽取 　 内存卡 　 下载器 　 十六进制字符 　 响应 　 静态工厂 　 构造函数 　 swt 　 Overview 　 对象池模式 　 过滤筛选 　 支票 　 金额大写转换 　 空心菱形 　 AspectJ 　 面向切面编程 　 方法名 　 网址信息 　 动态代理模式 　 线程安全 　 htmlparser 　
    © 2019-2022 服务器之家(www.tuohang.net) 版权所有关于我们联系我们版权申明网站地图