SpringBoot实现AOP拦截

最新推荐文章于 2024-06-08 13:49:02 发布

原创最新推荐文章于 2024-06-08 13:49:02 发布 · 965 阅读

0 ·

CC 4.0 BY-SA版权

springboot 专栏收录该内容

1 篇文章

订阅专栏

本文介绍了在SpringBoot中使用Aspect注解实现AOP拦截的方法，对比了与实现MethodInterceptor接口的区别，强调了注解方式的灵活性和低耦合特性。内容包括在maven中引入相关依赖、设置日志拦截以及测试Controller的步骤。

背景：实现MethodInterceptor拦截器大致也分为两种，一种是实现MethodInterceptor接口，另一种利用Aspect的注解或配置。
关于实现MethodInterceptor接口的这种方法，还需要在配置文件中做配置，在SpringMVC中使用还可以，在SpringBoot中使用起来似乎没有那么方便。
本文主要还是说Aspect注解方式，个人觉得这种方法才比较灵活，与配置与工程整个代码都没有耦合（你添加一个类，做几个注解就可以用了，无需在其他地方再做什么），更易应用。

1.maven中引入

    <dependency>
      	<groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
        <version>2.1.0.RELEASE</version>
    </dependency>
    <dependency>
    	<groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.42</version>
    </dependency>

2.日志拦截

package com.huaj.config;

import com.alibaba.fastjson.JSONObject;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.Date;

/**
 * aop拦截方法日志信息
 */
@Aspect
@Component
public class AopLogAspect {

	private static final Logger logger = LoggerFactory.getLogger(AopLogAspect.class);

	private static final SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");// 设置日期格式

	// 申明一个切点 里面是 execution表达式
	@Pointcut("execution(* com.huaj..*.*(..))")
	private void serviceAspect() {
	}

	// 请求method前打印内容
	@Before(value = "serviceAspect()")
	public void methodBefore(JoinPoint joinPoint) {
		ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder
				.getRequestAttributes();
		HttpServletRequest request = requestAttributes.getRequest();
		JSONObject jsonObject = new JSONObject();
		// 请求时间
		jsonObject.put("request_time", df.format(new Date()));
		// 请求URL
		jsonObject.put("request_url", request.getRequestURL().toString());
		// 请求的方法
		jsonObject.put("request_method", request.getMethod());
		// 请求类方法
		jsonObject.put("signature", joinPoint.getSignature());
		// 请求参数
		jsonObject.put("request_args", Arrays.toString(joinPoint.getArgs()));

		JSONObject requestJsonObject = new JSONObject();
		requestJsonObject.put("request", jsonObject);
		logger.info("方法请求前日志为:{}",requestJsonObject);
	}

	// 在方法执行完后打印返回内容
	@AfterReturning(returning = "o", pointcut = "serviceAspect()")
	public void methodAfterReturing(Object o) {
		JSONObject respJSONObject = new JSONObject();
		JSONObject jsonObject = new JSONObject();
		jsonObject.put("response_time", df.format(new Date()));
		jsonObject.put("response_content", JSONObject.toJSONString(o));
		respJSONObject.put("response", jsonObject);
		logger.info("方法请求后日志为:{}",respJSONObject);
	}
}

3.测试TestController

package com.huaj.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;

/**
 * @author huaj
 * @date 2020/2/28
 * @description
 */
@RestController
public class TestController{
 
    private static final Logger logger = LoggerFactory.getLogger(TestController.class);

    @GetMapping("/test")
    public String test(HttpServletRequest request){
        logger.info("测试日志拦截~~~~");
        return "测试日志拦截";
    }


}