1.首先定义个切面标签源
public enum Source {
main("10", "微信"),
platform("20", "支付宝"),
driverApp("25", "app"),
shipperApplet("70", "小程序"),
private String code;
private String name;
private Source(String code, String name) {
this.code = code;
this.name = name;
}
public String getCode() {
return code;
}
public String getName() {
return name;
}
public static String getCode(String name) {
for (Source source : Source.values()) {
if (name.equals(source.getName())) {
return source.getCode();
}
}
return null;
}
public static String getName(String code) {
for (Source status : Source.values()) {
if (code.equals(status.getCode())) {
return status.getName();
}
}
return "";
}
}
2.切面工具接口
/**
* @author admin
* 自定义注解, 拦截日志
*/
@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SystemLog {
/**
* 模块名称 系统管理-用户管理-列表页面
*
* @return
*/
String menu() default "";
/**
* 接口名称
*
* @return
*/
String operation() default "";
/**
* 来源: 小程序还是APP
* @return
*/
Source source() default Source.main;
/**
* 是否记录请求参数和响应数据, 默认true: 记录; false:不记录
*
* @return
*/
boolean isData() default false;
}
3.切面实现类
/**
* author : admin
* Date : 2019/12/18
* 日志切面类
*/
@Aspect
@Component
public class LogAspect {
private Logger logger = LoggerFactory.getLogger(LogAspect.class);
//切点
@Pointcut("@annotation(com.xxx.SystemLog)")
public void logger() {
}
@Before("logger()")
public void doBefore(JoinPoint joinPoint) {
ProceedingJoinPoint point = (ProceedingJoinPoint)joinPoint;
//从上下文中获取reqeust
ServletRequestAttributes servletRequestAttributes =
(ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
HttpServletRequest request = servletRequestAttributes.getRequest();
StringBuffer stringBuffer = new StringBuffer();
MethodSignature methodSignature = (MethodSignature)point.getSignature();
Method method = methodSignature.getMethod();
String requestParams = getRequestParams(point, request);
// 获取请求信息
SystemLog systemLog = method.getAnnotation(SystemLog.class);
String menuName = systemLog.menu();
stringBuffer.append("URL【")
.append(request.getRequestURI())
.append("】;requestType【")
.append(request.getMethod())
.append("】;IP【")
.append(request.getRemoteAddr())
.append("】;响应该http请求的类方法【")
.append(joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName())
.append("】;Params【")
.append(requestParams + "】")
.append(";操作菜单【")
.append(menuName + "】");
logger.info("请求开始:" + stringBuffer.toString());
}
@AfterReturning(returning = "object", pointcut = "logger()")
public void doAfterReturning(Object object) {
if (object != null) {
logger.info("请求结束返回的结果【{}】", object.toString());
}
}
@AfterThrowing(value = "logger()", throwing = "e")
public void doAfterThrowing(Throwable e) {
logger.info("发生异常【" + e.getMessage() + "】");
}
/**
* 获取请求参数
*
* @param request
* @return
*/
public String getRequestParams(ProceedingJoinPoint point, HttpServletRequest request) {
MethodSignature methodSignature = (MethodSignature)point.getSignature();
Method method = methodSignature.getMethod();
String queryString = null;
String requestMethod = request.getMethod();
if (requestMethod.equals(HttpMethod.POST.name())) {
//参数值
Object[] args = ArrayUtils.toArray(point.getArgs());
queryString = JSON.toJSONString(args[0], SerializerFeature.WriteMapNullValue);
}
else {
//参数名
Parameter[] parameters = method.getParameters();
//参数值
Object[] args = ArrayUtils.toArray(point.getArgs());
Map<String, Object> map = new HashMap<>();
for (int i = 0; i < parameters.length; i++) {
map.put(parameters[i].getName(), args[i]);
}
queryString = JSON.toJSONString(map);
}
return queryString;
}
}
使用方法:
在controler中添加注解(@SystemLog)
@SystemLog(menu = "通过ID查看详情)", operation = "查询", source = Source.XXXapp)
@RequestGetMapping
@ApiOperation("查看磅单夹(通过ID查看货源详情)")
public String getXXXById(@RequestParam @ApiParam("id") Integer id) {
return “”;
}
效果: