跳到主要内容
版本:Next

Epoch Framework 技术支持清单

项目分支介绍

分支描述
master

本文用于说明当前仓库已落地并在 starter 中提供自动装配的能力范围,以及对应的关键配置入口。

总览

领域模块支持的技术/能力关键开关/前缀备注
消息framework-starter-messageRedis Pub/Sub;Redis Streams;RocketMQ v5app.mq.type / app.mq.*不支持 RabbitMQ(已移除);消费侧统一 MessageDTO
定时任务framework-starter-jobNative(TaskScheduler);Quartz(memory/database);XXL-JOBapp.job.*仅启用 native 时会禁止 Quartz 自动启动
通知-邮件framework-starter-notifySMTP;WeCom;异步 THREAD_POOL/MESSAGEapp.email.*发送入参使用 EmailSendDTO.accountId 查询账号配置
通知-短信framework-starter-notify阿里云短信;验证码生成/校验app.sms.*
Redis 基础framework-starter-redisRedisTemplate/StringRedisTemplate 自动装配spring.data.redis.*默认序列化策略
MyBatisframework-starter-mybatisMyBatis/MyBatis-Plus 通用配置mybatis*字段填充/ID 生成等通用能力
WebSocketframework-starter-websocketWebSocket 自动装配websocket.*
监控链路framework-starter-monitorTracer/Metrics/API Log见模块配置
幂等framework-starter-idempotent重复提交拦截(注解 + AOP)见模块配置

配置明细

消息(framework-starter-message)

目的配置项示例/取值说明
选择消息实现app.mq.typeREDIS / REDIS_STREAM / ROCKETMQ决定加载哪种消息实现(自动装配开关)
Redis 配置app.mq.redis.*见各项目实际配置Redis Pub/Sub 与 Streams 的通道/Stream/消费组/重试等参数
RocketMQ 配置app.mq.rocket.*endpointstopicconsumer-groupRocketMQ v5 endpoints、默认 topic、consumerGroup、ACL/namespace 等
消息体协议MessageDTOcontent/tag消费侧统一反序列化为 MessageDTOtag 用于过滤/路由

定时任务(framework-starter-job)

能力配置项示例/取值说明
Native 任务app.job.native-enabledtrue/false是否启用 Spring 原生任务(TaskScheduler 动态调度)
Native 线程池app.job.native-config.*thread-pool-sizethread-name-prefix原生任务 TaskScheduler 线程池参数
Quartz 总开关app.job.quartz-enabledtrue/false是否启用 Quartz
Quartz 模式app.job.quartz-modememory / database选择 Quartz 存储模式;不配置则不启用 Quartz
XXL-JOB 总开关app.job.xxl-job-enabledtrue/false是否启用 XXL-JOB
XXL-JOB 配置app.job.xxl-job.*admin-addressesappnameaccess-tokenXXL-JOB 执行器接入参数

通知-邮件(framework-starter-notify)

目的配置项示例/取值说明
平台选择app.email.default-platformSMTP / WECOM默认邮件平台
SMTP 配置app.email.smtp.*hostportusernamepasswordSMTP 发送参数(可结合 accountId 动态覆盖)
WeCom 配置app.email.wecom.*corpidcorpsecretagentid企业微信邮箱发送参数(可结合 accountId 动态覆盖)
异步模式app.email.async.modeTHREAD_POOL / MESSAGE线程池异步或投递到消息系统(MessageSender)
动态账号EmailSendDTO.accountId123发送时通过 EmailAccountApi 查询账号配置并应用

通知-短信(framework-starter-notify)

目的配置项示例/取值说明
短信平台app.sms.*见各项目实际配置短信发送与验证码相关配置入口
阿里云短信app.sms.platforms.aliyun.*access-key-idaccess-key-secret阿里云短信平台参数(以实际属性为准)

Redis 基础(framework-starter-redis)

目的配置项示例/取值说明
Redis 连接spring.data.redis.*hostportpasswordSpring Data Redis 标准连接参数

MyBatis(framework-starter-mybatis)

目的配置项示例/取值说明
MyBatis/MyBatis-Plusmybatis* / mybatis-plus*见各项目实际配置数据源与 MyBatis 相关配置(以项目实际为准)

WebSocket(framework-starter-websocket)

目的配置项示例/取值说明
WebSocketwebsocket.*见各项目实际配置WebSocket 自动装配相关配置(以模块属性为准)

监控链路(framework-starter-monitor)

目的配置项示例/取值说明
Tracer/Metrics/API Log见模块配置framework-starter-monitor 模块文档与属性类为准

幂等(framework-starter-idempotent)

目的配置项示例/取值说明
重复提交拦截见模块配置framework-starter-idempotent 模块文档与注解为准