概述

使用spring aop 来实现日志的统一收集功能

详细

使用spring aop 来实现日志的统一收集功能。

spring aop 配置

首先，我们定义2种注解，一种是给service用的，一种是给Controller用的。

给service使用的aop扫描
<aop:aspectj-autoproxy />

<context:annotation-config />

<context:component-scan base-package="com.demodashi">

	<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller" />

</context:component-scan>

<tx:annotation-driven />
给Controller使用的aop扫描
<aop:aspectj-autoproxy />

<aop:aspectj-autoproxy proxy-target-class="true" />

<!-- 扫描web包，应用Spring的注解 -->

<context:component-scan	base-package="com.demodashi">

	<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller" />

	<context:exclude-filter type="annotation" expression="javax.inject.Named" />

	<context:exclude-filter type="annotation" expression="javax.inject.Inject" />

</context:component-scan>

java实现

实现思路，先定义两个注解类，一个给service类用的，一个给从controller类用的，然后使用切面类，对这两个注解进行绑定监控。结果就是，当使用注解绑定某个service类或者controller类的某个方法时，这个切面类就能监控到，并且能获取到这个service方法的相关输入，输出参数等。这样，就能实现了aop日志了。

给controller使用的注解类
package com.demodashi.aop.annotation;

import java.lang.annotation.*;    

/**

 *自定义注解 拦截Controller

 */    

@Target({ElementType.PARAMETER, ElementType.METHOD})

@Retention(RetentionPolicy.RUNTIME)

@Documented

public  @interface ControllerLogAnnotation {

    String description()  default "";

}
给service使用的注解类
package com.demodashi.aop.annotation;

import java.lang.annotation.*;    

/**

 *自定义注解 拦截service

 */    

@Target({ElementType.PARAMETER, ElementType.METHOD})

@Retention(RetentionPolicy.RUNTIME)

@Documented

public  @interface ServiceLogAnnotation {    

    String description()  default "";

}
日志切面类
package com.demodashi.aop;

import java.lang.reflect.Method;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpSession;

import org.aspectj.lang.JoinPoint;

import org.aspectj.lang.annotation.AfterReturning;

import org.aspectj.lang.annotation.AfterThrowing;

import org.aspectj.lang.annotation.Aspect;

import org.aspectj.lang.annotation.Before;

import org.aspectj.lang.annotation.Pointcut;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.stereotype.Component;

import org.springframework.web.context.request.RequestContextHolder;

import org.springframework.web.context.request.ServletRequestAttributes;

import com.alibaba.fastjson.JSONObject;

import com.demodashi.aop.annotation.ControllerLogAnnotation;

import com.demodashi.aop.annotation.ServiceLogAnnotation;

import com.demodashi.base.UserVO;

/**

 * 切点类

 * @author xgchen

 *

 */

@Aspect

@Component

public  class SystemLogAspect {    

	public SystemLogAspect(){

	}

    //本地异常日志记录对象

    private  static  final Logger logger = LoggerFactory.getLogger(SystemLogAspect.class);    

    //Service层切点

    @Pointcut("@annotation(com.demodashi.aop.annotation.ServiceLogAnnotation)")

    public  void serviceAspect() {

    }

    //Controller层切点

    @Pointcut("@annotation(com.demodashi.aop.annotation.ControllerLogAnnotation)")

    public  void controllerAspect() {

    }

    /**

     * 前置通知 用于拦截Controller层记录用户的操作

     *

     * @param joinPoint 切点

     */

    @Before("controllerAspect()")

	public  void doBefore4control(JoinPoint joinPoint) {

        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();

        HttpSession session = request.getSession();

        //读取session中的用户

        UserVO user = (UserVO) session.getAttribute("USER");

        //请求的IP

        String ip = request.getRemoteAddr();

         try {

            //*========控制台输出=========*//

            System.out.println("=====control 前置通知开始=====");

            System.out.println("请求方法:" + (joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()"));

            System.out.println("方法描述:" + getControllerMethodDescription(joinPoint));

            System.out.println("请求人ID:" + user.getId());

            System.out.println("请求人NAME:" + user.getName());

            System.out.println("请求IP:" + ip);

            System.out.println("=====前置通知结束=====");

        }  catch (Exception e) {

            //记录本地异常日志

            logger.error("==前置通知异常==");

            logger.error("异常信息:{}", e.getMessage());

        }

    }

    @Before("serviceAspect()")

    public  void doBefore4service(JoinPoint joinPoint) {

    	HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();

        HttpSession session = request.getSession();

        //读取session中的用户

        UserVO user = (UserVO) session.getAttribute("USER");

        //获取请求ip

        String ip = request.getRemoteAddr();

        //获取用户请求方法的参数并序列化为JSON格式字符串

        String params = "";

         if (joinPoint.getArgs() !=  null && joinPoint.getArgs().length > 0) {

             for ( int i = 0; i < joinPoint.getArgs().length; i++) {

                params += JSONObject.toJSON(joinPoint.getArgs()[i]).toString() + ";";

            }

        }

        try {

            /*========控制台输出=========*/

        	System.out.println("=====service 前置通知开始=====");

            System.out.println("异常方法:" + (joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()"));

            System.out.println("方法描述:" + getServiceMthodDescription(joinPoint));

            System.out.println("请求人ID:" + user.getId());

            System.out.println("请求人NAME:" + user.getName());

            System.out.println("请求IP:" + ip);

            System.out.println("请求参数:" + params);

        }  catch (Exception ex) {

            //记录本地异常日志

            logger.error("==异常通知异常==");

            logger.error("异常信息:{}", ex.getMessage());

        }

    }

    @AfterReturning(pointcut="serviceAspect()", returning="returnValue")

    public  void after4service(JoinPoint joinPoint, Object returnValue) {

    	HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();

        HttpSession session = request.getSession();

        //读取session中的用户

        UserVO user = (UserVO) session.getAttribute("USER");

        //获取请求ip

        String ip = request.getRemoteAddr();

        //获取用户请求方法的参数并序列化为JSON格式字符串

        String params = "";

         if (joinPoint.getArgs() !=  null && joinPoint.getArgs().length > 0) {

             for ( int i = 0; i < joinPoint.getArgs().length; i++) {

                params += JSONObject.toJSON(joinPoint.getArgs()[i]).toString() + ";";

            }

        }

        try {

            /*========控制台输出=========*/

        	System.out.println("=====service 后置通知开始=====");

            System.out.println("异常方法:" + (joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()"));

            System.out.println("方法描述:" + getServiceMthodDescription(joinPoint));

            System.out.println("请求人ID:" + user.getId());

            System.out.println("请求人NAME:" + user.getName());

            System.out.println("请求IP:" + ip);

            System.out.println("请求参数:" + params);

            System.out.println("返回值为：" + JSONObject.toJSON(returnValue).toString());

        }  catch (Exception ex) {

            //记录本地异常日志

            logger.error("==异常通知异常==");

            logger.error("异常信息:{}", ex.getMessage());

        }

    }

    /**

     * 异常通知 用于拦截service层记录异常日志

     *

     * @param joinPoint

     * @param e

     */

    @AfterThrowing(pointcut = "serviceAspect()", throwing = "e")

	public  void doAfterThrowing(JoinPoint joinPoint, Throwable e) {

    	HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();

        HttpSession session = request.getSession();

        //读取session中的用户

        UserVO user = (UserVO) session.getAttribute("USER");

        //获取请求ip

        String ip = request.getRemoteAddr();

        //获取用户请求方法的参数并序列化为JSON格式字符串

        String params = "";

         if (joinPoint.getArgs() !=  null && joinPoint.getArgs().length > 0) {

             for ( int i = 0; i < joinPoint.getArgs().length; i++) {

            	 params += JSONObject.toJSON(joinPoint.getArgs()[i]).toString() + ";";

            }

        }

        try {

            /*========控制台输出=========*/

            System.out.println("=====异常通知开始=====");

            System.out.println("异常代码:" + e.getClass().getName());

            System.out.println("异常信息:" + e.getMessage());

            System.out.println("异常方法:" + (joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()"));

            System.out.println("方法描述:" + getServiceMthodDescription(joinPoint));

            System.out.println("请求人ID:" + user.getId());

            System.out.println("请求人NAME:" + user.getName());

            System.out.println("请求IP:" + ip);

            System.out.println("请求参数:" + params);

            System.out.println("=====异常通知结束=====");

        }  catch (Exception ex) {

            //记录本地异常日志

            logger.error("==异常通知异常==");

            logger.error("异常信息:{}", ex.getMessage());

        }

         /*==========记录本地异常日志==========*/

        logger.error("异常方法:{}异常代码:{}异常信息:{}参数:{}", joinPoint.getTarget().getClass().getName() + joinPoint.getSignature().getName(), e.getClass().getName(), e.getMessage(), params);    

    }    

    /**

     * 获取注解中对方法的描述信息 用于service层注解

     *

     * @param joinPoint 切点

     * @return 方法描述

     * @throws Exception

     */

     public  static String getServiceMthodDescription(JoinPoint joinPoint)

             throws Exception {

        String targetName = joinPoint.getTarget().getClass().getName();

        String methodName = joinPoint.getSignature().getName();

        Object[] arguments = joinPoint.getArgs();

        Class targetClass = Class.forName(targetName);

        Method[] methods = targetClass.getMethods();

        String description = "";

         for (Method method : methods) {

             if (method.getName().equals(methodName)) {

                Class[] clazzs = method.getParameterTypes();

                 if (clazzs.length == arguments.length) {

                    description = method.getAnnotation(ServiceLogAnnotation. class).description();

                     break;

                }

            }

        }

         return description;

    }    

    /**

     * 获取注解中对方法的描述信息 用于Controller层注解

     *

     * @param joinPoint 切点

     * @return 方法描述

     * @throws Exception

     */

     public  static String getControllerMethodDescription(JoinPoint joinPoint)  throws Exception {

        String targetName = joinPoint.getTarget().getClass().getName();

        String methodName = joinPoint.getSignature().getName();

        Object[] arguments = joinPoint.getArgs();

        Class targetClass = Class.forName(targetName);

        Method[] methods = targetClass.getMethods();

        String description = "";

         for (Method method : methods) {

             if (method.getName().equals(methodName)) {

                Class[] clazzs = method.getParameterTypes();

                 if (clazzs.length == arguments.length) {

                    description = method.getAnnotation(ControllerLogAnnotation. class).description();

                     break;

                }

            }

        }

         return description;

    }

}
aop使用

就是将注解绑定到具体的service方法上面，或者control方法，如下所示：

@ServiceLogAnnotation(description = "修改密码")

@Override

public UserVO changePassword(UserVO vo, String newPassword) {

	vo.setPassword(newPassword);

	return vo;

}
@ResponseBody

@RequestMapping("/editPassword.do")

@ControllerLogAnnotation(description = "接受修改密码的请求")

public Map changePassword(ModelMap modelMap, HttpServletRequest request,

		HttpServletResponse response) throws IOException {

	String message = null;

	String result = null;

	Object vo = request.getSession().getAttribute("USER");

	if (vo == null) {

		message = "操作失败：对象不能为空！";

	} else if (StringUtils.isBlank(request.getParameter("newPassword"))) {

		message = "新登陆密码不能为空！";

	}

	if (message == null) {

		try {

			userApplication.changePassword((UserVO)vo, request.getParameter("newPassword"));

			message = "修改成功！";

			result = ConstantBean.SUCCESS;

		} catch (Exception e) {

			message = e.getMessage();

			result = ConstantBean.SYSERR;

		}

	} else {

		result = ConstantBean.SYSERR;

	}

	return toMap("data", message, "result", result);

}

运行起来

首把demo导入到eclipse后，运行的界面如下：

用户名 1001 密码 123

登陆后，修改密码，则看到eclipse控制台打印如下信息：

这样一个aop收集日志的功能了，这样的方式比直接把log写在具体的方法上要强多了，收集起来的log，可以直接写在本地，也可以接入elk方案。

接入elk方案可以参考本网站中的：《ELK + kafka 日志方案》

注：本文著作权归作者，由demo大师发表，拒绝转载，转载需要作者授权

spring aop实现日志收集的更多相关文章

  1. Spring AOP 完成日志记录

    Spring AOP 完成日志记录 http://hotstrong.iteye.com/blog/1330046

  2. Spring AOP进行日志记录

    在java开发中日志的管理有很多种.我一般会使用过滤器,或者是Spring的拦截器进行日志的处理.如果是用过滤器比较简单,只要对所有的.do提交进行拦截,然后获取action的提交路径就可以获取对每个 ...

  3. Spring AOP进行日志记录，管理

    在java开发中日志的管理有很多种.我一般会使用过滤器,或者是Spring的拦截器进行日志的处理.如果是用过滤器比较简单,只要对所有的.do提交进行拦截,然后获取action的提交路径就可以获取对每个 ...

  4. TinyFrame再续篇：整合Spring AOP实现日志拦截

    上一篇中主要讲解了如何使用Spring IOC实现依赖注入的.但是操作的时候,有个很明显的问题没有解决,就是日志记录问题.如果手动添加,上百个上千个操作,每个操作都要写一遍WriteLog方法,工作量 ...

  5. 使用Spring AOP 实现日志管理(简单教程)

    有时候,我们在做项目时会遇到这样的需求: 给XXX.java中的所有方法加上指定格式的日志输出. 针对这种指定类.或者指定方法进行共性操作的功能,我们完全可以使用Spring AOP来实现. 本文使用 ...

  6. Spring AOP统一日志 全量日志

    Spring AOP 切面@Around注解的具体使用 lichuangcsdn 2019-02-19 23:21:36 63936 收藏 61分类专栏: Spring 文章标签: Spring AO ...

  7. spring aop简单日志实例

    转载自:http://www.blogjava.net/laoding/articles/242611.html 一直就用spring的IOC,遗憾spring的另一重要组成部分AOP却没用过,所以近 ...

  8. Spring AOP的日志记录

    现在的项目是Spring+MyBatis,前段时间项目经理让我干了一个活,就是给所有的controller里的所有方法加上日志记录的代码,其实没有多少,也就300来个方法,也没有抱怨什么,一边打着瞌睡 ...

  9. spring:利用Spring AOP 使日志输入与方法分离

    对方法进行日志输出是一种很常见的功能.传统的做法是把输出语句写在方法体的内部,在调用该方法时,用输入语句输出信息来记录方法的执行! 1.先写一个普通类: package com.importnew; ...

随机推荐

  1. emouse思·睿—评论与观点整理之五

    虽说我主要做的硬件,平时的兴趣爱好比较关注移动互联网,混迹于虎嗅.爱范儿.雷锋网.36Kr.cnBeta.瘾科技.i黑马.TechWeb等这类科技以及创业媒体,遗憾的是系统的去写的并不多,好在还算充分 ...

  2. BMap：JavaScript API

    ylbtech-Map-Baidu:JavaScript API JavaScript API百度地图JavaScript API是一套由JavaScript语言编写的应用程序接口,可帮助您在网站中构 ...

  3. Verilog 加法器和减法器(5)

    前面二进制加法运算,我们并没有提操作数是有符号数,还是无符号数.其实前面的二进制加法对于有符号数和无符号数都成立.比如前面的8位二进制加法运算,第一张图我们选radix是unsigned,表示无符号加 ...

  4. axios post提交的Content-Type

    使用axios的坑 jQuery.ajax的post提交默认的请求头的Content-Type: application/x-www-form-urlencoded而axios.post提交的请求头是 ...

  5. Backbone.js 的 View 中定义事件

    使用 Backbone 的 View 时,可以象传统 jQuery 那样定义事件,$("selector").click(function(){...}).幸运的是 Backbon ...

  6. 关于如何使用javascript监听滚动条滚动事件

    在网页中,通常有一个通往网页顶部的锚点,现在我们就来实现它 Html代码: <a id="scrollup" href="#top" style=&quo ...

  7. （转）unity使用line renderer画线

    原文地址:http://www.xuanyusong.com/archives/561 任何一个无规则曲线它都是有若干个线段组成,及时是圆形它也是又若干个线段组成的,也就是说将若干个线段拼接起来就是我 ...

  8. HTTP 响应实体主体：XML 及 XML parser

    本文内容 HTTP 响应实体主体:XML XML parser 总结 各编程语言实现的 XML parser   HTTP 响应实体主体:XML 实体主体(entity-body)通常是HTTP响应里 ...

  9. 使用docker api

    前提: 系统centos 7 docker version 1.10.3 使用systemd启动docker 访问方式: 修改/usr/lib/systemd/system/docker.servic ...

  10. 微信小程序 - tab+swiper切换（非组件）

    无奈slot不支持循环,无法成为组件. 该模板适用于新闻等,点击下载示例:tabswiper