使用Spring AOP使用注解记录用户操作日志

最新推荐文章于 2024-05-20 11:22:17 发布

小飞鹤

最新推荐文章于 2024-05-20 11:22:17 发布

阅读量2.8w

点赞数 15

分类专栏：架构与优化 Java技术栈架构

本文链接：https://blog.csdn.net/he90227/article/details/44175365

版权

Java技术栈架构同时被 2 个专栏收录

28 篇文章 65 订阅

订阅专栏

架构与优化

25 篇文章 0 订阅

订阅专栏

1.自定义注解，记录操作日志

1.自定义注解

package com.jay.demo3.aop1.myannotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

//业务注释类  -- 定义 ： 运行期间基于方法的注解    参考http://my.oschina.net/yangzg/blog/343945
/*
 * 常用注解说明： 
 * 1. RetentionPolicy(保留策略)是一个enum类型，有三个值 
 * SOURCE        --  这个Annotation类型的信息只会保留在程序源码里，源码如果经过了编译后，Annotation的数据就会消失，并不会保留在编译好的.class文件里
 * CLASS         --  这个Annotation类型的信息保留在程序源码中，同时也会保留在编译好的.class文件里面,在执行的时候，并不会把这一些信息加载到虚拟 机(JVM)中去.注意一下，当你没有设定一个Annotation类型的Retention值时，系统默认值是CLASS。
 * RUNTIME       --  在源码、编译好的.class文件中保留信息，在执行的时候会把这一些信息加载到JVM中去的。
 * 
 * 2.ElementType @Target中的ElementType用来指定Annotation类型可以用在哪些元素上
 * TYPE(类型)    -- 在Class，Interface，Enum和Annotation类型上
 * FIELD        -- 属性上
 * METHOD       -- 方法上
 * PARAMETER    -- 参数上
 * CONSTRUCTOR  -- 构造函数上
 * LOCAL_VARIABLE -- 局部变量
 * ANNOTATION_TYPE   -- Annotation类型上
 * PACKAGE           -- 包上
 * 
 * 3.Documented    -- 让这个Annotation类型的信息能够显示在API说明文档上；没有添加的话，使用javadoc生成的API文件找不到这个类型生成的信息
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface BussAnnotation {
	//模块名
	String moduleName() default "";
	//操作内容
	String option() default "";
}

2.业务逻辑和接口

1.接口

public interface UserManagerApplogic {
	public void addUser(String name);
	public void addOne(int type,int parentid);
}

2.接口实现

package com.jay.demo3.aop1.impl;

import org.springframework.stereotype.Component;

import com.jay.demo3.aop1.UserManagerApplogic;
import com.jay.demo3.aop1.myannotation.BussAnnotation;
//用户管理业务逻辑实现类   
@Component("userManager")
public class UserManagerApplogicImpl implements UserManagerApplogic {

	@BussAnnotation(moduleName="人员管理",option="添加用户")
	@Override
	public void addUser(String name) {
		System.out.println("add a User name is "+name);
	}

	@BussAnnotation(moduleName="人员管理",option="添加新人")
	@Override
	public void addOne(int type, int parentid) {
		System.out.println("add a new one type : "+type+" \t perentid : "+parentid);
	}

}

3.日志拦截器切面处理类

package com.jay.demo3.aop1.interceptor;


import java.lang.reflect.Method;


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.springframework.stereotype.Component;


import com.jay.demo3.aop1.myannotation.BussAnnotation;


//切面类  http://my.oschina.net/yangzg/blog/343945
/*
 * 特别注意： Spring的配置文件中添加：  
 * 
 * <aop:aspectj-autoproxy />
 * spring-mvc-dispatcher.xml中天机
 * <!--通知spring使用cglib而不是jdk的来生成代理方法 AOP可以拦截到Controller-->  
 * <aop:aspectj-autoproxy proxy-target-class="true"/>
 *
 * <aop:config>节点中proxy-target-class="true"不为true时。
 * 当登录的时候会报这个异常java.lang.NoSuchMethodException: $Proxy54.login()，
 */


@Aspect
@Component
public class LogInterceptor {


    // 定义切入点  @Pointcut("execution(public * com.jay..*.*(..))")  -- 表示对com.jay 包下的所有方法都可添加切入点
    @Pointcut("execution(public * com.jay..*.addUser(..))")
    public void aApplogic() {
    }
    
    //定义切入点  -- 拦截指定的方法  这里拦截 com.jay.demo3.aop1.impl.UserManagerApplogicImpl 的addOne()方法
    @Pointcut("execution(public * com.jay..*.addOne(..))")
    public void joinPointForAddOne(){
        
    }
    
    /**
     * 环绕通知 用于拦截指定内容，记录用户的操作
     */
    @Around(value = "aApplogic() && @annotation(annotation) &&args(object,..) ", argNames = "annotation,object")
    public Object interceptorApplogic(ProceedingJoinPoint pj,
            BussAnnotation annotation, Object object) throws Throwable {
        System.out.println("moduleName:" + annotation.moduleName());
        System.out.println("option:" + annotation.option());
        pj.proceed();
        System.out.println(pj.getSignature().getName());
        for(Object obj : pj.getArgs()){
            System.out.println(obj.toString());
        }
        return object;
    }
    
    /**
     * 环绕通知   拦截指定的切点，这里拦截joinPointForAddOne切入点所指定的addOne()方法
     * 
     */
    @Around("joinPointForAddOne()")
    public Object interceptorAddOne(ProceedingJoinPoint joinPoint) throws Throwable {
        System.out.println("Aop start");
        String methodRemark = getMthodRemark(joinPoint);
        Object result = null;
        try {  
            // 记录操作日志...谁..在什么时间..做了什么事情..  
            result = joinPoint.proceed();  
        } catch (Exception e) {  
            // 异常处理记录日志..log.error(e);  
            throw e;  
        }  
        System.out.println(methodRemark);
        System.out.println("Aop end");
        return result;
    }


     // 获取方法的中文备注____用于记录用户的操作日志描述  
    public static String getMthodRemark(ProceedingJoinPoint joinPoint)  
            throws Exception {  
        String targetName = joinPoint.getTarget().getClass().getName();  
        String methodName = joinPoint.getSignature().getName();  
        System. out.println("====调用" +methodName+"方法-开始！");
        Object[] arguments = joinPoint.getArgs();   //获得参数列表
        System.out.println("打印出方法调用时传入的参数，可以在这里通过添加参数的类型，进行一些简易逻辑处理和判断");
        if(arguments.length<=0){
            System.out.println("=== "+methodName+" 方法没有参数");
        }else{
        for(int i=0;i<arguments.length;i++){
            System.out.println("==== 参数   "+(i+1)+" : "+arguments[i]);
        }
        }
  
        Class targetClass = Class.forName(targetName);  
        Method[] method = targetClass.getMethods();  
        String methode = "";  
        for (Method m : method) {  
            if (m.getName().equals(methodName)) {  
                Class[] tmpCs = m.getParameterTypes();  
                if (tmpCs.length == arguments.length) {  
                    BussAnnotation methodCache = m.getAnnotation(BussAnnotation.class);  
                    methode = methodCache.moduleName();  
                    break;  
                }  
            }  
        }  
        return methode;  
    }  
}

4.测试类：

package com.jay.demo3.aop1.test;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import com.jay.demo3.aop1.UserManagerApplogic;

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "classpath:*.xml")
public class AopTest1 {
	@Autowired
	private UserManagerApplogic userManager;
	
	@Test
	public void testAopAddUser(){
		userManager.addUser("You you ");
	}

	@Test
	public void testAopAddOne(){
		userManager.addOne(1, 1);
	}
	
}

5.Spring的配置文件添加以下内容

<context:annotation-config/>  
<aop:aspectj-autoproxy />
<context:component-scan base-package="com.jay" />

2.spring mvc +spring aop结合注解的用户操作日志记录

参考了网上的一些文章但是他们写的不是很全自己也是经过了一些摸索可以实现记录 spring mvc controller层操作记录

package com.wssys.framework;

import java.lang.reflect.Method;
import java.text.SimpleDateFormat;
import java.util.Calendar;

import javax.servlet.http.HttpServletRequest;
import org.apache.shiro.SecurityUtils;
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.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 com.wssys.bean.BolBean;
import com.wssys.bean.ComPanyForm;
import com.wssys.bean.DeliverBean;
import com.wssys.bean.GoodsForm;
import com.wssys.dao.SyslogDao;
import com.wssys.entity.Companycontacts;
import com.wssys.entity.PusFrontUser;
import com.wssys.entity.PusMenu;
import com.wssys.entity.PusRole;
import com.wssys.entity.PusSysUser;
import com.wssys.entity.Syslog;
import com.wssys.utils.StringUtil;
import com.wssys.utils.TCPIPUtil;

/**
 * \
 * 
 * @Aspect 实现spring aop 切面（Aspect）：
 *         一个关注点的模块化，这个关注点可能会横切多个对象。事务管理是J2EE应用中一个关于横切关注点的很好的例子。 在Spring
 *         AOP中，切面可以使用通用类（基于模式的风格） 或者在普通类中以 @Aspect 注解（@AspectJ风格）来实现。
 * 
 *         AOP代理（AOP Proxy）： AOP框架创建的对象，用来实现切面契约（aspect contract）（包括通知方法执行等功能）。
 *         在Spring中，AOP代理可以是JDK动态代理或者CGLIB代理。 注意：Spring
 *         2.0最新引入的基于模式（schema-based
 *         ）风格和@AspectJ注解风格的切面声明，对于使用这些风格的用户来说，代理的创建是透明的。
 * @author q
 * 
 */
@Component
@Aspect
public class LogService {

	@Autowired
	private SyslogDao syslogDao;

	public LogService() {
		System.out.println("Aop");
	}

	/**
	 * 在Spring
	 * 2.0中，Pointcut的定义包括两个部分：Pointcut表示式(expression)和Pointcut签名(signature
	 * )。让我们先看看execution表示式的格式：
	 * 括号中各个pattern分别表示修饰符匹配（modifier-pattern?）、返回值匹配（ret
	 * -type-pattern）、类路径匹配（declaring
	 * -type-pattern?）、方法名匹配（name-pattern）、参数匹配（(param
	 * -pattern)）、异常类型匹配（throws-pattern?），其中后面跟着“?”的是可选项。
	 * 
	 * @param point
	 * @throws Throwable
	 */

	@Pointcut("@annotation(com.wssys.framework.MethodLog)")
	public void methodCachePointcut() {

	}

	// // @Before("execution(* com.wssys.controller.*(..))")
	// public void logAll(JoinPoint point) throws Throwable {
	// System.out.println("打印========================");
	// }
	//
	// // @After("execution(* com.wssys.controller.*(..))")
	// public void after() {
	// System.out.println("after");
	// }

	// 方法执行的前后调用
	// @Around("execution(* com.wssys.controller.*(..))||execution(* com.bpm.*.web.account.*.*(..))")
	// @Around("execution(* com.wssys.controller.*(..))")
	// @Around("execution(* org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter.handle(..))")
	@Around("methodCachePointcut()")
	public Object around(ProceedingJoinPoint point) throws Throwable {
		HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder
				.getRequestAttributes()).getRequest();
		SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss E");
		Calendar ca = Calendar.getInstance();
		String operDate = df.format(ca.getTime());
		String ip = TCPIPUtil.getIpAddr(request);
		PusSysUser user = (PusSysUser) SecurityUtils.getSubject()
				.getPrincipal();
		String loginName;
		String name;
		if (user != null) {
			loginName = user.getAccount();
			// name = user.name;
		} else {
			loginName = "匿名用户";
			// name = "匿名用户";
		}

		String monthRemark = getMthodRemark(point);
		String monthName = point.getSignature().getName();
		String packages = point.getThis().getClass().getName();
		if (packages.indexOf("$$EnhancerByCGLIB$$") > -1) { // 如果是CGLIB动态生成的类
			try {
				packages = packages.substring(0, packages.indexOf("$$"));
			} catch (Exception ex) {
				ex.printStackTrace();
			}
		}

		String operatingcontent = "";
		Object[] method_param = null;

		Object object;
		try {
			method_param = point.getArgs();	//获取方法参数 
			// String param=(String) point.proceed(point.getArgs());
			object = point.proceed();
		} catch (Exception e) {
			// 异常处理记录日志..log.error(e);
			throw e;
		}
		Syslog sysLog = new Syslog();
		sysLog.setIpAddress(ip);
		sysLog.setLoginName(loginName);
		sysLog.setMethodName(packages + "." + monthName);
		sysLog.setMethodRemark(monthRemark);
		//这里有点纠结 就是不好判断第一个object元素的类型 只好通过  方法描述来 做一一  转型感觉 这里 有点麻烦 可能是我对 aop不太了解  希望懂的高手在回复评论里给予我指点
		//有没有更好的办法来记录操作参数  因为参数会有 实体类 或者javabean这种参数怎么把它里面的数据都解析出来?
		if (StringUtil.stringIsNull(monthRemark).equals("会员新增")) {
			PusFrontUser pfu = (PusFrontUser) method_param[0];
			sysLog.setOperatingcontent("新增会员:" + pfu.getAccount());
		} else if (StringUtil.stringIsNull(monthRemark).equals("新增角色")) {
			PusRole pr = (PusRole) method_param[0];
			sysLog.setOperatingcontent("新增角色:" + pr.getName());
		} else if (StringUtil.stringIsNull(monthRemark).equals("用户登录")) {
			PusSysUser currUser = (PusSysUser) method_param[0];
			sysLog.setOperatingcontent("登录帐号:" + currUser.getAccount());
		} else if (StringUtil.stringIsNull(monthRemark).equals("用户退出")) {
			sysLog.setOperatingcontent("具体请查看用户登录日志");
		} else if (StringUtil.stringIsNull(monthRemark).equals("角色名称修改")) {
			PusRole pr = (PusRole) method_param[0];
			sysLog.setOperatingcontent("修改角色:" + pr.getName());
		} else if (StringUtil.stringIsNull(monthRemark).equals("新增后台用户")) {
			PusSysUser psu = (PusSysUser) method_param[0];
			sysLog.setOperatingcontent("新增后台用户:" + psu.getAccount());
		} else if (StringUtil.stringIsNull(monthRemark).equals("更新菜单")) {
			PusMenu pm = (PusMenu) method_param[0];
			sysLog.setOperatingcontent("更新菜单:" + pm.getName());
		} else if (StringUtil.stringIsNull(monthRemark).equals("保存菜单")) {
			PusMenu pm = (PusMenu) method_param[0];
			sysLog.setOperatingcontent("保存菜单:" + pm.getName());
		} else if (StringUtil.stringIsNull(monthRemark).equals("修改公司")) {
			ComPanyForm ciform = (ComPanyForm) method_param[0];
			sysLog.setOperatingcontent("修改公司:" + ciform.getName());
		} else if (StringUtil.stringIsNull(monthRemark).equals("联系人更新")) {
			Companycontacts ct = (Companycontacts) method_param[0];
			sysLog.setOperatingcontent("联系人更新:" + ct.getName());
		} else if (StringUtil.stringIsNull(monthRemark).equals("修改货物")) {
			GoodsForm goodsForm = (GoodsForm) method_param[0];
			sysLog.setOperatingcontent("修改货物（货物id/编号）:" + goodsForm.getId());
		} else if (StringUtil.stringIsNull(monthRemark).equals("打印出库单")) {
			DeliverBean owh= (DeliverBean) method_param[0];
			sysLog.setOperatingcontent("出库单单号:" + owh.getCknum());
		} else if (StringUtil.stringIsNull(monthRemark).equals("打印提单")) {
			BolBean bol= (BolBean) method_param[0];
			sysLog.setOperatingcontent("提货单号:" + bol.getBolnum());
		} else if (StringUtil.stringIsNull(monthRemark).equals("系统左侧菜单查询")) {
			sysLog.setOperatingcontent("无");
		} else {
			sysLog.setOperatingcontent("操作参数:" + method_param[0]);
		}

		syslogDao.save(sysLog);
		return object;
	}

	// 方法运行出现异常时调用	
	// @AfterThrowing(pointcut = "execution(* com.wssys.controller.*(..))",
	// throwing = "ex")
	public void afterThrowing(Exception ex) {
		System.out.println("afterThrowing");
		System.out.println(ex);
	}

	// 获取方法的中文备注____用于记录用户的操作日志描述
	public static String getMthodRemark(ProceedingJoinPoint joinPoint)
			throws Exception {
		String targetName = joinPoint.getTarget().getClass().getName();
		String methodName = joinPoint.getSignature().getName();
		Object[] arguments = joinPoint.getArgs();

		Class targetClass = Class.forName(targetName);
		Method[] method = targetClass.getMethods();
		String methode = "";
		for (Method m : method) {
			if (m.getName().equals(methodName)) {
				Class[] tmpCs = m.getParameterTypes();
				if (tmpCs.length == arguments.length) {
					MethodLog methodCache = m.getAnnotation(MethodLog.class);
					if (methodCache != null) {
						methode = methodCache.remark();
					}
					break;
				}
			}
		}
		return methode;
	}

}

spring application.xml配置:

<!– aop –>
<bean id=”logService”></bean>

<!– 启动对@AspectJ注解的支持 –>
<aop:aspectj-autoproxy proxy-target-class=”true” />

spring mvc controller层action的
设置例如:

	@RequestMapping(value = "/addFrontUser", method = RequestMethod.POST)
	@MethodLog(remark = "会员新增")
	public String saveFrontUserAction(@ModelAttribute("psu") PusFrontUser pfu,
			BindingResult result, SessionStatus status,
			HttpServletResponse response) {
		if (pusFrontUserDao.checkAccount(pfu.getAccount()) > 0) {
			PrintWriter out = null;
			try {
				out = response.getWriter();
			} catch (IOException e) {
				// TODO Auto-generated catch block
				e.printStackTrace();
			}

			out.write("保存失败,会员帐号已经存在");

			out.flush();
			return null;
		}
		// Timestamp now = new Timestamp(System.currentTimeMillis());// 获取系统当前时间

		int saverec = 0;

		pfu.setPwd(new Sha384Hash(pfu.getPwd()).toBase64());
		saverec = pusFrontUserDao.save(pfu);

		PrintWriter out = null;
		try {
			out = response.getWriter();
		} catch (IOException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		if (saverec > 0) {
			out.write("保存成功,您可以继续保存或者关闭当前页面");
		} else {
			out.write("保存失败");
		}

		out.flush();
		return null;
	}

package com.wssys.framework;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 表示对标记有xxx注解的类,做代理 注解@Retention可以用来修饰注解，是注解的注解，称为元注解。
 * Retention注解有一个属性value，是RetentionPolicy类型的，Enum RetentionPolicy是一个枚举类型，
 * 这个枚举决定了Retention注解应该如何去保持，也可理解为Rentention 搭配
 * RententionPolicy使用。RetentionPolicy有3个值：CLASS RUNTIME SOURCE
 * 用@Retention(RetentionPolicy
 * .CLASS)修饰的注解，表示注解的信息被保留在class文件(字节码文件)中当程序编译时，但不会被虚拟机读取在运行的时候；
 * 用@Retention(RetentionPolicy.SOURCE
 * )修饰的注解,表示注解的信息会被编译器抛弃，不会留在class文件中，注解的信息只会留在源文件中；
 * 用@Retention(RetentionPolicy.RUNTIME
 * )修饰的注解，表示注解的信息被保留在class文件(字节码文件)中当程序编译时，会被虚拟机保留在运行时，
 * 所以他们可以用反射的方式读取。RetentionPolicy.RUNTIME
 * 可以让你从JVM中读取Annotation注解的信息，以便在分析程序的时候使用.
 * 
 * 类和方法的annotation缺省情况下是不出现在javadoc中的，为了加入这个性质我们用@Documented
 *  java用  @interface Annotation{ } 定义一个注解 @Annotation，一个注解是一个类。
 *  @interface是一个关键字，在设计annotations的时候必须把一个类型定义为@interface，而不能用class或interface关键字 
 * 
 * @author q
 * 
 */

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MethodLog {
String remark() default "";
	String operType() default "0";   
   // String desc() default "";
}

日志数据效果:

基本可以实现监控用户的数据操作

aop 太吊了
改变了传统的每个日志必须去一个个的方法里写的方式
直接通过反射得到所有数据一个类解决
开发不是一般的快

这个过程中为了做这个功能对spring aop 只是匆匆的看了一遍接下来的时间有空就得好好研究下该技术的原理以及实现

小飞鹤

关注

15
点赞
踩
64

收藏

觉得还不错? 一键收藏
6
评论
使用Spring AOP使用注解记录用户操作日志

1.自定义注解，记录操作日志1.自定义注解package com.jay.demo3.aop1.myannotation;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import ja
复制链接

扫一扫