AOP实现注解方式日志管理

注解方式日志管理"/>

AOP实现注解方式日志管理

 此说明仅仅是简单说明，其中一些工具类或者属性都可以自定义，可以灵活修改

依赖

拦截器使用的shiro中的

<!-- SpringBoot Web容器 -->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId>
</dependency><!-- SpringBoot 拦截器 -->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!-- Shiro使用Srping框架 -->
<dependency><groupId>org.apache.shiro</groupId><artifactId>shiro-spring</artifactId>
</dependency>

数据库表结构

使用的是oracle表结构

-- 操作日志记录
-- ----------------------------
create sequence seq_sys_oper_logincrement by 1start with 100nomaxvaluenominvaluecache 20;drop table sys_oper_log cascade constraints;
create table sys_oper_log (oper_id 			number          not null ,title             varchar2(50)    default '',business_type     number          default 0,method            varchar2(100)   default '',operator_type     number          default 0,oper_name 	    varchar2(50)    default '',dept_name 		varchar2(50)    default '',oper_url 		    varchar2(255) 	default '',oper_ip 			varchar2(50) 	default '',oper_location     varchar2(255)   default '',oper_param 		varchar2(2000) 	default '',status 			number 		    default 0,error_msg 		varchar2(2000) 	default '' ,oper_time 		date
);alter table sys_oper_log add constraint pk_sys_oper_log primary key (oper_id);comment on table  sys_oper_log               is '操作日志记录';
comment on column sys_oper_log.oper_id       is '日志主键seq_sys_oper_log.nextval';
comment on column sys_oper_log.title         is '模块标题';
comment on column sys_oper_log.business_type is '业务类型（0其它 1新增 2修改 3删除）';
comment on column sys_oper_log.method        is '方法名称';
comment on column sys_oper_log.operator_type is '操作类别（0其它 1后台用户 2手机端用户）';
comment on column sys_oper_log.oper_name     is '操作人员';
comment on column sys_oper_log.dept_name     is '部门名称';
comment on column sys_oper_log.oper_url      is '请求URL';
comment on column sys_oper_log.oper_ip       is '主机地址';
comment on column sys_oper_log.oper_location is '操作地点';
comment on column sys_oper_log.oper_param    is '请求参数';
comment on column sys_oper_log.status        is '操作状态（0正常 1异常）';
comment on column sys_oper_log.error_msg     is '错误消息';
comment on column sys_oper_log.oper_time     is '操作时间';

定义注解

package common.annotation;import common.enums.BusinessType;
import common.enums.OperatorType;import java.lang.annotation.*;/*** 自定义操作日志记录注解*/
@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {/*** 模块*/public String title() default "";/*** 功能*/public BusinessType businessType() default BusinessType.OTHER;/*** 操作人类别*/public OperatorType operatorType() default OperatorType.MANAGE;/*** 是否保存请求的参数*/public boolean isSaveRequestData() default true;
}

AOP拦截类

package com.framework.aspectj;import common.annotation.Log;
import common.enums.BusinessStatus;
import common.json.JSON;
import common.utils.ServletUtils;
import common.utils.StringUtils;
import com.framework.util.ShiroUtils;
import com.system.domain.SysOperLog;
import com.system.domain.SysUser;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;import java.lang.reflect.Method;
import java.util.Map;/*** 操作日志记录处理*/
@Aspect
@Component
public class LogAspect {private static final Logger log = LoggerFactory.getLogger(LogAspect.class);// 配置织入点（此处使用注解的相对路径）@Pointcut("@annotation(common.annotation.Log)")public void logPointCut() {}/*** 前置通知 用于拦截操作** @param joinPoint 切点*/@AfterReturning(pointcut = "logPointCut()")public void doBefore(JoinPoint joinPoint) {handleLog(joinPoint, null);}/*** 后置通知 用于拦截异常操作** @param joinPoint* @param e*/@AfterThrowing(value = "logPointCut()", throwing = "e")public void doAfter(JoinPoint joinPoint, Exception e) {handleLog(joinPoint, e);}protected void handleLog(final JoinPoint joinPoint, final Exception e) {try {// 获得注解Log controllerLog = getAnnotationLog(joinPoint);if (controllerLog == null) {return;}// 获取当前的用户（此处使用shiro定义的工具类）SysUser currentUser = ShiroUtils.getSysUser();// *========数据库日志=========*//SysOperLog operLog = new SysOperLog();operLog.setStatus(BusinessStatus.SUCCESS.ordinal());// 请求的地址String ip = ShiroUtils.getIp();operLog.setOperIp(ip);operLog.setOperUrl(ServletUtils.getRequest().getRequestURI());if (currentUser != null) {operLog.setOperName(currentUser.getLoginName());if (StringUtils.isNotNull(currentUser.getDept())&& StringUtils.isNotEmpty(currentUser.getDept().getDeptName())) {operLog.setDeptName(currentUser.getDept().getDeptName());}}if (e != null) {operLog.setStatus(BusinessStatus.FAIL.ordinal());operLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000));}// 设置方法名称String className = joinPoint.getTarget().getClass().getName();String methodName = joinPoint.getSignature().getName();operLog.setMethod(className + "." + methodName + "()");// 处理设置注解上的参数getControllerMethodDescription(controllerLog, operLog);// 保存数据库(此处省略，可以注入operateService或者异步进行数据库插入处理)} catch (Exception exp) {// 记录本地异常日志log.error("==前置通知异常==");log.error("异常信息:{}", exp.getMessage());exp.printStackTrace();}}/*** 获取注解中对方法的描述信息 用于Controller层注解** @param log     日志* @param operLog 操作日志* @throws Exception*/public void getControllerMethodDescription(Log log, SysOperLog operLog) throws Exception {// 设置action动作operLog.setBusinessType(log.businessType().ordinal());// 设置标题operLog.setTitle(log.title());// 设置操作人类别operLog.setOperatorType(log.operatorType().ordinal());// 是否需要保存request，参数和值if (log.isSaveRequestData()) {// 获取参数的信息，传入到数据库中。setRequestValue(operLog);}}/*** 获取请求的参数，放到log中** @param operLog 操作日志* @throws Exception 异常*/private void setRequestValue(SysOperLog operLog) throws Exception {Map<String, String[]> map = ServletUtils.getRequest().getParameterMap();String params = JSON.marshal(map);operLog.setOperParam(StringUtils.substring(params, 0, 2000));}/*** 是否存在注解，如果存在就获取*/private Log getAnnotationLog(JoinPoint joinPoint) throws Exception {Signature signature = joinPoint.getSignature();MethodSignature methodSignature = (MethodSignature) signature;Method method = methodSignature.getMethod();if (method != null) {return method.getAnnotation(Log.class);}return null;}
}

用例

BusinessType是个枚举类，此处不在说明

    @Log(title = "部门管理", businessType = BusinessType.INSERT)@PostMapping("/add")@ResponseBodypublic AjaxResult addSave(SysDept dept) {dept.setCreateBy(ShiroUtils.getLoginName());return toAjax(deptService.insertDept(dept));}