入门

开发环境

如果您之前未搭建 Golang 开发环境，请先安装 Golang 环境。
推荐使用最新版本的 Golang，或保证现有 Golang 版本 >= 1.18。小于 1.18 版本，可以自行尝试使用但不保障兼容性和稳定性。
确保打开 go mod 支持 (Golang >= 1.18时，默认开启)。

快速开始

在当前目录下创建 demo 文件夹，进入该目录中执行如下命令，初始化项目：

bash

go mod init demo/hello

创建 main.go 文件
在 main.go 文件中添加如下代码：

package main

import (
	"github.com/quarkcloudio/quark-go/v3"
	adminservice "github.com/quarkcloudio/quark-go/v3/app/admin"
	adminmodule "github.com/quarkcloudio/quark-go/v3/template/admin"
	"github.com/glebarez/sqlite"
	"gorm.io/gorm"
)

func main() {

	// 配置资源
	config := &quark.Config{
		// JWT加密密串
		AppKey:    "123456",
		// 加载服务
		Providers: adminservice.Providers,
		// 数据库配置
		DBConfig: &quark.DBConfig{
			Dialector: sqlite.Open("./data.db"),
			Opts:      &gorm.Config{},
		},
	}

	// 实例化对象
	b := quark.New(config)

	// WEB根目录
	b.Static("/", "./web/app")

	// 初始化安装
	adminmodule.Install()

	// 中间件
	b.Use(adminmodule.Middleware)

	// 响应Get请求
	b.GET("/", func(ctx *quark.Context) error {
		return ctx.String(200, "Hello World!")
	})

	// 启动服务
	b.Run(":3000")
}

拉取依赖

bash

# 第一步，创建vendor目录
go mod vendor
# 第二步，安装依赖:
go mod tidy

配置信息

在 main.go 代码中配置数据库相关信息：

DBConfig: &quark.DBConfig{
	Dialector: sqlite.Open("./data.db"),
	Opts:      &gorm.Config{},
},

替换 AppKey（请务必更改，且不可泄露）：

config := &quark.Config{
    AppKey:"Your App Key",
}

WARNING

注意：因为AppKey用于JWT加密，请务必更改！

启动服务

bash

go run main.go

后台地址： http://127.0.0.1:3000/admin/

默认用户名：administrator 密码：123456

框架中使用

Hertz框架

首先确保 Hertz 框架安装成功
在 main.go 文件中正确引入quark-go相关包
在 main.go 文件中添加如下代码：

// Code generated by hertz generator.

package main

import (
	"github.com/cloudwego/hertz/pkg/app"
	"github.com/cloudwego/hertz/pkg/app/server"
	"github.com/quarkcloudio/quark-go/v3"
	"github.com/quarkcloudio/quark-go/v3/adapter/hertzadapter"
	"github.com/quarkcloudio/quark-go/v3/app/admin"
	adminmodule "github.com/quarkcloudio/quark-go/v3/template/admin"
	"gorm.io/driver/mysql"
	"gorm.io/gorm"
)

func main() {
	h := server.Default(server.WithHostPorts(":3000"))

	// 注册路由
	register(h)

	// 静态文件
	h.StaticFile("/admin/", "./web/app/admin/index.html")

	// WEB根目录
	fs := &app.FS{Root: "./web/app", IndexNames: []string{"index.html"}}
	h.StaticFS("/", fs)

	// 数据库配置信息
	dsn := "root:fK7xPGJi1gJfIief@tcp(127.0.0.1:3306)/quarkgo?charset=utf8&parseTime=True&loc=Local"

	// 配置资源
	config := &quark.Config{
		AppKey:    "123456",
		Providers: admin.Providers,
		DBConfig: &quark.DBConfig{
			Dialector: mysql.Open(dsn),
			Opts:      &gorm.Config{},
		},
	}

	// 创建对象
	b := quark.New(config)

	// 初始化安装
	adminmodule.Install()

	// 中间件
	b.Use(adminmodule.Middleware)

	// 适配hertz
	hertzadapter.Adapter(b, h)

	// 启动服务
	h.Spin()
}

Gin框架

首先确保 Gin 框架安装成功
在 main.go 文件中正确引入quark-go相关包
在 main.go 文件中添加如下代码：

package main

import (
	"github.com/gin-contrib/static"
	"github.com/gin-gonic/gin"
	"github.com/quarkcloudio/quark-go/v3"
	"github.com/quarkcloudio/quark-go/v3/adapter/ginadapter"
	"github.com/quarkcloudio/quark-go/v3/app/admin"
	adminmodule "github.com/quarkcloudio/quark-go/v3/template/admin"
	"gorm.io/driver/mysql"
	"gorm.io/gorm"
)

func main() {
	r := gin.Default()

	// WEB根目录
	r.Use(static.Serve("/", static.LocalFile("./web/app", false)))

	// 数据库配置信息
	dsn := "root:fK7xPGJi1gJfIief@tcp(127.0.0.1:3306)/quarkgo?charset=utf8&parseTime=True&loc=Local"

	// 配置资源
	config := &quark.Config{
		AppKey:    "123456",
		Providers: admin.Providers,
		DBConfig: &quark.DBConfig{
			Dialector: mysql.Open(dsn),
			Opts:      &gorm.Config{},
		},
	}

	// 创建对象
	b := quark.New(config)

	// 初始化安装
	adminmodule.Install()

	// 中间件
	b.Use(adminmodule.Middleware)

	// 适配gin
	ginadapter.Adapter(b, r)

	r.Run(":3000")
}

Fiber框架

首先确保 Fiber 框架安装成功
在 main.go 文件中正确引入quark-go相关包
在 main.go 文件中添加如下代码：

package main

import (
	"strings"
	"time"

	"github.com/gofiber/fiber/v2"
	"github.com/quarkcloudio/quark-go/v3"
	"github.com/quarkcloudio/quark-go/v3/adapter/fiberadapter"
	"github.com/quarkcloudio/quark-go/v3/app/admin"
	adminmodule "github.com/quarkcloudio/quark-go/v3/template/admin"
	"gorm.io/driver/mysql"
	"gorm.io/gorm"
)

func main() {
	app := fiber.New()

	// 将/admin重定向到/admin/
	app.Use("/admin", func(c *fiber.Ctx) error {
		originalUrl := c.OriginalURL()

		if !strings.HasSuffix(originalUrl, "/") && !strings.Contains("originalUrl", ".") {
			return c.Redirect(originalUrl + "/")
		}

		return c.Next()
	})

	// WEB根目录
	app.Static("/", "./web/app", fiber.Static{
		Compress:      true,
		ByteRange:     true,
		Browse:        false,
		Index:         "index.html",
		CacheDuration: 1 * time.Second,
		MaxAge:        3600,
	})

	// 数据库配置信息
	dsn := "root:fK7xPGJi1gJfIief@tcp(127.0.0.1:3306)/quarkgo?charset=utf8&parseTime=True&loc=Local"

	// 配置资源
	config := &quark.Config{
		AppKey:    "123456",
		Providers: admin.Providers,
		DBConfig: &quark.DBConfig{
			Dialector: mysql.Open(dsn),
			Opts:      &gorm.Config{},
		},
	}

	// 创建对象
	b := quark.New(config)

	// 初始化安装
	adminmodule.Install()

	// 中间件
	b.Use(adminmodule.Middleware)

	// 适配fiber
	fiberadapter.Adapter(b, app)

	app.Listen(":3000")
}

Zero框架

首先确保 Zero 框架安装成功
在 main.go 文件中正确引入quark-go相关包
在 main.go 文件中添加如下代码：

package main

import (
	"flag"
	"fmt"
	"net/http"
	"os"

	"github.com/quarkcloudio/quark-go/v3"
	"github.com/quarkcloudio/quark-go/v3/adapter/zeroadapter"
	"github.com/quarkcloudio/quark-go/v3/app/admin"
	"github.com/quarkcloudio/quark-go/v3/examples/zeroadmin/internal/config"
	"github.com/quarkcloudio/quark-go/v3/examples/zeroadmin/internal/handler"
	"github.com/quarkcloudio/quark-go/v3/examples/zeroadmin/internal/svc"
	adminmodule "github.com/quarkcloudio/quark-go/v3/template/admin"
	"gorm.io/driver/mysql"
	"gorm.io/gorm"

	"github.com/zeromicro/go-zero/core/conf"
	"github.com/zeromicro/go-zero/rest"
)

var configFile = flag.String("f", "etc/zeroadmin-api.yaml", "the config file")

func main() {
	flag.Parse()

	var c config.Config
	conf.MustLoad(*configFile, &c)

	server := rest.MustNewServer(c.RestConf)
	defer server.Stop()

	// WEB根目录
	staticFile("/", "./web/app", server)

	ctx := svc.NewServiceContext(c)
	handler.RegisterHandlers(server, ctx)

	// 数据库配置信息
	dsn := "root:fK7xPGJi1gJfIief@tcp(127.0.0.1:3306)/quarkgo?charset=utf8&parseTime=True&loc=Local"

	// 配置资源
	config := &quark.Config{
		AppKey:    "123456",
		Providers: admin.Providers,
		DBConfig: &quark.DBConfig{
			Dialector: mysql.Open(dsn),
			Opts:      &gorm.Config{},
		},
	}

	// 创建对象
	b := quark.New(config)

	// 初始化安装
	adminmodule.Install()

	// 中间件
	b.Use(adminmodule.Middleware)

	// 适配gozero
	zeroadapter.Adapter(b, server)

	fmt.Printf("Starting server at %s:%d...\n", c.Host, c.Port)
	server.Start()
}

// 加载静态文件
func staticFile(root string, dirPath string, server *rest.Server) {
	rd, _ := os.ReadDir(dirPath)

	for _, f := range rd {
		fileName := f.Name()
		subPath := root + fileName + "/"
		subDirPath := dirPath + "/" + fileName
		if isDir(subDirPath) {
			staticFile(subPath, subDirPath, server)
		}
	}

	server.AddRoute(
		rest.Route{
			Method:  http.MethodGet,
			Path:    root + ":file",
			Handler: http.StripPrefix(root, http.FileServer(http.Dir(dirPath))).ServeHTTP,
		},
	)
}

// 判断所给路径是否为文件夹
func isDir(path string) bool {
	s, err := os.Stat(path)
	if err != nil {
		return false
	}
	return s.IsDir()
}

入门 ​

开发环境 ​

快速开始 ​

拉取依赖 ​

配置信息 ​

启动服务 ​

框架中使用 ​

Hertz框架 ​

Gin框架 ​

Fiber框架 ​

Zero框架 ​

入门

开发环境

快速开始

拉取依赖

配置信息

启动服务

框架中使用

Hertz框架

Gin框架

Fiber框架

Zero框架