前言
今天翻出了以前的一个项目,发现对于日志的存储,是存储在数据库中的,将对应的入参、出参、请求方式、请求路径等信息存储在数据表中,想到这样的存储如果时间久了该数据表的数据量会很大,想到用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项目下载进行测试。