SpringBoot项目AOP+自定义注解实现菜单点击量统计

最新推荐文章于 2024-04-16 16:10:54 发布

原创最新推荐文章于 2024-04-16 16:10:54 发布 · 2.1k 阅读

5 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#aop #自定义注解

java 专栏收录该内容

11 篇文章

订阅专栏

本文介绍了如何在SpringBoot项目中使用AOP和自定义注解来统计菜单的点击量。首先，添加AOP依赖并说明了SpringBoot自动启用AOP的特性。接着，详细讲解了创建自定义注解的步骤，然后阐述了如何构建切面类。最后通过在Controller层添加注解并进行测试，验证了系统的有效性和实用性。

一：在添加aop的依赖

        <!-- aop依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

注意：在完成了引入AOP依赖包后，不需要去做其他配置。AOP的默认配置属性中，spring.aop.auto属性默认是开启的，也就是说只要引入了AOP依赖后，默认已经增加了@EnableAspectJAutoProxy，不需要在程序主类中增加@EnableAspectJAutoProxy来启用。（就是不需要像spring项目那样在配置文件中开启切面扫描）

二：创建自定义注解

import java.lang.annotation.*;

/**
 * Controller层统计点击量的自定义注解
 */
@Target({ElementType.METHOD,ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ControllerLog {

    String value() default "";
}

三：创建切面类

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
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.util.HashMap;
import java.util.Iterator;
import java.util.Map;

/**
 * AOP切面统计菜单点击次数
 */
@Aspect
@Component
public class LogAspect {
    /**
     * Controller的切入点
     */
    @Pointcut("@annotation(com.niucheng.eblog.common.annotation.ControllerLog)")
    private void ControllerAspet(){

    }


    /**
     * 前置通知来统计接口url，请求方法，参数，
     */
    @Before(value = "ControllerAspet()")
    private void doBefore(JoinPoint joinPoint){
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        //请求url
        System.out.println("------------url:"+request.getRequestURI());
        //调用的方法
        System.out.println("------------method:"+joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()");

        //请求的参数
        Map<String, String[]> properties = request.getParameterMap();
        Map<Object, Object> returnMap = new HashMap<Object, Object>();
        Iterator<Map.Entry<String, String[]>> entries = properties.entrySet().iterator();
        Map.Entry entry;
        String name = "";
        String value = "";

        while (entries.hasNext()) {
            entry = (Map.Entry) entries.next();
            name = (String) entry.getKey();
            Object valueObj = entry.getValue();
            if (null == valueObj) {
                value = "";
            } else if (valueObj instanceof String[]) {
                String[] values = (String[]) valueObj;
                for (int i = 0; i < values.length; i++) {
                    value = values[i] + ",";
                }
                value = value.substring(0, value.length() - 1);
            } else {
                value = valueObj.toString();
            }
            returnMap.put(name, value);
        }
        System.out.println("------------param:"+returnMap.toString());
    }

四：测试

在Controller层增加@ControllerLog()注解

    @RequestMapping("/success")
    @ControllerLog()
    public String success(Map<String,Object> map){
        map.put("hello","你好");
        return "success";
    }

在浏览器输入：http://localhost:8080/success

输出结果：