CodeSpirit 开发环境搭建及启动指南

CodeSpirit 开发环境搭建及启动指南

本指南将帮助您快速搭建CodeSpirit(码灵)低代码框架的开发环境。CodeSpirit基于 .NET 10 和 Aspire 13.0 构建,通过简单的几个步骤即可启动完整的开发环境。

最后更新: 2025年12月22日
框架版本: v2.0.0
image

  • 操作系统: Windows 10/11, macOS 12+, 或 Linux (Ubuntu 20.04+)
  • CPU: Intel i5 或 AMD Ryzen 5 及以上(推荐i7/Ryzen 7)
  • 内存: 16GB RAM(推荐32GB)
  • 存储: 至少20GB可用空间(SSD推荐)

注意: CodeSpirit默认使用GreptimeDB进行审计日志存储和搜索。Elasticsearch为可选组件,如需使用请参考相关配置文档。

Windows


macOS


Linux (Ubuntu)


验证安装


Visual Studio 2026 (推荐)

  • 下载地址: https://visualstudio.microsoft.com/vs/
  • 选择工作负载:ASP.NET 和 Web 开发

或者 Visual Studio Code


VS Code必需扩展:


  • 下载地址: https://www.docker.com/products/docker-desktop
  • 安装后启动Docker Desktop

验证安装:



CodeSpirit使用Aspire自动管理所有依赖服务,无需手动启动Docker容器:


服务说明:

  • MySQL/SQL Server: 主数据库存储(根据DatabaseType配置选择)
  • Redis: 缓存和会话存储(端口: 6380)
  • RabbitMQ: 消息队列服务(管理界面端口: 15672)
  • GreptimeDB: 时序数据库,用于审计日志存储(HTTP端口: 4000, gRPC端口: 4001)
  • Seq: 结构化日志服务(端口: 5341)

使用.NET Aspire(推荐)


如果是正常启动,将看到以下缤纷的控制台输出:

image

启动后访问:

  • Aspire Dashboard: http://localhost:17109(自动打开)
  • Web应用: https://localhost:7120(启动后显示具体端口)

注意:

  1. 实际端口号可能因系统配置而异,请查看Aspire Dashboard获取准确的端口信息。
  2. 如何登录页没有正常呈现,请按照下面的必填参数配置进行配置。

或者使用Visual Studio

  1. 打开
  2. 设置 为启动项目
  3. 按 F5 运行
    image
    注意,需确保以下服务均正常启动:
    image


CodeSpirit采用Clean Architecture设计,项目结构如下:


项目使用以下默认配置,由.NET Aspire自动管理:

  • 数据库类型: 支持MySQL和SQL Server两种数据库(通过配置选择)
  • MySQL: 端口3306,由Aspire自动配置

    image

  • SQL Server: 端口1433,由Aspire自动配置
  • 数据库: 自动创建和迁移
  • 连接字符串: 由Aspire自动管理
  • Redis: (具体见管理UI)
  • RabbitMQ: (管理界面: http://localhost:15672, 用户名/密码: admin/Password123)

    image

  • GreptimeDB:
    • HTTP端口:
    • gRPC端口:
    • 健康检查: http://localhost:4000/health
  • Seq日志服务: (具体端口见资源面板)

    image

  • Redis Commander: 通过Aspire Dashboard访问

image

Aspire 千问 Qwen 教程 支持两种参数配置方式,配置系统会按以下优先级读取(高优先级会覆盖低优先级):

  1. User Secrets(开发环境推荐,避免提交敏感信息到代码库)
  2. appsettings.json(开发环境备选方案)

提示: 对于敏感信息(如 API 密钥),强烈推荐使用 User Secrets,避免将密钥提交到代码库。

LLM 配置参数

以下参数用于配置通用 LLM 服务(如 AI 卡片、智能审批等功能):

参数名称 说明 是否必填 默认值 LLM API密钥 ✅ 必填 无 LLM API基础地址 可选 LLM模型名称 可选 请求超时时间(秒) 可选 最大Token数 可选 是否使用代理 可选 代理地址 可选 空字符串

AI表单填充 LLM 配置参数

以下参数用于配置 AI 表单智能填充功能:

参数名称 说明 是否必填 默认值 AI表单填充LLM API密钥 ✅ 必填 无 API基础地址 可选 模型名称 可选 禁用思考模式 可选 响应格式类型 可选 温度参数 可选 TopP参数 可选 启用流式响应 可选

其他可选参数

以下参数已有默认值,通常无需修改:

参数名称 说明 默认值 JWT密钥 JWT颁发者 JWT受众 MySQL密码 SQL Server密码 RabbitMQ用户名 RabbitMQ密码

方法一:使用 User Secrets(推荐开发环境)

使用 .NET User Secrets 可以安全地存储敏感信息,无需担心提交到代码库:


方法二:使用 appsettings.json(开发环境备选)

编辑 文件,添加参数配置:


⚠️ 重要提示:

  • 如果使用 配置敏感信息,请确保该文件已添加到 中
  • 或者创建 文件(该文件默认已在 中),避免将 API 密钥提交到代码库
  • 强烈推荐使用 User Secrets 方式,更安全且不会误提交

阿里云通义千问(DashScope)

开发阶段免费额度完全够用:

  1. 访问 阿里云 DashScope
  2. 注册/登录账号
  3. 创建 API Key
  4. 将 API Key 配置到上述参数中

💡 推荐阅读:阿里云通义千问免费体验指南 – 详细的注册指南、配置教程和成本分析,帮助您零成本体验 CodeSpirit 的强大 AI 能力!

OpenAI(如使用 OpenAI 兼容接口)

如果使用 OpenAI 兼容的 API 服务,需要修改以下参数:

使用 User Secrets 配置:


或使用 appsettings.json 配置:


启动项目后,如果参数配置不正确,您会在控制台或 Aspire Dashboard 中看到相关错误信息。确保以下服务能够正常启动:

  • ✅ ConfigCenter(配置中心)- 需要 LLM 参数
  • ✅ Web 前端 – 需要 AI 表单填充 LLM 参数

提示: 如果暂时不需要使用 AI 功能,可以设置一个占位符值,但某些依赖 AI 的功能将无法正常工作。

创建 :


创建 :


访问Aspire Dashboard (http://localhost:17109) 确认所有服务正常运行:

  • ✅ CodeSpirit.Web (Web前端)
  • ✅ CodeSpirit.IdentityApi (身份认证)
  • ✅ CodeSpirit.ConfigCenter (配置中心)
  • ✅ CodeSpirit.MessagingApi (消息服务)
  • ✅ CodeSpirit.ExamApi (考试系统)
  • ✅ CodeSpirit.FileStorageApi (文件存储)
  • ✅ CodeSpirit.SurveyApi (问卷调查)
  • ✅ CodeSpirit.ApprovalApi (审批流程)
  • ✅ CodeSpirit.PathfinderApi (AI目标管理)
  • ✅ MySQL/SQL Server (数据库,根据配置)
  • ✅ Redis (缓存)
  • ✅ RabbitMQ (消息队列)
  • ✅ GreptimeDB (时序数据库)
  • ✅ Seq (日志服务)

打开结构化日志面板,检查是否存在错误:

image

系统平台:https://localhost:7120

账号:systemadmin

密码:CodeSpirit@2025

image

登录后可以看到系统平台后台管理UI:

image

租户平台(默认租户):https://localhost:7120/default/login

账号:admin

密码:123@Admin

image

image

一般是以下情况导致:

  1. 镜像无法拉取,一般在docker面板或Aspire管理面板的日志中可以看到。建议配置镜像源或路由上网。
  2. 关键服务故障,比如Web服务出现故障。
  3. 端口冲突或网络错误,具体可以看启动控制台错误:

image

如果遇到端口冲突,修改 中的端口配置。

由于项目使用.NET Aspire管理服务,如果遇到服务启动问题:





如果系统内存不足,可以:

  1. 关闭不必要的应用程序
  2. 调整GreptimeDB内存设置(在Program.cs中)
  3. 考虑升级系统内存到推荐配置(16GB推荐,32GB更佳)

如果启动时遇到以下错误或服务无法正常启动:

  • ConfigCenter 服务启动失败
  • Web 前端无法访问 AI 功能
  • 控制台提示缺少 LLM 配置参数

解决方案

  1. 检查参数是否已配置
    
    
  2. 配置缺失的参数
    • 参考 必填参数配置 章节
    • 确保至少配置了 和 两个必填参数
  3. 验证配置
    • 重启应用后,检查 Aspire Dashboard 中的服务状态
    • 查看服务日志确认参数是否正确加载

提示: 如果暂时不需要使用 AI 功能,可以设置占位符值(如 ),但相关 AI 功能将无法正常工作。


在Visual Studio或VS Code中设置断点,按F5启动调试。

项目提供了完整的Kubernetes部署文件:



生产环境配置通过以下方式管理:

  • Kubernetes ConfigMap: 存储应用配置
  • Kubernetes Secret: 存储敏感信息
  • 配置中心: 动态配置管理

环境搭建完成后,您可以:

  1. 📖 阅读 项目整体架构设计
  2. 🔧 了解 CodeSpirit.Core核心框架
  3. 📋 查看 总体技术体系说明
  4. 🔐 学习 统一异常处理指南
  5. 💻 参考 CRUD开发示例 开始开发

如果遇到问题,请参考:

  • GitHub Issues
  • 项目Wiki
  • 讨论区

祝您开发愉快!🚀

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/256478.html原文链接:https://javaforall.net

(0)
上一篇 2026年3月13日 上午11:05
下一篇 2026年3月13日 上午11:05


相关推荐

关注全栈程序员社区公众号