Skip to content

Latest commit

 

History

History
267 lines (187 loc) · 7.08 KB

tutorial.md

File metadata and controls

267 lines (187 loc) · 7.08 KB
Raw

文档

进入英文版

Nunu框架使用教程

Nunu是一个基于Go语言的Web框架，它提供了一套优雅的项目结构和命令操作，使得开发者可以更加高效地开发Web应用程序。

要求

要使用Nunu 高级Layout，您需要在系统上安装以下软件：

  • Golang 1.19或更高版本
  • Git
  • MySQL5.7或更高版本
  • Redis

安装

在开始使用Nunu之前，需要先安装它。可以通过以下命令进行安装：

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

国内用户可以使用GOPROXY加速go install

$ go env -w GO111MODULE=on
$ go env -w GOPROXY=https://goproxy.cn,direct

tips: 如果go install成功，却提示找不到nunu命令，这是因为环境变量没有配置，可以把 GOBIN 目录配置到环境变量中即可

创建项目

使用Nunu创建一个新项目非常简单，只需要在命令行中输入以下命令：

nunu new projectName

其中projectName是你想要创建的项目名称,这里我们选择Advanced Layout

国内加速源：

nunu new默认拉取github源，你也可以使用国内加速仓库

// 使用高级模板(推荐)
nunu new projectName -r https://gitee.com/go-nunu/nunu-layout-advanced.git

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

执行完上述命令后，Nunu会自动创建一个目录结构优雅的Go项目，包含了一些常用的文件和目录。

创建组件

在Nunu中，可以使用以下命令批量创建Handler、Service、Repository、Model组件：

nunu create all order

其中，order是你想要创建的组件名称。

执行完上述命令后，Nunu会自动在对应目录创建组件，并写入对应的结构体和一些常用的方法。

// 日志信息
Created new handler: internal/handler/order.go
Created new service: internal/service/order.go
Created new repository: internal/repository/order.go
Created new model: internal/model/order.go

注册路由

编辑 internal/server/http.go

将handler.OrderHandler添加为NewServerHTTP的参数，这样就写好了OrderHandler的依赖关系。

紧接着我们我们再注册一个路由，noAuthRouter.GET("/order", orderHandler.GetOrderById)

func NewServerHTTP(
	// ...
	orderHandler *handler.OrderHandler,     // new
) *gin.Engine {
    // ...

	// 无权限路由
	noAuthRouter := r.Group("/").Use(middleware.RequestLogMiddleware(logger))
	{
		noAuthRouter.GET("/order", orderHandler.GetOrderById)   // new

编写Wire Provider

编辑 cmd/server/wire.go，将刚刚生成文件中的工厂函数添加到providerSet中，如下所示：

//go:build wireinject
// +build wireinject

package main

// ...

var HandlerSet = wire.NewSet(
	handler.NewHandler,
	handler.NewUserHandler,

	handler.NewOrderHandler, // new
)

var ServiceSet = wire.NewSet(
	service.NewService,
	service.NewUserService,

	service.NewOrderService, // new
)

var RepositorySet = wire.NewSet(
	repository.NewDB,
	repository.NewRedis,
	repository.NewRepository,
	repository.NewUserRepository,

	repository.NewOrderRepository, // new
)

func newApp(*viper.Viper, *log.Logger) (*gin.Engine, func(), error) {
	panic(wire.Build(
		ServerSet,
		RepositorySet,
		ServiceSet,
		HandlerSet,
		SidSet,
		JwtSet,
	))
}

编译Wire

在Nunu中，可以使用以下命令编译Wire：

nunu wire all

执行完上述命令后，我们选择cmd/server/wire.go文件，生成对应的wire_gen.go文件。

打开cmd/server/wire_gen.go文件，我们可以看到orderRepository、orderService、orderHandler的依赖关系代码自动生成了。

func NewApp(viperViper *viper.Viper, logger *log.Logger) (*gin.Engine, func(), error) {
	jwt := middleware.NewJwt(viperViper)
	handlerHandler := handler.NewHandler(logger)
	sidSid := sid.NewSid()
	serviceService := service.NewService(logger, sidSid, jwt)
	db := repository.NewDB(viperViper)
	client := repository.NewRedis(viperViper)
	repositoryRepository := repository.NewRepository(db, client, logger)
	userRepository := repository.NewUserRepository(repositoryRepository)
	userService := service.NewUserService(serviceService, userRepository)
	userHandler := handler.NewUserHandler(handlerHandler, userService)
	
	
	orderRepository := repository.NewOrderRepository(repositoryRepository)
	orderService := service.NewOrderService(serviceService, orderRepository)
	orderHandler := handler.NewOrderHandler(handlerHandler, orderService)
	
	
	engine := server.NewServerHTTP(logger, jwt, userHandler, orderHandler)
	return engine, func() {
	}, nil
}

至此，我们已经走完了Nunu项目中的核心流程，

接下来，你需要修改config/local.yml中的Mysql和Redis配置信息，

并在相关的文件中编写你的逻辑代码即可。

internal/handler/order.go            // 处理请求参数和响应
internal/service/order.go            // 实现业务逻辑
internal/repository/order.go         // 与数据库和Redis等交互
internal/model/order.go              // 数据表实体，GORM model

启动项目

最后，在Nunu中，可以使用以下命令启动项目：

// 请先修改config/local.yml中的 MySQL 和 Redis 配置信息

// 初次启动server之前，请先执行以下数据库迁移
nunu run ./cmd/migration  

 // 启动server
nunu run ./cmd/server    

// 或

nunu run

// 或

 nunu run ./cmd/server  --excludeDir=".git,.idea,tmp,vendor" --includeExt="go,yml,vue"  -- --conf=./config/local.yml

执行完上述命令后，Nunu会自动启动项目，并监听文件更新，支持热重启。

自动化生成Swagger文档

首先我们在本机，安装以下swag命令行工具

go install github.com/swaggo/swag/cmd/swag@latest

swaggo能通过注释自动生成OpenAPI文档，我们只需要在handler函数之前编写我们的注释即可，例如：

// GetProfile godoc
// @Summary 获取用户信息
// @Schemes
// @Description
// @Tags 用户模块
// @Accept json
// @Produce json
// @Security Bearer
// @Success 200 {object} response.Response
// @Router /user [get]
func (h *userHandler) GetProfile(ctx *gin.Context) {
    // ...
}

执行swag init命令生成文档相关文件

swag init  -g cmd/server/main.go -o ./docs --parseDependency

// or

make swag

浏览器打开文档页面

http://127.0.0.1:8000/swagger/index.html

总结

Nunu框架提供了一套优雅的项目结构和命令操作，使得开发者可以更加高效地开发Web应用程序。通过本教程，你已经学会了如何使用Nunu创建项目、创建Handler、创建Service、创建Repository、编译Wire和启动项目。希望这些内容能够帮助你更好地使用Nunu框架。