API接口记录AOP

注解

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

/**
 * 使用该注解后,会将API接口操作记录存储到DB中
 * @author wanlf
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD })
public @interface OpLog {

	/**
	 * 操作说明
	 * 
	 * @return 操作说明
	 */
	String value();
}

切面

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.Enumeration;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import com.miaoshaproject.annotation.OpLog;

/**
 * 用户操作切面
 * @author wanlf
 */
@Component
@Aspect
public class UserOperationAop {
   
	@Autowired
	private OperateHistoryService operateHistoryService;

	@Before("@annotation(com.xxx.pass.annotation.OpLog)")
	private void BeforeController(JoinPoint joinPoint) {
		MethodSignature signature = (MethodSignature) joinPoint.getSignature();
		Method method = signature.getMethod();
		ServletRequestAttributes sra = (ServletRequestAttributes) (RequestContextHolder.getRequestAttributes());
		HttpServletRequest request = sra.getRequest();

		// 获取操作描述
		OpLog annotation = method.getAnnotation(OpLog.class);
		String description = annotation.value();

		// 获取用户
		User loginUser = (User) SecurityUtils.getSubject().getPrincipal();
		// 获取IP
		String ip = IPUtils.getIp(request);
		// 请求方法
		String requestMethod = request.getMethod();
		// 请求URL
		String requestUrl = request.getRequestURL().toString();
		// 查询参数
		String queryString = request.getQueryString();
		// 请求头
		StringBuilder headerBuilder = new StringBuilder();
		Enumeration<String> headerNames = request.getHeaderNames();
		while (headerNames.hasMoreElements()) {
			String headerName = headerNames.nextElement();
			String headerValue = request.getHeader(headerName);
			headerBuilder.append(headerName).append(":").append(headerValue).append(",");
		}
		String requestHeaders = headerBuilder.toString();
		// 请求表单参数
		StringBuilder formBuilder = new StringBuilder();
		Map<String, String[]> paramterMap = request.getParameterMap();
		for (Map.Entry<String, String[]> key : paramterMap.entrySet()) {
			String[] values = paramterMap.get(key);
			if (values != null && values.length != 0) {
				StringBuffer valueBuffer = new StringBuffer();
				for (String value : values) {
					valueBuffer.append(value).append(",");
				}
				formBuilder.append(key).append(":").append(valueBuffer);
			}
		}
		String requestParam = formBuilder.toString();
		// 请求体
		String requestBody = bodyToString(joinPoint);

		OperateHistory operateHistory = new OperateHistory();
		operateHistory.setUser(loginUser);
		operateHistory.setIp(ip);
		operateHistory.setDescription(description);
		operateHistory.setRequestMethod(requestMethod);
		operateHistory.setRequestUrl(requestUrl);
		operateHistory.setQueryString(queryString);
		operateHistory.setRequestHeaders(requestHeaders);
		operateHistory.setRequestParam(requestParam);
		operateHistory.setRequestBody(requestBody);

		// 存入db
		operateHistoryService.insert(OperateHistory);
	}
	
	/**
	 * 将请求中的body转换为字符串
	 * @param joinPoint
	 * @return
	 */
	private String bodyToString(JoinPoint joinPoint) {
		MethodSignature signature = (MethodSignature) joinPoint.getSignature();
		Method method = signature.getMethod();
		Annotation[][] parameterAnnotations = method.getParameterAnnotations();
		for (Annotation[] annotations : parameterAnnotations) {
			for (Annotation annotation : annotations) {
				if (annotation.annotationType().isAssignableFrom(RequestBody.class)) {
					StringBuffer sb = new StringBuffer();
					Object[] args = joinPoint.getArgs();
					for (Object arg : args) {
						sb.append(arg);
					}
					return sb.toString();
				}
			}
		}
		return null;
	}
}