Go-Blueprint 快速搭建流行框架项目

Go-Blueprint 是一个用于快速搭建 Golang 项目的脚手架工具，它可以帮助开发者快速初始化各种流行框架的项目结构。下面我将详细介绍如何使用 go-blueprint。

安装 Go-Blueprint

首先需要安装 go-blueprint：

go install github.com/go-blueprint/cli/cmd/bp@latest

安装完成后，可以通过 bp --help 查看可用命令。

常用命令

1. 创建新项目

bp new <project-name>

这会创建一个基础项目结构，包含：

• main.go
• go.mod
• 基本目录结构

2. 添加框架支持

Go-Blueprint 支持多种流行框架，可以通过以下命令添加：

# 添加 Gin 框架
bp add gin

# 添加 Echo 框架
bp add echo

# 添加 Fiber 框架
bp add fiber

# 添加 Beego 框架
bp add beego

3. 添加数据库支持

# 添加 GORM 支持
bp add gorm

# 添加 SQLx 支持
bp add sqlx

# 添加 MongoDB 支持
bp add mongo

4. 添加认证支持

# 添加 JWT 认证
bp add jwt

示例：创建 Gin + GORM 项目

下面是一个完整的示例，展示如何创建一个包含 Gin 和 GORM 的项目：

# 创建新项目
bp new my-gin-app

# 进入项目目录
cd my-gin-app

# 添加 Gin 框架
bp add gin

# 添加 GORM 支持
bp add gorm

# 添加 JWT 认证
bp add jwt

项目结构

执行上述命令后，项目结构大致如下：

my-gin-app/
├── cmd/
│   └── server/
│       └── main.go
├── internal/
│   ├── config/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   └── utils/
├── pkg/
├── go.mod
└── go.sum

生成的代码示例

main.go

package main

import (
	"log"
	"my-gin-app/internal/config"
	"my-gin-app/internal/routes"
)

func main() {
	// 初始化配置
	cfg, err := config.Load()
	if err != nil {
		log.Fatalf("Failed to load config: %v", err)
	}

	// 初始化路由
	router := routes.Setup(cfg)

	// 启动服务器
	if err := router.Run(":" + cfg.Server.Port); err != nil {
		log.Fatalf("Failed to start server: %v", err)
	}
}

路由示例 (internal/routes/router.go)

package routes

import (
	"github.com/gin-gonic/gin"
	"my-gin-app/internal/config"
	"my-gin-app/internal/controllers"
)

func Setup(cfg *config.Config) *gin.Engine {
	router := gin.Default()

	// 健康检查路由
	router.GET("/health", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"status": "ok",
		})
	})

	// 用户路由组
	userController := controllers.NewUserController(cfg)
	userGroup := router.Group("/users")
	{
		userGroup.GET("", userController.GetUsers)
		userGroup.POST("", userController.CreateUser)
		userGroup.GET("/:id", userController.GetUserByID)
	}

	return router
}

配置示例 (internal/config/config.go)

package config

import (
	"log"
	"os"

	"github.com/spf13/viper"
)

type Config struct {
	Server struct {
		Port string `mapstructure:"port"`
	} `mapstructure:"server"`
	Database struct {
		Host     string `mapstructure:"host"`
		Port     string `mapstructure:"port"`
		User     string `mapstructure:"user"`
		Password string `mapstructure:"password"`
		Name     string `mapstructure:"name"`
	} `mapstructure:"database"`
	JWT struct {
		Secret string `mapstructure:"secret"`
	} `mapstructure:"jwt"`
}

func Load() (*Config, error) {
	viper.SetConfigName("config")
	viper.SetConfigType("yaml")
	viper.AddConfigPath(".")
	viper.AutomaticEnv()

	if err := viper.ReadInConfig(); err != nil {
		log.Printf("Error reading config file, %s", err)
	}

	var cfg Config
	if err := viper.Unmarshal(&cfg); err != nil {
		return nil, err
	}

	// 设置默认值
	if cfg.Server.Port == "" {
		cfg.Server.Port = "8080"
	}

	return &cfg, nil
}

自定义模板

Go-Blueprint 允许你自定义项目模板。你可以在项目根目录创建 .blueprint 文件夹，并在其中添加自定义模板。

优势

1. 快速启动：几分钟内搭建完整项目结构
2. 标准化：遵循最佳实践的项目结构
3. 模块化：按需添加功能模块
4. 可扩展：支持自定义模板

总结

Go-Blueprint 是一个强大的工具，可以显著减少项目初始化时间，特别适合需要快速原型开发或遵循标准化结构的团队。通过简单的命令组合，你可以快速搭建出包含各种流行框架和组件的项目基础。