Web开发学习(9)全局埋点

埋点的作用是把客户端每次访问服务端的操作记录下来,包括请求连接 请求者ip 请求参数 请求结果等等,以便于在出现异常的情况下排查,在用户量庞大的情况下还可以对这些记录做数据分析.这个功能我还是坚持一直以来的原则,一次封装终身受用,使用拦截器的方式全局做埋点记录.

首先创建一个注解类,这个注解类的作用是在action方法上标注当前方法的中文信息,记录到日志以后有便于查阅

package cn.sdh.common.annotation;

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

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface WebOperateAnno {
	
	String memo() default "无定义";
	
}

这个方法的缺点是需要在每个action上进行配置,对我这种比较爱偷懒的猿来说还是有点不怎么好忍受的,还好我有权限系统(上一篇),记录每个权限对应的链接,也就是我知道客户端访问的链接后就能通过权限数据获取到对应的权限(就是菜单),菜单的名称其实就是我需要的备注,这样我就不需要在每个action方法做备注了,当然有些没进行权限配置的action方法还是需要注解的,先来看下注解的代码

/**
	 * 跳转到主页
	 * 
	 * @throws JSONException
	 */
	@WebOperateAnno(memo="主页")
	public String index() throws JSONException {

		entity = SpringSecurityUtils.getCurrentUser();

		List<Permission> perList = entity.getSignPer();

		HttpServletRequest request = ServletActionContext.getRequest();
		request.setAttribute("perList", perList);
		request.setAttribute("perListJson", JSONUtil.serialize(perList));

		return "index";
	}

很简单的注解,然后在来看下核心代码,action拦截器

package cn.sdh.common.intercepter;

import javax.servlet.http.HttpServletRequest;

import org.apache.log4j.Logger;
import org.apache.struts2.ServletActionContext;

import cn.sdh.common.annotation.WebOperateAnno;
import cn.sdh.entity.Account;
import cn.sdh.utils.MyCacheUtil;
import cn.sdh.utils.MyJsonUtil;
import cn.sdh.utils.SpringSecurityUtils;

import com.opensymphony.xwork2.ActionInvocation;
import com.opensymphony.xwork2.interceptor.MethodFilterInterceptor;
@SuppressWarnings("serial")
public class WebOperateIntercepter extends MethodFilterInterceptor {

	private static final Logger logger = Logger.getLogger("oplog");

	private static final Logger sysLogger = Logger.getLogger(WebOperateIntercepter.class);
	
	@Override
	protected String doIntercept(ActionInvocation invocation) throws Exception {
		String result = null;
		try {
			//先执行action方法
			result = invocation.invoke();
			
			String enterMethod = invocation.getProxy().getMethod();
			//获取action方法上的WebOperateAnno 注解
			WebOperateAnno webOperateAnno = invocation.getAction().getClass().getMethod(enterMethod, new Class[0]).getAnnotation(WebOperateAnno.class);
			
			Object returnData = invocation.getAction();
			
			writeLog(webOperateAnno,returnData);
		} catch (Exception e) {
			sysLogger.error("操作日志记录失败",e);
		}
		
		
		return result;
	}
	
	private void writeLog(WebOperateAnno ano, Object returnData){
		//当前登录用户
		Account account = SpringSecurityUtils.getCurrentUser();
		
		String operate = "";
		if(account != null){
			operate = account.getUsername();
		}
		
		//从注解中获取备注
		String memo = "";
		if(ano != null){
			memo = ano.memo();
		}
		
		HttpServletRequest request = ServletActionContext.getRequest();
		//请求者ip
		String ip = request.getRemoteAddr();
		//请求类型 post or get
		String method = request.getMethod();
		//请求的链接
		String url = request.getRequestURI();
		//通过请求的链接从权限系统获取到当前模块
		String module = MyCacheUtil.getPerNameByUrl(url);
		
		//对请求的参数进行json格式化
		String entityString = MyJsonUtil.getJsonByObject(request.getParameterMap());
		
		//做日志记录
		logger.info(module+"|"+operate+"|"+ip+"|"+memo+"|"+method+"|"+url+"|"+entityString+"|"+returnData.toString());
		
	}
	

}

简单的一个拦截器记录操作信息到单独的日志文件,你也可以记录到数据库,我是感觉如果记录到数据库的话多多少少会影响一点效率,而且这个数据量也是挺大的.这边还值得一提的是结果值是被调用的action的toString方法,还记不记得上一篇讲的action基类,所有的action类都从它派生,在这里他又发挥作用了,看一下基类里面的toString代码

public String toString(){
		StringBuilder builder = new StringBuilder();
		builder.append(",success:");
		builder.append(this.success);
		if(this.entity != null){
			builder.append("entity:");
			builder.append(this.entity.toString());
		}if(this.searchList != null){
			builder.append("searchList:");
			builder.append(this.searchList.toString());
		}
		
		return builder.toString();
	}

因为我所有的返回值都是基于entity和searchList实现的,所以可以很方便的把返回值获取到,其实程序中有很多模块的实现不是随便想想的,大多数情况下这些设计都是可以复用的,这也体现出了设计模式的重要性.

最后只要在struts文件中配置拦截器就可以了

<interceptors>
			<interceptor name="webOperate"
				class="cn.sdh.common.intercepter.WebOperateIntercepter" />
			<interceptor-stack name="crudStack">
				
				<interceptor-ref name="defaultStack"/> 
				<interceptor-ref name="webOperate" />
			</interceptor-stack>
		</interceptors>
		
		
		
		<default-interceptor-ref name="crudStack" />