springboot服务使用aspect切面实现方法日志打印

2020-11-30 10:05:35 阅读：244 来源： 互联网

标签：springboot xxx xx logManage 切面 aspect LogMessage 注解方法

项目每次写controller方法，都要在开始和结束打印一行日志表示方法开始和结束，每个方法都要写，太过于麻烦和重复，想到了spring的aop切面，所以使用@Aspect切面和自定义log注解实现了下切面日志打印.

AOP

AOP （Aspect Orient Programming）,直译过来就是面向切面编程。AOP 是一种编程思想，是面向对象编程（OOP）的一种补充,在程序开发中主要用来解决一些系统层面上的问题，比如日志，事务，权限等等，这里主要是做一下方法的日志打印。

aop相关注解：

@Aspect:作用是把当前类标识为一个切面供容器读取

@Pointcut：Pointcut是植入Advice的触发条件。每个Pointcut的定义包括2部分，一是表达式，二是方法签名。方法签名必须是 public及void型。可以将Pointcut中的方法看作是一个被Advice引用的助记符，因为表达式不直观，因此我们可以通过方法签名的方式为此表达式命名。因此Pointcut中的方法只需要方法签名，而不需要在方法体内编写实际代码。
@Around：环绕增强，相当于MethodInterceptor
@AfterReturning：后置增强，相当于AfterReturningAdvice，方法正常退出时执行
@Before：标识一个前置增强方法，相当于BeforeAdvice的功能，相似功能的还有
@AfterThrowing：异常抛出增强，相当于ThrowsAdvice
@After: final增强，不管是抛出异常或者正常退出都会执行

自定义注解

声明一个注解要用到的东西

修饰符：访问修饰符必须为public,不写默认为pubic；
关键字：关键字为@interface；
注解名称：注解名称为自定义注解的名称，使用时还会用到；
注解类型元素：注解类型元素是注解中内容，可以理解成自定义接口的实现部分；

代码：

自定义log注解代码

/**
 * 日志注解
 *
 * Target：用于明确注解用于目标类的哪个位置
 * Retention：用于标识自定义注解的生命周期
 *            RUNTIME:生命周期持续到运行时，能够通过反射获取到
 * Documented：用于标识自定义注解能够使用javadoc命令生成关于注解的文档
 *
 * @author xxx
 * @date 2020/xx/xx
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogMessage {

    /**
     * 使用value值，在使用注解的时候，不需要写@LogMessage(value=xxx）,直接写@LogMessage(xxx）即可
     */
    String value() default "";

    /**
     * 别名使用value，所以在使用注解时，既可以写@LogMessage(xxx），也可以写@LogMessage(description=xxx）
     */
    @AliasFor("value")
    String description() default "";
}

apsect切面类注解

/**
 * 日志切面类
 * Aspect ：作用是把当前类标识为一个切面供容器读取
 *
 * @author xxx
 * @date 2020/xx/xx
 */
@Slf4j
@Aspect
@Component
public class LogAspect {

    /**
     * 前置增强，目标方法执行之前执行
     * within:用于匹配所以持有指定注解类型内的方法
     * annotation:用于匹配当前执行方法持有指定注解的方法
     * within(com.xxx.xxx..*) com.xxx.xxx包及子包下的任何方法执行
     *
     * @param joinPoint
     * @param logManage
     * @return void
     * @author xxx
     * @date 2020/xx/xx
     */
    @Before("within(com.xxx.xxx..*) && @annotation(logManage)")
    public void addBeforeLogger(JoinPoint joinPoint, LogMessage logManage) {
        // 处理参数
        Object[] args = joinPoint.getArgs(); // 参数值
        String[] argNames = ((MethodSignature) joinPoint.getSignature()).getParameterNames();
        Map<String, Object> paramsMap = new HashMap<>();
        StringBuilder sb = new StringBuilder();
        if (args != null && args.length > 0) {
            for (int i = 0; i < args.length; i++) {
                paramsMap.put(argNames[i], args[i].toString());
            }
            for (Map.Entry<String, Object> entry : paramsMap.entrySet()) {
                sb.append(entry.getKey()).append(":").append(entry.getValue()).append(";");
            }
        }

        log.info("[{}] Start", logManage.value());
        log.info("[方法名称：{}，方法参数：{}", ((MethodSignature) joinPoint.getSignature()).getMethod().getName(), sb.toString());
    }

    /**
     * 返回增强，目标方法正常执行完毕时执行
     *
     * within:用于匹配所以持有指定注解类型内的方法
     * annotation:于匹配当前执行方法持有指定注解的方法
     * within(com.xxx.xxx..*) com.xxx.xxx 包及子包下的任何方法执行
     *
     * @param joinPoint
     * @param logManage
     * @return void
     * @author xxx
     * @date 2020/xx/xx
     */
    @AfterReturning("within(com.xxx.xxx..*) && @annotation(logManage)")
    public void addAfterReturningLogger(JoinPoint joinPoint, LogMessage logManage) {
        log.info("[{}] End", logManage.value());
    }
}

controller中使用

@LogMessage("测试日志打印")
@PutMapping(value = "/test", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
public void xxx() {

	log.info("test");

}

这样在方法执行前和返回后都会打印日志，只需要在想要打印日志的方法上添加@LogMessage("")注解就可以了。

标签：springboot,xxx,xx,logManage,切面,aspect,LogMessage,注解,方法
来源： https://blog.csdn.net/sayoko06/article/details/110368103

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9