hhyykk/ipms-sjy
1
1
Fork 0
mirror of https://gitee.com/hhyykk/ipms-sjy.git synced 2025-07-25 08:25:07 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

[新增][定时任务]ApiAccessLog、ApiErrorLog、JobLog 3个日志的定时清理

Browse Source
This commit is contained in:
j-sentinel
2023-10-01 16:53:17 +08:00
parent 3875c80471
commit 11921fab5a
29 changed files with 391 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
yudao-framework/yudao-spring-boot-starter-job/src/main/java/cn/iocoder/yudao/framework/quartz/config/YudaoQuartzAutoConfiguration.java
View File

@ -1,9 +1,12 @@
package cn.iocoder.yudao.framework.quartz.config;
import cn.iocoder.yudao.framework.quartz.core.job.JobLogJobHandler;
import cn.iocoder.yudao.framework.quartz.core.job.LogJobProperties;
import cn.iocoder.yudao.framework.quartz.core.scheduler.SchedulerManager;
import lombok.extern.slf4j.Slf4j;
import org.quartz.Scheduler;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.scheduling.annotation.EnableScheduling;
@ -15,6 +18,7 @@ import java.util.Optional;
@AutoConfiguration
@EnableScheduling // 开启 Spring 自带的定时任务
@Slf4j
@EnableConfigurationProperties(LogJobProperties.class)
public class YudaoQuartzAutoConfiguration {
@Bean
@ -26,4 +30,9 @@ public class YudaoQuartzAutoConfiguration {
return new SchedulerManager(scheduler.get());
}
@Bean
public JobLogJobHandler jobLogJobHandler(LogJobProperties logJobProperties){
return new JobLogJobHandler(logJobProperties);
}
}

33
yudao-framework/yudao-spring-boot-starter-job/src/main/java/cn/iocoder/yudao/framework/quartz/core/job/JobLogJobHandler.java Normal file
View File

@ -0,0 +1,33 @@
package cn.iocoder.yudao.framework.quartz.core.job;
import cn.iocoder.yudao.framework.quartz.core.handler.JobHandler;
import cn.iocoder.yudao.framework.quartz.core.service.JobLogFrameworkService;
import lombok.AllArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import javax.annotation.Resource;
/**
* @Author: j-sentinel
* @Date: 2023/9/30 20:40
*/
@Slf4j
@AllArgsConstructor
public class JobLogJobHandler implements JobHandler {
private LogJobProperties logJobProperties;
public JobLogJobHandler(LogJobProperties logJobProperties) {
this.logJobProperties = logJobProperties;
}
@Resource
private JobLogFrameworkService jobLogFrameworkService;
@Override
public String execute(String param) throws Exception {
Integer integer = jobLogFrameworkService.timingJobCleanLog(logJobProperties.getJobCleanRetainDay());
log.info("定时执行清理定时任务日志数量({})个",integer);
return String.format("定时执行清理定时任务日志数量 %s 个", integer);
}
}

20
yudao-framework/yudao-spring-boot-starter-job/src/main/java/cn/iocoder/yudao/framework/quartz/core/job/LogJobProperties.java Normal file
View File

@ -0,0 +1,20 @@
package cn.iocoder.yudao.framework.quartz.core.job;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* @Author: j-sentinel
* @Date: 2023/9/30 16:17
*/
@Data
@ConfigurationProperties(prefix = "yudao.clean-job")
public class LogJobProperties {
private int accessRetainDay = 7;
private int errorRetainDay = 8;
private int jobCleanRetainDay = 7;
}

6
yudao-framework/yudao-spring-boot-starter-job/src/main/java/cn/iocoder/yudao/framework/quartz/core/service/JobLogFrameworkService.java
View File

@ -41,4 +41,10 @@ public interface JobLogFrameworkService {
@NotNull(message = "运行时长不能为空") Integer duration,
boolean success, String result);
/**
* 清理 @param jobCleanRetainDay 天的访问日志
*
* @param jobCleanRetainDay 超过多少天就进行清理
*/
Integer timingJobCleanLog(Integer jobCleanRetainDay);
}

6
yudao-framework/yudao-spring-boot-starter-web/pom.xml
View File

@ -61,6 +61,12 @@
<artifactId>jsoup</artifactId>
</dependency>
<!-- Job 定时任务相关 -->
<dependency>
<groupId>cn.iocoder.boot</groupId>
<artifactId>yudao-spring-boot-starter-job</artifactId>
</dependency>
</dependencies>
</project>

13
yudao-framework/yudao-spring-boot-starter-web/src/main/java/cn/iocoder/yudao/framework/apilog/config/YudaoApiLogAutoConfiguration.java
View File

@ -1,11 +1,14 @@
package cn.iocoder.yudao.framework.apilog.config;
import cn.iocoder.yudao.framework.apilog.core.filter.ApiAccessLogFilter;
import cn.iocoder.yudao.framework.apilog.core.job.ApiAccessLogJobHandler;
import cn.iocoder.yudao.framework.apilog.core.job.ApiErrorLogJobHandler;
import cn.iocoder.yudao.framework.apilog.core.service.ApiAccessLogFrameworkService;
import cn.iocoder.yudao.framework.apilog.core.service.ApiAccessLogFrameworkServiceImpl;
import cn.iocoder.yudao.framework.apilog.core.service.ApiErrorLogFrameworkService;
import cn.iocoder.yudao.framework.apilog.core.service.ApiErrorLogFrameworkServiceImpl;
import cn.iocoder.yudao.framework.common.enums.WebFilterOrderEnum;
import cn.iocoder.yudao.framework.quartz.core.job.LogJobProperties;
import cn.iocoder.yudao.framework.web.config.WebProperties;
import cn.iocoder.yudao.framework.web.config.YudaoWebAutoConfiguration;
import cn.iocoder.yudao.module.infra.api.logger.ApiAccessLogApi;
@ -31,6 +34,16 @@ public class YudaoApiLogAutoConfiguration {
return new ApiErrorLogFrameworkServiceImpl(apiErrorLogApi);
}
@Bean
public ApiAccessLogJobHandler apiAccessLogJobHandler(LogJobProperties logJobProperties) {
return new ApiAccessLogJobHandler(logJobProperties);
}
@Bean
public ApiErrorLogJobHandler apiErrorLogJobHandler(LogJobProperties logJobProperties) {
return new ApiErrorLogJobHandler(logJobProperties);
}
/**
* 创建 ApiAccessLogFilter Bean，记录 API 请求日志
*/

34
yudao-framework/yudao-spring-boot-starter-web/src/main/java/cn/iocoder/yudao/framework/apilog/core/job/ApiAccessLogJobHandler.java Normal file
View File

@ -0,0 +1,34 @@
package cn.iocoder.yudao.framework.apilog.core.job;
import cn.iocoder.yudao.framework.apilog.core.service.ApiAccessLogFrameworkService;
import cn.iocoder.yudao.framework.quartz.core.handler.JobHandler;
import cn.iocoder.yudao.framework.quartz.core.job.LogJobProperties;
import lombok.AllArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import javax.annotation.Resource;
/**
* @Author: j-sentinel
* @Date: 2023/9/30 16:13
*/
@Slf4j
@AllArgsConstructor
public class ApiAccessLogJobHandler implements JobHandler {
private LogJobProperties logJobProperties;
public ApiAccessLogJobHandler(LogJobProperties logJobProperties) {
this.logJobProperties = logJobProperties;
}
@Resource
private ApiAccessLogFrameworkService apiAccessLogFrameworkService;
@Override
public String execute(String param) throws Exception {
apiAccessLogFrameworkService.jobCleanAccessLog(logJobProperties.getAccessRetainDay());
return "";
}
}

34
yudao-framework/yudao-spring-boot-starter-web/src/main/java/cn/iocoder/yudao/framework/apilog/core/job/ApiErrorLogJobHandler.java Normal file
View File

@ -0,0 +1,34 @@
package cn.iocoder.yudao.framework.apilog.core.job;
import cn.iocoder.yudao.framework.apilog.core.service.ApiErrorLogFrameworkService;
import cn.iocoder.yudao.framework.quartz.core.handler.JobHandler;
import cn.iocoder.yudao.framework.quartz.core.job.LogJobProperties;
import lombok.AllArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import javax.annotation.Resource;
/**
* @Author: j-sentinel
* @Date: 2023/9/30 16:13
*/
@Slf4j
@AllArgsConstructor
public class ApiErrorLogJobHandler implements JobHandler {
private LogJobProperties logJobProperties;
public ApiErrorLogJobHandler(LogJobProperties logJobProperties) {
this.logJobProperties = logJobProperties;
}
@Resource
private ApiErrorLogFrameworkService apiErrorLogFrameworkService;
@Override
public String execute(String param) throws Exception {
apiErrorLogFrameworkService.jobCleanErrorLog(logJobProperties.getErrorRetainDay());
return "";
}
}

6
yudao-framework/yudao-spring-boot-starter-web/src/main/java/cn/iocoder/yudao/framework/apilog/core/service/ApiAccessLogFrameworkService.java
View File

@ -14,4 +14,10 @@ public interface ApiAccessLogFrameworkService {
*/
void createApiAccessLog(ApiAccessLog apiAccessLog);
/**
* 清理 @param accessLogJobDay 天的访问日志
*
* @param accessLogJobDay 超过多少天就进行清理
*/
void jobCleanAccessLog(Integer accessLogJobDay);
}

5
yudao-framework/yudao-spring-boot-starter-web/src/main/java/cn/iocoder/yudao/framework/apilog/core/service/ApiAccessLogFrameworkServiceImpl.java
View File

@ -25,4 +25,9 @@ public class ApiAccessLogFrameworkServiceImpl implements ApiAccessLogFrameworkSe
apiAccessLogApi.createApiAccessLog(reqDTO);
}
@Override
public void jobCleanAccessLog(Integer accessLogJobDay) {
apiAccessLogApi.jobCleanAccessLog(accessLogJobDay);
}
}

6
yudao-framework/yudao-spring-boot-starter-web/src/main/java/cn/iocoder/yudao/framework/apilog/core/service/ApiErrorLogFrameworkService.java
View File

@ -14,4 +14,10 @@ public interface ApiErrorLogFrameworkService {
*/
void createApiErrorLog(ApiErrorLog apiErrorLog);
/**
* 清理 @param errorLogJobDay 天的访问日志
*
* @param errorLogJobDay 超过多少天就进行清理
*/
void jobCleanErrorLog(Integer errorLogJobDay);
}

5
yudao-framework/yudao-spring-boot-starter-web/src/main/java/cn/iocoder/yudao/framework/apilog/core/service/ApiErrorLogFrameworkServiceImpl.java
View File

@ -25,4 +25,9 @@ public class ApiErrorLogFrameworkServiceImpl implements ApiErrorLogFrameworkServ
apiErrorLogApi.createApiErrorLog(reqDTO);
}
@Override
public void jobCleanErrorLog(Integer errorLogJobDay) {
apiErrorLogApi.jobCleanErrorLog(errorLogJobDay);
}
}