Epoch Framework 技术支持清单
项目分支介绍
| 分支 | 描述 |
|---|---|
| master |
本文用于说明当前仓库已落地并在 starter 中提供自动装配的能力范围,以及对应的关键配置入口。
总览
| 领域 | 模块 | 支持的技术/能力 | 关键开关/前缀 | 备注 |
|---|---|---|---|---|
| 消息 | framework-starter-message | Redis Pub/Sub;Redis Streams;RocketMQ v5 | app.mq.type / app.mq.* | 不支持 RabbitMQ(已移除);消费侧统一 MessageDTO |
| 定时任务 | framework-starter-job | Native(TaskScheduler);Quartz(memory/database);XXL-JOB | app.job.* | 仅启用 native 时会禁止 Quartz 自动启动 |
| 通知-邮件 | framework-starter-notify | SMTP;WeCom;异步 THREAD_POOL/MESSAGE | app.email.* | 发送入参使用 EmailSendDTO.accountId 查询账号配置 |
| 通知-短信 | framework-starter-notify | 阿里云短信;验证码生成/校验 | app.sms.* | |
| Redis 基础 | framework-starter-redis | RedisTemplate/StringRedisTemplate 自动装配 | spring.data.redis.* | 默认序列化策略 |
| MyBatis | framework-starter-mybatis | MyBatis/MyBatis-Plus 通用配置 | mybatis* | 字段填充/ID 生成等通用能力 |
| WebSocket | framework-starter-websocket | WebSocket 自动装配 | websocket.* | |
| 监控链路 | framework-starter-monitor | Tracer/Metrics/API Log | 见模块配置 | |
| 幂等 | framework-starter-idempotent | 重复提交拦截(注解 + AOP) | 见模块配置 |
配置明细
消息(framework-starter-message)
| 目的 | 配置项 | 示例/取值 | 说明 |
|---|---|---|---|
| 选择消息实现 | app.mq.type | REDIS / REDIS_STREAM / ROCKETMQ | 决定加载哪种消息实现(自动装配开关) |
| Redis 配置 | app.mq.redis.* | 见各项目实际配置 | Redis Pub/Sub 与 Streams 的通道/Stream/消费组/重试等参数 |
| RocketMQ 配置 | app.mq.rocket.* | endpoints、topic、consumer-group | RocketMQ v5 endpoints、默认 topic、consumerGroup、ACL/namespace 等 |
| 消息体协议 | MessageDTO | content/tag | 消费侧统一反序列化为 MessageDTO;tag 用于过滤/路由 |
定时任务(framework-starter-job)
| 能力 | 配置项 | 示例/取值 | 说明 |
|---|---|---|---|
| Native 任务 | app.job.native-enabled | true/false | 是否启用 Spring 原生任务(TaskScheduler 动态调度) |
| Native 线程池 | app.job.native-config.* | thread-pool-size、thread-name-prefix | 原生任务 TaskScheduler 线程池参数 |
| Quartz 总开关 | app.job.quartz-enabled | true/false | 是否启用 Quartz |
| Quartz 模式 | app.job.quartz-mode | memory / database | 选择 Quartz 存储模式;不配置则不启用 Quartz |
| XXL-JOB 总开关 | app.job.xxl-job-enabled | true/false | 是否启用 XXL-JOB |
| XXL-JOB 配置 | app.job.xxl-job.* | admin-addresses、appname、access-token | XXL-JOB 执行器接入参数 |
通知-邮件(framework-starter-notify)
| 目的 | 配置项 | 示例/取值 | 说明 |
|---|---|---|---|
| 平台选择 | app.email.default-platform | SMTP / WECOM | 默认邮件平台 |
| SMTP 配置 | app.email.smtp.* | host、port、username、password | SMTP 发送参数(可结合 accountId 动态覆盖) |
| WeCom 配置 | app.email.wecom.* | corpid、corpsecret、agentid | 企业微信邮箱发送参数(可结合 accountId 动态覆盖) |
| 异步模式 | app.email.async.mode | THREAD_POOL / MESSAGE | 线程池异步或投递到消息系统(MessageSender) |
| 动态账号 | EmailSendDTO.accountId | 123 | 发送时通过 EmailAccountApi 查询账号配置并应用 |
通知-短信(framework-starter-notify)
| 目的 | 配置项 | 示例/取值 | 说明 |
|---|---|---|---|
| 短信平台 | app.sms.* | 见各项目实际配置 | 短信发送与验证码相关配置入口 |
| 阿里云短信 | app.sms.platforms.aliyun.* | access-key-id、access-key-secret | 阿里云短信平台参数(以实际属性为准) |
Redis 基础(framework-starter-redis)
| 目的 | 配置项 | 示例/取值 | 说明 |
|---|---|---|---|
| Redis 连接 | spring.data.redis.* | host、port、password | Spring Data Redis 标准连接参数 |
MyBatis(framework-starter-mybatis)
| 目的 | 配置项 | 示例/取值 | 说明 |
|---|---|---|---|
| MyBatis/MyBatis-Plus | mybatis* / mybatis-plus* | 见各项目实际配置 | 数据源与 MyBatis 相关配置(以项目实际为准) |
WebSocket(framework-starter-websocket)
| 目的 | 配置项 | 示例/取值 | 说明 |
|---|---|---|---|
| WebSocket | websocket.* | 见各项目实际配置 | WebSocket 自动装配相关配置(以模块属性为准) |
监控链路(framework-starter-monitor)
| 目的 | 配置项 | 示例/取值 | 说明 |
|---|---|---|---|
| Tracer/Metrics/API Log | 见模块配置 | 以 framework-starter-monitor 模块文档与属性类为准 |
幂等(framework-starter-idempotent)
| 目的 | 配置项 | 示例/取值 | 说明 |
|---|---|---|---|
| 重复提交拦截 | 见模块配置 | 以 framework-starter-idempotent 模块文档与注解为准 |