取消controller的请求信息打印到日志中

最新推荐文章于 2025-01-01 16:18:44 发布

万凌峰

最新推荐文章于 2025-01-01 16:18:44 发布

阅读量534

点赞数

分类专栏： # SpringBoot 文章标签： AOP

本文链接：https://blog.youkuaiyun.com/u014265423/article/details/102718919

版权

SpringBoot 专栏收录该内容

11 篇文章

订阅专栏

本文介绍了一种在Java应用中实现接口请求日志记录的切面方法，并通过注解来选择性地忽略特定Controller的请求日志，确保敏感信息不被记录。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

注解

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

/**
 * 使用该注解后,"不会"将controller的请求信息打印到日志中
 * @author wanlf
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface ApiLogIgnore {

}

切面

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.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import com.miaoshaproject.annotation.ApiLogIgnore;

/**
 * 接口请求日志切面
 * @author wanlf
 */
@Component
@Aspect
public class ApiLogAop {
  
	private static Logger logger = LoggerFactory.getLogger(ApiLogAop.class);

	@Pointcut("execution(* com.xxx.xxx.feaute.*.controller..*(..))")
	public void controller() {
	}

	@Before("controller()")
	private void beforeController(JoinPoint joinPoint) {
		MethodSignature signature = (MethodSignature) joinPoint.getSignature();
		Method method = signature.getMethod();
		if (method.isAnnotationPresent(ApiLogIgnore.class)) {
			return;
		}
		if (method.isAnnotationPresent(RequestMapping.class) 
		 || method.isAnnotationPresent(PostMapping.class)
		 || method.isAnnotationPresent(PutMapping.class)	
		 || method.isAnnotationPresent(DeleteMapping.class)
	     || method.isAnnotationPresent(GetMapping.class)) {
			StringBuffer sb = new StringBuffer();
			ServletRequestAttributes sra = (ServletRequestAttributes) 
			(RequestContextHolder.getRequestAttributes());
			HttpServletRequest request = sra.getRequest();
			String requestStr = requestToString(request);
			String bodyStr = bodyToString(joinPoint);
			sb.append(requestStr).append(bodyStr);
			logger.info("[接口请求AOP]{}", sb.toString());
		}
	}
	
	/**
	 * 将请求中的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 "BODY:";
	}
	
	/**
	 * 将请求转换为字符串、除了body
	 * @param request
	 * @return
	 */
	private String requestToString(HttpServletRequest request){
		StringBuffer sb=new StringBuffer();
		
		//请求客户端IP
		
		String ip=IPUtils.getIP(request);
		sb.append("IP:").append(ip).append("|");
		
		//请求URL
		String method=request.getMethod();
		StringBuffer requestURL=request.getRequestURL();
		sb.append(method).append(" ").append(requestURL).append(" |");
		// 请求头
		/*sb.append("HEADERS:[");
		Enumeration<String> headerNames = request.getHeaderNames();
		while (headerNames.hasMoreElements()) {
			String headerName = headerNames.nextElement();
			String headerValue = request.getHeader(headerName);
			sb.append(headerName).append(":").append(headerValue).append(",");
		}
		sb.append("]|");*/
		
		//请求查询参数
		String queryString=request.getQueryString();
		sb.append("QUERY_STRING:").append(queryString).append("|");
		
		//请求表单参数
		sb.append("PARAMETERS:[");
					
		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(",");
				}
				sb.append(key).append(":").append(valueBuffer);
			}
		}
		sb.append("]|");
		return sb.toString();
	}
}