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" class="com.wssys.framework.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 只是匆匆的看了一遍  接下来的时间有空就得好好研究下该技术 的原理以及实现

评论

10 楼 kandaness 2017-06-23  

q472358790 写道

你好 请教你一下  你有没有遇到方法被拦截了两次这种情况？  方便的话 邮件联系:[e-mail]

请问下你解决了么？

9 楼 u010402518 2015-12-07  

个人觉得获取方法备注的代码写成这样更优，上文中class又被加载了一次，会耗性能。
public static String getMethodRemark(JoinPoint joinPoint) throws Exception {

Class<?> clazz = joinPoint.getTarget().getClass();
String name = joinPoint.getSignature().getName();
Object[] parameterTypes = joinPoint.getArgs();
for (Method method : clazz.getDeclaredMethods()) {
if (method.getName().equals(name) && method.getParameterTypes().length == parameterTypes.length) {
MethodLog methodLog = method.getAnnotation(MethodLog.class);
if (methodLog != null) {
return methodLog.value();
}
break;
}
}

return "";
}

8 楼 拨弦waitC 2015-07-06  

3楼：在springmvc配置文件中加上<aop:aspectj-autoproxy />

7 楼 zqb666kkk 2014-10-23  

haungfeilong136 写道

lz能不能给份代码学习下

http://skyfar666.iteye.com/blog/2147058 已经分享

6 楼 haungfeilong136 2014-08-26  

lz能不能给份代码学习下

5 楼 IT_LDB 2014-06-30  

zqb666kkk 写道

q472358790 写道

你好 请教你一下  你有没有遇到方法被拦截了两次这种情况？  方便的话 邮件联系:[e-mail]

那倒没有

环回吧。

4 楼 IT_LDB 2014-06-30  

IT_LDB 写道

楼主，您好，我看了您的帖子之后，自己动手尝试写了下。发现在springmvc中无法使用，能否将配置贴出来呢？纠结了5个小时了。。。
如果方便的话，QQ交流吧。。。 450897041 。       

【自己最开始用的struts,没有考虑到mvc框架会和spring都扫描包，springmvc和spring配置加载顺序问题】发现怎么配置都不能正常的切入到项目。
最开始以为是spring没有正确生成切面对象，后来发现是servlet-mvc.xml
扫描了我要切入的对象，那么spring去扫描的时候发现内存中已经有了该对象
就不再对其进行aop增强或者事务控制，于是，在spring-mvc配置文件中去掉了
扫描service的路径，一切恢复正常，因为service层是我要切入的面。所以应该是
由spring来管理。

spring-mvc.xml部分配置
[code=html]
<!-- 扫描的时候过滤掉Service层，aop要在service进行切入！  -->
<context:component-scan base-package="com.buyantech.infoaudit">
<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Service"/>
</context:component-scan>
<context:component-scan base-package="com.buyantech.log">
<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Service"/>
</context:component-scan>


spring部分配置
[code=html]
<context:component-scan base-package="com.**.service" />

3 楼 IT_LDB 2014-06-25  

楼主，您好，我看了您的帖子之后，自己动手尝试写了下。发现在springmvc中无法使用，能否将配置贴出来呢？纠结了5个小时了。。。
如果方便的话，QQ交流吧。。。 450897041 。       

2 楼 zqb666kkk 2014-05-21  

q472358790 写道

你好 请教你一下  你有没有遇到方法被拦截了两次这种情况？  方便的话 邮件联系:[e-mail]

那倒没有

1 楼 q472358790 2014-05-21  

你好 请教你一下  你有没有遇到方法被拦截了两次这种情况？  方便的话 邮件联系:[e-mail]