Spring Boot入门(6)-使用AOP统一处理Web请求日志

avatar 2017年10月30日20:29:58 6 2862 views
博主分享免费Java教学视频，B站账号：Java刘哥 ，长期提供技术问题解决、项目定制：本站商品点此
本文介绍 SpringBoot 使用 AOP 统一处理 Web 请求日志。

一、导入依赖

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-aop</artifactId>
  4. </dependency>


二、代码示例


这里通过一个拦截器的示例介绍。主要看 HttpAspect.java 的代码

1、UserController.java
  1. package com.liuyanzhao.blog.controller;
  3. import com.liuyanzhao.blog.domain.User;
  4. import com.liuyanzhao.blog.repository.UserRepository;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.web.bind.annotation.*;
  8. import java.util.List;
  10. /**
  11.  * @Author 言曌
  12.  * @DATE 2017/10/29 上午10:33
  13.  * @URL http://liuyanzhao.com
  14.  */
  16. @RestController
  17. public class UserController {
  19.     @Autowired
  20.     private UserRepository userRepository;
  23.     /**
  24.      * 查询所有用户列表
  25.      * @return
  26.      */
  27.     @GetMapping(value = "/users")
  28.     public List<User> listUser() {
  29.         System.out.println("List all user!");
  30.         return userRepository.findAll();
  31.     }
  35.     /**
  36.      * 删除一个用户
  37.      * @param id
  38.      */
  39.     @DeleteMapping(value = "/users/{id}")
  40.     public void deleteUser(@PathVariable("id") Integer id) {
  41.         System.out.println("Delete a user!");
  42.         userRepository.delete(id);
  43.     }
  46. }



2、UserRepository.java
  1. package com.liuyanzhao.blog.repository;
  3. import com.liuyanzhao.blog.domain.User;
  4. import org.springframework.data.jpa.repository.JpaRepository;
  7. /**
  8.  * @Author 言曌
  9.  * @DATE 2017/10/29 上午10:35
  10.  * @URL http://liuyanzhao.com
  11.  */
  13. public interface UserRepository  extends JpaRepository<User,Integer>{//表名和Id类型
  16. }



3、User.java
  1. package com.liuyanzhao.blog.domain;
  4. import javax.persistence.Entity;
  5. import javax.persistence.GeneratedValue;
  6. import javax.persistence.Id;
  7. import javax.validation.constraints.Min;
  9. @Entity
  10. public class User {
  12.     @Id
  13.     @GeneratedValue
  14.     private Integer id;
  16.     private String name;
  18.     private String gender;
  20.     private Integer age;
  22.     public Integer getId() {
  23.         return id;
  24.     }
  26.     public void setId(Integer id) {
  27.         this.id = id;
  28.     }
  30.     public String getName() {
  31.         return name;
  32.     }
  34.     public void setName(String name) {
  35.         this.name = name;
  36.     }
  38.     public String getGender() {
  39.         return gender;
  40.     }
  42.     public void setGender(String gender) {
  43.         this.gender = gender;
  44.     }
  46.     public Integer getAge() {
  47.         return age;
  48.     }
  50.     public void setAge(Integer age) {
  51.         this.age = age;
  52.     }
  53. }



4、HttpAspect.java 拦截器

① 写法一、
  1. package com.liuyanzhao.blog.aspect;
  3. import org.aspectj.lang.annotation.After;
  4. import org.aspectj.lang.annotation.Aspect;
  5. import org.aspectj.lang.annotation.Before;
  6. import org.springframework.stereotype.Component;
  8. /**
  9.  * @Author 言曌
  10.  * @DATE 2017/10/30 下午7:03
  11.  * @URL http://liuyanzhao.com
  12.  */
  14. @Aspect
  15. @Component
  16. public class HttpAspect {
  18.     //在UserController所有方法调用之前执行一次
  19.     @Before("execution(public * com.liuyanzhao.blog.controller.UserController.*(..))")
  20.     public void doBefore() {
  21.         System.out.println("11111111");
  22.     }
  24.     //在UserController所有方法调用之后执行一次
  25.     @After("execution(public * com.liuyanzhao.blog.controller.UserController.*(..))")
  26.     public void doAfter() {
  27.         System.out.println("222222222");
  28.     }
  30. }

注意：

@Aspect  表示该类是一个面向切面编程的类

@Component  表示将该类加入 Spring 容器

@Before("execution(public * com.liuyanzhao.blog.controller.UserController.*(..))")  表示在 UserController 类下的所有方法执行前执行。

@After与@Before相反



然后我们可以发起一个查询所有用户的请求和删除一个用户的请求，观察控制台



可以证明拦截器是有效的



② 写法二、

我们发现上面的 @Before 和 @After 后面的代码是一样的，重复了，本着不写重复代码的原则，我们要把它整理一下，所以 HttpAspect.java 可以改成这样
  1. package com.liuyanzhao.blog.aspect;
  3. import org.aspectj.lang.annotation.After;
  4. import org.aspectj.lang.annotation.Aspect;
  5. import org.aspectj.lang.annotation.Before;
  6. import org.aspectj.lang.annotation.Pointcut;
  7. import org.springframework.stereotype.Component;
  9. /**
  10.  * @Author 言曌
  11.  * @DATE 2017/10/30 下午7:03
  12.  * @URL http://liuyanzhao.com
  13.  */
  15. @Aspect
  16. @Component
  17. public class HttpAspect {
  20.     @Pointcut("execution(public * com.liuyanzhao.blog.controller.UserController.*(..))")
  21.     public void log() { }
  23.     //在UserController所有方法调用之前执行一次
  24.     @Before("log()")
  25.     public void doBefore() {
  26.         System.out.println("11111111");
  27.     }
  29.     //在UserController所有方法调用之后执行一次
  30.     @After("log()")
  31.     public void doAfter() {
  32.         System.out.println("222222222");
  33.     }
  34. }



③ 写法三 (推荐)
  1. package com.liuyanzhao.blog.aspect;
  3. import org.aspectj.lang.annotation.After;
  4. import org.aspectj.lang.annotation.Aspect;
  5. import org.aspectj.lang.annotation.Before;
  6. import org.aspectj.lang.annotation.Pointcut;
  7. import org.slf4j.Logger;
  8. import org.slf4j.LoggerFactory;
  9. import org.springframework.stereotype.Component;
  11. /**
  12.  * @Author 言曌
  13.  * @DATE 2017/10/30 下午7:03
  14.  * @URL http://liuyanzhao.com
  15.  */
  17. @Aspect
  18. @Component
  19. public class HttpAspect {
  21.     private final static Logger logger = LoggerFactory.getLogger(HttpAspect.class);
  23.     @Pointcut("execution(public * com.liuyanzhao.blog.controller.UserController.*(..))")
  24.     public void log() { }
  26.     //在UserController所有方法调用之前执行一次
  27.     @Before("log()")
  28.     public void doBefore() {
  29.         logger.info("11111111111");
  30.     }
  32.     //在UserController所有方法调用之后执行一次
  33.     @After("log()")
  34.     public void doAfter() {
  35.         logger.info("22222222222");
  36.     }
  37. }

注意 Logger 的包不要导错了，要导 org.slf4j.Logger; 下的

和方法一执行同样的操作，控制台效果图如下



我们发现这次的日志里会有时间，进程号，端口号，哪个类输出的日志等信息，更加强大，所以更为推荐使用。


三、将 http 请求写入日志


将上面的 HttpAspect.java 修改一下，用于获取 Http 请求，并写入日志
  1. package com.liuyanzhao.blog.aspect;
  3. import org.aspectj.lang.JoinPoint;
  4. import org.aspectj.lang.annotation.*;
  5. import org.slf4j.Logger;
  6. import org.slf4j.LoggerFactory;
  7. import org.springframework.stereotype.Component;
  8. import org.springframework.web.context.request.RequestContextHolder;
  9. import org.springframework.web.context.request.ServletRequestAttributes;
  11. import javax.servlet.http.HttpServletRequest;
  13. /**
  14.  * @Author 言曌
  15.  * @DATE 2017/10/30 下午7:03
  16.  * @URL http://liuyanzhao.com
  17.  */
  19. @Aspect
  20. @Component
  21. public class HttpAspect {
  23.     private final static Logger logger = LoggerFactory.getLogger(HttpAspect.class);
  25.     @Pointcut("execution(public * com.liuyanzhao.blog.controller.UserController.*(..))")
  26.     public void log() { }
  28.     //在UserController所有方法调用之前执行一次
  29.     @Before("log()")
  30.     public void doBefore(JoinPoint joinPoint) {
  31.         ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  32.         HttpServletRequest request = attributes.getRequest();
  34.         //url
  35.         logger.info("url={}",request.getRequestURL());
  37.         //method
  38.         logger.info("method={}",request.getMethod());
  40.         //ip
  41.         logger.info("ip={}",request.getRemoteAddr());
  43.         //类方法
  44.         logger.info("class_method={}",joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
  46.         //参数
  47.         logger.info("args={}",joinPoint.getArgs());
  49.     }
  51.     //在UserController所有方法调用之后执行一次
  52.     @After("log()")
  53.     public void doAfter() {
  54.         logger.info("22222222222");
  55.     }
  57.     //返回结果
  58.     @AfterReturning(returning = "object",pointcut = "log()")
  59.     public void doAfterReturning(Object object) {
  60.         logger.info("response={}",object);
  61.     }
  62. }

发起一个请求，控制台效果图





历史上的今天
十月
30日
  • 微信
  • 交流学习，资料分享
  • weinxin
  • 个人淘宝
  • 店铺名：言曌博客咨询部

  • (部分商品未及时上架淘宝)
avatar

发表评论

avatar 登录者：匿名
匿名评论，评论回复后会有邮件通知

  

已通过评论：0   待审核评论数：0