详解Spring Boot中使用AOP统一处理Web请求日志
更新时间：2017年05月13日 16:24:08 作者：zmken497300
本篇文章主要介绍了详解Spring Boot中使用AOP统一处理Web请求日志，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
在spring boot中，简单几步，使用spring AOP实现一个拦截器：
1、引入依赖：
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
2、创建拦截器类（在该类中，定义了拦截规则：拦截com.xjj.web.controller包下面的所有类中，有@RequestMapping注解的方法。）：
/**
* 拦截器：记录用户操作日志，检查用户是否登录……
* @author XuJijun
*/
@Aspect
@Component
public class ControllerInterceptor {
private static final Logger logger = LoggerFactory.getLogger(ControllerInterceptor.class);
@Value(“${spring.profiles}”)
private String env;
/**
* 定义拦截规则：拦截com.xjj.web.controller包下面的所有类中，有@RequestMapping注解的方法。
*/
@Pointcut(“execution(* com.xjj.web.controller..*(..)) and @annotation(org.springframework.web.bind.annotation.RequestMapping)”)
public void controllerMethodPointcut(){}
/**
* 拦截器具体实现
* @param pjp
* @return JsonResult（被拦截方法的执行结果，或需要登录的错误提示。）
*/
@Around(“controllerMethodPointcut()”) //指定拦截器规则；也可以直接把“execution(* com.xjj………)”写进这里
public Object Interceptor(ProceedingJoinPoint pjp){
long beginTime = System.currentTimeMillis();
MethodSignature signature = (MethodSignature) pjp.getSignature();
Method method = signature.getMethod(); //获取被拦截的方法
String methodName = method.getName(); //获取被拦截的方法名
Set<Object> allParams = new LinkedHashSet<>(); //保存所有请求参数，用于输出到日志中
logger.info(”请求开始，方法：{}”, methodName);
Object result = null;
Object[] args = pjp.getArgs();
for(Object arg : args){
//logger.debug(“arg: {}”, arg);
if (arg instanceof Map<?, ?>) {
//提取方法中的MAP参数，用于记录进日志中
@SuppressWarnings(“unchecked”)
Map<String, Object> map = (Map<String, Object>) arg;
allParams.add(map);
}else if(arg instanceof HttpServletRequest){
HttpServletRequest request = (HttpServletRequest) arg;
if(isLoginRequired(method)){
if(!isLogin(request)){
result = new JsonResult(ResultCode.NOT_LOGIN, “该操作需要登录！去登录吗？\n\n（不知道登录账号？请联系老许。）”, null);
}
}
//获取query string 或 posted form data参数
Map<String, String[]> paramMap = request.getParameterMap();
if(paramMap!=null && paramMap.size()>0){
allParams.add(paramMap);
}
}else if(arg instanceof HttpServletResponse){
//do nothing…
}else{
//allParams.add(arg);
}
}
try {
if(result == null){
// 一切正常的情况下，继续执行被拦截的方法
result = pjp.proceed();
}
} catch (Throwable e) {
logger.info(”exception: ”, e);
result = new JsonResult(ResultCode.EXCEPTION, “发生异常：”+e.getMessage());
}
if(result instanceof JsonResult){
long costMs = System.currentTimeMillis() - beginTime;
logger.info(”{}请求结束，耗时：{}ms”, methodName, costMs);
}
return result;
}
/**
* 判断一个方法是否需要登录
* @param method
* @return
*/
private boolean isLoginRequired(Method method){
if(!env.equals(“prod”)){ //只有生产环境才需要登录
return false;
}
boolean result = true;
if(method.isAnnotationPresent(Permission.class)){
result = method.getAnnotation(Permission.class).loginReqired();
}
return result;
}
//判断是否已经登录
private boolean isLogin(HttpServletRequest request) {
return true;
/*String token = XWebUtils.getCookieByName(request, WebConstants.CookieName.AdminToken);
if(“1”.equals(redisOperator.get(RedisConstants.Prefix.ADMIN_TOKEN+token))){
return true;
}else {
return false;
}*/
}
}
/**
* 拦截器：记录用户操作日志，检查用户是否登录……
* @author XuJijun
*/
@Aspect
@Component
public class ControllerInterceptor {
private static final Logger logger = LoggerFactory.getLogger(ControllerInterceptor.class);
@Value("${spring.profiles}")
private String env;
/**
* 定义拦截规则：拦截com.xjj.web.controller包下面的所有类中，有@RequestMapping注解的方法。
*/
@Pointcut("execution(* com.xjj.web.controller..*(..)) and @annotation(org.springframework.web.bind.annotation.RequestMapping)")
public void controllerMethodPointcut(){}
/**
* 拦截器具体实现
* @param pjp
* @return JsonResult（被拦截方法的执行结果，或需要登录的错误提示。）
*/
@Around("controllerMethodPointcut()") //指定拦截器规则；也可以直接把“execution(* com.xjj.........)”写进这里
public Object Interceptor(ProceedingJoinPoint pjp){
long beginTime = System.currentTimeMillis();
MethodSignature signature = (MethodSignature) pjp.getSignature();
Method method = signature.getMethod(); //获取被拦截的方法
String methodName = method.getName(); //获取被拦截的方法名
Set<Object> allParams = new LinkedHashSet<>(); //保存所有请求参数，用于输出到日志中
logger.info("请求开始，方法：{}", methodName);
Object result = null;
Object[] args = pjp.getArgs();
for(Object arg : args){
//logger.debug("arg: {}", arg);
if (arg instanceof Map<?, ?>) {
//提取方法中的MAP参数，用于记录进日志中
@SuppressWarnings("unchecked")
Map<String, Object> map = (Map<String, Object>) arg;
allParams.add(map);
}else if(arg instanceof HttpServletRequest){
HttpServletRequest request = (HttpServletRequest) arg;
if(isLoginRequired(method)){
if(!isLogin(request)){
result = new JsonResult(ResultCode.NOT_LOGIN, "该操作需要登录！去登录吗？\n\n（不知道登录账号？请联系老许。）", null);
}
}
//获取query string 或 posted form data参数
Map<String, String[]> paramMap = request.getParameterMap();
if(paramMap!=null && paramMap.size()>0){
allParams.add(paramMap);
}
}else if(arg instanceof HttpServletResponse){
//do nothing...
}else{
//allParams.add(arg);
}
}
try {
if(result == null){
// 一切正常的情况下，继续执行被拦截的方法
result = pjp.proceed();
}
} catch (Throwable e) {
logger.info("exception: ", e);
result = new JsonResult(ResultCode.EXCEPTION, "发生异常："+e.getMessage());
}
if(result instanceof JsonResult){
long costMs = System.currentTimeMillis() - beginTime;
logger.info("{}请求结束，耗时：{}ms", methodName, costMs);
}
return result;
}
/**
* 判断一个方法是否需要登录
* @param method
* @return
*/
private boolean isLoginRequired(Method method){
if(!env.equals("prod")){ //只有生产环境才需要登录
return false;
}
boolean result = true;
if(method.isAnnotationPresent(Permission.class)){
result = method.getAnnotation(Permission.class).loginReqired();
}
return result;
}
//判断是否已经登录
private boolean isLogin(HttpServletRequest request) {
return true;
/*String token = XWebUtils.getCookieByName(request, WebConstants.CookieName.AdminToken);
if("1".equals(redisOperator.get(RedisConstants.Prefix.ADMIN_TOKEN+token))){
return true;
}else {
return false;
}*/
}
}
3、测试
浏览器中输入：http://localhost:8082/api/admin/login
测试结果：
2016-07-26 11:58:12,057:INFO http-nio-8082-exec-1 (ControllerInterceptor.java:58) - 请求开始，方法：login 2016-07-26 11:58:12,061:INFO http-nio-8082-exec-1 (ControllerInterceptor.java:103) - login请求结束，耗时：8ms
2016-07-26 11:58:12,057:INFO http-nio-8082-exec-1 (ControllerInterceptor.java:58) - 请求开始，方法：login 2016-07-26 11:58:12,061:INFO http-nio-8082-exec-1 (ControllerInterceptor.java:103) - login请求结束，耗时：8ms
证明拦截器已经生效。
源代码参考：https://github.com/xujijun/my-spring-boot
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。
相关文章
这篇文章主要介绍了mybatisplus解决驼峰命名映射问题详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-09-09
这篇文章主要介绍了Java编程实现调用com操作Word方法实例代码，代码注释很详细，在这里分给大家，需要的朋友可以参考下。2017-09-09
IntelliJ IDEA 2020.3.3现已发布!新增“受信任项目”功能
这篇文章主要介绍了IntelliJ IDEA 2020.3.3现已发布!新增“受信任项目”功能,本文给大家分享了idea2020.3.3激活码的详细破解教程，每种方法都很好用，使用idea2020.3以下所有版本，需要的朋友可以参考下2021-03-03
下面小编就为大家带来一篇基于Java中进制的转换函数详解。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-07-07
Hibernate是一种Java对象关系映射框架，提供了多种查询和抓取策略，用于优化数据库访问性能。查询策略包括延迟加载、立即加载、查询缓存等，抓取策略包括join抓取、子查询抓取、批量抓取等。这些策略可以根据实际应用场景进行选择和配置，提高数据访问的效率和稳定性2023-04-04
SSH框架网上商城项目第16战之Hibernate二级缓存处理首页热门显示
这篇文章主要介绍了SSH框架网上商城项目第16战之Hibernate的二级缓存处理首页的热门显示，感兴趣的小伙伴们可以参考一下2016-06-06
这篇文章主要介绍了java图形界面编程实战代码,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2019-07-07
这篇文章主要介绍了Java8 Lamda方法引用和构造引用,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-04-04
这篇文章主要介绍了Java基本数据类型和运算符,结合实例形式详细分析了java基本数据类型、数据类型转换、算术运算符、逻辑运算符等相关原理与操作技巧,需要的朋友可以参考下2021-08-08
这篇文章主要介绍了java正则表达式如何获取xml文件中指定节点的值问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2023-06-06
最新评论