Springboot模块系列:切面AOP

1 配置pom.xml

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

2 切面

2.1 AOP

package com.company.web.aop;

import java.util.Arrays;
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.After;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

/**
 * Log record aop. 
 * @author xindaqi 
 * @since 2020-10-23
 */
@Aspect 
@Component
public class ApiCallLog {

    private Logger logger = LoggerFactory.getLogger(ApiCallLog.class);

    /**
     * 1. execution : 表达式主体
     * 2. * :任意类型返回值
     * 3. com.company.web.controller : AOP切片的包名
     * 4. .. :当前包及子包
     * 5. * : 类名,*表示所有类
     * 6. .*(..) : 方法名,*表示任何方法名,..:任何参数类型
     */
    @Pointcut("execution(* com.company.web.controller..*(..)) || execution(* com.company.web.exception..*(..))")
    public void callLog() {}

    @Before("callLog()")
    public void doBefore(JoinPoint joinPoint) {
        logger.info("===Api call aspect do before.===");
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        logger.info("URL: {}", request.getRequestURI().toString());
        logger.info("HTTP METHOD: {}", request.getMethod());
        logger.info("IP: {}", request.getRemoteAddr());
        logger.info("Class METHOD: {}", joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        logger.info("ARGS: {}", Arrays.toString(joinPoint.getArgs()));
        Enumeration<String> enums = request.getParameterNames();
        while(enums.hasMoreElements()) {
            String paramName = (String) enums.nextElement();
            logger.info("Parameter name: {}", request.getParameter(paramName));
        }
    }

    @After("callLog()")
    public void doAfter(JoinPoint joinPoint) {
        logger.info("===Api call aspect do after.===");

    }

    @AfterReturning("callLog()")
    public void doAfterReturing(JoinPoint joinPoint) {
        logger.info("===Api call aspect do afterReturing.===");
    }
    
}

2.2 Controller

package com.company.web.controller;

import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.annotation.Validated;
import org.springframework.validation.BindException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.company.web.dto.*;
import com.company.web.service.*;
import com.company.web.vo.common.*;

import javax.validation.Valid;
import javax.validation.constraints.NotBlank;
import java.util.List;

/**
 * Transactional test.
 * @author xindaqi
 * @since 2020-10-20
 */
@CrossOrigin(origins = "*", maxAge = 3600)
@RestController 
@RequestMapping("/api/function/test")
public class TransactionalTestController {

    static Logger logger = LoggerFactory.getLogger(TransactionalTestController.class);

    @Autowired 
    private IDataSaveService dataSaveService;

    @RequestMapping(value = "/transactional/rollback/raw", method = RequestMethod.POST)
    public ResponseVO saveDataWithRollback(@RequestBody @Valid QuestionAnswerInputDTO params) {
        
            Boolean dataSaveFlag = dataSaveService.saveQuestionAndAnswerWithTransactionRollback(params);
            if(dataSaveFlag) {
                logger.info("成功--保存问题和答案");
                return ResponseVO.ok();
            }else {
                logger.info("失败--保存问题和答案");
                return ResponseVO.fail();
            }

    }
    
}
  • 结果
2020-10-23 17:41:42 [INFO] - ===Api call aspect do before.===
2020-10-23 17:41:42 [INFO] - URL: /api/function/test/transactional/rollback/raw
2020-10-23 17:41:42 [INFO] - HTTP METHOD: POST
2020-10-23 17:41:42 [INFO] - IP: 0:0:0:0:0:0:0:1
2020-10-23 17:41:42 [INFO] - Class METHOD: com.company.web.controller.TransactionalTestController.saveDataWithRollback
2020-10-23 17:41:42 [INFO] - ARGS: [com.company.web.dto.QuestionAnswerInputDTO@3582b3f0]
2020-10-23 17:41:42 [INFO] - {dataSource-3} inited
Creating a new SqlSession
Registering transaction synchronization for SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@166ead49]
JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@4d07abdd] will be managed by Spring
==>  Preparing: insert into questions_repository (questions) values (?) 
==> Parameters: 20201023-4(String)
<==    Updates: 1
Releasing transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@166ead49]
Fetched SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@166ead49] from current transaction
==>  Preparing: insert into answers_repository (answers, questions_fk) values (?, ?) 
==> Parameters: 20201023-4(String), 20201023-4(String)
<==    Updates: 1
Releasing transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@166ead49]
Transaction synchronization committing SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@166ead49]
Transaction synchronization deregistering SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@166ead49]
Transaction synchronization closing SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@166ead49]
2020-10-23 17:41:42 [INFO] - 成功--保存问题和答案
2020-10-23 17:41:42 [INFO] - ===Api call aspect do after.===
2020-10-23 17:41:42 [INFO] - ===Api call aspect do afterReturing.===

3 补充说明

3.1 切面注解

序号注解描述
1Pointcut切面配置,执行指定包下的方法时调用切面方法,可以使用运算符&&,||,!
2Before前置通知,方法执行前调用切面
3After后置通知,方法执行后调用切面
4AfterReturing返回通知,方法执行后返回结果后调用切面
5AfterThrowing异常通知,方法抛出异常后调用切面
5Around环绕通知,围绕方法执行,可统计耗时,日志打印,适用于任何方法拦截,相当于MethodInterceptor,CGLib代理,代理普通类,因此可以使用反射获取类的方法,使用该注解可以拦截任意级别的方法

3.2 Pointcut参数

execution(* com.company.web.controller..*.*(..)) || execution(* com.company.web.exception..*.*(..))
序号参数说明
1execution执行表达式,可使用运算符,&&,||,!
2*任意类型返回值
3com.company.web.controllerAOP切的包
4当前包及子包
5*类名,*表示所有类
6.*(…)方法名,*表示所有方法, …表示所有参数

4 小结

  • AOP应用于:日志打印,入参/出参打印,方法耗时监控,全局异常拦截
  • Spring默认开启aop即EnableAspectJAutoProxy
  • execution使用运算符切多个包,&&,||,!

[参考文献]
[1]https://blog.csdn.net/weixin_42176639/article/details/98587117
[2]https://segmentfault.com/q/1010000015400916
[3]https://blog.csdn.net/cx308679291/article/details/104535576/
[4]https://cloud.tencent.com/developer/article/1436085
[5]https://www.iteye.com/blog/412887952-qq-com-2305333
[6]https://www.cnblogs.com/wm-dv/p/11735828.html

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

天然玩家

坚持才能做到极致

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值