AOP 提供了一种面向切面操作的扩展机制,通常这些操作是与业务无关的,在实际应用中,可以实现:日志处理、事务控制、参数校验和自定义注解等功能。
一、日志处理
在调试程序时,如果需要在执行方法前打印方法参数,或者在执行方法后打印方法返回结果,可以使用切面来实现。
@Slf4j
@Aspect
@Component
public class LoggerAspect {
@Around("execution(* cn.codeartist.spring.aop.sample.*.*(..))")
public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
// 方法执行前日志
log.info("Method args: {}", joinPoint.getArgs());
Object proceed = joinPoint.proceed();
// 方法执行后日志
log.info("Method result: {}", proceed);
return proceed;
}
}
二、事务控制
Spring 提供的声明式事务也是基于 AOP 来实现的,在需要添加事务的方法上面使用 @Transactional 注解。
@Service
public class DemoService {
@Transactional(rollbackFor = Exception.class)
public void insertBatch() {
// 带事务控制的业务操作
}
}
三、参数校验
如果需要在方法执行前对方法参数进行校验时,可以使用前置通知来获取切入点方法的参数,然后进行校验。
@Slf4j
@Aspect
@Component
public class ValidatorAspect {
@Before("execution(* cn.codeartist.spring.aop.sample.*.*(..))")
public void doBefore(JoinPoint joinPoint) {
// 方法执行前校验参数
Object[] args = joinPoint.getArgs();
}
}
四、自定义注解
因为 AOP 可以拦截到切入点方法,Spring 也支持通过注解的方式来定义切点表达式,所以可以通过 AOP 来实现自定义注解的功能。
例如,自定义一个注解来实现声明式缓存,把方法的返回值进行缓存。
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Cacheable {
/**
* 缓的Key
*/
String key();
/**
* 缓存过期时间
*/
long timeout() default 0L;
/**
* 缓存过期时间单位(默认:毫秒)
*/
TimeUnit timeUnit() default TimeUnit.MILLISECONDS;
}
然后定义一个切片来实现常规的缓存操作,先读缓存,缓存不存在时执行方法,然后把方法的返回结果进行缓存。
@Aspect
@Component
public class AnnotationAspect {
@Around("@annotation(cacheable)")
public Object doAround(ProceedingJoinPoint joinPoint, Cacheable cacheable) throws Throwable {
// 自定义缓存逻辑
return joinPoint.proceed();
}
}
五、若依操作日志处理
代码目录,代码存放在ruoyi-framework模块下面,具体目录如下
package com.ruoyi.framework.aspectj;
1、如下图代码,日志拦截过程分为处理请求前执行、处理完请求后执行、拦截异常操作,其中正常处理和异常处理都会调用handleLog的方法插入操作日志。
其中正常处理,参数送入jsonResult,响应结果参数
异常处理,参数送入e。记录异常日志
/**
* 处理请求前执行
*/
@Before(value = "@annotation(controllerLog)")
public void boBefore(JoinPoint joinPoint, Log controllerLog)
{
TIME_THREADLOCAL.set(System.currentTimeMillis());
}
/**
* 处理完请求后执行
*
* @param joinPoint 切点
*/
@AfterReturning(pointcut = "@annotation(controllerLog)", returning = "jsonResult")
public void doAfterReturning(JoinPoint joinPoint, Log controllerLog, Object jsonResult)
{
handleLog(joinPoint, controllerLog, null, jsonResult);
}
/**
* 拦截异常操作
*
* @param joinPoint 切点
* @param e 异常
*/
@AfterThrowing(value = "@annotation(controllerLog)", throwing = "e")
public void doAfterThrowing(JoinPoint joinPoint, Log controllerLog, Exception e)
{
handleLog(joinPoint, controllerLog, e, null);
}
如下是操作日志插入代码
protected void handleLog(final JoinPoint joinPoint, Log controllerLog, final Exception e, Object jsonResult)
{
try
{
// 获取当前的用户
LoginUser loginUser = SecurityUtils.getLoginUser();
// *========数据库日志=========*//
SysOperLog operLog = new SysOperLog();
operLog.setStatus(BusinessStatus.SUCCESS.ordinal());
// 请求的地址
String ip = IpUtils.getIpAddr();
operLog.setOperIp(ip);
operLog.setOperUrl(StringUtils.substring(ServletUtils.getRequest().getRequestURI(), 0, 255));
if (loginUser != null)
{
operLog.setOperName(loginUser.getUsername());
}
if (e != null)
{
operLog.setStatus(BusinessStatus.FAIL.ordinal());
operLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000));
}
// 设置方法名称
String className = joinPoint.getTarget().getClass().getName();
String methodName = joinPoint.getSignature().getName();
operLog.setMethod(className + "." + methodName + "()");
// 设置请求方式
operLog.setRequestMethod(ServletUtils.getRequest().getMethod());
// 处理设置注解上的参数
getControllerMethodDescription(joinPoint, controllerLog, operLog, jsonResult);
// 设置消耗时间
operLog.setCostTime(System.currentTimeMillis() - TIME_THREADLOCAL.get());
// 保存数据库
AsyncManager.me().execute(AsyncFactory.recordOper(operLog));
}
catch (Exception exp)
{
// 记录本地异常日志
log.error("异常信息:{}", exp.getMessage());
exp.printStackTrace();
}
finally
{
TIME_THREADLOCAL.remove();
}
}
业务逻辑:
1、获取登录用户信息。
2、创建SysOperLog实列对像,初始化对象值。
3、记录ip地址(IpUtils.getIpAddr())、设置状态是成功还是失败、设置消耗时间。
4、通过异步插入数据库AsyncManager.me().execute(AsyncFactory.recordOper(operLog));
5、异步插入可以减少接口响应时间。
六、未来计划
1、ruoyi非分离版本拆解
2、ruoyi-vue-pro:讲解工作流
3、ruoyi-vue-pro:支付模块,电商模块
4、基于ruoyi-vue-pro项目开发
5、JEECG低代码开发平台
请关注我,本星球会持续推出更多的开源项目代码解析,如有更好的意见请留言回复或者私信。