06.AOP日志

AOP日志

一、配置注意事项

1). applicationContext.xml

1. 包路径扫描一定的包括aop配置类的包路径
2. 要开启注解支持

二、AOP切面配置日志信息

1). 在切面类中我们需要获取登录用户的username，还需要获取ip地址，我们怎么处理？

1. username获取: SecurityContextHolder 获取
2. ip地址获取
   1. ip地址的获取我们可以通过 request.getRemoteAddr() 方法获取到。
   2. 在Spring中可以通过 RequestContextListener来获取 request或session对象。

2). LogAop

package com.lingting.travel.aop;

import com.lingting.travel.controller.SysLogController;
import com.lingting.travel.domain.SysLog;
import com.lingting.travel.service.SysLogService;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.core.context.SecurityContext;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.core.userdetails.User;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpServletRequest;

import java.lang.reflect.Method;
import java.util.Date;

/**
    放入 IOC 容器
    切面 注解配置方式配置
    在每个特定的方法 前 后 执行；生成日志信息
 */
@Component
@Aspect
public class LogAop {

    /** 获取容器中的 web 原生 API */
    @Autowired
    private HttpServletRequest request;

    /** 日志service层 bean*/
    @Autowired
    private SysLogService sysLogService;

    /** 访问时间 */
    private Date startTime;

    /** 访问的类 */
    private Class executionClass;

    /** 访问的方法 */
    private Method executionMethod;

    /** 前置通知
     获取 访问的时间 访问的类 访问的方法
     JoinPoint 封装了 要访问信息
     */
    @Before("execution(* com.lingting.travel.controller.*.*(..))")
    public void doBefore(JoinPoint jp) throws NoSuchMethodException {

        // 访问的时间
        startTime = new Date();

        // 访问的类
        executionClass = jp.getTarget().getClass();

        // 访问的方法 方法的名称
        String methodName = jp.getSignature().getName();

        // 获取访问的方法的参数
        Object[] args = jp.getArgs();

        // 分情况讨论获取 方法对象
        if (args == null || args.length == 0) {
            executionMethod = executionClass.getMethod(methodName);
        } else {
            // 有参数的情况，需要加盖args中所有的元素遍历，获取对应的Class,装入一个 Class[]
            Class[] classArgs = new Class[args.length];
            for (int i = 0; i < args.length; i++) {
                classArgs[i] = args[i].getClass();
            }

            executionMethod = executionClass.getMethod(methodName, classArgs);
        }
    }

    /** 后置通知
     获取 时长， ip url ...

     */
    @After("execution(* com.lingting.travel.controller.*.*(..))")
    public void doAfter(JoinPoint jp) throws Exception {

        // 获取类上的 @RequestMapping 对象
        if (executionClass != SysLogController.class) {
            RequestMapping classAnnotion = (RequestMapping)executionClass.getAnnotation(RequestMapping.class);

            if (classAnnotion != null) {
                // 获取方法上的 @RequestMapping对象
                RequestMapping methodAnnotion = (RequestMapping)executionMethod.getAnnotation(RequestMapping.class);

                if (methodAnnotion != null) {

                    // 日志信息的pojo
                    SysLog sysLog = new SysLog();

                    // 拼接 类上与方法上的 @RequestMapping对象 的value
                    sysLog.setUrl(classAnnotion.value()[0] + methodAnnotion.value()[0]);

                    // 计算访问时长
                    sysLog.setExecutionTime(System.currentTimeMillis() - startTime.getTime());

                    // 获取 ip
                    sysLog.setIp(request.getRemoteAddr());

                    // 还可以通过securityContext中获取，也可以从request.getSession中获取

                    /*
                     SecurityContext context = (SecurityContext)
                     request.getSession().getAttribute("SPRING_SECURITY_CONTEXT");
                     */
                    SecurityContext context = SecurityContextHolder.getContext();

                    String username = ((User)(context.getAuthentication().getPrincipal())).getUsername();
                    sysLog.setUsername(username);

                    sysLog.setMethod("[类名]" + executionClass.getName() + "[方法名]" + executionMethod.getName());

                    sysLog.setVisitTime(startTime);

                    // 调用Service, 将sysLog对象插入到数据库
                    sysLogService.save(sysLog);
                }
            }
        }
    }
}

2). sysLogService service层代码

public interface SysLogService {

    /** 将日志信息保存到数据库 */
    public Integer save(SysLog sysLog);
}

@Service
public class SysLogServiceImpl implements SysLogService {

    @Autowired
    private SysLogDao sysLogDao;

    /** 将日志信息保存到数据库 */
    @Override
    public Integer save(SysLog sysLog) {
        return sysLogDao.save(sysLog);
    }
}

3). sysLogDao dao层代码

public interface SysLogDao {

    /** 将日志信息保存到数据库 */
    @Insert("insert into sysLog(visitTime, username, ip, url, executionTime, method) " +
            "values(#{visitTime}, #{username},  #{ip}, #{url}, #{executionTime}, #{method})")
    public Integer save(SysLog sysLog);
}

3). SysLog pojo

public class SysLog {
    private String id;
    private Date visitTime;
    private String visitTimeStr;
    private String username;
    private String ip;
    private String url;
    private Long executionTime;
    private String method;
    ...

4. 数据库中的表

-- 【日志表 sysLog】
create table sysLog(
       id varchar(32) default sys_guid() primary key, -- 主键 无意义uuid
       visitTime timestamp, -- 访问时间
       username varchar(50), -- 操作者用户名
       ip varchar(30), -- 访问ip
       url varchar(50), -- 访问资源url
       executionTime int, -- 执行时长
       method varchar(200) -- 访问方法
);