📄 @SysLog 日志注解使用

POM 依赖

<!--日志处理-->
<dependency>
	<groupId>com.pig4cloud</groupId>
	<artifactId>pig-common-log</artifactId>
	<version>${log.version}</version>
</dependency>

@SysLog 注解

• 接口上使用@SysLog 注释当前接口的作用即可

@SysLog("添加终端")
@PostMapping
@PreAuthorize("@pms.hasPermission('sys_client_add')")
public R add(@Valid @RequestBody SysOauthClientDetails sysOauthClientDetails) {
	return new R<>(sysOauthClientDetailsService.save(sysOauthClientDetails));
}

• 进阶: expression 动态标题

v4.5 + 版本增加此属性

@SysLog(expression = "'添加角色'.concat(#sysRole.roleName)")

@SysLog(expression = "#sysRole.roleName.concat('xxx')")

原理讲解

• AOP 切面获取当前请求的注解值，并 异步 发送时间，减少日志操作的性能损耗

@Aspect
@Slf4j
public class SysLogAspect {

	@Around("@annotation(sysLog)")
	public Object around(ProceedingJoinPoint point, SysLog sysLog) throws Throwable {
		String strClassName = point.getTarget().getClass().getName();
		String strMethodName = point.getSignature().getName();
		log.debug("[类名]:{},[方法]:{}", strClassName, strMethodName);
		SpringContextHolder.publishEvent(new SysLogEvent(logVo));
		return obj;
	}

}

• 监听器在接收到日志事件后进行调用 feign 入口处理

@Slf4j
@AllArgsConstructor
public class SysLogListener {
	private final RemoteLogService remoteLogService;

	@Async
	@Order
	@EventListener(SysLogEvent.class)
	public void saveSysLog(SysLogEvent event) {
		SysLog sysLog = (SysLog) event.getSource();
		remoteLogService.saveLog(sysLog, SecurityConstants.FROM_IN);
	}
}

异步操作说明 @EnableAsync

@EnableAsync 注解启用了 Spring 异步方法执行功能，在 Spring Framework API (opens new window) 中有详细介绍。