FreeKit Pro Modules
基于 .NET 10 的模块化 DDD 方案,文档以当前仓库代码为准,覆盖默认宿主、模块注册、部署方式与共享基础库。
快速导航
| 入口 | 说明 |
|---|---|
| 快速入门 | 以 FreeKit.Host、docker-compose.yml、launchSettings.json 为准的启动说明 |
| 技术栈介绍 | 当前默认宿主、模块注册表与基础设施选型 |
| 一键部署 | build\run_freekit_pro_modules.* 与 Compose 部署说明 |
| 配置项参考 | Host / Job / Message 三类宿主的关键配置段 |
| 新模块指南 | 按 IModuleStartup 与 E.Modules 接入新模块 |
| API 总览 | 真实路由前缀、响应模型与 Swagger 入口 |
| 常见问题 | 针对当前代码结构整理的排障说明 |
| FreeKit 基础库 | FreeKit Core、Extras、Modularity 与扩展库文档 |
| BuildingBlocks | 仓库内公共基础设施与 Web 组件说明 |
当前默认宿主
默认运行入口位于 src\Services\Host\:
| 宿主 | 项目 | 作用 | 本地默认地址 |
|---|---|---|---|
| 主 API | FreeKit.Host | 聚合业务 API、Swagger/RapiDoc、SignalR、健康检查 | https://localhost:7002/kit_api / http://localhost:5002/kit_api |
| Job | FreeKit.Job.Host | FreeScheduler 任务宿主与任务初始化入口 | https://localhost:7000/job_api / http://localhost:5000/job_api |
| Message | FreeKit.MessageHandler.Host | CAP 消费端与消息处理入口 | https://localhost:7003/message_api / http://localhost:5003/message_api |
| HealthChecks | FreeKit.HealthChecks | 独立基础设施健康检查 UI | https://localhost:5005 / http://localhost:5004 |
默认启用的模块
以下模块来自 src\Services\Host\FreeKit.DI\E.cs 的 Modules 注册表:
| 注册键 | Startup | 所属目录 | 说明 |
|---|---|---|---|
identity | IdentityModuleStartup | src\Services\Identity\FreeKit.Identity | 认证、权限、组织、SSO、OAuth2 |
identity-inf | IdentityInfrastructureModuleStartup | src\Services\Identity\FreeKit.Identity.Infrastructure | 公共附件、设置等基础能力 |
platform | PlatformModuleStartup | src\Services\Plat\FreeKit.Platform | 区域、导航、热点、工具、代码生成 |
holiday | HolidayModuleStartup | src\Services\Holiday\Holidays | 节假日数据接口 |
todo | ToDoModuleStartup | src\Services\ToDo\FreeKit.ToDos | 待办示例模块 |
cmskit | CmsKitModuleStartup | src\Services\CmsKit\FreeKit.CmsKit | 文章、短内容、评论、通知、推荐、检索 |
toolkit | ToolKitModuleStartup | src\Services\CmsKit\FreeKit.Toolkit | 工具集合与代理能力 |
im | ImModuleStartup | src\Services\IM\FreeKit.IM | 即时通讯、好友、群组、消息反应 |
member | MemberModuleStartup | src\Services\Identity\FreeKit.Member | 会员积分、地址等扩展能力 |
short | ShortModuleStartup | src\Services\Plat\FreeKit.Short | 短链能力 |
src\Services\Mall 中还包含 FreeKit.Mall 代码,但当前默认 FreeKit.Host 未将其加入 E.Modules。
技术栈速览
| 层次 | 技术 |
|---|---|
| Web 框架 | ASP.NET Core / .NET 10 |
| 模块化 | IGeekFan.FreeKit.Modularity |
| ORM | FreeSql(CodeFirst) |
| 缓存 | FreeRedis |
| 定时任务 | FreeScheduler |
| 消息总线 | CAP + RabbitMQ |
| 日志 | Serilog |
| 实时通信 | SignalR |
| 搜索 | MeiliSearch |
| 文档 | Swagger UI + RapiDoc |
文档说明
本网站同时包含两类内容:
docs/services/doc/**:面向当前 FreeKitModules 工程的整理文档。docs/repo/**:从仓库内 README / 设计文档整理进站点的镜像文档。