From 7f977f9a8d09b74cfe4e4102188e89be6a2dd38c Mon Sep 17 00:00:00 2001 From: panghu Date: Thu, 28 Jul 2022 14:46:28 +0800 Subject: [PATCH] =?UTF-8?q?=E8=A1=A5Log=E7=9B=AE=E5=BD=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 - .../com/snhanyue/course/common/log/Log.java | 31 +++ .../snhanyue/course/common/log/LogAspect.java | 188 ++++++++++++++++++ .../resources/templates/admin/log/list.html | 169 ++++++++++++++++ 4 files changed, 388 insertions(+), 1 deletion(-) create mode 100644 src/main/java/com/snhanyue/course/common/log/Log.java create mode 100644 src/main/java/com/snhanyue/course/common/log/LogAspect.java create mode 100644 src/main/resources/templates/admin/log/list.html diff --git a/.gitignore b/.gitignore index 69d4e69..ce4b726 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,6 @@ target # Log file *.log -log # BlueJ files diff --git a/src/main/java/com/snhanyue/course/common/log/Log.java b/src/main/java/com/snhanyue/course/common/log/Log.java new file mode 100644 index 0000000..4f0b48f --- /dev/null +++ b/src/main/java/com/snhanyue/course/common/log/Log.java @@ -0,0 +1,31 @@ +package com.snhanyue.course.common.log; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * 自定义操作日志记录注解 + * @author fuce + * @date: 2018年9月30日 下午3:36:05 + */ +@Target({ ElementType.PARAMETER, ElementType.METHOD }) +@Retention(RetentionPolicy.RUNTIME) +@Documented +public @interface Log +{ + /** 模块 */ + String title() default ""; + + /** 功能 */ + String action() default ""; + + /** 渠道 */ + String channel() default "1";//1后台 + + /** 是否保存请求的参数 */ + boolean isSaveRequestData() default true; + +} diff --git a/src/main/java/com/snhanyue/course/common/log/LogAspect.java b/src/main/java/com/snhanyue/course/common/log/LogAspect.java new file mode 100644 index 0000000..c53a505 --- /dev/null +++ b/src/main/java/com/snhanyue/course/common/log/LogAspect.java @@ -0,0 +1,188 @@ +package com.snhanyue.course.common.log; + +import java.lang.reflect.Method; +import java.util.Date; +import java.util.Map; + +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.beans.factory.annotation.Autowired; +import org.springframework.scheduling.annotation.Async; +import org.springframework.scheduling.annotation.EnableAsync; +import org.springframework.stereotype.Component; + +import com.snhanyue.course.model.auto.TsysOperLog; +import com.snhanyue.course.model.auto.TsysUser; +import com.snhanyue.course.satoken.SaTokenUtil; +import com.snhanyue.course.service.SysOperLogService; +import com.snhanyue.course.util.ServletUtils; +import com.snhanyue.course.util.StringUtils; +import com.google.gson.Gson; + +/** + * 操作日志记录处理 + * @author fuce + * @date: 2018年9月30日 下午1:40:33 + */ +@Aspect +@Component +@EnableAsync +public class LogAspect +{ + private static final Logger log = LoggerFactory.getLogger(LogAspect.class); + + @Autowired + private SysOperLogService operLogService; + + // 配置织入点 + @Pointcut("@annotation(com.snhanyue.course.common.log.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); + } + + @Async + protected void handleLog(final JoinPoint joinPoint, final Exception e) + { + try + { + // 获得注解 + Log controllerLog = getAnnotationLog(joinPoint); + if (controllerLog == null) + { + return; + } + + // 获取当前的用户 + TsysUser currentUser = SaTokenUtil.getUser(); + + // *========数据库日志=========*// + TsysOperLog operLog = new TsysOperLog(); + + //赋值操作 + /*String ip = SaTokenUtil.getIp(); + operLog.setOperIp(ip);*/ + // 操作地点 + //operLog.setOperLocation(AddressUtils.getRealAddressByIP(ip)); + // 请求的地址 + operLog.setOperUrl(ServletUtils.getRequest().getRequestURI()); + if (currentUser != null) + { +// //操作人 + operLog.setOperName(currentUser.getUsername()); +// if (StringUtils.isNotNull(currentUser.getDept()) +// && StringUtils.isNotEmpty(currentUser.getDept().getDeptName())) +// { +// operLog.setDeptName(currentUser.getDept().getDeptName()); +// } + } + + if (e != null) + { + //错误日志 + operLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000)); + } + // 设置方法名称 + String className = joinPoint.getTarget().getClass().getName(); + String methodName = joinPoint.getSignature().getName(); + operLog.setMethod(className + "." + methodName + "()"); + operLog.setOperTime(new Date()); + // 处理设置注解上的参数 + getControllerMethodDescription(controllerLog, operLog); + // 保存数据库 + //System.out.println("-----------------"); + //System.out.println(new Gson().toJson(operLog)); + //System.out.println("-----------------"); + operLogService.insertSelective(operLog); + } + catch (Exception exp) + { + // 记录本地异常日志 + log.error("==前置通知异常=="); + log.error("异常信息:{}", exp.getMessage()); + exp.printStackTrace(); + } + } + + /** + * 获取注解中对方法的描述信息 用于Controller层注解 + * + * @param joinPoint 切点 + * @return 方法描述 + * @throws Exception + */ + public void getControllerMethodDescription(Log log, TsysOperLog operLog) throws Exception + { + // 设置action动作 + // operLog.setAction(log.action()); + // 设置标题 + operLog.setTitle(log.title()); + // 设置channel + //operLog.setChannel(log.channel()); + // 是否需要保存request，参数和值 + if (log.isSaveRequestData()) + { + // 获取参数的信息，传入到数据库中。 + setRequestValue(operLog); + } + } + + /** + * 获取请求的参数，放到log中 + * + * @param operLog + * @param request + */ + private void setRequestValue(TsysOperLog operLog) + { + Map map = ServletUtils.getRequest().getParameterMap(); + Gson gson=new Gson(); + String params = gson.toJson(map); + operLog.setOperParam(StringUtils.substring(params, 0, 255)); + } + + /** + * 是否存在注解，如果存在就获取 + */ + 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; + } +} diff --git a/src/main/resources/templates/admin/log/list.html b/src/main/resources/templates/admin/log/list.html new file mode 100644 index 0000000..8e18e20 --- /dev/null +++ b/src/main/resources/templates/admin/log/list.html @@ -0,0 +1,169 @@ + + + + + + +
+
+
+
+ +
+ +
+ + +
+
+
+
+
+
+
+
+
+ + + + + + + + + + + \ No newline at end of file -- Gitee