SpringBoot集成AOP管理日志

写在前面

如何将所有的通过url的请求参数以及返回结果都输出到日志中？

如果在controller的类中每个方法名都写一个log输出肯定是不明智的选择。使用Spring的AOP功能即可完成。

AOP 是 Aspect Oriented Program （面向切面）的编程的缩写。他是和面向对象编程相对的一个概念。在面向对象的编程中，我们倾向于采用封装、继承、多态等概念，将一个个的功能在对象中来实现。但是，我们在实际情况中也发现，会有另外一种需求就是一类功能在很多对象的很多方法中都有需要。例如有一些对数据库访问的方法有事务管理的需求，有很多方法中要求打印日志。按照面向对象的方式，那么这些相同的功能要在很多地方来实现或者在很多地方来调用。这就非常繁琐并且和这些和业务不相关的需求耦合太紧密了。所以后来就出现了面向切面的编程来解决这一类问题，并对面向对象的编程做了很好的补充

代码实现

1、在pom.xml中添加aspect依赖包。

 <!-- aop -->
  <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-aop</artifactId>
  </dependency>

2、添加WebLogAspect类。

package com.fit.aop;

import java.util.Enumeration;

import javax.servlet.http.HttpServletRequest;

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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

@Aspect
@Component
public class WebLogAspect {

    private static final Logger logger = LoggerFactory.getLogger(WebLogAspect.class);

    @Pointcut("execution(public * com.fit.controller.*.*(..))")
    public void webLog() {
    }
    /**
     * 使用AOP前置通知拦截请求参数信息
     */
    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        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());
        Enumeration<String> enu = request.getParameterNames();
        while (enu.hasMoreElements()) {
            String name = (String) enu.nextElement();
            logger.info("name:{},value:{}", name, request.getParameter(name));
        }
    }
    /**
     * 后置通知 
     * @param ret
     * @throws Throwable
     */
    @AfterReturning(returning = "ret", pointcut = "webLog()")
    public void doAfterReturning(Object ret) throws Throwable {
        // 处理完请求，返回内容
        logger.info("RESPONSE : " + ret);
    }
}

3、UserController测试类

package com.fit.controller;

import java.util.HashMap;
import java.util.Map;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class UserController {
    @ResponseBody
    @RequestMapping(value = "getUser")
    public Map<String, Object> getUser() {
        Map<String, Object> user = new HashMap<String, Object>();
        user.put("name", "zlzhaoe");
        user.put("age", "21");
        return user;
    }
}

4、SpringBoot启动类

package com.fit;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class App {
    /**
     * @param args
     */
    public static void main(String[] args) {
        // TODO Auto-generated method stub
          SpringApplication.run(App.class, args);
    }
}

5、启动App，访问http://localhost:8080/getUser，日志打印如下：
这里写图片描述

SpringBoot集成AOP管理日志

写在前面

代码实现

猜你喜欢