202206-9|SpringBoot和@Aspect实现自建Log日志功能
【摘要】 主页：小王叔叔的博客支持:点赞👍关注✔️收藏💖一、效果二、技术应用：JDK1.8+SpringBoot2.0+ 、@Aspect注解MySql5.6+三、上代码---我的博客只上干货！！！！Log实体对象类.javapackage *****.***.***.modules.sys.log.entity;import java.io.Serializable;import java....
主页：小王叔叔的博客
支持:点赞👍关注✔️收藏💖
一、效果
二、技术应用：
JDK1.8+
SpringBoot2.0+ 、@Aspect注解
MySql5.6+
三、上代码---我的博客只上干货！！！！
Log实体对象类.java
package *****.***.***.modules.sys.log.entity;
import java.io.Serializable;
import java.util.Date;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.Table;
import org.springframework.stereotype.Component;
import io.swagger.annotations.ApiModelProperty;
@Entity
@Table(name = "sys_log")
@Component
@org.hibernate.annotations.Table(comment="系统日志信息", appliesTo = "sys_log")
public class SysLog implements Serializable{
private static final long serialVersionUID = 42L;
@Id
@ApiModelProperty("主键")
@Column(name="id",nullable = false,columnDefinition = "bigint(64) comment '主键'")
private Long id;// 主键Id
@ApiModelProperty("日志编号")
@Column(name="log_id",columnDefinition = "varchar(255) comment '日志编号'" )
private String logId;//日志编号
@ApiModelProperty("请求链接")
@Column(name="url",columnDefinition = "text comment '请求链接'" )
private String url;//请求链接
@ApiModelProperty("请求方法")
@Column(name="method",columnDefinition = "text comment '请求方法'" )
private String method;//请求方法
@ApiModelProperty("请求类名")
@Column(name="class_name",columnDefinition = "text comment '请求类名'" )
private String className;//请求方法
@ApiModelProperty("请求方法名")
@Column(name="method_name",columnDefinition = "text comment '请求方法名'" )
private String methodName;//请求方法
@ApiModelProperty("请求参数")
@Column(name="params",columnDefinition = "text comment '请求参数'" )
private String params;//请求参数
@ApiModelProperty("日志类型:（1：系统日志2：业务日志）")
@Column(name="lot_type",columnDefinition = "varchar(255) comment '日志类型:（1：系统日志2：业务日志）'" )
private String logType;//请求方法
@ApiModelProperty("请求方式:（GET/POST)")
@Column(name="type",columnDefinition = "varchar(255) comment '请求方式（GET/POST)'" )
private String type;//请求方法
@ApiModelProperty("请求IP")
@Column(name="IP",columnDefinition = "text comment '请求IP'" )
private String ip;//请求方法
@ApiModelProperty("操作的数据库表")
@Column(name="log_table",columnDefinition = "varchar(255) comment '操作的数据库表'" )
private String table;//操作的数据库表
@ApiModelProperty("请求异常")
@Column(name="log_error",columnDefinition = "text comment '请求异常'" )
private String logError;//请求异常
@ApiModelProperty("运行时长")
@Column(name="time",columnDefinition = "varchar(255) comment '运行时长'" )
private long time;//
@ApiModelProperty("备注")
@Column(name="log_comment",columnDefinition = "text comment '备注'" )
private String logComment;//备注
@ApiModelProperty("创建人")
@Column(name="create_by" )
private String createBy;//创建人
@ApiModelProperty("创建时间")
@Column(name="create_time" )
private Date createTime;//创建时间
//setter()/getter();
}
四、实现基本保存功能，基本的CRUD.java
package ****.****.****.modules.sys.log.controller;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import *****.modules.sys.log.entity.SysLog;
import *******.modules.sys.log.service.SysLogService;
import io.swagger.annotations.ApiOperation;
@CrossOrigin//跨域
@RestController
@RequestMapping("/SysLog")
public class SysLogController{
@Autowired
public SysLogService sysLogService;
// //添加AOP注解日志管理
// @SysLogAspectValue(
// describtion = "获取所有日志列表信息",
// logType = "1",
// type="POST",
// url="/SysLog/SelectAllSysLog",
// table="sys_log",
// params = "SysLog",
// method = "POST"
// )
@ResponseBody
@ApiOperation(value = "获取所有日志列表信息", notes = "/SysLog/SelectAllSysLog")
@GetMapping(value = "/SelectAllSysLog")
public List<SysLog> SelectAllSysLog(){
return sysLogService.SelectAllSysLogList(page).getContent();
}
}
package *******.*****.******modules.sys.log.service;
import org.springframework.data.domain.Page;
import ***.***.****t.modules.sys.log.entity.SysLog;
/***
* 系统日志接口
* @ClassName: SysLogService
* @Description: TODO(描述)
* @author author
* @date 2019-12-03 10:55:22
*/
public interface SysLogService {
/***
* 日志保存
* @Title: save
* @Description: TODO(描述)
* @param sysLog
* @author author
* @date 2019-12-10 09:56:28
*/
void save(SysLog sysLog);
}
package ***.****.****.modules.sys.log.service.impl;
import java.util.ArrayList;
import java.util.List;
import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.CriteriaQuery;
import javax.persistence.criteria.Predicate;
import javax.persistence.criteria.Root;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.stereotype.Service;
import ***.***.***.***.****.modules.sys.log.entity.SysLog;
import ***.*.*.*.*.*.*.*.modules.sys.log.repository.SysLogRepository;
import *.*.*.*.*.*.*.*.*.*.modules.sys.log.service.SysLogService;
/**
* 系统日志实现类
* @ClassName: SysLogServiceImpl
* @Description: TODO(描述)
* @author author
* @date 2019-12-03 10:55:17
*/
@Service("SysLogService")
public class SysLogServiceImpl implements SysLogService{
@Autowired
public SysLogRepository sysLogRepository;
@Override
public Page<SysLog> SelectAllSysLogList(int page) {
Sort sort = new Sort(Sort.Direction.DESC, "createTime");//创建时间正序排列
Pageable pageable = PageRequest.of(page, this.size, sort);
Page<SysLog> sysLog = sysLogRepository.findAll (new Specification<SysLog>() {
@Override
public Predicate toPredicate(Root<SysLog> root,
CriteriaQuery<?> query, CriteriaBuilder criteriaBuilder) {
List<Predicate> list = new ArrayList<Predicate>();
//拼接 where条件-----------------
//---------------------------
Predicate[] p = new Predicate[list.size()];
return criteriaBuilder.and(list.toArray(p));
}
}, pageable);
return sysLog;
}
@Override
public void save(SysLog sysLog) {
sysLogRepository.save(sysLog);
}
}
package *.*.*.*.*.*.*.modules.sys.log.repository;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.data.jpa.repository.JpaRepository;
import *.*.*.*.*.*.*.*.modules.sys.log.entity.SysLog;
/**
* 系统日志管理类
* @ClassName: SysLogRepository
* @Description: TODO(描述)
* @author author
* @date 2019-12-03 10:55:09
*/
public interface SysLogRepository extends JpaRepository<SysLog, Long> {
}
已上就是基本的业务功能中的CRUD的功能，下面就是重点的log的AOP切面功能，，，
五、AOP切面功能动态获取log信息
1）、在每个需要用到的方法头上增加注释，附加案例【四中第一个截图】
package *.*.*.*.*.*.*.*.modules.sys.log.controller;
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;
/***
* 系统日志管理表
* @ClassName: SysLogController
* @Description: TODO(描述)
* @author author
* @date 2019-12-03 10:54:52
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented//注释文档
public @interface SysLogAspectValue {
String describtion() default "";//日志描述
String logType() default "1";//日志种类-1：系统日志2：业务日志
String type() default "GET";//请求方式:（GET/POST)
String url() default "";//请求链接
String table() default "";//操作的数据库表
String params() default "";//请求参数
String method() default "";//请求方法
}
制作切面内容
package *.*.*.*.*.*.*.modules.sys.log.controller;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import javax.servlet.http.HttpServletRequest;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Around;
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.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import com.google.gson.Gson;
import *.*.*.*.*.*.common.utils.IdGenerate;
import *.*.*.*.*.*.modules.sys.log.entity.SysLog;
import *.*.*.*.*.*.modules.sys.log.service.SysLogService;
/***
* 系统日志切面
* @ClassName: SysLogAspect
* @Description: TODO(描述)
* @author author
* @date 2019-12-04 10:34:41
*/
@Aspect // 使用@Aspect注解声明一个切面
@Component
public class SystemLogAspect{
private final String POINT_CUT ="@annotation(*.*.*.*.*.modules.sys.log.entity)";
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(SystemLogAspect.class);
@Autowired
public SysLogService sysLogService;
/**
* 这里我们使用注解的形式
* 当然，我们也可以通过切点表达式直接指定需要拦截的package,需要拦截的class 以及 method
* 切点表达式: execution(...)
*/
@Pointcut(POINT_CUT)
public void PointCut() {}
/**
* 环绕通知 @Around ， 当然也可以使用 @Before (前置通知) @After (后置通知)
* @param point
* @return
* @throws Throwable
*/
//@Around(POINT_CUT)
@Around("@annotation(SysLogAspectValue)")
public Object around(ProceedingJoinPoint point) throws Throwable {
long beginTime = System.currentTimeMillis();
Object result = point.proceed();
try {
//正常保存日志
saveLog(point, System.currentTimeMillis() - beginTime);
} catch (Exception e) {
//异常保存日志
//afterReturningMethod(point, e);
}
return result;
}
/***
* 捕获异常
*
* @Title: afterReturningMethod
* @Description: TODO(描述)
* @param joinPoint
* @param e
* @author author
* @throws Throwable
* @date 2019-12-10 01:40:37
*/
@AfterThrowing(throwing = "exception",value = "@annotation(SysLogAspectValue)",argNames="exception")
public void afterReturningMethod(JoinPoint joinPoint, Exception e) throws Throwable{
if(e!=null){
SysLog sysLog = new SysLog();
long beginTime = System.currentTimeMillis();
long time = System.currentTimeMillis() - beginTime;
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
Method method = signature.getMethod();
// 接收到请求，记录请求内容
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
sysLog.setId(IdGenerate.longUUIDId());//主键
sysLog.setLogId(sysLog.getId().toString());//日志编号
sysLog.setTime(time);//时长
sysLog.setIp(request.getRemoteAddr());//请求的IP
sysLog.setCreateBy(sysLog.getIp());//请求人
sysLog.setCreateTime( new Date() );//创建时间
SysLogAspectValue sysLogAspectValue = method.getAnnotation(SysLogAspectValue.class);
if(sysLogAspectValue != null){
//注解上的描述
sysLog.setLogComment(sysLogAspectValue.describtion());//备注
sysLog.setLogType(sysLogAspectValue.logType());//日志类型
sysLog.setType(sysLogAspectValue.type());//请求类型
sysLog.setUrl(sysLogAspectValue.url());//请求链接
sysLog.setTable(sysLogAspectValue.table());//操作的数据表
sysLog.setMethod(sysLogAspectValue.method());//操作请求方法
}
//请求的 类名、方法名
sysLog.setClassName(joinPoint.getTarget().getClass().getName());//类名
sysLog.setMethodName(signature.getName());//方法名
//请求的参数
Object[] args = joinPoint.getArgs();
List<String> list = new ArrayList<String>();
for (Object o : args) {
list.add(new Gson().toJson(o));
}
sysLog.setParams("Params:[ " + list.toString()+" ]:Aspectj @AfterThrowing");
sysLog.setLogError(joinPoint.getSignature().getName()+ "[ message:" + e.getMessage() + "]:Aspectj @AfterThrowing");
System.out.println("=====异常保存日志成功==============================");
sysLogService.save(sysLog);
log.trace(POINT_CUT, sysLog);
System.out.println("=====异常保存日志 结束=========================");
}
}
/**
* 正常保存日志
* @param joinPoint
* @param time
* @throws Throwable
*/
public void saveLog(ProceedingJoinPoint joinPoint, long time) {
SysLog sysLog = new SysLog();
sysLog = this.addSysLog(joinPoint,sysLog , time );
//请求的参数
Object[] args = joinPoint.getArgs();
List<String> list = new ArrayList<String>();
for (Object o : args) {
list.add(new Gson().toJson(o));
}
sysLog.setParams("Params:[ " + list.toString()+" ]:Aspectj @Around");
sysLog.setLogError( "[ message: 无 ]:Aspectj @Around");
System.out.println("=====正常保存日志成功==============================");
sysLogService.save(sysLog);
log.trace(POINT_CUT, sysLog);
System.out.println("=====正常保存日志 结束=========================");
}
/**
* 组装日志model
* @Title: addSysLog
* @Description: TODO(描述)
* @param sysLog
* @return
* @author author
* @date 2019-12-10 02:09:04
*/
public SysLog addSysLog(ProceedingJoinPoint joinPoint, SysLog sysLog , long time) {
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
Method method = signature.getMethod();
// 接收到请求，记录请求内容
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
sysLog.setId(IdGenerate.longUUIDId());//主键
sysLog.setLogId(sysLog.getId().toString());//日志编号
sysLog.setTime(time);//时长
sysLog.setIp(request.getRemoteAddr());//请求的IP
sysLog.setCreateBy(sysLog.getIp());//请求人
sysLog.setCreateTime( new Date() );//创建时间
SysLogAspectValue sysLogAspectValue = method.getAnnotation(SysLogAspectValue.class);
if(sysLogAspectValue != null){
//注解上的描述
sysLog.setLogComment(sysLogAspectValue.describtion());//备注
sysLog.setLogType(sysLogAspectValue.logType());//日志类型
sysLog.setType(sysLogAspectValue.type());//请求类型
sysLog.setUrl(sysLogAspectValue.url());//请求链接
sysLog.setTable(sysLogAspectValue.table());//操作的数据表
sysLog.setMethod(sysLogAspectValue.method());//操作请求方法
}
//请求的 类名、方法名
sysLog.setClassName(joinPoint.getTarget().getClass().getName());//类名
sysLog.setMethodName(signature.getName());//方法名
return sysLog;
}
}
生成这个Log切面日志的用法：
以上是自己整理的，并测试过，可以直接用
⚠️注意 ~
💯本期内容就结束了，如果内容有误，麻烦大家评论区指出！
如有疑问❓可以在评论区留言💬或私信留言💬，尽我最大能力🏃♀️帮大家解决👨🏫！
如果我的文章有帮助到您，欢迎关注+点赞✔️鼓励博主🏃，您的鼓励是我分享的动力🏃🏃🏃~
【版权声明】本文为华为云社区用户原创内容，未经允许不得转载，如需转载请自行联系原作者进行授权。如果您发现本社区中有涉嫌抄袭的内容，欢迎发送邮件进行举报，并提供相关证据，一经查实，本社区将立刻删除涉嫌侵权内容，举报邮箱：
cloudbbs@huaweicloud.com
- 点赞
- 收藏
- 关注作者
评论（0）