Spring使用AOP记录日志（javaconfig配置）

需求：使用spring AOP来记录返回数据日志及异常情况的返回

引入jar

本实例基于spring + maven项目,具体spring maven项目配置就不赘述了,网上有好多资料可供参考,需引入的相关jar如下：

<!-- spring AOP -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-aop</artifactId>
    <version>4.3.10.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjrt</artifactId>
    <version>1.8.10</version>
</dependency>
<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.8.10</version>
    <scope>runtime</scope>
</dependency>

配置自定义注解

新建自定义注解类

@Documented
@Inherited
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {

}

在Controller使用注解

/**
 * 查询用户列表
 */
@Log // 注解使用
@RequestMapping({"/", "/api/user/list"})
@ResponseBody
public Map<String, Object> list() {
    Map<String, Object> json = new HashMap<>(16);
    List<User> userList = userService.listUser();
    json.put("list", userList);
    return json;
}

添加Aspect类

新建LogAspect文件

@Configuration
@EnableAspectJAutoProxy // 开启aop 相当于 <aop:aspectj-autoproxy proxy-target-class="true"/>
@Aspect // 切面
@Component // 把普通pojo实例化到spring容器中，相当于配置文件中的<bean id="" class=""/>
public class LogAspect {
    /**
     * 日志输出
     */
    private static final Logger logger = LoggerFactory.getLogger(LoggerFilter.class);

    /**
     * 日志记录AOP
     * 使用 @Around环绕通知，切点使用@annotation（xxxxx）进行定义
     * 即 使用@Log自定义注解的方法进入此方法
     */
    @Around("@annotation(com.os.common.aspect.Log)")
    public Object aroundCacheAble(ProceedingJoinPoint joinPoint) throws Throwable {
        try {
            // 环绕通知=前置+目标方法执行+后置通知，proceed方法就是用于启动目标方法执行的
            Object result = joinPoint.proceed();
            logger.info("返回数据" + FastJsonUtils.toJSONString(result));
            return result;
        } catch (Exception e) {
            // 异常捕获
            // 获取类型、方法名
            String className = joinPoint.getTarget().getClass().getSimpleName();
            String methodName = joinPoint.getSignature().getName();
            String errInfo = className + "." + methodName + "--error";
            // 异常日志输出
            LoggerFactory.getLogger(joinPoint.getTarget().getClass()).error(errInfo, e);
            if (isJson(joinPoint)) {
                // 返回错误json
                Map<String, Object> json = new HashMap<>(4);
                json.put("message", "这是json错误页");
                return json;
            } else {
                // 返回错误页面
                return "pages/error";
            }

        }
    }

    /**
     * 判断是否是ajax返回
     *
     * @param joinPoint 连接点
     * @return true ajax请求 false 页面请求
     */
    private Boolean isJson(ProceedingJoinPoint joinPoint) {
        Class<?> classTarget = joinPoint.getTarget().getClass();
        Class<?>[] par = ((MethodSignature) joinPoint.getSignature()).getParameterTypes();
        try {
            // 带@ResponseBody注册的方法为ajax方法，所以判断是否带@ResponseBody即可
            Method objMethod = classTarget.getMethod(joinPoint.getSignature().getName(), par);
            ResponseBody annotation = objMethod.getAnnotation(ResponseBody.class);
            if (annotation != null) {
                return true;
            }
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        }
        return false;
    }
}

以上代码注释已经很详细了，就不一一解释了，至此AOP日志完成，启动项目就可以看到输出日志了