Raystack Stencil 项目教程
1. 项目的目录结构及介绍
stencil/
├── cmd/
│ ├── stencil/
│ │ └── main.go
├── config/
│ ├── config.yaml
├── internal/
│ ├── api/
│ ├── service/
│ ├── repository/
│ └── utils/
├── pkg/
│ ├── logger/
│ ├── middleware/
│ └── validator/
├── scripts/
│ ├── build.sh
│ └── deploy.sh
├── go.mod
├── go.sum
└── README.md
目录结构介绍
- cmd/: 包含项目的启动文件,通常是
main.go
文件。 - config/: 存放项目的配置文件,如
config.yaml
。 - internal/: 包含项目的内部逻辑代码,通常分为
api
、service
、repository
和utils
等模块。 - pkg/: 存放项目的公共库代码,如
logger
、middleware
和validator
等。 - scripts/: 包含项目的构建和部署脚本,如
build.sh
和deploy.sh
。 - go.mod 和 go.sum: Go 模块依赖管理文件。
- README.md: 项目的基本介绍文档。
2. 项目的启动文件介绍
cmd/stencil/main.go
main.go
是项目的启动文件,负责初始化配置、加载依赖、启动服务等。以下是 main.go
的基本结构:
package main
import (
"log"
"os"
"github.com/raystack/stencil/config"
"github.com/raystack/stencil/internal/api"
"github.com/raystack/stencil/pkg/logger"
)
func main() {
// 加载配置文件
cfg, err := config.LoadConfig("config/config.yaml")
if err != nil {
log.Fatalf("Failed to load config: %v", err)
}
// 初始化日志
logger.Init(cfg.Log)
// 启动 API 服务
api.Start(cfg)
// 等待中断信号
sigChan := make(chan os.Signal, 1)
signal.Notify(sigChan, os.Interrupt, syscall.SIGTERM)
<-sigChan
// 优雅关闭
api.Stop()
}
启动文件功能
- 加载配置: 从
config/config.yaml
文件中加载配置。 - 初始化日志: 根据配置初始化日志系统。
- 启动 API 服务: 启动项目的 API 服务。
- 等待中断信号: 等待系统中断信号,如
Ctrl+C
,以便优雅关闭服务。
3. 项目的配置文件介绍
config/config.yaml
config.yaml
是项目的配置文件,包含项目的各种配置项,如数据库连接、日志级别、服务端口等。以下是一个示例配置文件:
server:
port: 8080
database:
host: localhost
port: 5432
user: postgres
password: secret
name: stencil
log:
level: info
format: text
配置文件内容
- server: 服务配置,如端口号。
- database: 数据库配置,包括主机、端口、用户名、密码和数据库名称。
- log: 日志配置,如日志级别和日志格式。
通过以上配置文件,项目可以灵活地调整运行时的行为,如切换数据库、调整日志输出等。