Golang快速构建应用程序脚手架工具插件Nunu的使用

Nunu是一个用于构建Go应用程序的脚手架工具。它的名字来源于英雄联盟游戏中的一个角色，一个骑在雪人肩膀上的小男孩。就像Nunu一样，这个项目站在巨人的肩膀上，因为它建立在Go生态系统中流行库的组合之上。这个组合可以让你快速构建高效可靠的应用程序。

特性

Nunu包含以下流行库：

• Gin: 高性能HTTP框架
• Gorm: ORM库
• Wire: Google的依赖注入工具
• Viper: 配置管理
• Zap: 高性能日志库
• Golang-jwt: JWT实现
• Go-redis: Redis客户端
• Testify: 测试工具
• Sonyflake: 分布式ID生成
• Gocron: 任务调度
• Go-sqlmock: SQL模拟
• Gomock: 接口模拟
• Swaggo: Swagger文档生成
• Casbin: 权限控制
• Pitaya: 游戏服务器框架
• MCP-GO: 微服务框架

安装

要使用Nunu，你需要在系统上安装以下软件：

• Go 1.19或更高版本
• Git
• Docker (可选)
• MySQL 5.7或更高版本 (可选)
• Redis (可选)

安装Nunu:

go install github.com/go-nunu/nunu@latest

提示：如果go install成功但nunu命令无法识别，可能是因为环境变量未配置。你可以将GOBIN目录添加到环境变量中。

创建新项目

创建一个新的Go项目：

nunu new projectName

默认情况下，它会从GitHub拉取源，但你也可以使用中国的加速仓库：

// 使用基础模板
nunu new projectName -r https://gitee.com/go-nunu/nunu-layout-basic.git
// 使用高级模板
nunu new projectName -r https://gitee.com/go-nunu/nunu-layout-advanced.git

创建组件

你可以为项目创建handler、service、repository和model：

nunu create handler user
nunu create service user
nunu create repository user
nunu create model user

或者一次性创建所有组件：

nunu create all user

运行项目

快速运行项目：

nunu run

这个命令会启动你的Go项目，并在文件更新时支持热重载。

编译wire.go

快速编译wire.go：

nunu wire

这个命令会编译你的wire.go文件并生成所需的依赖项。

项目结构

.
├── api
│   └── v1
├── cmd
│   ├── migration
│   ├── server
│   │   ├── wire
│   │   │   ├── wire.go
│   │   │   └── wire_gen.go
│   │   └── main.go
│   └── task
├── config
├── deploy
├── docs
├── internal
│   ├── handler
│   ├── middleware
│   ├── model
│   ├── repository
│   ├── server
│   └── service
├── pkg
├── scripts
├── test
│   ├── mocks
│   └── server
├── web
├── Makefile
├── go.mod
└── go.sum

示例代码

以下是一个简单的handler示例：

// internal/handler/user.go
package handler

import (
	"net/http"

	"github.com/gin-gonic/gin"
	"github.com/go-nunu/nunu-example/internal/service"
)

type UserHandler struct {
	*Handler
	userService service.UserService
}

func NewUserHandler(handler *Handler, userService service.UserService) *UserHandler {
	return &UserHandler{
		Handler:     handler,
		userService: userService,
	}
}

func (h *UserHandler) GetUser(ctx *gin.Context) {
	userId := ctx.Param("id")
	if userId == "" {
		ctx.JSON(http.StatusBadRequest, gin.H{
			"error": "user id is required",
		})
		return
	}

	user, err := h.userService.GetUserById(ctx, userId)
	if err != nil {
		ctx.JSON(http.StatusInternalServerError, gin.H{
			"error": err.Error(),
		})
		return
	}

	ctx.JSON(http.StatusOK, user)
}

对应的service示例：

// internal/service/user.go
package service

import (
	"context"

	"github.com/go-nunu/nunu-example/internal/model"
	"github.com/go-nunu/nunu-example/internal/repository"
)

type UserService interface {
	GetUserById(ctx context.Context, id string) (*model.User, error)
}

type userService struct {
	userRepo repository.UserRepository
}

func NewUserService(userRepo repository.UserRepository) UserService {
	return &userService{
		userRepo: userRepo,
	}
}

func (s *userService) GetUserById(ctx context.Context, id string) (*model.User, error) {
	return s.userRepo.GetById(ctx, id)
}

总结

Nunu是一个功能强大的Go应用程序脚手架工具，它集成了许多流行的Go库，可以帮助开发者快速构建高效、可靠的应用程序。通过简单的命令行工具，你可以轻松创建项目结构、生成组件代码，并快速启动开发服务器。