仅涉及后端,全部目录看顶部专栏,代码、文档、接口路径在:
【Lilishop商城】记录一下B2B2C商城系统学习笔记~_清晨敲代码的博客-CSDN博客
全篇只介绍重点架构逻辑,具体编写看源代码就行,读起来也不复杂~
谨慎:源代码中有一些注释是错误的,有的注释意思完全相反,有的注释对不上号,我在阅读过程中就顺手更新了,并且在我不会的地方添加了新的注释,所以在读源代码过程中一定要谨慎啊!
目录
xxl-job的简单介绍和使用:xxl-job快速入门指南-CSDN博客_xxljob入门
详细使用看这个:xxl-job详细使用指南-CSDN博客_xxl-job
重点就是两个概念:调度模块(调度中心)、执行模块(执行器);
调度模块重点就是负责管理调度信息的,有可视化平台,可以添加定时任务去执行,本身不含业务信息。
执行模块就是需要开发人员集成xxl-job模块,开发执行器业务即可。
开始之前先说一下,调度模块的启动看上面文章这里就不介绍了,本来可以直接使用shop提供的xxl-jod里面的jar,但是启动时一直报错,这个错误又没法处理,所以直接下载了对应版本的源码包运行的~
Error: Invalid or corrupt jarfile /Users/hebrf/Desktop/projects/project/lilishop-master/xxl-job/xxl-job-admin-2.3.0-SNAPSHOT.jar
shop项目是直接在 consumer 模块添加定时任务的,我们在上一篇消息中间件里面也是新建了 consumer 模块,现在就可以直接加在里面的 timetask 业务就好。
先添加依赖,由于之后的这里也会有很多业务逻辑,所以直接依赖 framework 就可以。
- /lilishop-master/consumer/pom.xml
-
- <dependencies>
- <dependency>
- <groupId>com.xuxueligroupId>
- <artifactId>xxl-job-coreartifactId>
- <version>${xxl-job}version>
- dependency>
- dependencies>
然后在resource的配置文件application.xml中设置配置信息,设置调度中心接口等信息
- # /lilishop-master/consumer/src/main/resources/application.yml
-
- xxl:
- job:
- admin:
- # 调度中心的部署地址。若调度中心采用集群部署,存在多个地址,则用逗号分隔。执行器将会使用该地址进行”执行器心跳注册”和”任务结果回调”。
- addresses: http://127.0.0.1:9001/xxl-job-admin
- executor:
- # 执行器的应用名称,它是执行器心跳注册的分组依据。
- appname: xxl-job-executor-lilishop
- address:
- # 执行器的IP地址,用于”调度中心请求并触发任务”和”执行器注册”。执行器IP默认为空,表示自动获取IP。多网卡时可手动设置指定IP,手动设置IP时将会绑定Host。
- ip:
- # 执行器的端口号,默认值为9999。单机部署多个执行器时,注意要配置不同的执行器端口。
- port: 8891
- # 日志存放路径
- logpath: ./xxl-job/executor
- # 执行器日志文件的定期清理功能,指定日志保存天数,日志文件过期自动删除。限制至少保存3天,否则功能不生效。
- logretentiondays: 7
然后配置执行器对象
- //详见: cn.lili.timetask.config.XxlJobConfig
-
- @Configuration
- public class XxlJobConfig {
- private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
-
- @Value("${xxl.job.admin.addresses}")
- private String adminAddresses;
-
- @Value("${xxl.job.accessToken}")
- private String accessToken;
-
- @Value("${xxl.job.executor.appname}")
- private String appname;
-
- @Value("${xxl.job.executor.address}")
- private String address;
-
- @Value("${xxl.job.executor.ip}")
- private String ip;
-
- @Value("${xxl.job.executor.port}")
- private int port;
-
- @Value("${xxl.job.executor.logpath}")
- private String logPath;
-
- @Value("${xxl.job.executor.logretentiondays}")
- private int logRetentionDays;
-
-
- @Bean
- public XxlJobSpringExecutor xxlJobExecutor() {
- logger.info(">>>>>>>>>>> xxl-job config init.");
- XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
- xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
- xxlJobSpringExecutor.setAppname(appname);
- xxlJobSpringExecutor.setAddress(address);
- xxlJobSpringExecutor.setIp(ip);
- xxlJobSpringExecutor.setPort(port);
- xxlJobSpringExecutor.setAccessToken(accessToken);
- xxlJobSpringExecutor.setLogPath(logPath);
- xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
-
- return xxlJobSpringExecutor;
- }
-
- }
执行器添加之后,然后就可以添加执行的业务了,也就是任务。
我们可以看到shop里面的任务一共就三个 everyMinuteExecute 、everyHourExecuteJobHandler 、everyDayExecuteJobHandler ,分别是每分钟、每小时、每天执行定时任务。在shop项目的业务中,只会用到这三种定时任务,所以只添加三种任务就可以。
而每个任务里面会对应多个小业务的,我们不能直接将业务写在任务里面,耦合度高且代码又难读。所以就给每类任务添加了任务执行(就是业务)抽象接口, 每新增一个业务就实现对应的接口并创建bean,然后在任务处理类中注入抽象接口的List,那么任务方法执行时,会从list里面获取到业务,拿到就for循环执行业务~
接下来就开始写任务和业务啦
- //给每类任务添加了任务执行(就是业务)抽象接口,就拿每分钟举例啦
- //详见:cn.lili.timetask.handler.EveryMinuteExecute
-
- public interface EveryMinuteExecute {
- /**
- * 执行
- */
- void execute();
- }
- //添加任务执行(业务)实现类,我们加上两个实现类来进行测试
- //(这里注意,由于我不能在consumer模块中直接加,所以新创建了个consumer-test-xxl-job模块,定时任务都是在这个模块里面测试的,看代码的时候注意啊)
- //详见:cn.lili.timetask.handle.impl.TestMinuteExecute1
- //详见:cn.lili.timetask.handle.impl.TestMinuteExecute2
-
- @Component
- @Slf4j
- public class TestMinuteExecute1 implements EveryMinuteExecute {
- @Override
- public void execute() {
- XxlJobHelper.log("TestMinuteExecute1");
- log.info("每分钟子任务执行:TestMinuteExecute1");
- }
- }
- //添加任务类
- //详见:cn.lili.timetask.TimedTaskJobHandler
-
- @Slf4j
- @Component
- public class TimedTaskJobHandler {
-
- /**
- * @Description: 将相同任务的业务放到一起执行
- **/
- @Autowired(required = false)
- private List
everyMinuteExecutes; -
- /**
- * 每分钟任务
- *
- * @throws Exception
- */
- @XxlJob("everyMinuteExecute")
- public ReturnT
everyMinuteExecute(String param) { - log.info("每分钟任务执行");
- if (everyMinuteExecutes == null || everyMinuteExecutes.size() == 0) {
- return ReturnT.SUCCESS;
- }
-
- for (int i = 0; i < everyMinuteExecutes.size(); i++) {
- try {
- everyMinuteExecutes.get(i).execute();
- } catch (Exception e) {
- log.error("每分钟任务异常", e);
- }
- }
- return ReturnT.SUCCESS;
- }
- }
运行consumer模块前,先打开任务调度平台,添加一个执行器,此时执行器是没有OnLine 机器的
然后启动consumer模块,然后就可以看到有OnLine 机器啦
此时任务还不会执行,因为我们还没有添加任务,我们现在去添加任务,添加完成后记得启动任务,然后就可以看到任务执行啦
定时任务添加完毕