JAVA自定义注解和AOP配合使用

  // 对数据源进行管理
<tx:advice id="txAdvice" transaction-manager="transactionManager">
    <tx:attributes>
        <tx:method name="add*"     propagation="REQUIRED"  rollback-for="Exception" />
        <tx:method name="save*"    propagation="REQUIRED"  rollback-for="Exception" />
        <tx:method name="insert*"  propagation="REQUIRED"  rollback-for="Exception" />
        <tx:method name="update*"  propagation="REQUIRED"  rollback-for="Exception" />
        <tx:method name="modify*"  propagation="REQUIRED"  rollback-for="Exception" />
        <tx:method name="delete*"  propagation="REQUIRED"  rollback-for="Exception" />
        <tx:method name="remove*"  propagation="REQUIRED"  rollback-for="Exception" />
    </tx:attributes>
</tx:advice>

    <aop:config proxy-target-class="true">
        <aop:advisor pointcut="execution(* com.etc..service.impl.*ServiceImpl.*(..))" advice-ref="txAdvice" />
    </aop:config>

  通过上面的配置，可以实现事务的处理，但是这个配置却非常不灵活，他限制了类必须在service层，其次，方法名必须以add、save、insert等开头，才能被切面管理到，如果不符合这些规则改怎么办呢？
新的需求：
在曾经的开发中遇到这样一个需求，系统中的部分业务方法在被调用到时，需要向log表插入日志，业务方法名没有规律，你不可能把所有的业务方法名都配置到上面，那么问题就来了，是否有一种语法可以在每个需要记录日志的方法中进行标识，让Spring AOP感知到，这就是下面要讲解的–自定义注解。

以下是具体具体实现

注解代码

package com.esurer.common.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
 * 系统日志注解
 * ClassName SysLog
 * @Function TODO
 * @date 2017年12月1日
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SysLog {

    String value() default "";
}

切面代码：

package com.esurer.common.aspect;

import com.google.gson.Gson;
import com.esurer.common.annotation.SysLog;
import com.esurer.common.utils.HttpContextUtils;
import com.esurer.common.utils.IPUtils;
import com.esurer.modules.sys.entity.SysLogEntity;
import com.esurer.modules.sys.entity.SysUserEntity;
import com.esurer.modules.sys.service.SysLogService;
import org.apache.shiro.SecurityUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
import java.util.Date;
/**
 * 系统日志，切面处理类
 * ClassName SysLogAspect
 * @Function TODO
 * @date 2017年12月1日
 */
@Aspect
@Component
public class SysLogAspect {
    @Autowired
    private SysLogService sysLogService;
    
    @Pointcut("@annotation(com.esurer.common.annotation.SysLog)")
    public void logPointCut() { 
        
    }

    @Around("logPointCut()")
    public Object around(ProceedingJoinPoint point) throws Throwable {
        long beginTime = System.currentTimeMillis();
        //执行方法
        Object result = point.proceed();
        //执行时长(毫秒)
        long time = System.currentTimeMillis() - beginTime;

        //保存日志
        saveSysLog(point, time);

        return result;
    }

    private void saveSysLog(ProceedingJoinPoint joinPoint, long time) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();

        SysLogEntity sysLog = new SysLogEntity();
        SysLog syslog = method.getAnnotation(SysLog.class);
        if(syslog != null){
            //注解上的描述
            sysLog.setOperation(syslog.value());
        }

        //请求的方法名
        String className = joinPoint.getTarget().getClass().getName();
        String methodName = signature.getName();
        sysLog.setMethod(className + "." + methodName + "()");

        //请求的参数
        Object[] args = joinPoint.getArgs();
        try{
            String params = new Gson().toJson(args[0]);
            sysLog.setParams(params);
        }catch (Exception e){

        }

        //获取request
        HttpServletRequest request = HttpContextUtils.getHttpServletRequest();
        //设置IP地址
        sysLog.setIp(IPUtils.getIpAddr(request));

        //用户名
        String username = ((SysUserEntity) SecurityUtils.getSubject().getPrincipal()).getUsername();
        sysLog.setUsername(username);

        sysLog.setTime(time);
        sysLog.setCreateDate(new Date());
        //保存系统日志
        sysLogService.save(sysLog);
    }
}

使用切面的代码：

/**
     * 修改登录用户密码
     */
    @SysLog("修改密码")
    @RequestMapping("/password")
    public R password(String password, String newPassword){
        Assert.isBlank(newPassword, "新密码不为能空");
        
        //sha256加密
        password = new Sha256Hash(password, getUser().getSalt()).toHex();
        //sha256加密
        newPassword = new Sha256Hash(newPassword, getUser().getSalt()).toHex();
                
        //更新密码
        int count = sysUserService.updatePassword(getUserId(), password, newPassword);
        if(count == 0){
            return R.error("原密码不正确");
        }
        
        return R.ok();
    }

数据库日志记录

总结

通过上面代码，我们可以看到，只要我们在期望记录日志的方法上增加@LogOperation注解，该方法的动作就会被记录进日志表，不管方法叫什么名字，类在什么位置，都可以轻松的解决，而且没有代码入侵，期望本篇博客对大家有所帮助。