1. 简介
项目中需要记录用户的敏感操作,系统异常日志时,需要用到该组件。该组件可以记录用户访问的客户端类型、IP地址、请求地址、请求参数、操作时间、操作耗时、请求返回、是否异常等详细信息,为系统的安全防护提供数据基础。
日志组件通过自定义注解的方式实现,避免侵入业务逻辑,在需要记录日志的接口加入@SysLog注解即可。
如图:
2. 基础环境
- java8+
- 开发框架 springboot2.0.4,spring5,jersey2,swagger2,hibernate-validate4,jpa,hibernate5
3. 如何使用
3.1. 添加依赖
<dependency>
<groupId>com.jpxx.syslog</groupId>
<artifactId>syslog-web-api</artifactId>
<version>BASE-1.1.0-SNAPSHOT</version>
</dependency>
3.2. 注入Bean
在项目的***Application主类中注入SysLogAspect
@Bean
public SysLogAspect sysLogAspect(){
return new SysLogAspect();
}
3.3. 注册服务
在项目的***ResouceConfig注册 SysLogApi.class (com.jpxx.syslog.web.api.SysLogApi.class)
register(SyslogApi.class);
3.4. 添加注解
@SysLog("修改数据字典")
@ApiOperation(value="修改数据字典")
@PUT
@Consumers(MediaType.APPLICATION_JSON)
public WebApiResponse(Dto dto,@Context SecurityContext context){...}
源码地址:http://sources.jpsycn.com/dev-plat/java-server/com/sys-log.git