概述

使用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. tmux 终端分屏利器使用

    介绍 Tmux 是一个工具,用于在一个终端窗口中运行多个终端会话. 不仅如此,你还可以通过 Tmux 使终端会话运行于后台或是按需接入.断开会话,这个功能非常实用. 很好的工具,记录一下,以后要常用. ...

  2. [2014亚马逊amazon] 在线笔试题 大于非负整数N的第一个回文数 Symmetric Number

    1.题目 如标题,求大于整数N(N>=0)的第一个回文数的字符串表示形式. 这个题目也是当时笔试第一次见到,花了一个小时才做出了.慢慢总结还是挺简单的. 2.分析 分析如下: (1)一位数N(9 ...

  3. C# winform DevExpress上传图片到数据库【转】

    实现功能如下图: 注明:此文使用的是DevExpress控件,winform 原生控件也是一样使用方法. 1.点击选择图片按钮,功能为通过对话框选择要上传的文件,并将该文件在下面的PictureEdi ...

  4. [leetcode]Pascal's Triangle II @ Python

    原题地址:https://oj.leetcode.com/problems/pascals-triangle-ii/ 题意: Given an index k, return the kth row ...

  5. [leetcode]Reverse Words in a String @ Python

    原题地址:https://oj.leetcode.com/problems/reverse-words-in-a-string/ 题意: Given an input string, reverse ...

  6. SQL操作查漏补缺

    SQL教程地址:http://www.w3school.com.cn/sql/index.asp TOP 子句 TOP 子句用于规定要返回的记录的数目. 对于拥有数千条记录的大型表来说,TOP 子句是 ...

  7. git pull fails “unable to resolve reference” “unable to update local ref”

    问题 由于有人rebase了分支,或者不知道怎么搞的.其他人拉取代码的时候,发现拉不下来. >git fetch error: cannot lock ref 'refs/remotes/ori ...

  8. Android 与 js 简单互调

    总结: Android 调用  js: 在 Android 中创建通往 javascript 的接口; 在 html  中定义要执行的方法; 在  Android  中的具体事件中进行调用. cont ...

  9. MySQL8.0手动安装心得。

    https://dev.mysql.com/downloads/mysql/ mysql从5.7一下子跳跃到了8.0,其中的改变还是很大,有点这里就不说了,小伙伴们自己去百度了解一下,这里重点说一下, ...

  10. JavaScript判断变量是否为数组的方法(Array)

    废话不多说直接上一个代码: 1.这里是通用的检测方法 /* * 判断是否是数组 */ function isArray(obj){ return Object.prototype.toString.c ...