# tasklet-back **Repository Path**: feng-kailong/tasklet-back ## Basic Information - **Project Name**: tasklet-back - **Description**: 定时任务调度平台-后端代码 - **Primary Language**: Java - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 2 - **Forks**: 0 - **Created**: 2025-10-12 - **Last Updated**: 2025-12-02 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Tasklet - 定时任务调度平台 Tasklet 是一个功能强大、高度可定制的分布式定时任务调度平台,采用 Spring Boot 3.2.0 构建,支持多种存储、缓存和消息队列的灵活配置,满足不同场景下的部署需求。 ## 📋 目录 - [项目简介](#项目简介) - [技术栈](#技术栈) - [核心特性](#核心特性) - [项目结构](#项目结构) - [配置说明](#配置说明) - [快速开始](#快速开始) - [主要功能模块](#主要功能模块) - [API 文档](#api-文档) - [开发说明](#开发说明) ## 🎯 项目简介 Tasklet 是一个企业级的定时任务调度平台,提供任务注册、调度、执行、监控等完整的任务管理功能。平台采用模块化设计,支持多种技术栈的灵活切换,可根据实际环境选择最适合的存储、缓存和消息队列方案。 ## 🛠 技术栈 - **框架**: Spring Boot 3.2.0 - **Java 版本**: JDK 17 - **ORM**: MyBatis Plus 3.5.14 - **认证**: Sa-Token 1.44.0 - **文档**: SpringDoc OpenAPI (Swagger) - **任务调度**: Quartz 2.5.0 - **工具库**: Hutool 5.8.40, FastJSON2 2.0.52, EasyExcel 4.0.3 - **其他**: WebSocket, Thymeleaf, OkHttp ## ✨ 核心特性 ### 1. 高度定制化的组件配置 #### 数据库支持 - **MySQL**: 生产环境推荐,支持完整的数据库功能 - **H2**: 内存数据库,无需外部依赖,适合开发测试环境 #### 缓存支持 - **Redis**: 分布式缓存,支持集群部署 - **Memory (Caffeine)**: 本地内存缓存,无需外部依赖 #### 存储支持 - **MinIO**: 对象存储服务,支持分布式文件存储 - **Local**: 本地文件存储,无需外部依赖 #### 消息队列支持 - **RabbitMQ**: 企业级消息队列,支持复杂的路由规则 - **Redis**: 基于 Redis 的轻量级消息队列 - **Local**: 本地内存队列(LinkedBlockingQueue),无需外部依赖 ### 2. 任务调度功能 - **任务类型**: - 自动注册:执行器自动注册任务到调度中心 - 手动创建:通过界面手动创建和配置任务 - Glue 脚本:支持动态脚本任务(支持多种脚本类型) - **路由策略**: - FIRST(第一个) - LAST(最后一个) - ROUND(轮询) - RANDOM(随机) - CONSISTENT_HASH(一致性HASH) - LEAST_FREQUENTLY_USED(最不经常使用) - LEAST_RECENTLY_USED(最近最久未使用) - FAILOVER(故障转移) - BUSYOVER(忙碌转移) - SHARDING_BROADCAST(分片广播) - **阻塞处理策略**: 支持多种阻塞处理方式 - **任务超时控制**: 可配置任务执行超时时间 - **任务重试**: 支持失败任务自动重试 - **子任务支持**: 支持任务依赖和子任务链 ### 3. 消息队列管理 - 支持 Exchange、Queue、Binding 的完整管理 - 消息持久化配置 - 消息列表查询和监控 - 支持多种 Exchange 类型(Direct、Topic、Fanout 等) ### 4. 通知系统 - **通知方式**: - 邮件通知 - 短信通知(阿里云) - 钉钉通知 - 微信通知 - **通知场景**: 支持任务执行成功、失败等多种场景的通知配置 ### 5. 认证授权 - 基于 Sa-Token 的认证体系 - 支持多组织架构 - 用户权限管理 - Token 存储支持 Redis 和内存两种方式 ## 📁 项目结构 ``` tasklet-back/ ├── src/main/java/com/fkl/tasklet/ │ ├── auth/ # 认证授权模块 │ │ ├── api/ # API 接口定义 │ │ ├── application/ # 应用服务层 │ │ ├── domain/ # 领域模型 │ │ ├── infrastructure/ # 基础设施层 │ │ └── interfaces/ # 接口层(Controller) │ ├── job/ # 任务调度模块 │ │ ├── api/ # API 接口定义 │ │ ├── application/ # 应用服务层 │ │ ├── domain/ # 领域模型 │ │ ├── infrastructure/ # 基础设施层 │ │ └── interfaces/ # 接口层(Controller、WebSocket) │ ├── message/ # 消息队列模块 │ │ ├── api/ # API 接口定义 │ │ ├── application/ # 应用服务层 │ │ ├── domain/ # 领域模型 │ │ ├── infrastructure/ # 基础设施层 │ │ └── interfaces/ # 接口层(Controller) │ ├── notice/ # 通知模块 │ │ ├── api/ # API 接口定义 │ │ ├── application/ # 应用服务层 │ │ ├── domain/ # 领域模型 │ │ ├── infrastructure/ # 基础设施层 │ │ └── interfaces/ # 接口层(Controller) │ ├── common/ # 公共模块 │ │ ├── config/ # 配置类(数据库、缓存、存储等) │ │ ├── entity/ # 公共实体 │ │ ├── enums/ # 枚举类 │ │ ├── exception/ # 异常处理 │ │ ├── response/ # 响应封装 │ │ └── utils/ # 工具类 │ └── TaskletApplication.java # 启动类 ├── src/main/resources/ │ ├── application.yml # 配置文件 │ ├── mapper/ # MyBatis Mapper XML │ └── templates/ # 模板文件 └── pom.xml # Maven 配置 ``` ## ⚙️ 配置说明 ### 核心配置项 在 `application.yml` 中,通过 `tasklet` 命名空间下的配置项控制各组件的选择: ```yaml tasklet: db-type: mysql # 数据库类型: h2 | mysql cache-type: redis # 缓存类型: memory | redis storage-type: local # 存储类型: local | minio mq: type: redis # 消息队列类型: local | redis | rabbitmq persistence: true # 是否持久化消息队列配置 time-zone: Asia/Shanghai # 时区配置(执行器和调度中心需一致) ``` ### 数据库配置 #### MySQL 配置 ```yaml datasource: mysql: url: jdbc:mysql://192.168.146.147:3306/tasklet?useSSL=false&serverTimezone=UTC&allowPublicKeyRetrieval=true driver-class-name: com.mysql.cj.jdbc.Driver username: root password: your_password ``` #### H2 配置(无需外部依赖) ```yaml datasource: h2: url: jdbc:h2:mem:tasklet driver-class-name: org.h2.Driver username: root password: your_password ``` ### 缓存配置 #### Redis 配置 ```yaml spring: data: redis: host: 192.168.146.147 port: 6379 timeout: 10000ms lettuce: pool: max-active: 20 max-idle: 10 min-idle: 2 ``` #### Memory 缓存(无需配置,自动使用 Caffeine) ### 存储配置 #### MinIO 配置 ```yaml storage: endpoint: http://192.168.146.147:9000 fileHost: http://192.168.146.147:9000 accessKey: your_access_key secretKey: your_secret_key dirName: tasklet resourceHandler: /tasklet/local/storage resourceUrl: http://localhost:9090/tasklet/local/storage/ ``` #### Local 存储(无需外部依赖,使用本地文件系统) ### 消息队列配置 #### RabbitMQ 配置 ```yaml spring: rabbitmq: host: 192.168.146.147 username: guest password: guest virtual-host: / port: 5672 http-port: 15672 ``` #### Redis 消息队列(使用 Redis 配置) #### Local 消息队列(无需外部依赖,使用 LinkedBlockingQueue) ### 邮件配置 ```yaml spring: mail: host: smtp.163.com port: 465 username: your_email@163.com password: your_authorization_code protocol: smtp properties: mail: smtp: auth: true ssl: enable: true ``` ### Sa-Token 配置 ```yaml sa-token: token-name: tasklet timeout: 86400 # Token 有效期(秒) active-timeout: 7200 # Token 活跃有效期(秒) is-concurrent: false is-share: false token-style: uuid is-log: true ``` ## 🚀 快速开始 ### 环境要求 - JDK 17+ - Maven 3.6+ - MySQL 8.0+ 或 H2(开发环境) - Redis(可选,如果使用 Redis 缓存或消息队列) - RabbitMQ(可选,如果使用 RabbitMQ 消息队列) - MinIO(可选,如果使用 MinIO 存储) ### 最小化部署(无需外部依赖) 对于开发测试环境,可以配置为完全无需外部依赖的模式: ```yaml tasklet: db-type: h2 # 使用 H2 内存数据库 cache-type: memory # 使用内存缓存 storage-type: local # 使用本地存储 mq: type: local # 使用本地内存队列 persistence: false # 不持久化 ``` ### 安装步骤 1. **克隆项目** ```bash git clone cd tasklet-back ``` 2. **配置数据库** 如果使用 MySQL,需要先创建数据库: ```sql CREATE DATABASE tasklet DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci; ``` 然后导入 SQL 脚本: ```bash mysql -u root -p tasklet < tasklet.sql ``` 3. **修改配置文件** 根据实际环境修改 `src/main/resources/application.yml` 中的配置项。 4. **编译运行** ```bash mvn clean package java -jar target/tasklet-back-1.0-SNAPSHOT.jar ``` 5. **访问应用** - 应用地址: http://localhost:9090 - API 文档: http://localhost:9090/swagger-ui.html ## 📦 主要功能模块 ### 1. 认证授权模块 (auth) - 用户登录/登出 - 用户管理(CRUD) - 组织管理 - 权限控制 - 仪表盘统计 ### 2. 任务调度模块 (job) - **项目管理**: 项目组、项目的创建和管理 - **执行器管理**: 执行器的注册、心跳、状态监控 - **任务管理**: - 任务创建(自动注册、手动创建、Glue 脚本) - 任务编辑和删除 - 任务启用/停用 - Cron 表达式配置 - 任务参数配置(初始化、前置、执行、后置、销毁参数) - **任务执行**: - 任务触发和执行 - 执行日志查看 - 执行历史记录 - WebSocket 实时日志推送 - **任务监控**: - 任务执行统计 - 任务状态监控 - 执行器状态监控 ### 3. 消息队列模块 (message) - **Exchange 管理**: 创建、删除、查询 Exchange - **Queue 管理**: 创建、删除、查询 Queue - **Binding 管理**: Exchange 和 Queue 的绑定关系 - **消息管理**: - 消息发送 - 消息列表查询 - 消息监控 - **消息持久化**: 支持消息队列配置的持久化存储 ### 4. 通知模块 (notice) - **通知配置**: 创建和管理通知配置 - **通知方式**: 支持邮件、短信、钉钉、微信等多种通知方式 - **通知场景**: 支持任务执行成功、失败等场景的通知 - **通知记录**: 通知发送历史记录查询 ## 📚 API 文档 项目集成了 SpringDoc OpenAPI,启动应用后可通过以下地址访问 API 文档: - Swagger UI: http://localhost:9090/swagger-ui.html - OpenAPI JSON: http://localhost:9090/v3/api-docs ## 💻 开发说明 ### 架构设计 项目采用 DDD(领域驱动设计)分层架构: - **api**: 接口定义层,定义 Facade 接口和 DTO - **application**: 应用服务层,处理业务逻辑 - **domain**: 领域模型层,包含实体、值对象、领域服务 - **infrastructure**: 基础设施层,包含数据访问、外部服务调用 - **interfaces**: 接口层,包含 Controller、WebSocket 等 ### 定制化组件实现 项目通过策略模式和条件注解实现了各组件的灵活切换: - **数据库**: `@ConditionalOnProperty` 根据 `tasklet.db-type` 选择数据源 - **缓存**: `CacheValueClient` 接口,提供 `RedisCacheValueClient` 和 `InMemoryCacheValueClient` 实现 - **存储**: `StorageClient` 接口,提供 `MinioStorageClient` 和 `LocalStorageClient` 实现 - **消息队列**: `MqClient` 接口,提供 `RabbitMqClient`、`RedisMqClient` 和 `LocalMqClient` 实现 ### 时区配置 **重要**: 执行器和调度中心的时区配置必须一致,否则会导致任务调度时间不准确。 ```yaml tasklet: time-zone: Asia/Shanghai # 执行器和调度中心需保持一致 ``` ### 数据库初始化 项目提供了完整的 SQL 脚本 `tasklet.sql`,包含以下表结构: - `auth_organizations`: 组织表 - `auth_users`: 用户表 - `job_project_groups`: 项目组表 - `job_projects`: 项目表 - `job_executors`: 执行器表 - `job_scheduled`: 定时任务表 - `job_log`: 任务执行日志表 - `message_exchange`: 消息交换机表 - `message_queue`: 消息队列表 - `message_bind`: 消息绑定表 - `message_content`: 消息内容表 - `notice_config`: 通知配置表 - `notice_record`: 通知记录表 ## 📝 许可证 [根据实际情况填写] ## 👥 贡献 欢迎提交 Issue 和 Pull Request! ## 📧 联系方式 [根据实际情况填写]