栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

spring Boot 日志管理--使用AOP统一处理Web请求日志

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

spring Boot 日志管理--使用AOP统一处理Web请求日志

导语
  AOP (Aspects Oriented Programming)面向切面编程,通过预编译的方式和运行期动态代理实现程序功能的统一维护。AOP作为Spring 框架中的一个重要的内容,通过对既有程序定义一个切点,然后再起前后切入不同的执行内容的方式来实现一些拓展性的操作。例如,打开/关闭数据库连接、打开/关闭事务、记录日志等等。
  AOP不会破坏原有逻辑,所以它可以很好的对业务逻辑各个部件之间进行隔离,从而降低了各个部件之间的耦合度,这个在开发中是非常重要的,同时提高了程序的可重用性,同时提高了开发效率

准备工作

   由于需要用到Web请求来完成切面的日志记录测试,所以在使用的时候,需要先引入Web模块,并且创建一个简单的Hello World的请求。

  • pom.xml中引入Web模块
    
       org.springframework.boot
       spring-boot-starter-web
    
  • 实现一个简单的RestFul的请求接口
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;


@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello(@RequestParam("name") String name){
        return "hello"+name;
    }
}

引入AOP依赖

  在Spring Boot 中引入AOP。

     
        org.springframework.boot
        spring-boot-starter-aop
     

  完成AOP依赖引入之后,一般是不需要做多余的配置的,因为在Spring Boot中有自动注入,在使用的AOP的Starter的时候,就会自动装配对应的依赖。

实现Web层的日志切面

  实现AOP切面主要有如下的几个要素

  • 使用 @Aspect注解将指定的Java类设置为切面
  • 使用 @ Pointcut 定义一个切入点,可以是一个表达式,例如,某些函数名
  • 根据需要在切入点的不同的位置实现切入内容操作
    • 使用@Before 在切入点开始的位置
    • 使用@After 在切入点结束的位置
    • 使用@AfterReturning 在切入点return内容之后切入内容
    • 使用@Around 在接入点前后切入内容,并且自己控制合适执行切入点和自身的内容
    • 使用@AfterThrowing 用来处理当切入内容发生异常之后的处理逻辑。
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;
import java.util.logging.Logger;


@Aspect
@Component
public class WebLogAspect {

    private Logger logger = Logger.getLogger("hello");
    @Pointcut("execution(public * com.example.demo..*.*(..))")
    public void webLog(){

    }
    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint){
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        logger.info("URL : "+request.getRequestURL().toString());
        logger.info("HTTP_METHOD :"+request.getMethod());
        logger.info("IP : "+request.getRemoteAddr());
        logger.info("CLASS_METHOD : "+joinPoint.getSignature().getDeclaringTypeName()+"."+joinPoint.getSignature().getName());
        logger.info("ARGS : "+ Arrays.toString(joinPoint.getArgs()));
    }

    @AfterReturning(returning = "ret",pointcut = "webLog()")
    public void doAfterReturning(Object ret){
        logger.info("RESPONSE :"+ret);
    }
}

  从上面可以看出,通过@Pointcat()定义的切入点是com.example.demo 包下面的所有函数,对Web层所有请求处理做切入点,然后通过@Before 实现,对请求内容的日志记录。最后通过@AfterReturning记录请求返回的对象。

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/936785.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号