簡要日誌記錄功能 —— 使用aop實現日誌記錄
阿新 • • 發佈：2021-10-08
記錄操作使用者IP地址，使用者名稱等相關資訊，以及所操作的介面模組、型別、說明
@
目錄一、自定義操作日誌註解
import java.lang.annotation.*; /** * 自定義操作日誌註解 * * @Author: change **/ @Target(ElementType.METHOD)//註解放置的目標位置即方法級別 @Retention(RetentionPolicy.RUNTIME)//註解在哪個階段執行 @Documented public @interface OperationLogAnnotation { // 操作模組 String operModul() default ""; // 操作型別 String operType() default ""; // 操作說明 String operDesc() default ""; }
二、操作日誌切面處理類
package com.lzby.tqj.annotation; import cn.hutool.json.JSONUtil; import com.lzby.tqj.common.IpUtils; import com.lzby.tqj.dao.SysIpLogMapper; import com.lzby.tqj.dao.SysLogMapper; import com.lzby.tqj.entity.SysLog; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.annotation.AfterReturning; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Pointcut; import org.aspectj.lang.reflect.MethodSignature; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; import org.springframework.web.context.request.RequestAttributes; import org.springframework.web.context.request.RequestContextHolder; import javax.servlet.http.HttpServletRequest; import java.lang.reflect.Method; import java.util.Map; import java.util.UUID; /** * 操作日誌切面處理類 * * @Author: changge **/ @Aspect @Component public class OperationLogAspect { @Autowired SysLogMapper sysLogMapper; @Autowired SysIpLogMapper sysIpLogMapper; /** * 設定操作日誌切入點 在註解的位置切入程式碼 */ @Pointcut("@annotation(com.lzby.tqj.annotation.OperationLogAnnotation)") public void operLogPoinCut() { } /** * 記錄操作日誌 * * @param joinPoint 方法的執行點 * @param result 方法返回值 * @throws Throwable */ @AfterReturning(returning = "result", value = "operLogPoinCut()") public void saveOperLog(JoinPoint joinPoint, Object result) throws Throwable { // 獲取RequestAttributes RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes(); // 從獲取RequestAttributes中獲取HttpServletRequest的資訊 HttpServletRequest request = (HttpServletRequest) requestAttributes.resolveReference(RequestAttributes.REFERENCE_REQUEST); try { //將返回值轉換成map集合 Map<String, String> map = (Map<String, String>) result; SysLog sysLog = new SysLog(); // 從切面織入點處通過反射機制獲取織入點處的方法 MethodSignature signature = (MethodSignature) joinPoint.getSignature(); //獲取切入點所在的方法 Method method = signature.getMethod(); //獲取操作 OperationLogAnnotation annotation = method.getAnnotation(OperationLogAnnotation.class); if (annotation != null) { sysLog.setModel(annotation.operModul()); sysLog.setType(annotation.operType()); sysLog.setDescription(annotation.operDesc()); } cn.hutool.json.JSONObject user = JSONUtil.parseObj(request.getHeader("userDetail")); //設定儲存的日誌資訊 sysLog.setId(UUID.randomUUID().toString()); //操作使用者 sysLog.setSfzh(user.getStr("sfzh")); String userName = sysIpLogMapper.getUserName(user.getStr("sfzh")); sysLog.setName(userName); //操作IP sysLog.setIp(IpUtils.getIpAddr(request)); //返回值資訊 sysLog.setResult(map.toString()); sysLog.setTypeName(method.getName()); //儲存日誌 sysLogMapper.insert(sysLog); } catch (Exception e) { e.printStackTrace(); } } }
三、獲取IP工具類
import com.lzby.tqj.common.util.EscapeUtil; import com.lzby.tqj.common.util.StringUtils; import javax.servlet.http.HttpServletRequest; import java.net.InetAddress; import java.net.UnknownHostException; /** * 獲取IP方法 */ public class IpUtils { public static String getIpAddr(HttpServletRequest request) { if (request == null) { return "unknown"; } String ip = request.getHeader("x-forwarded-for"); if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { ip = request.getHeader("Proxy-Client-IP"); } if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { ip = request.getHeader("X-Forwarded-For"); } if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { ip = request.getHeader("WL-Proxy-Client-IP"); } if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { ip = request.getHeader("X-Real-IP"); } if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { ip = request.getRemoteAddr(); } return "0:0:0:0:0:0:0:1".equals(ip) ? "127.0.0.1" : EscapeUtil.clean(ip); } public static boolean internalIp(String ip) { byte[] addr = textToNumericFormatV4(ip); return internalIp(addr) || "127.0.0.1".equals(ip); } private static boolean internalIp(byte[] addr) { if (StringUtils.isNull(addr) || addr.length < 2) { return true; } final byte b0 = addr[0]; final byte b1 = addr[1]; // 10.x.x.x/8 final byte SECTION_1 = 0x0A; // 172.16.x.x/12 final byte SECTION_2 = (byte) 0xAC; final byte SECTION_3 = (byte) 0x10; final byte SECTION_4 = (byte) 0x1F; // 192.168.x.x/16 final byte SECTION_5 = (byte) 0xC0; final byte SECTION_6 = (byte) 0xA8; switch (b0) { case SECTION_1: return true; case SECTION_2: if (b1 >= SECTION_3 && b1 <= SECTION_4) { return true; } case SECTION_5: switch (b1) { case SECTION_6: return true; } default: return false; } } /** * 將IPv4地址轉換成位元組 * * @param text IPv4地址 * @return byte 位元組 */ public static byte[] textToNumericFormatV4(String text) { if (text.length() == 0) { return null; } byte[] bytes = new byte[4]; String[] elements = text.split("\\.", -1); try { long l; int i; switch (elements.length) { case 1: l = Long.parseLong(elements[0]); if ((l < 0L) || (l > 4294967295L)) { return null; } bytes[0] = (byte) (int) (l >> 24 & 0xFF); bytes[1] = (byte) (int) ((l & 0xFFFFFF) >> 16 & 0xFF); bytes[2] = (byte) (int) ((l & 0xFFFF) >> 8 & 0xFF); bytes[3] = (byte) (int) (l & 0xFF); break; case 2: l = Integer.parseInt(elements[0]); if ((l < 0L) || (l > 255L)) { return null; } bytes[0] = (byte) (int) (l & 0xFF); l = Integer.parseInt(elements[1]); if ((l < 0L) || (l > 16777215L)) { return null; } bytes[1] = (byte) (int) (l >> 16 & 0xFF); bytes[2] = (byte) (int) ((l & 0xFFFF) >> 8 & 0xFF); bytes[3] = (byte) (int) (l & 0xFF); break; case 3: for (i = 0; i < 2; ++i) { l = Integer.parseInt(elements[i]); if ((l < 0L) || (l > 255L)) { return null; } bytes[i] = (byte) (int) (l & 0xFF); } l = Integer.parseInt(elements[2]); if ((l < 0L) || (l > 65535L)) { return null; } bytes[2] = (byte) (int) (l >> 8 & 0xFF); bytes[3] = (byte) (int) (l & 0xFF); break; case 4: for (i = 0; i < 4; ++i) { l = Integer.parseInt(elements[i]); if ((l < 0L) || (l > 255L)) { return null; } bytes[i] = (byte) (int) (l & 0xFF); } break; default: return null; } } catch (NumberFormatException e) { return null; } return bytes; } public static String getHostIp() { try { return InetAddress.getLocalHost().getHostAddress(); } catch (UnknownHostException e) { } return "127.0.0.1"; } public static String getHostName() { try { return InetAddress.getLocalHost().getHostName(); } catch (UnknownHostException e) { } return "未知"; } }