当前位置: 首页 > 编程笔记 >

aop注解方式实现全局日志管理方法

彭宏义
2023-03-14
本文向大家介绍aop注解方式实现全局日志管理方法,包括了aop注解方式实现全局日志管理方法的使用技巧和注意事项,需要的朋友参考一下

1:日志实体类

public class SysLog {
 /** */
 private Integer id;
 /** 日志描述*/
 private String description;
 /** 执行的方法*/
 private String method;
 /** 日志类型 0:操作日志;1:异常日志*/
 private Integer logType;
 /** 客户端请求的ip地址*/
 private String requestIp;
 /** 异常代码*/
 private String exceptionCode;
 /** 异常详细信息*/
 private String exceptionDetail;
 /** 请求参数*/
 private String params;
 /** 操作人*/
 private String createBy;
 /** 操作时间*/
 private String createDate;
 public Integer getId() {
  return id;
 }
 public void setId(Integer id) {
  this.id = id;
 }
 public String getDescription() {
  return description;
 }
 public void setDescription(String description) {
  this.description = description;
 }
 public String getMethod() {
  return method;
 }
 public void setMethod(String method) {
  this.method = method;
 }
 public Integer getLogType() {
  return logType;
 }
 public void setLogType(Integer logType) {
  this.logType = logType;
 }
 public String getRequestIp() {
  return requestIp;
 }
 public void setRequestIp(String requestIp) {
  this.requestIp = requestIp;
 }
 public String getExceptionCode() {
  return exceptionCode;
 }
 public void setExceptionCode(String exceptionCode) {
  this.exceptionCode = exceptionCode;
 }
 public String getExceptionDetail() {
  return exceptionDetail;
 }
 public void setExceptionDetail(String exceptionDetail) {
  this.exceptionDetail = exceptionDetail;
 }
 public String getParams() {
  return params;
 }
 public void setParams(String params) {
  this.params = params;
 }
 public String getCreateBy() {
  return createBy;
 }
 public void setCreateBy(String createBy) {
  this.createBy = createBy;
 }
 public String getCreateDate() {
  return createDate;
 }
 public void setCreateDate(String createDate) {
  this.createDate = createDate;
 }
}

2:maven需要的jar

<dependency> 
   <groupId>org.aspectj</groupId> 
   <artifactId>aspectjrt</artifactId> 
   <version>1.7.4</version> 
  </dependency> 
 <dependency> 
   <groupId>org.aspectj</groupId> 
   <artifactId>aspectjweaver</artifactId> 
   <version>1.7.4</version> 
 </dependency> 
<dependency> 
   <groupId>cglib</groupId> 
   <artifactId>cglib</artifactId> 
   <version>2.1_3</version> 
 </dependency>
<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-aop</artifactId>
  <version>4.2.5.RELEASE</version>
</dependency> 

这里要求项目使用的是jdk1.7

3:springServlet-mvc.xml

<!--proxy-target-class="true"强制使用cglib代理 如果为false则spring会自动选择--> 
<aop:aspectj-autoproxy proxy-target-class="true"/> 

加上proxy-target-class="true"是为了可以拦截controller里面的方法

4:定义切面,我这里主要写前置通知和异常通知

下面开始自定义注解

import java.lang.annotation.*;
@Target({ElementType.PARAMETER, ElementType.METHOD}) 
@Retention(RetentionPolicy.RUNTIME) 
@Documented 
public @interface Log {
	/** 要执行的操作类型比如:add操作 **/ 
	 public String operationType() default ""; 
	 /** 要执行的具体操作比如:添加用户 **/ 
	 public String operationName() default "";
}

切面类

import java.lang.reflect.Method;
import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.Date;
import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
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 com.gtcity.user.model.SysLog;
import com.gtcity.user.model.SysUser;
import com.gtcity.user.service.SysLogService;
/**
 * @author panliang
 * @version 创建时间:2017-3-31 
 * @desc 切点类 
 *
 */
@Aspect
@Component
public class SystemLogAspect {
	//注入Service用于把日志保存数据库 
	@Resource 
	private SysLogService systemLogService;
	private static final Logger logger = LoggerFactory.getLogger(SystemLogAspect. class); 
	
	//Controller层切点 
	//第一个*代表所有的返回值类型
	//第二个*代表所有的类
	//第三个*代表类所有方法
	//最后一个..代表所有的参数。
	 @Pointcut("execution (* com.gtcity.web.controller..*.*(..))") 
	 public void controllerAspect() { 
	 } 
	 
	 /**
	 * 
	 * @author: panliang
	 * @time:2017-3-31 下午2:22:16
	 * @param joinPoint 切点
	 * @describtion:前置通知 用于拦截Controller层记录用户的操作 
	 */
	 @Before("controllerAspect()")
	 public void doBefore(JoinPoint joinPoint) {
		/* System.out.println("==========执行controller前置通知===============");
		 if(logger.isInfoEnabled()){
			 logger.info("before " + joinPoint);
		 }*/
		 
		 HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest(); 
   HttpSession session = request.getSession(); 
   //读取session中的用户 
   SysUser user = (SysUser) session.getAttribute("user"); 
   if(user==null){
  	 user=new SysUser();
  	 user.setUserName("非注册用户");
   }
   //请求的IP 
   String ip = request.getRemoteAddr();
   try { 
    
    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 operationType = "";
    String operationName = "";
    for (Method method : methods) { 
     if (method.getName().equals(methodName)) { 
      Class[] clazzs = method.getParameterTypes(); 
      if (clazzs.length == arguments.length) { 
       operationType = method.getAnnotation(Log.class).operationType();
       operationName = method.getAnnotation(Log.class).operationName();
       break; 
      } 
     } 
    }
    //*========控制台输出=========*// 
    System.out.println("=====controller前置通知开始====="); 
    System.out.println("请求方法:" + (joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()")+"."+operationType); 
    System.out.println("方法描述:" + operationName); 
    System.out.println("请求人:" + user.getUserName()); 
    System.out.println("请求IP:" + ip); 
    //*========数据库日志=========*// 
    SysLog log = new SysLog(); 
    log.setDescription(operationName); 
    log.setMethod((joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()")+"."+operationType); 
    log.setLogType(0); 
    log.setRequestIp(ip); 
    log.setExceptionCode(null); 
    log.setExceptionDetail( null); 
    log.setParams( null); 
    log.setCreateBy(user.getUserName());
    log.setCreateDate(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date())); 
    log.setRequestIp(ip);
    //保存数据库 
    systemLogService.insert(log); 
    System.out.println("=====controller前置通知结束====="); 
   } catch (Exception e) { 
    //记录本地异常日志 
    logger.error("==前置通知异常=="); 
    logger.error("异常信息:{}", e.getMessage()); 
   } 
		 
		 
	 } 
	 
	 
 
  /**
	 * 
	 * @author: panliang
	 * @time:2017-3-31 下午2:24:36
	 * @param joinPoint 切点 
	 * @describtion:异常通知 用于拦截记录异常日志 
	 */
  @AfterThrowing(pointcut = "controllerAspect()", throwing="e") 
  public void doAfterThrowing(JoinPoint joinPoint, Throwable e) { 
 	 
 	 HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest(); 
   HttpSession session = request.getSession(); 
   //读取session中的用户 
   SysUser user = (SysUser) session.getAttribute("user"); 
   if(user==null){
   	 user=new SysUser();
   	 user.setUserName("非注册用户");
   }
   //请求的IP 
   String ip = request.getRemoteAddr();
   
   String params = ""; 
   if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) { 
   
  	 params=Arrays.toString(joinPoint.getArgs());
   } 
   try { 
    
    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 operationType = "";
    String operationName = "";
    for (Method method : methods) { 
     if (method.getName().equals(methodName)) { 
      Class[] clazzs = method.getParameterTypes(); 
      if (clazzs.length == arguments.length) { 
       operationType = method.getAnnotation(Log.class).operationType();
       operationName = method.getAnnotation(Log.class).operationName();
       break; 
      } 
     } 
    }
    /*========控制台输出=========*/ 
    System.out.println("=====异常通知开始====="); 
    System.out.println("异常代码:" + e.getClass().getName()); 
    System.out.println("异常信息:" + e.getMessage()); 
    System.out.println("异常方法:" + (joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()")+"."+operationType); 
    System.out.println("方法描述:" + operationName); 
    System.out.println("请求人:" + user.getUserName()); 
    System.out.println("请求IP:" + ip); 
    System.out.println("请求参数:" + params); 
    //==========数据库日志========= 
    SysLog log = new SysLog();
    log.setDescription(operationName); 
    log.setExceptionCode(e.getClass().getName()); 
    log.setLogType(1); 
    log.setExceptionDetail(e.getMessage()); 
    log.setMethod((joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()")); 
    log.setParams(params); 
    log.setCreateBy(user.getUserName()); 
    log.setCreateDate(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date())); 
    log.setRequestIp(ip); 
    //保存数据库 
    systemLogService.insert(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); 
 
  } 
	 
}

5:在controller里面

/**
	 * 根据用户名去找密码 判断用户名和密码是否正确
	 * @author panliang
	 * @param request
	 * @param response
	 * @throws IOException 
	 */
	@RequestMapping("/skipPage.do")
	@Log(operationType="select操作:",operationName="用户登录")//注意:这个不加的话,这个方法的日志记录不会被插入
	public ModelAndView skipPage(HttpServletRequest request,HttpServletResponse response) throws IOException{
		
		ModelAndView result=null;
		String username = request.getParameter("email");
		String password = request.getParameter("password");
		int flag = sysUserService.login(request, username, password);
		if(flag==1){//登录成功
			result=new ModelAndView("redirect:/login/dispacher_main.do");
		}else if(flag==2){//用户名不存在		
			result=new ModelAndView("redirect:/login/login.do?errorCode=1");			
		} else{//密码不正确	
			result=new ModelAndView("redirect:/login/login.do?errorCode=2");			
		}
		return result;
	}

对于想要了解其他三种通知的可以参考这篇博文:点击打开链接

这样用户在访问后台时,不管是正常访问还是出现bug数据库都有记录

以上这篇aop注解方式实现全局日志管理方法就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持小牛知识库。

 类似资料:
  • 本文向大家介绍spring AOP自定义注解方式实现日志管理的实例讲解,包括了spring AOP自定义注解方式实现日志管理的实例讲解的使用技巧和注意事项,需要的朋友参考一下 今天继续实现AOP,到这里我个人认为是最灵活,可扩展的方式了,就拿日志管理来说,用Spring AOP 自定义注解形式实现日志管理。废话不多说,直接开始!!! 关于配置我还是的再说一遍。 在applicationContex

  • 本文向大家介绍Spring Aop之AspectJ注解配置实现日志管理的方法,包括了Spring Aop之AspectJ注解配置实现日志管理的方法的使用技巧和注意事项,需要的朋友参考一下 最近项目要做一个日志功能,我用Spring Aop的注解方式来实现。 创建日志注解 创建切面通知类 记录操作的方法名,参数和花费的时间,使用环绕通知 扫描和启动aop注解 日志注解的应用 效果 以上这篇Sprin

  • 本文向大家介绍springMVC自定义注解,用AOP来实现日志记录的方法,包括了springMVC自定义注解,用AOP来实现日志记录的方法的使用技巧和注意事项,需要的朋友参考一下 需求背景 最近的一个项目,在项目基本完工的阶段,客户提出要将所有业务操作的日志记录到数据库中,并且要提取一些业务的关键信息(比如交易单号)体现在日志中。 为了保证工期,在查阅了资料以后,决定用AOP+自定义注解的方式来完

  • 本文向大家介绍使用Spring的注解方式实现AOP实例,包括了使用Spring的注解方式实现AOP实例的使用技巧和注意事项,需要的朋友参考一下 spring对AOP的实现提供了很好的支持。下面我们就使用Spring的注解来完成AOP做一个例子。 首先,为了使用Spring的AOP注解功能,必须导入如下几个包。aspectjrt.jar,aspectjweaver.jar,cglib-nodep.j

  • 我们这里说的全局变量,着重指的是能够全局动态响应的情况。 说到全局变量,我们首先想到的可能就是vuex,确实,这是最好的实现方式。在uni-app中,我们还可以有其他的实现方式,这里我们做一个抛砖引玉的讨论,当然,我们 推荐的,还是使用uView封装后的vuex的实现方式,它具有配置简单,使用方便的特点。 整体来说,在uni-app中,可以有如下实现全局变量的方式: 本地存储 配置文件 挂载Vue

  • 本文向大家介绍Spring框架基于AOP实现简单日志管理步骤解析,包括了Spring框架基于AOP实现简单日志管理步骤解析的使用技巧和注意事项,需要的朋友参考一下 SPringAOP的使用 技术概述,描述这个技术是做什么?学习该技术的原因,技术的难点在哪里。 为了实现项目管理员端的操作数据库日志,便于方便所以利用Spring框架的AOP机制进行实现,项目的难点在于如果设置切入点,如何获取参数。 技