使用AOP切面实现日志记录

本文参考EL-ADMIN 后台管理系统，学习相关AOP(Aspect-Oriented Programming:面向切面编程)，并实现使用AOP进行日志管理。特别感谢该项目的源代码作者：elunez

• 一、准备阶段
• 二、编码阶段
• 三、使用阶段

SpringBoot中需要先引入aop依赖

    com.baomidou
    mybatis-plus
    3.4.1

    org.springframework.boot
    spring-boot-starter-aop

    org.lionsoul
    ip2region
    1.7.2

    nl.basjes.parse.useragent
    yauaa
    5.23

创建一张sys_log的日志表

CREATE TABLE `sys_log` (
  `log_id` bigint NOT NULL AUTO_INCREMENT COMMENT 'ID',
  `description` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `log_type` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `method` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `params` text CHARACTER SET utf8 COLLATE utf8_general_ci,
  `request_ip` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `time` bigint DEFAULT NULL,
  `username` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `address` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `browser` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  `exception_detail` text CHARACTER SET utf8 COLLATE utf8_general_ci,
  `create_time` datetime DEFAULT NULL,
  PRIMARY KEY (`log_id`) USING BTREE,
  KEY `log_create_time_index` (`create_time`) USING BTREE,
  KEY `inx_log_type` (`log_type`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=3537 DEFAULT CHARSET=utf8mb3 COMMENT='系统日志';

日志工具类

@Slf4j
public class LogUtils {

    private static boolean ipLocal = false;

    private static File file = null;

    private static DbConfig config;

    // IP归属地查询
    public static final String IP_URL = "http://whois.pconline.com.cn/ipJson.jsp?ip=%s&json=true";

    
    public static String getCityInfo(String ip) {
        if (ipLocal) {
            return getLocalCityInfo(ip);
        } else {
            return getHttpCityInfo(ip);
        }
    }

    
    private static String getLocalCityInfo(String ip) {
        try {
            DataBlock dataBlock = new DbSearcher(config, file.getPath())
                    .binarySearch(ip);
            String region = dataBlock.getRegion();
            String address = region.replace("0|", "");
            char symbol = '|';
            if (address.charAt(address.length() - 1) == symbol) {
                address = address.substring(0, address.length() - 1);
            }
            return address;
        } catch (Exception e) {
            log.error(e.getMessage(), e);
        }
        return "";
    }

    
    private static String getHttpCityInfo(String ip) {
        String api = String.format(IP_URL, ip);
        JSONObject object = JSONUtil.parseObj(HttpUtil.get(api));
        return object.get("addr", String.class);
    }
}

日志实体类

@Data
@EqualsAndHashCode(callSuper = false)
@TableName("sys_log")
public class LogDO {

    private static final long serialVersionUID = 1L;

    
    @TableId(value = "log_id", type = IdType.AUTO)
    private Long id;

    
    private String username;

    
    private String description;

    
    private String method;

    
    private String params;

    
    private String logType;

    
    private String requestIp;

    
    private String address;

    
    private String browser;

    
    private Long time;

    
    private byte[] exceptionDetail;

    
    private Timestamp createTime;

    public LogDO(String logType, Long time) {
        this.logType = logType;
        this.time = time;
    }
}

Serivce类

public interface LogService {
    
    @Async
    void save(String username, String browser, String ip, ProceedingJoinPoint joinPoint, LogDO log);
}

Service实现类

@Service
public class LogServiceImpl implements LogService {

    @Autowired
    private LogMapper logMapper;

    @Override
    public void save(String username, String browser, String ip, ProceedingJoinPoint joinPoint, LogDO log) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        MyLog aopLog = method.getAnnotation(MyLog.class);
        // 方法路径
        String methodName = joinPoint.getTarget().getClass().getName() + "." + signature.getName() + "()";
        // 描述
        if (log != null) {
            log.setDescription(aopLog.value());
        }
        assert log != null;
        log.setRequestIp(ip);

        log.setAddress(LogUtils.getCityInfo(log.getRequestIp()));
        log.setMethod(methodName);
        log.setUsername(username);
        log.setParams(getParameter(method, joinPoint.getArgs()));
        log.setBrowser(browser);
        logMapper.insert(log);
    }

    
    private String getParameter(Method method, Object[] args) {
        List