【项目】仿牛客网社区开发第3章 Spring Boot 实践开发社区核心功能 10 统一记录日志

太过爱你忘了你带给我的痛 2024-03-22 12:19 42阅读 0赞

### 【项目】仿牛客网社区开发 ###

#### 文章目录 ####

*   *  【项目】仿牛客网社区开发
     *   *  第3章 Spring Boot 实践 开发社区核心功能
         *   *  10 统一记录日志
             *   *  10.1 需求
                 *  10.2 AOP的概念
                 *  10.3 AOP的术语
                 *  10.4 AOP的实现
                 *  10.5 Spring AOP

![在这里插入图片描述][9f7ca8a1ef124c6784ec1025b355418f.png_pic_center]

#### 第3章 Spring Boot 实践 开发社区核心功能 ####

##### 10 统一记录日志 #####

###### 10.1 需求 ######

*  帖子模块
 *  评论模块
 *  消息模块

![在这里插入图片描述][06209d17ed3e4c37875a259e01e54527.png_pic_center]

硬编码的方法会导致耦合度太高，不易修改。

###### 10.2 AOP的概念 ######

*  Aspect Oriented Programing， 即面向方面（切面）编程。
 *  AOP是一种编程思想，是对OOP的补充， 可以进一步提高编程的效率。

![在这里插入图片描述][96b20bdf3e594f10acd0b0b2becb1ee5.png_pic_center]

> 代码使用简单，重点理解这种思想

【单独定义组件】

这个组件不会与我们的已有系统发生关系，不需要额外的去主动调用。

###### 10.3 AOP的术语 ######

![在这里插入图片描述][d2f123e7485248589feaa28cfc803552.png_pic_center]

*  Target：目标对象，我们要处理的需求的目标【程序中已经开发好的一个个bean 】
 *  Aspect：切面，业务需求【一个额外的bean，完成我们额外的需求】
    
     *  Pointcut：切点【声明要织入到哪些目标对象的哪些位置】
     *  Advice：通知【额外需求到底要做什么】
 *  Joinpoint：连接点，织入位置【目标对象有很多地方可以被织入代码】

###### 10.4 AOP的实现 ######

*  AspectJ 【学习成本较高】
    
     *  AspectJ是语言级的实现，它扩展了Java语言，定义了AOP语法。
     *  AspectJ在编译期织入代码，它有一个专门的编译器，用来生成遵守Java字节码规范的class文件。
 *  Spring AOP
    
     *  Spring AOP使用纯Java实现，它不需要专门的编译过程，也不需要特殊的类装载器。
     *  Spring AOP**在运行时通过代理的方式织入代码**，**只支持方法**类型的连接点。 【虽然不全面，但是是一个性价比很高的解决方案】
     *  Spring支持对AspectJ的集成

###### 10.5 Spring AOP ######

*  JDK动态代理
    
     *  Java提供的动态代理技术，可以在运行时创建接口的代理实例。
     *  Spring AOP默认采用此种方式，在接口的代理实例中织入代码。
 *  CGLib动态代理
    
     *  采用底层的字节码技术，在运行时创建子类代理实例。
     *  当目标对象不存在接口时，Spring AOP会采用此种方式，在子类实例中织入代码

代码体会：

package com.nowcoder.community.aspect;
    
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.*;
    import org.springframework.stereotype.Component;
    
    /**
     * @Projectname: community
     * @Classname: AlphaAspect
     * @Author: Ding Jiaxiong
     * @Date:2023/4/19 18:49
     */
    
    @Component
    @Aspect
    public class AlphaAspect {
        
    
        // 定义切点
        @Pointcut("execution(* com.nowcoder.community.service.*.*(..))")
        public void pointcut() {
        
    
        }
    
        @Before("pointcut()")
        public void before() {
        
            System.out.println("before");
        }
    
        @After("pointcut()")
        public void after() {
        
            System.out.println("after");
        }
    
        @AfterReturning("pointcut()")
        public void afterRetuning() {
        
            System.out.println("afterRetuning");
        }
    
        @AfterThrowing("pointcut()")
        public void afterThrowing() {
        
            System.out.println("afterThrowing");
        }
    
        @Around("pointcut()")
        public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        
            System.out.println("around before");
            Object obj = joinPoint.proceed();
            System.out.println("around after");
            return obj;
        }
    
    }

![在这里插入图片描述][9d25fd1931e34cc894ea22e818081cbf.png_pic_center]

这样就对所有的业务都生效了。

直接启动服务器，访问首页

![在这里插入图片描述][8011b0c55e6f4fc79bc63f26e0755bca.png_pic_center]

可以看到，到处都是

![在这里插入图片描述][d26a2948ebc7490aabf4057e93b85f39.png_pic_center]

当然因为我们代码中并没有报错，所以没有那两个throw 的输出。

【实现需求：记日志】

记录啥呢？ 用户在xx 时间访问了xxx 方法。

package com.nowcoder.community.aspect;
    
    import org.aspectj.lang.JoinPoint;
    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;
    
    import javax.servlet.http.HttpServletRequest;
    import java.text.SimpleDateFormat;
    import java.util.Date;
    
    /**
     * @Projectname: community
     * @Classname: ServiceLogAspect
     * @Author: Ding Jiaxiong
     * @Date:2023/4/19 19:02
     */
    
    @Component
    @Aspect
    public class ServiceLogAspect {
        
    
        private static final Logger logger = LoggerFactory.getLogger(ServiceLogAspect.class);
    
        @Pointcut("execution(* com.nowcoder.community.service.*.*(..))")
        public void pointcut() {
        
    
        }
    
        @Before("pointcut()")
        public void before(JoinPoint joinPoint) {
        
            // 用户[1.2.3.4],在[xxx],访问了[com.nowcoder.community.service.xxx()].
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
            String ip = request.getRemoteHost();
            String now = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date());
            String target = joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName();
            logger.info(String.format("用户[%s],在[%s],访问了[%s].", ip, now, target));
        }
    
    }

直接重启服务器看看，访问首页

![在这里插入图片描述][56c5385577cb404ab578c0204b8214ce.png_pic_center]

没问题，每一个业务都使用到了这个通知【在访问前】。

[9f7ca8a1ef124c6784ec1025b355418f.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/70ff6cc81d8a43289c1a0d70ad36e39e.png
[06209d17ed3e4c37875a259e01e54527.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/dcd33f78aedc421fbfdeabc6fe62b12e.png
[96b20bdf3e594f10acd0b0b2becb1ee5.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/11c6b3da4098449e8b3b6003053cd003.png
[d2f123e7485248589feaa28cfc803552.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/c3e3d3dc04a54ba6a522047383e90525.png
[9d25fd1931e34cc894ea22e818081cbf.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/3175c3edffed47a982b40be706a977e9.png
[8011b0c55e6f4fc79bc63f26e0755bca.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/3c2705e6541e495e9cfc594e56cce136.png
[d26a2948ebc7490aabf4057e93b85f39.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/f1c24d087d0a4a9dad6a0c6da656e968.png
[56c5385577cb404ab578c0204b8214ce.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/7fcc846b620f4df9805553769a9122ee.png