IDEA整合SSM框架之配置AOP切面日志
-
什么是AOP
- AOP中的术语
- AOP中的注解
- 配置切面日志
-
引入切面依赖
* 切面日志实现类
* 开启切面编程
* 运行项目,验证结果
什么是AOP
AOP是一个切面编程的思想,就是能够让我们在不影响主业务功能的前提下,
横切扩展新的功能。比如本章演示的切面日志功能,在不影响主业务流程的情况下打印一些日志。
AOP中的术语
- aspect(切面):切面由pointcut和advice组成,是横切逻辑定义和连接点定义的组成;
- jointpoint(连接点):连接点是应用程序提供给切面插入的地方,可以添加新的方法
- advice(增强):是织入到连接点上的一段程序,另外它还拥有连接点的相关信息,advice是我们切面功能的实现,它通知程序新的行为
- pointcut(切点):所谓切点就是你所切取的类中的方法,通常使用pointcuts通过正则表达式来把明显的名字和模式进行匹配应用
- introduction(引介):一种特殊的增强,允许添加新的方法和属性到类中
- target(目标类):是指那些将使用advice的类,一般是指独立的那些商务模型,就是我的advice植入到什么位置
- proxy(代理类):一个类被AOP织入增强后,就会产生一个结果类,他是融合了原类和增强逻辑的代理类;使用了proxy的模式。是指应用了advice的对象,看起来和target对象很相似
- weaving(织入):织入就是讲增强逻辑添加到目标对象的过程,是指应用aspects到一个target对象创建proxy对象的过程
AOP中的注解
- @Apsect:将当前类标识为一个切面;
- @Pointcut:定义切点,这里使用的是条件表达式;
- @Before:前置增强,就是在目标方法执行之前执行;
- @AfterReturning:后置增强,方法退出时执行;
- @AfterThrowing:有异常时该方法执行;
- @After:最终增强,无论什么情况都会执行;
- @Afround:环绕增强;
配置切面日志
主要功能是打印接口中的参数和返回结果信息
引入切面依赖
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15 1<!-- https://mvnrepository.com/artifact/org.aspectj/aspectjrt -->
2 <dependency>
3 <groupId>org.aspectj</groupId>
4 <artifactId>aspectjrt</artifactId>
5 <version>1.9.2</version>
6 </dependency>
7
8 <!-- https://mvnrepository.com/artifact/org.aspectj/aspectjweaver -->
9 <dependency>
10 <groupId>org.aspectj</groupId>
11 <artifactId>aspectjweaver</artifactId>
12 <version>1.9.2</version>
13 </dependency>
14
15
切面日志实现类
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 1@Aspect
2@Component
3@Slf4j
4public class AspectLog {
5 /**
6 * 切点
7 */
8 @Pointcut(value = "execution(* com.xiao.demo.springmvc.controller.*.*(..))")
9 public void logPoincut() {
10
11 }
12
13 @Around(value = "logPoincut()")
14 public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
15 //记录开始时间
16 long beginTime = System.currentTimeMillis();
17
18 RequestAttributes ra = RequestContextHolder.getRequestAttributes();
19 ServletRequestAttributes sra = (ServletRequestAttributes) ra;
20 HttpServletRequest request = sra.getRequest();
21 // 获取请求地址
22 Object requestPath = request.getRequestURI();
23 String ip = getIpAddr(request);
24 //格式换开始时间
25 String optTime = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date());
26 //参数
27 Object paramObj = joinPoint.getArgs();
28 String param = StringUtils.isEmpty(paramObj) ? "无参数" : JSON.toJSONString(paramObj);
29 //返回结果
30 Object resultObj = joinPoint.proceed();
31 String result = StringUtils.isEmpty(resultObj) ? "无返回值" : JSON.toJSONString(resultObj);
32 //获取切点方法对象
33 MethodSignature signature = (MethodSignature) joinPoint.getSignature();
34 Method method = signature.getMethod();
35 //获取类名
36 String className = joinPoint.getTarget().getClass().getName();
37 //获取方法名
38 String methodName = method.getName();
39
40 log.info("*****************************************************************************************************************");
41 log.info("[访问时间]>>>>>" + optTime);
42 log.info("[访问 IP]>>>>>" + ip);
43 log.info("[访问路由]>>>>>" + requestPath);
44 log.info("[访问方法]>>>>>" + className.concat(".").concat(methodName).concat("()"));
45 log.info("[传入参数]>>>>>" + param);
46 log.info("[返回参数]>>>>>" + result);
47 log.info("[耗费时间]>>>>>" + (System.currentTimeMillis() - beginTime) + " ms");
48 log.info("*****************************************************************************************************************\n");
49 return resultObj;
50 }
51
52 @AfterThrowing(throwing = "ex", pointcut = "logPoincut()")
53 public void doRecoveryActions(JoinPoint joinPoint, Throwable ex) {
54 long beginTime = System.currentTimeMillis();
55 //格式换开始时间
56 String optTime = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date());
57
58 RequestAttributes ra = RequestContextHolder.getRequestAttributes();
59 ServletRequestAttributes sra = (ServletRequestAttributes) ra;
60 HttpServletRequest request = sra.getRequest();
61 // 获取请求地址
62 Object requestPath = request.getRequestURI();
63 String ip = getIpAddr(request);
64
65 //参数
66 Object paramObj = joinPoint.getArgs();
67 String param = StringUtils.isEmpty(paramObj) ? "无参数" : JSON.toJSONString(paramObj);
68 //获取切点方法对象
69 MethodSignature signature = (MethodSignature) joinPoint.getSignature();
70 Method method = signature.getMethod();
71 //获取类名
72 String className = joinPoint.getTarget().getClass().getName();
73 //获取方法名
74 String methodName = method.getName();
75
76 log.error("\n");
77 log.error("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
78 log.error("[异常时间]>>>>>" + optTime);
79 log.error("[访问 IP]>>>>>" + ip);
80 log.error("[访问路由]>>>>>" + requestPath);
81 log.error("[异常类型]>>>>>" + ex.getClass().getName());
82 log.error("[异常方法]>>>>>" + className.concat(".").concat(methodName).concat("()"));
83 log.error("[传入参数]>>>>>" + param);
84 log.error("[耗费时间]>>>>>" + (System.currentTimeMillis() - beginTime) + " ms");
85 log.error("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n");
86 }
87
88 /**
89 * 获取IP地址
90 */
91 public String getIpAddr(HttpServletRequest request) {
92 String ip = request.getHeader("x-forwarded-for");
93 if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
94 ip = request.getHeader("Proxy-Client-IP");
95 }
96 if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
97 ip = request.getHeader("WL-Proxy-Client-IP");
98 }
99 if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
100 ip = request.getRemoteAddr();
101 }
102 return "0:0:0:0:0:0:0:1".equals(ip) ? "127.0.0.1" : ip;
103 }
104}
105
106
开启切面编程
-
在spring-mvc.xml文件中添加如下代码
1
2
3
4
5
6
7 1<!--切面日志-->
2 <bean id="aspectLog" class="com.xiao.demo.springmvc.config.AspectLog"/>
3 <!--开启切面功能-->
4 <!--自动为spring容器中那些配置@aspectJ切面的bean创建代理,织入切面-->
5 <aop:aspectj-autoproxy proxy-target-class="true"/>
6
7
运行项目,验证结果
- 查看控制台输出
本文只是简单演示如何实现切面日志功能,想要加载其他功能,请自行扩展。