spring-AOP+自定义注解实现日志管理（注解方式实现）

约定不等于承诺〃 2022-05-22 10:41 401阅读 0赞

# 一、场景 #

后台管理系统中，管理员操作系统时生成日志保存在数据库中。

# 二、实现 #

### 1、jar包依赖 ###

<dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aop</artifactId>
        <version>4.3.14.RELEASE</version>
    </dependency>

### 2、spring\_mvc配置 ###

启动对aop支持。

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns:context="http://www.springframework.org/schema/context"
           xmlns:mvc="http://www.springframework.org/schema/mvc"
           xmlns:aop="http://www.springframework.org/schema/aop"
           xsi:schemaLocation="http://www.springframework.org/schema/beans
                            http://www.springframework.org/schema/beans/spring-beans.xsd
                            http://www.springframework.org/schema/mvc
                            http://www.springframework.org/schema/mvc/spring-mvc.xsd
                            http://www.springframework.org/schema/context
                            http://www.springframework.org/schema/context/spring-context.xsd
                           http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.3.xsd
                           ">
    
        
        <context:component-scan base-package="com.manage.controller"/>
    
        
        <context:component-scan base-package="com.manage.aspect" />
    
        
        <mvc:annotation-driven/>
    
        
    
    
    
        <aop:aspectj-autoproxy />    
    </beans>

### 3、Log.java类 ###

用于日志持久化操作。

import java.io.Serializable;
    import java.util.Date;
    
    public class Log implements Serializable{
        private String id;
    
        private String operationName;//操作name
    
        private String methodName;//执行方法名
    
        private String className;//类名
    
        private String operationType;//操作类型
    
    
        private String exceptionDetail;//异常信息
    
        private String params;//参数
    
        private String adminName;//操作人姓名
    
        private Date createDate;//操作日期
    
        private float time;//执行时间
    }

### 4、自定义注解@Log ###

import java.lang.annotation.*;
    
    //表示该注解用于什么地方。默认值为任何元素，表示该注解用于什么地方,参数和方法
    //(包 方法)
    @Target({ElementType.PACKAGE, ElementType.METHOD})
    //定义该注解的生命周期 
    //(始终不会被丢弃运行期也保留)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented//表示是否将注解信息添加在java文档中
    public @interface Log {
        //    要执行的操作类型 add
        String operationType() default "";
    
        //    要执行的具体操作比如：添加用户
        String operationName() default "";
    }

### 5、切面LogAspect.java ###

import com.manage.anno.Log;
    import com.manage.model.Result;
    import com.manage.service.LogService;
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.Around;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Pointcut;
    import org.aspectj.lang.reflect.MethodSignature;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    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.lang.reflect.Method;
    import java.util.Date;
    import java.util.UUID;
    
    
    @Component
    @Aspect
    public class LogAspect {
    
    //    注入日志操作service
    
        @Autowired
        private LogService logService;
    
        private static final Logger logger = (Logger) LoggerFactory.getLogger(LogAspect.class);
    
        @Pointcut("within(com.manage.controller.*) && @annotation(com.manage.anno.Log)")//controller包下的带Log注解的方法
        public void controllerAspect() {
    
        }
    
        //配置controller环绕通知,使用在方法aspect()上注册的切入点
        // 环绕通知：环绕目标方式执行
        @Around("controllerAspect()")
        public Result around(ProceedingJoinPoint pjp) throws Throwable {
    
            long startTime = System.currentTimeMillis();//开始时间
    
            Result result = null;
            com.manage.model.Log log = new com.manage.model.Log();
    
    //        获取操作用户
            HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
            String userName = (String) request.getSession().getAttribute("username");
            System.out.println("获取session内容" + request.getSession().getAttribute("username"));
    
            if (userName == null) {
                log.setAdminName("非登录用户");
            } else {
                log.setAdminName(userName);//操作用户
            }
    
    
            // 执行目标方法
            try {
                // 前置通知
                String methodName1 = pjp.getSignature().getName();
                System.out.println("前置通知=>" + "方法名：" + methodName1 + "");
                Object[] params = pjp.getArgs();
                StringBuilder stringBuilder = new StringBuilder();
                for (int i = 0; i < params.length - 1; i++) {
                    stringBuilder.append(params[i] + ",");
                    System.out.println("参数为：" + params[i]);
                }
                System.out.println("stringBuilder" + stringBuilder);
                MethodSignature methodName = (MethodSignature) pjp.getSignature();
                Method method = methodName.getMethod();
                String name = method.getAnnotation(Log.class).operationName();
                String type = method.getAnnotation(Log.class).operationType();
                System.out.println(name + "========================");
                System.out.println(type + "========================");
                String className = pjp.getTarget().getClass().getName();
    
                log.setCreateDate(new Date());
                log.setId(UUID.randomUUID().toString().replaceAll("\\-", ""));//去掉横线 32位
                log.setMethodName(methodName1);
                log.setClassName(className);
                log.setParams(stringBuilder.toString());
                log.setOperationName(name);
                log.setOperationType(type);
    
                result = (Result) pjp.proceed();
                // 返回通知
    
                System.out.println("返回通知" + result);
                log.setExceptionDetail("无异常");
            } catch (Throwable e) {
                System.out.println("异常通知" + e);
                log.setExceptionDetail(e.toString());
            }
            //后置通知
            System.out.println("后置通知");
            long endTime = System.currentTimeMillis();//结束时间
            float excTime = (float) (endTime - startTime) / 1000;
            System.out.println("执行时间:" + excTime + "s");
            log.setTime(excTime);
            System.out.println(log);
    
            logService.insert(log);
            return result;
        }
    
    
    }

### 6、在controller层使用 ###

@RequestMapping("/login")
        @ResponseBody
        @Log(operationName = "管理员登录",operationType = "select")
        public Result login(@RequestParam("name") String name,
                            @RequestParam("pass") String pass,
                            HttpSession session) {
            boolean b = adminService.login(name, pass);
            Result result = new Result();
            if (b) {//登陆成功
                session.setAttribute("username", name);
                result.setCode(1);
                result.setError(false);
                result.setMessage("登陆成功！");
                result.setData(name);//返回管理员name
            } else {
                result.setCode(0);
                result.setError(true);
                result.setMessage("密码不正确!");
                result.setData(null);
            }
            return result;
        }

# 三、测试 #

![70][]

# 四、问题与解决 #

##### 1、通配符的匹配很全面, 但无法找到元素 'aop:aspectj-autoproxy' 的声明 #####

**为AOP添加命名空间。**

**![70 1][]**

#### 2、自定义注解使用 ####

[https://www.cnblogs.com/acm-bingzi/p/javaAnnotation.html][https_www.cnblogs.com_acm-bingzi_p_javaAnnotation.html]

#### 3、切点表达式的使用 ####

[https://blog.csdn.net/keda8997110/article/details/50747923][https_blog.csdn.net_keda8997110_article_details_50747923]

#### 4、java在非servlet的普通类中获取session ####

HttpServletRequest request = ((ServletRequestAttributes)RequestContextHolder.getRequestAttributes()).getRequest();
    request.getSession();

#### 5、环绕通知controller无返回值 ####

![70 2][]

# 五、参考文档 #

[spring-aop的三种实现方式][spring-aop]

[spring-aop理解与实例][spring-aop 1]

spring-aop注解配置实现日志管理： [https://www.cnblogs.com/jianjianyang/p/4910851.html][https_www.cnblogs.com_jianjianyang_p_4910851.html]

[http://www.cnblogs.com/leifei/p/8194644.html][http_www.cnblogs.com_leifei_p_8194644.html]

[70]: /images/20220522/59e78f8bfa6941eca3d29edafee50c49.png
[70 1]: /images/20220522/da10995f9f144534b11bd0cda4dcbc9a.png
[https_www.cnblogs.com_acm-bingzi_p_javaAnnotation.html]: https://www.cnblogs.com/acm-bingzi/p/javaAnnotation.html
[https_blog.csdn.net_keda8997110_article_details_50747923]: https://blog.csdn.net/keda8997110/article/details/50747923
[70 2]: /images/20220522/1517d617fac44acbb5245230a412a6c2.png
[spring-aop]: https://blog.csdn.net/donggua3694857/article/details/52752503
[spring-aop 1]: http://blog.wenka.top/2017/01/01/Spring4-Aop/
[https_www.cnblogs.com_jianjianyang_p_4910851.html]: https://www.cnblogs.com/jianjianyang/p/4910851.html
[http_www.cnblogs.com_leifei_p_8194644.html]: http://www.cnblogs.com/leifei/p/8194644.html