#7注解+切面AOP+枚举类记录日志

 

目录

1、分析

2、示例（可直接复制修改使用）

2.1、注解UserLog

2.2、被记录方法：

2.3、枚举类：

2.4、UserLogUtil:

2.5、切面

2.6、UserLogEvaluationContext

---

 

---

 

1、分析

通过枚举类将每个方法需要记录的日志内容单独存储，降低了耦合度，增加了可扩展性。

通过注解的方式切入具体的方法，在返回成功后再进行日志记录。

将参数注入到StandardEvaluationContext上下文中，通过#name的方式来获取参数，进行必要参数的日志记录。

将自定义的增强方法注册到Spel上下文中，可以在Spel表达式中进行调用。

2、示例（可直接复制修改使用）

2.1、注解UserLog

@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Target(ElementType.METHOD)
public @interface UserLog {
    UserLogEnum value();
}

2.2、被记录方法：

@UserLog(UserLogEnum.NEW_ADJUST_TRADE_AUDIT)
public int insertAdjustTradeRequest(AdjustTradeRequest adjustTradeRequest, String methodName, String modelName) 

2.3、枚举类：

NEW_ADJUST_TRADE_AUDIT(
	 "''",
        "#modelName",
        "(#aspectMethodName=='insertAdjustTradeRequest'?'新增':'修改')+'交易调整请求信息'+#convertDescription('，id： ',#adjustTradeRequest.getId())” )

private final String methodParams;
private final String modelName;
private final String description;

UserLogEnum(String methodParams, String modelName, String description) {
    this.methodParams = methodParams;
    this.modelName = modelName;
    this.description = description;
}

#是Spel表达式中获取方法参数的意思，对于实体直接使用.即可获得其属性,

在Spel表达式中字符串要以’’单引号做为开始和结束，

编译器中换行的+号不包裹在枚举类属性的“”双引号中（此处因为使用了String做为其属性所以使用双引号

Spel中的表达式连接直接使用+

convertDescription是注册到Spel上下文中的方法

aspectMethodName 是通过上下文中的setVariables方法来注册的。

 

2.4、UserLogUtil:

public class UserLogUtil {
	
	private static UserLogEvaluationContext userLogEvaluationContext;

    /**
     * 获取单例的上下文
     */
    public UserLogEvaluationContext getUserLogEvaluationContext() {
        if (userLogEvaluationContext == null){
            userLogEvaluationContext = new UserLogEvaluationContext();
        }
        return userLogEvaluationContext;
    }

    public UserLogUtil() throws NoSuchMethodException {
        this.getUserLogEvaluationContext();
      
        userLogEvaluationContext.registerFunction("convertDescription", this.getClass().getDeclaredMethod("convertDescription",String.class,Object.class));
    }
	public static  String convertDescription(String description,T fieldValue) throws ParseException {
      if (ObjectUtils.isEmpty(fieldValue)) {
          return "";
      }
      if(fieldValue instanceof Date) {
          return description + formatDate(fieldValue.toString());
      }
      return description  + fieldValue ;
    }
}

2.5、切面

@AfterReturning(value = "@annotation(userLog)",returning = "res")
public void doUserLog(JoinPoint joinPoint, UserLog userLog,Object res){
    modelName=null;
    methodParams = null;
    description = null;
    Method method ;
    Object[] args ;
    try{
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature)signature;
        Method targetMethod = methodSignature.getMethod();
        method = joinPoint.getTarget().getClass().getDeclaredMethod(signature.getName(), targetMethod.getParameterTypes());
        args = joinPoint.getArgs();
    } catch (Exception e){
        return;
    }

    String userName = SecurityContextHolder.getContext().getAuthentication().getName();
    try {
        parseExpression(method, args, userLog);
    } catch (Exception e) {   
  return;
    }
//记录日志
}
private void parseExpression(Method method, Object[] args, UserLog userLog) throws NoSuchFieldException, IllegalAccessException {
    // 获取被拦截方法参数名列表
    ParameterNameDiscoverer discoverer = new LocalVariableTableParameterNameDiscoverer();
    String[] parametersOfMethod = discoverer.getParameterNames(method);
List parametersList = new ArrayList<>(Arrays.asList(parametersOfMethod));
    List