SpringAOP拦截Controller,Service实现日志管理(自定义注解的方式)

最新推荐文章于 2022-09-01 00:00:00 发布

沧浪之水12010137

最新推荐文章于 2022-09-01 00:00:00 发布

阅读量141

点赞数

原文链接：http://itindex.net/detail/50710-springaop-controller-service

版权

首先我们为什么需要做日志管理，在现实的上线中我们经常会遇到系统出现异常或者问题。这个时候就马上打开CRT或者SSH连上服务器拿日子来分析。受网络的各种限制。于是我们就想为什么不能直接在管理后台查看报错的信息呢。于是日志管理就出现了。

     其次个人觉得做日志管理最好的是Aop，有的人也喜欢用拦截器。都可以，在此我重点介绍我的实现方式。

     Aop有的人说拦截不到Controller。有的人说想拦截到Controller必须得拦截org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter。

首先Aop可以拦截到Controller的，这个是毋容置疑的其次须拦截AnnotationMethodHandlerAdapter也不是必须的。最起码我没有验证成功过这个。我的Spring版本是4.0.3。

     Aop之所以有的人说拦截不到Controller是因为Controller被jdk代理了。我们只要把它交给cglib代理就可以了。

第一步定义两个注解：

package com.annotation;

import java.lang.annotation.*;

/**
*自定义注解拦截Controller
*/

@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SystemControllerLog {

String description()  default "";

}

package com.annotation;

import java.lang.annotation.*;

/**
*自定义注解拦截service
*/

@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SystemServiceLog {

String description()  default "";

}

第二步创建一个切点类：

package com.annotation;

import com.model.Log;
import com.model.User;
import com.service.LogService;
import com.util.DateUtil;
import com.util.JSONUtil;
import com.util.SpringContextHolder;
import com.util.WebConstants;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
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.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import java.lang.reflect.Method;

/**

切点类
@author tiangai
@since 2014-08-05 Pm 20:35
@version 1.0
*/
@Aspect
@Component
public class SystemLogAspect {
//注入Service用于把日志保存数据库
@Resource
private LogService logService;
//本地异常日志记录对象
private static final Logger logger = LoggerFactory.getLogger(SystemLogAspect. class);

//Service层切点
@Pointcut("@annotation(com.annotation.SystemServiceLog)")
public void serviceAspect() {
}

//Controller层切点
@Pointcut("@annotation(com.annotation.SystemControllerLog)")
public void controllerAspect() {
}

/**
- 前置通知用于拦截Controller层记录用户的操作
- @param joinPoint 切点
  */
  @Before(“controllerAspect()”)
  public void doBefore(JoinPoint joinPoint) {
  
  HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
  HttpSession session = request.getSession();
  //读取session中的用户
  User user = (User) session.getAttribute(WebConstants.CURRENT_USER);
  //请求的IP
  String ip = request.getRemoteAddr();
  try {
  //控制台输出=//
  System.out.println("=前置通知开始=");
  System.out.println(“请求方法:” + (joinPoint.getTarget().getClass().getName() + “.” + joinPoint.getSignature().getName() + “()”));
  System.out.println(“方法描述:” + getControllerMethodDescription(joinPoint));
  System.out.println(“请求人:” + user.getName());
  System.out.println(“请求IP:” + ip);
  //数据库日志=//
  Log log = SpringContextHolder.getBean(“logxx”);
  log.setDescription(getControllerMethodDescription(joinPoint));
  log.setMethod((joinPoint.getTarget().getClass().getName() + “.” + joinPoint.getSignature().getName() + “()”));
  log.setType(“0”);
  log.setRequestIp(ip);
  log.setExceptionCode( null);
  log.setExceptionDetail( null);
  log.setParams( null);
  log.setCreateBy(user);
  log.setCreateDate(DateUtil.getCurrentDate());
  //保存数据库
  logService.add(log);
  System.out.println("=前置通知结束=");
  } catch (Exception e) {
  //记录本地异常日志
  logger.error(“前置通知异常”);
  logger.error(“异常信息:{}”, e.getMessage());
  }
  }
/**
- 异常通知用于拦截service层记录异常日志
- @param joinPoint
- @param e
  /
  @AfterThrowing(pointcut = “serviceAspect()”, throwing = “e”)
  public void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
  HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
  HttpSession session = request.getSession();
  //读取session中的用户
  User user = (User) session.getAttribute(WebConstants.CURRENT_USER);
  //获取请求ip
  String ip = request.getRemoteAddr();
  //获取用户请求方法的参数并序列化为JSON格式字符串
  String params = “”;
  if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) {
  for ( int i = 0; i < joinPoint.getArgs().length; i++) {
  params += JSONUtil.toJsonString(joinPoint.getArgs()[i]) + “;”;
  }
  }
  try {
  /控制台输出=/
  System.out.println("=异常通知开始=");
  System.out.println(“异常代码:” + e.getClass().getName());
  System.out.println(“异常信息:” + e.getMessage());
  System.out.println(“异常方法:” + (joinPoint.getTarget().getClass().getName() + “.” + joinPoint.getSignature().getName() + “()”));
  System.out.println(“方法描述:” + getServiceMthodDescription(joinPoint));
  System.out.println(“请求人:” + user.getName());
  System.out.println(“请求IP:” + ip);
  System.out.println(“请求参数:” + params);
  /==数据库日志=/
  Log log = SpringContextHolder.getBean(“logxx”);
  log.setDescription(getServiceMthodDescription(joinPoint));
  log.setExceptionCode(e.getClass().getName());
  log.setType(“1”);
  log.setExceptionDetail(e.getMessage());
  log.setMethod((joinPoint.getTarget().getClass().getName() + “.” + joinPoint.getSignature().getName() + “()”));
  log.setParams(params);
  log.setCreateBy(user);
  log.setCreateDate(DateUtil.getCurrentDate());
  log.setRequestIp(ip);
  //保存数据库
  logService.add(log);
  System.out.println("=异常通知结束=");
  } catch (Exception ex) {
  //记录本地异常日志
  logger.error(“异常通知异常”);
  logger.error(“异常信息:{}”, ex.getMessage());
  }
  /记录本地异常日志*/
  logger.error(“异常方法:{}异常代码:{}异常信息:{}参数:{}”, joinPoint.getTarget().getClass().getName() + joinPoint.getSignature().getName(), e.getClass().getName(), e.getMessage(), params);
}

/**
- 获取注解中对方法的描述信息用于service层注解
- @param joinPoint 切点
- @return 方法描述
- @throws Exception
  */
  public static String getServiceMthodDescription(JoinPoint joinPoint)
  throws Exception {
  String targetName = joinPoint.getTarget().getClass().getName();
  String methodName = joinPoint.getSignature().getName();
  Object[] arguments = joinPoint.getArgs();
  Class targetClass = Class.forName(targetName);
  Method[] methods = targetClass.getMethods();
  String description = “”;
  for (Method method : methods) {
  if (method.getName().equals(methodName)) {
  Class[] clazzs = method.getParameterTypes();
  if (clazzs.length == arguments.length) {
  description = method.getAnnotation(SystemServiceLog. class).description();
  break;
  }
  }
  }
  return description;
  }
/**
- 获取注解中对方法的描述信息用于Controller层注解
- @param joinPoint 切点
- @return 方法描述
- @throws Exception
  */
  public static String getControllerMethodDescription(JoinPoint joinPoint) throws Exception {
  String targetName = joinPoint.getTarget().getClass().getName();
  String methodName = joinPoint.getSignature().getName();
  Object[] arguments = joinPoint.getArgs();
  Class targetClass = Class.forName(targetName);
  Method[] methods = targetClass.getMethods();
  String description = “”;
  for (Method method : methods) {
  if (method.getName().equals(methodName)) {
  Class[] clazzs = method.getParameterTypes();
  if (clazzs.length == arguments.length) {
  description = method.getAnnotation(SystemControllerLog. class).description();
  break;
  }
  }
  }
  return description;
  }
  }

第三步把Controller的代理权交给cglib

在实例化ApplicationContext的时候需要加上

Xml代码

aop:aspectj-autoproxy/
在调用Controller的时候AOP发挥作用所以在SpringMVC的配置文件里加上

Xml代码

沧浪之水12010137

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
SpringAOP拦截Controller,Service实现日志管理(自定义注解的方式)

首先我们为什么需要做日志管理，在现实的上线中我们经常会遇到系统出现异常或者问题。这个时候就马上打开CRT或者SSH连上服务器拿日子来分析。受网络的各种限制。于是我们就想为什么不能直接在管理后台查看报错的信息呢。于是日志管理就出现了。其次个人觉得做日志管理最好的是Aop，有的人也喜欢用拦截器。都可以，在此我重点介绍我的实现方式。 Aop有的人说拦截不到Controller。有...
复制链接

扫一扫