ahsu1230/mathnavigator-orion

Orion镜像说明

镜像概述

Orion是基于Golang开发的核心API服务，采用gin HTTP框架构建，负责连接MySQL数据库，为Web客户端提供数据交互接口，实现用户、程序、课程、公告等实体的创建与持久化管理。

核心功能

1. 提供HTTP API接口，支持Web客户端与数据库的CRUD操作
2. 实现用户、程序、课程等实体的数据存储与查询
3. 支持单元测试与集成测试，保证代码质量
4. 提供代码格式化工具，维护代码规范
5. 采用分层架构设计，便于扩展与维护

使用场景

适用于需要管理用户、课程、培训项目等数据的后端服务场景，如教育平台、培训管理系统等。

配置说明

前置条件

确保已安装Golang环境，验证命令：

bash
go version

运行方式

1. Docker Compose部署

bash
# 构建镜像
docker-compose build orion
# 启动服务
docker-compose start orion
# 停止服务
docker-compose stop orion

可通过Docker Desktop查看服务运行状态。

2. 本地直接运行

bash
go run main.go
# 停止服务按CTRL+C

测试方法

运行所有测试

bash
go test ./...

详细输出测试

bash
go test -v ./...

无缓存测试

bash
go test -v -count=1 ./...

指定文件测试

bash
go test -v -count=1 ./src/repos/program_repos_test.go

代码格式化

bash
go fmt ./...

代码结构

Orion采用三层架构：

1. Domains：实体对象（如Program、Class），描述实体属性
2. Controllers：处理网络逻辑（HTTP请求/响应、JSON序列化），基于gin定义API端点
3. Repos：处理数据库交互（MySQL连接、查询），包含迁移文件（repos/migrations目录）

开发流程

1. 修改Domains与数据库层：定义实体→添加迁移文件→更新Repos代码并测试
2. 修改Controller层：更新逻辑→配置API端点→测试
3. 集成测试：添加tests_integration目录下的测试用例

注：Controllers和Repos以接口形式定义，支持mock测试，简化单元测试流程。