SpringBoot集成MongoDB做日誌存儲

前言

今天翻出了以前的一個項目，發現對於日誌的存儲，是存儲在數據庫中的，將對應的入參、出參、請求方式、請求路徑等信息存儲在數據表中，想到這樣的存儲如果時間久了該數據表的數據量會很大，想到用MongoDB試試做日誌的存儲，這樣將日誌存儲在MongoDB數據庫，查詢對應的請求時也可以很快的查詢出來。

思路如下

既然要做日誌的存儲，那麼就需要用AOP來實現，這樣我們只需要配置一個配置類，就可以將請求發送到該類中，這樣每次請求時都會請求到該類，然後進行日誌的存儲操作，將日誌存儲到MongoDB。

過程如下

1、導入MongoDB依賴

		<!--mongodb-->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-data-mongodb</artifactId>
		</dependency>

2、導入AOP依賴

		<dependency>
			<groupId>org.aspectj</groupId>
			<artifactId>aspectjrt</artifactId>
			<version>1.9.1</version>
		</dependency>

3、創建一個日誌實體類

import lombok.Data;
import org.springframework.data.mongodb.core.mapping.Document;
import org.springframework.format.annotation.DateTimeFormat;

import java.util.Date;

@Document(collection = "logs")
@Data
public class LogBean {
    private String id;
    private Integer userId;
    private String username;
    @DateTimeFormat(pattern="yyyy-MM-dd")
    private Date createDate;
    private String ip;
    private String className;//類名
    private String method;//方法名
    private String reqParam;//請求
}

通過Document(collection = “logs”)來配置MongoDB的表名稱

4、創建一個獲取IP地址的工具類

import org.apache.commons.lang.StringUtils;

import javax.servlet.http.HttpServletRequest;

public class CommonUtils {


     /**
     * 默認IP地址
     */
   	 public final static String ERROR_IP = "127.0.0.1";
    
     public static String getUserIP(HttpServletRequest request) {
        // 優先取 X-Real-IP
        String ip = request.getHeader("X-Real-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.getRemoteAddr();
            if ("0:0:0:0:0:0:0:1".equals(ip)) {
                ip = ERROR_IP;
            }
        }
        if ("unknown".equalsIgnoreCase(ip)) {
            ip = ERROR_IP;
            return ip;
        }
        int index = ip.indexOf(',');
        if (index >= 0) {
            ip = ip.substring(0, index);
        }

        return ip;
    }
}

在該類中，通過getUserIP方法來獲取用戶的ip地址，從而存儲到MongoDB中。

5、創建一個日誌配置類

import com.chunqiu.mrjuly.common.utils.LogBean;
import com.chunqiu.mrjuly.modules.system.model.User;
import org.apache.shiro.SecurityUtils;
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.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.Date;

@Component
@Aspect
public class MongoDbLogAspect {
    @Autowired
    private MongoTemplate mongoTemplate;
    @Autowired
    private JulyProperties julyProperties;


    //切點的註解  是指那些方法需要被執行"AOP"
    @Pointcut("execution(* com.chunqiu.mrjuly.modules.system.controller.*.*(..))")
    public void logPoinCut(){}//定義一個切入點
    //返回後通知value="logPoinCut()"是指通知是在logPoinCut()切點返回後通知的
    //returning="rtv"是返回值
    //@AfterReturning這個註解是返回後通知的註解
    @AfterReturning(value="logPoinCut()",returning="rtv")
    //JoinPoint是連接點的意思我們要獲取到的如類名，方法名，請求參數等都是從連接點中取出來的
    public void afterLog(JoinPoint joinpoint, Object rtv) {
        System.out.println("進去切點。。。。。");
        LogBean logBean = new LogBean();
        logBean.setCreateDate(new Date());
        //獲取類名
        String classname = joinpoint.getTarget().getClass().getSimpleName();
        logBean.setClassName(classname);
        //獲取方法名
        String method = joinpoint.getSignature().getName();
        logBean.setMethod(method);
        //獲取請求參數
        String reqparam = "";
        logBean.setReqParam(reqparam);
        //返回值
        if (rtv != null) {
            logBean.setReqParam(rtv.toString());
        }
        //獲取request對象
        ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = requestAttributes.getRequest();
		/*	UserBean user = (UserBean) request.getSession().getAttribute("user");
		if(user!=null){
			logBean.setUserId(user.getId());
		}*/
        //獲取ip地址是封裝好的一個類
        String ip = CommonUtils.getUserIP(request);
        logBean.setIp(ip);
        User user = (User) SecurityUtils.getSubject().getPrincipal();
        logBean.setUsername(user.getName());
        //保存mongodb
        mongoTemplate.save(logBean);
        System.out.println("日誌存儲成功.........");
    }
}

啓動MongoDB，然後啓動項目，發送請求，查看logback日誌來查看是否運行了該方法，然後通過MongoDB的可視化工具查看日誌。

如果需要該項目，可以到我的GitHub項目下載進行測試。

以上就是對MongoDB實現日誌的記錄。