spring AOP实现访问日志管理
1. 数据库与表结构
1.1. 日志表信息描述
1.2. 创建日志信息表的sql语句
CREATE TABLE sysLog(
id VARCHAR2(32) default SYS_GUID() PRIMARY KEY,
visitTime timestamp,
username VARCHAR2(50),
ip VARCHAR2(30),
url VARCHAR2(50),
executionTime int,
method VARCHAR2(200)
)
1.3. 实体类
// 此处省略了setter和getter方法
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;
}
2. 基于AOP的访问日志处理
2.1. 创建切面类处理访问日志
```java
@Component
@Aspect
public class LogAop {
// 在web.xml中配置监听器RequestContextListener,然后就可以在此注入
@Autowired
private HttpServletRequest request;
@Autowired
private ISysLogService sysLogService;
private Date visitTime; //开始时间
private Class clazz; //访问的类
private Method method;//访问的方法
// 前置通知 主要是获取开始时间,执行的类是哪一个,执行的是哪一个方法
// JoinPoint对象封装了SpringAop中切面方法的信息,在切面方法中添加JoinPoint参数,就可以获取到封装了该方法信息的JoinPoint对象.
@Before("execution(* com.gy.controller.*.*(..))")
public void doBefore(JoinPoint jp) throws NoSuchMethodException {
visitTime = new Date();//当前时间就是开始访问的时间
clazz = jp.getTarget().getClass(); //具体要访问的类, Object getTarget(): 获取被代理的对象
// Signature getSignature() :获取封装了署名信息的对象,在该对象中可以获取到目标方法名,所属类的Class等信息
String methodName = jp.getSignature().getName(); //获取访问的方法的名称
Object[] args = jp.getArgs();//获取访问的方法的参数
//获取具体执行的方法的Method对象
if (args == null || args.length == 0) {
method = clazz.getMethod(methodName); //只能获取无参数的方法
} else {
Class[] classArgs = new Class[args.length];
for (int i = 0; i < args.length; i++) {
classArgs[i] = args[i].getClass();
}
clazz.getMethod(methodName, classArgs);
}
}
//后置通知
@After("execution(* com.gy.controller.*.*(..))")
public void doAfter(JoinPoint jp) throws Exception {
long time = new Date().getTime() - visitTime.getTime(); //获取访问的时长
String url = "";
//获取url
if (clazz != null && method != null && clazz != LogAop.class) {
//1.获取类上的@RequestMapping("/orders")
RequestMapping classAnnotation = (RequestMapping) clazz.getAnnotation(RequestMapping.class);
if (classAnnotation != null) {
String classValue = classAnnotation.value()[0];
//2.获取方法上的@RequestMapping(xxx)
RequestMapping methodAnnotation = method.getAnnotation(RequestMapping.class);
if (methodAnnotation != null) {
String methodValue = methodAnnotation.value()[0];
url = classValue + methodValue;
//获取访问的ip
String ip = request.getRemoteAddr();
//获取当前操作的用户
SecurityContext context = SecurityContextHolder.getContext();//从上下文中获了当前登录的用户
User user = (User) context.getAuthentication().getPrincipal();
String username = user.getUsername();
//将日志相关信息封装到SysLog对象
SysLog sysLog = new SysLog();
sysLog.setExecutionTime(time); //执行时长
sysLog.setIp(ip);
sysLog.setMethod("[类名] " + clazz.getName() + "[方法名] " + method.getName());
sysLog.setUrl(url);
sysLog.setUsername(username);
sysLog.setVisitTime(visitTime);
//调用Service完成操作
sysLogService.save(sysLog);
}
}
}
}
}
在前置通知中需要获取访问时间、访问的类以及访问的方法。
访问时间很简单,获取到当前时间即可。
startTime = new Date(); // 访问时间
获取用户访问的类,通过JoinPoint对象获取,JoinPoint对象封装了SpringAop中切面方法的信息,在切面方法中添加JoinPoint参数,就可以获取到封装了该方法信息的JoinPoint对象.
// 获取访问的类
executionClass = jp.getTarget().getClass();
获取用户访问的方法,通过JoinPoint对象获取,getSignature.getName()返回的是字符串格式的方法,要转换成对象。
String methodName = jp.getSignature().getName(); //获取访问的方法的名称
Object[] args = jp.getArgs();//获取访问的方法的参数
//获取具体执行的方法的Method对象
if (args == null || args.length == 0) {
method = clazz.getMethod(methodName); //只能获取无参数的方法
} else {
Class[] classArgs = new Class[args.length];
for (int i = 0; i < args.length; i++) {
classArgs[i] = args[i].getClass();
}
clazz.getMethod(methodName, classArgs);
}
在后置通知中获取用户访问的时长、url、ip地址以及当前操作的用户
当前时间减去访问的时间就是访问时长。
long time = new Date().getTime() - visitTime.getTime(); //获取访问的时长
获取访问类上的mapping以及方法上的mapping即是访问路径
//1.获取类上的@RequestMapping("/orders")
RequestMapping classAnnotation = (RequestMapping) clazz.getAnnotation(RequestMapping.class);
if (classAnnotation != null) {
String classValue = classAnnotation.value()[0];
// String[] classValue = classAnnotation.value();
//2.获取方法上的@RequestMapping(xxx)
RequestMapping methodAnnotation = method.getAnnotation(RequestMapping.class);
if (methodAnnotation != null) {
String methodValue = methodAnnotation.value()[0];
// String[] methodValue = methodAnnotation.value();
url = classValue + methodValue;
获取当前用户的IP地址,在web.xml中配置监听器RequestContextListener,通过HttpServletRequest类注入request对象。
<listener>
<listenerclass>org.springframework.web.context.request.RequestContextListener</listener-class>
</listener>
//获取访问的ip
String ip = request.getRemoteAddr();
获取当前操作的用户
SecurityContext context = SecurityContextHolder.getContext();//从上下文中获了当前登录的用户
User user = (User) context.getAuthentication().getPrincipal();
String username = user.getUsername();
将访问日志信息封装到SysLog对象
SysLog sysLog = new SysLog();
sysLog.setExecutionTime(time); //执行时长
sysLog.setIp(ip);
sysLog.setMethod("[类名] " + clazz.getName() + "[方法名] " + method.getName());
sysLog.setUrl(url);
sysLog.setUsername(username);
sysLog.setVisitTime(visitTime);
调用service完成sql注入
sysLogService.save(sysLog);
2.2. 创建service方法
@Service
@Transactional
public class SysLogServiceImpl implements ISysLogService {
@Autowired
private ISyslogDao syslogDao;
@Override
public void save(SysLog sysLog) throws Exception {
syslogDao.save(sysLog);
}
}
2.3. 创建Dao方法
public interface ISyslogDao {
@Insert("insert into syslog (visitTime, username, ip, url, executionTime, method) values " +
"(#{visitTime}, #{username}, #{ip}, #{url}, #{executionTime}, #{method})")
public void save(SysLog sysLog) throws Exception;
}
到这里,就完成将用户的访问记录保存到数据库的操作,要将记录在页面中展示,只需在前端做个展示页面,将数据读出展示即可。
me}, #{username}, #{ip}, #{url}, #{executionTime}, #{method})")
public void save(SysLog sysLog) throws Exception;
}
到这里,就完成将用户的访问记录保存到数据库的操作,要将记录在页面中展示,只需在前端做个展示页面,将数据读出展示即可。