• springboot整合aop，实现日志操作

    前言：

    整合之前，我们要明白aop是什么，为什么要用aop，aop能帮我们做什么。

    答：AOP是面向切面编程（Aspect-Oriented Programming）的简称，它是一种编程思想，旨在在面向对象编程（OOP）的基础上进行功能模块的解耦和隔离。在传统的业务处理代码中，通常需要进行事务处理、日志记录等操作，这些操作会分散到各个方法中，增加了开发和维护的难度。AOP通过预编译方式和运行期动态代理实现，在不修改源代码的情况下，将分散在各个方法中的重复代码提取出来，然后在程序编译或运行时，再将这些提取出来的代码应用到需要执行的地方。

    因此，AOP能够帮我们做以下事情：

    1. 降低业务逻辑的耦合性，提高程序的可重用型和开发效率。
    2. 对业务逻辑的各个部分进行隔离，便于模块化管理。
    3. 提取公共功能，减少重复代码，提高代码的可维护性和可读性。
    4. 提供一种新的编程视角和工具，使开发人员可以专注于业务逻辑的实现，而不用过多关注其他功能的实现。

    AOP能够提高开发效率和代码质量，降低维护成本。

    =========================================================================

    一、AOP介绍

    1、名词介绍

    （1）切面（Aspect）：切入点和通知的集合
    （2）连接点（Joinpoint）：目标对象中可以被增强的所有方法
    （3）通知（Advice）：增强的代码（逻辑），分为前置，后置，最终，异常，环绕
    （4）切入点（Pointcut）：目标对象中经过匹配最终增强的方法
    （5）引入（Introduction）：动态的为某个类增加和减少方法
    （6）目标对象（Target Object）：被代理的对象
    （7）AOP代理对象（AOP Proxy）：AOP框架创建的代理对象，用于实现切面，调用方法
    （8）织入（Weaving）：将通知应用到切入点的过程

    2、注解介绍

    （1）@EnableAspectJautoProxy 用于springboot启动类，代表开启注解aop功能支持
                    proxyTargetClass 是否强制使用CGlib的动态代理，默认false
                    exposeProxy 是否通过aop框架暴露该代理对象，aopContext能够访问
    （2）@Aspect 用于标注切面类
    （3）@Pointcut 用于标识切入点
                    value 切入点表达式
    （4） @Before 前置通知
    （5）@AfterReturning 后置通知
    （6）@AfterThrowing 异常通知
    （7）@After 最终通知
    （8）@Around 环绕通知，环绕通知代表了一个完整的流程，因此环绕通知和上面的四个通知任选其一使用

    3、切入点表达式

    （1）execution - 根据表达式匹配，使用最多

            execution([修饰符] 返回类型 [包名.类名].方法名(参数列表) [异常])

            支持的通配符有 *：匹配所有。..：匹配多级包或者多个参数。+表示类以及子类

    （2）within - 匹配方法所在的包或者类

    （3）this - 用于向通知方法中传入代理对象的引用

    （4）target - 用于向通知方法中传入目标对象的引用

    （5）args - 用于向通知方法中传入参数，并且匹配参数个数

    （6）@args - 和args都是匹配参数，但是@args要求传入切入点的参数必须标注指定注解，且不能是SOURCE源码注解，比如Lombok的

    （7）@within - 匹配加了某个注解的类中的所有方法

    （8）@target - 与@within类似，但是要求标注到类上的注解，必须为RUNTIME的

    （9）@annotation - 匹配加了某个注解的方法

    （10）bean 通过spring容器中的beName匹配

            可以使用通配符*来标识以什么开头，以什么结尾

    二、整合AOP实现，实现日志操作

    1、引入依赖

    2. <dependency>
    3.     <groupId>org.springframework.bootgroupId>
    4.     <artifactId>spring-boot-starter-aopartifactId>
    5. dependency>
    6. <dependency>
    7.     <groupId>com.alibabagroupId>
    8.     <artifactId>fastjsonartifactId>
    9.     <version>2.0.32version>
    10. dependency>

    2、类

    1. package com.mgx.demo.common.enums;
    2.  
    3. import lombok.AllArgsConstructor;
    4. import lombok.Getter;
    5.  
    6.  
    7. /**
    8.  * @author mgx
    9.  */
    10. @AllArgsConstructor
    11. @Getter
    12. public enum CharacterEnum {
    13.  
    14.     /**
    15.      * 特殊字符
    16.      */
    17.  
    18.     //空白
    19.     BLANK("")
    20.     //空格
    21.     , SPACE(" ")
    22.     //换行
    23.     , NEWLINE("\n")
    24.     //enter换行
    25.     , ENTER("\r")
    26.     //左斜杠
    27.     , SLASH("/")
    28.     //双左斜杠
    29.     , DOUBLE_SLASH("//")
    30.     //反斜杠
    31.     , BACKSLASH("\\")
    32.     //单引号
    33.     , QUOTES("'")
    34.     //双引号
    35.     , DOUBLE_QUOTES("\"")
    36.     //撇号
    37.     , APOSTROPHE("`")
    38.     //艾特符
    39.     , AT("@")
    40.     //井号
    41.     , HASHTAG("#")
    42.     //dollar符
    43.     , DOLLAR("$")
    44.     //百分号
    45.     , PERCENT("%")
    46.     //异或运算符 数字相同返回0，否则为1
    47.     , XOR("^")
    48.     //and符
    49.     , AND("&")
    50.     //星号
    51.     , ASTERISK("*")
    52.     //等于号
    53.     , EQUAL("=")
    54.     //下划线
    55.     , UNDERSCORE("_")
    56.     //点
    57.     , DOT(".")
    58.     //句号
    59.     , C_DOT("。")
    60.     //逗号
    61.     , COMMA(",")
    62.     //中文逗号
    63.     , C_COMMA("，")
    64.     //管道符
    65.     , PIPE("|")
    66.     //双管道符
    67.     , DOUBLE_PIPE("||")
    68.     //问号
    69.     , Q_MARK("?")
    70.     //叹号
    71.     , E_MARK("!")
    72.     //加号
    73.     , PLUS("+")
    74.     //连字号、短横杠、减号
    75.     , HYPHEN("-")
    76.     //小于符
    77.     , LT("<")
    78.     //大于符
    79.     , GT(">")
    80.     //冒号
    81.     , COLON(":")
    82.     //分号
    83.     , SEMICOLON(";")
    84.     //中文分号
    85.     , C_SEMICOLON("；")
    86.     //左圆括号 round
    87.     , L_R_BRACKETS("(")
    88.     //右圆括号
    89.     , R_R_BRACKETS(")")
    90.     //左右圆括号
    91.     , R_BRACKETS("()")
    92.     //左方括号 square
    93.     , L_S_BRACKETS("[")
    94.     //右方括号
    95.     , R_S_BRACKETS("]")
    96.     //左右方括号
    97.     , S_BRACKETS("[]")
    98.     //左大括号 curly
    99.     , L_C_BRACKETS("{")
    100.     //右大括号
    101.     , R_C_BRACKETS("{")
    102.     //左右大括号
    103.     , C_BRACKETS("{}")
    104.     ;
    105.  
    106.     private final String character;
    107.  
    108.     public String value() {
    109.         return character;
    110.     }
    111.  
    112. }
    1. package com.mgx.demo.utils;
    2.  
    3. import com.alibaba.fastjson.JSON;
    4. import com.mgx.demo.common.enums.CharacterEnum;
    5. import lombok.extern.slf4j.Slf4j;
    6. import org.springframework.web.context.request.RequestAttributes;
    7. import org.springframework.web.context.request.RequestContextHolder;
    8. import org.springframework.web.context.request.ServletRequestAttributes;
    9.  
    10. import javax.servlet.http.HttpServletRequest;
    11. import java.util.Arrays;
    12. import java.util.Objects;
    13.  
    14. /**
    15.  * @author mgx
    16.  */
    17. @Slf4j
    18. public class LogUtil {
    19.  
    20.     /**
    21.      * 接口请求日志
    22.      *
    23.      * @param param 接口获取参数
    24.      */
    25.     public static void param(Object... param) {
    26.         RequestAttributes ra = RequestContextHolder.getRequestAttributes();
    27.         ServletRequestAttributes sra = (ServletRequestAttributes) ra;
    28.         if (Objects.nonNull(sra)) {
    29.             HttpServletRequest request = sra.getRequest();
    30.             String url = request.getRequestURL().toString();
    31.             log.info("===============++++请求++++================\n地址：{}\n参数：{}", url, Objects.isNull(param) ? CharacterEnum.BLANK.value() : Arrays.toString(param));
    32.         }
    33.     }
    34.  
    35.     /**
    36.      * 接口请求日志
    37.      *
    38.      * @param param 封装后的参数，若数据结构较复杂，请考虑json转化string耗时及性能
    39.      */
    40.     public static void paramObject(Object param) {
    41.         RequestAttributes ra = RequestContextHolder.getRequestAttributes();
    42.         ServletRequestAttributes sra = (ServletRequestAttributes) ra;
    43.         if (Objects.nonNull(sra)) {
    44.             HttpServletRequest request = sra.getRequest();
    45.             String url = request.getRequestURL().toString();
    46.             log.info("===============++++请求++++================\n地址：{}\n参数：{}", url, Objects.isNull(param) ? CharacterEnum.BLANK.value() : JSON.toJSONString(param));
    47.         }
    48.     }
    49.  
    50.     public static void logRequest(HttpServletRequest request) {
    51.         log.info("===============++++请求++++================\n地址：{}\n方法：{}\nIP：{}", request.getRequestURL().toString(), request.getMethod(), request.getRemoteAddr());
    52.     }
    53.  
    54. }
    1. package com.mgx.demo.config.aop;
    2.  
    3. import com.alibaba.fastjson.JSON;
    4.  
    5. import com.mgx.demo.annotation.LogRequestParam;
    6. import com.mgx.demo.utils.LogUtil;
    7. import org.aspectj.lang.JoinPoint;
    8. import org.aspectj.lang.annotation.AfterReturning;
    9. import org.aspectj.lang.annotation.Aspect;
    10. import org.aspectj.lang.annotation.Before;
    11. import org.aspectj.lang.annotation.Pointcut;
    12. import org.slf4j.Logger;
    13. import org.slf4j.LoggerFactory;
    14. import org.springframework.stereotype.Component;
    15.  
    16. /**
    17.  *  自动打印日志
    18.  */
    19. @Aspect
    20. @Component
    21. public class WebLogAspect {
    22.     private static final Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
    23.  
    24.     @Pointcut("execution(public * com.mgx.demo.controller.*.*(..))")
    25.     public void webLog() {}
    26.  
    27.     @AfterReturning(returning = "ret", pointcut = "webLog()")
    28.     public void doAfterReturning(Object ret) {
    29.         // 处理完请求，返回内容
    30.         logger.info("RESPONSE : {}", JSON.toJSONString(ret));
    31.     }
    32.  
    33.     @Before("@annotation(logRequestParam) || @within(logRequestParam)")
    34.     public void doRequestParamLog(JoinPoint joinPoint, LogRequestParam logRequestParam) {
    35.         // 获取方法参数
    36.         Object[] args = joinPoint.getArgs();
    37.         if (args != null) {
    38.             if (args.length == 1) {
    39.                 LogUtil.paramObject(args[0]);
    40.             } else {
    41.                 LogUtil.param(args);
    42.             }
    43.         }
    44.     }
    45.  
    46. }
    1. package com.mgx.demo.annotation;
    2.  
    3. import java.lang.annotation.ElementType;
    4. import java.lang.annotation.Retention;
    5. import java.lang.annotation.RetentionPolicy;
    6. import java.lang.annotation.Target;
    7.  
    8. /**
    9.  * @author mgx
    10.  */
    11. @Target({ElementType.TYPE, ElementType.METHOD})
    12. @Retention(RetentionPolicy.RUNTIME)
    13. public @interface LogRequestParam {
    14. }
    1. "1.0" encoding="UTF-8"?>
    2. <configuration>
    3.  
    4.     <springProperty scope="context" name="logPath" source="project.log.config" defaultValue="${user.home}/springboot-mgx/logs"/>
    5.     <property name="LOG_HOME" value="${logPath}"/>
    6.  
    7.     
    8.     
    9.     <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    10.         <encoder>
    11.             
    12.             <pattern>%date{yyyy-MM-dd HH:mm:ss} %highlight(%-5level) (%file:%line\)- %m%npattern>
    13.             
    14.             <charset>UTF-8charset>
    15.         encoder>
    16.     appender>
    17.  
    18.     
    19.     
    20.     
    21.     <appender name="ALL" class="ch.qos.logback.core.rolling.RollingFileAppender">
    22.         <File>${LOG_HOME}/sys.logFile>
    23.         
    24.         
    25.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    26.             
    27.             
    28.             <fileNamePattern>${LOG_HOME}/%d{yyyy-MM/dd/HH}/sys.%i.logfileNamePattern>
    29.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    30.                 
    31.                 <maxFileSize>30MBmaxFileSize>
    32.             timeBasedFileNamingAndTriggeringPolicy>
    33.         rollingPolicy>
    34.         <encoder>
    35.             
    36.             <pattern>%d %p (%file:%line\)- %m%npattern>
    37.             
    38.             <charset>UTF-8charset> 
    39.         encoder>
    40.     appender>
    41.  
    42.     
    43.     <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
    44.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
    45.             <level>ERRORlevel>
    46.             <onMatch>ACCEPTonMatch>
    47.             <onMismatch>DENYonMismatch>
    48.         filter>
    49.         <file>${LOG_HOME}/sys.error.logfile>
    50.         <append>trueappend>
    51.         <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
    52.             <fileNamePattern>${LOG_HOME}/%d{yyyy-MM/dd/HH}/sys.error.%i.logfileNamePattern>
    53.             <maxFileSize>30MBmaxFileSize>
    54.         rollingPolicy>
    55.         <encoder>
    56.             <Pattern>%d %p (%file:%line\)- %m%nPattern>
    57.             <charset>UTF-8charset>
    58.         encoder>
    59.     appender>
    60.  
    61.     <contextListener class="ch.qos.logback.classic.jul.LevelChangePropagator">
    62.         <resetJUL>trueresetJUL>
    63.     contextListener>
    64.  
    65.     
    66.     <root level="info">
    67.         <appender-ref ref="CONSOLE"/>
    68.         <appender-ref ref="ALL"/>
    69.         <appender-ref ref="ERROR"/>
    70.     root>
    71.  
    72.     
    73.     
    74.     
    75.     <logger name="com.mgx.demo.controller" level="DEBUG"/>
    76.     <logger name="com.mgx.demo.mapper" level="DEBUG"/>
    77.     <logger name="springfox" level="ERROR"/>
    78.  
    79. configuration>

    application

     需要打印日志的地方，在类上加上自定义注解

    3、测试

  • 相关阅读:
    VBA技术资料MF54：VBA_EXCEL实时获取鼠标位置
    有效备考浙大MEM的五个好习惯建议
    [蓝桥杯复盘] 第 3 场双周赛20231111
    QSlider 类使用教程
    Pytorch（GPU）环境安装
    【Qt】字体更大的富文本
    sylar服务器框架分析——日志系统
    Linux下安装配置各种软件和服务
    Bio-Helix丨Bio-Helix艾美捷100bp DNA ladder说明书
    关于 Redis 的这些知识 你知道哪些
  • 原文地址：https://blog.csdn.net/qq_42405688/article/details/132970648