Golang学习日志 ━━ Gin-Vue-Admin按步骤手动创建api及router、service

已于 2023-06-25 00:31:54 修改
阅读量1.5k 收藏 7
点赞数 3
分类专栏： Golang 文章标签： vue.js golang 学习 gin-vue-admin admin
于 2022-11-16 16:02:27 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/snans/article/details/127886291
版权

gin-vue-admin是一套国人用golang开发的后台管理系统，最新版本的系统工具中已经自带自动化package功能，本文记录的是手动创建过程。
官网：https://www.gin-vue-admin.com/
学习视频：https://www.bilibili.com/video/BV1kv4y1g7nT/?p=6

准备工作

在server/api/v1、server/router、server/service目录下创建自己的文件夹及文件。
本例目录及文件命名都为myTest/enter.go和myTest/my_test1.go，包名都为myTestPkg。
在这里插入图片描述

数据模块

如果涉及数据库，那么就需要在model目录下根据gorm规则配置数据结构；如果没有数据库，那么本节略过。

server/model/myTest/test.go
package myTestPkg

import (
	"github.com/flipped-aurora/gin-vue-admin/server/global"
	"time"
)

// Test 结构体
type Test struct {
      global.GVA_MODEL
      Title  string `json:"title" form:"title" gorm:"column:title;comment:;size:255;"`
      Content  string `json:"content" form:"content" gorm:"column:content;comment:;"`
      Showtime  *time.Time `json:"showtime" form:"showtime" gorm:"column:showtime;comment:;"`
}


// TableName Test 表名
func (Test) TableName() string {
  return "test"
}
server/model/myTest/request/test.go
package request

import (
	"github.com/flipped-aurora/gin-vue-admin/server/model/myTest"
	"github.com/flipped-aurora/gin-vue-admin/server/model/common/request"
	"time"
)

type TestSearch struct{
    myTestPkg.Test
    StartCreatedAt *time.Time `json:"startCreatedAt" form:"startCreatedAt"`
    EndCreatedAt   *time.Time `json:"endCreatedAt" form:"endCreatedAt"`
    request.PageInfo
}

功能服务

server/service/myTest/enter.go
package myTestPkg

type ServiceGroup struct {
	MyTest1Service
}
server/service/myTest/my_test1.go
package myTestPkg

import (
	"fmt"
)

type MyTest1Service struct {
}

func (s *MyTest1Service) CreateService() {
	fmt.Print("这里仅执行打印")
}
server/service/enter.go
package service

import (
	"github.com/flipped-aurora/gin-vue-admin/server/service/example"
	"github.com/flipped-aurora/gin-vue-admin/server/service/myTest"
	"github.com/flipped-aurora/gin-vue-admin/server/service/system"
)

type ServiceGroup struct {
	SystemServiceGroup  system.ServiceGroup
	ExampleServiceGroup example.ServiceGroup
	MyTestServiceGroup  myTestPkg.ServiceGroup
}

var ServiceGroupApp = new(ServiceGroup)

API

server/api/v1/myTest/enter.go
package myTestPkg

import (
	"github.com/flipped-aurora/gin-vue-admin/server/service"
)

type ApiGroup struct {
	MyTest1Api
}

var (
	myTestService = service.ServiceGroupApp.MyTestServiceGroup.MyTest1Service
)
server/api/v1/myTest/my_test1.go
package myTestPkg

import (
	"github.com/flipped-aurora/gin-vue-admin/server/model/common/response"
	"github.com/gin-gonic/gin"
)

type MyTest1Api struct {
}

func (m *MyTest1Api) CreateApi(c *gin.Context) {
	myTestService.CreateService()

	response.Ok(c)
}
server/api/v1/enter.go
package v1

import (
	"github.com/flipped-aurora/gin-vue-admin/server/api/v1/example"
	"github.com/flipped-aurora/gin-vue-admin/server/api/v1/myTest"
	"github.com/flipped-aurora/gin-vue-admin/server/api/v1/system"
)

type ApiGroup struct {
	SystemApiGroup  system.ApiGroup
	ExampleApiGroup example.ApiGroup
	MyTestApiGroup  myTestPkg.ApiGroup
}

var ApiGroupApp = new(ApiGroup)

路由

server/router/myTest/enter.go
package myTestPkg

type RouterGroup struct {
	MyTest1Router
}
server/router/myTest/my_test1.go
package myTestPkg

import (
	"github.com/flipped-aurora/gin-vue-admin/server/api/v1"
	"github.com/flipped-aurora/gin-vue-admin/server/middleware"
	"github.com/gin-gonic/gin"
)

type MyTest1Router struct {
}

// InitMyTest1Router 初始化 MyTest1 路由信息
func (s *MyTest1Router) InitMyTest1Router(Router *gin.RouterGroup) {
	myTest1Router := Router.Group("myTest1").Use(middleware.OperationRecord())

	var myTest1Api = v1.ApiGroupApp.MyTestApiGroup.MyTest1Api
	{
		myTest1Router.POST("createMyTest1Api", myTest1Api.CreateApi)
	}
}
server/router/enter.go
package router

import (
	"github.com/flipped-aurora/gin-vue-admin/server/router/example"
	"github.com/flipped-aurora/gin-vue-admin/server/router/myTest"
	"github.com/flipped-aurora/gin-vue-admin/server/router/system"
)

type RouterGroup struct {
	System            system.RouterGroup
	Example           example.RouterGroup
	MyTestRouterGroup myTestPkg.RouterGroup
}

var RouterGroupApp = new(RouterGroup)

初始化

server/initialize/router.go
package initialize

import (
	"net/http"

	_ "github.com/flipped-aurora/gin-vue-admin/server/docs"
	"github.com/flipped-aurora/gin-vue-admin/server/global"
	"github.com/flipped-aurora/gin-vue-admin/server/middleware"
	"github.com/flipped-aurora/gin-vue-admin/server/router"
	"github.com/gin-gonic/gin"
	"github.com/swaggo/gin-swagger"
	"github.com/swaggo/gin-swagger/swaggerFiles"
)

// 初始化总路由

func Routers() *gin.Engine {
	Router := gin.Default()
	myTestRouter := router.RouterGroupApp.MyTestRouterGroup
	systemRouter := router.RouterGroupApp.System
	exampleRouter := router.RouterGroupApp.Example

	Router.StaticFS(global.GVA_CONFIG.Local.Path, http.Dir(global.GVA_CONFIG.Local.StorePath)) // 为用户头像和文件提供静态地址
	Router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
	global.GVA_LOG.Info("register swagger handler")
	// 方便统一添加路由组前缀 多服务器上线使用

	PublicGroup := Router.Group("")
	{
		// 健康监测
		PublicGroup.GET("/health", func(c *gin.Context) {
			c.JSON(200, "ok")
		})
	}
	{
		systemRouter.InitBaseRouter(PublicGroup) // 注册基础功能路由 不做鉴权
		systemRouter.InitInitRouter(PublicGroup) // 自动初始化相关
	}
	PrivateGroup := Router.Group("")
	PrivateGroup.Use(middleware.JWTAuth()).Use(middleware.CasbinHandler())
	{
		systemRouter.InitApiRouter(PrivateGroup)                 // 注册功能api路由
		systemRouter.InitJwtRouter(PrivateGroup)                 // jwt相关路由
		systemRouter.InitUserRouter(PrivateGroup)                // 注册用户路由
		systemRouter.InitMenuRouter(PrivateGroup)                // 注册menu路由
		systemRouter.InitSystemRouter(PrivateGroup)              // system相关路由
		systemRouter.InitCasbinRouter(PrivateGroup)              // 权限相关路由
		systemRouter.InitAutoCodeRouter(PrivateGroup)            // 创建自动化代码
		systemRouter.InitAuthorityRouter(PrivateGroup)           // 注册角色路由
		systemRouter.InitSysDictionaryRouter(PrivateGroup)       // 字典管理
		systemRouter.InitAutoCodeHistoryRouter(PrivateGroup)     // 自动化代码历史
		systemRouter.InitSysOperationRecordRouter(PrivateGroup)  // 操作记录
		systemRouter.InitSysDictionaryDetailRouter(PrivateGroup) // 字典详情管理
		systemRouter.InitAuthorityBtnRouterRouter(PrivateGroup)  // 字典详情管理

		exampleRouter.InitExcelRouter(PrivateGroup)                 // 表格导入导出
		exampleRouter.InitCustomerRouter(PrivateGroup)              // 客户路由
		exampleRouter.InitFileUploadAndDownloadRouter(PrivateGroup) // 文件上传下载功能路由

		myTestRouter.InitMyTest1Router(PrivateGroup)
	}

	InstallPlugin(Router) // 安装插件

	global.GVA_LOG.Info("router register success")
	return Router
}
server/initialize/gorm.go

如果涉及数据库，在model中配置完后，可以在这里注册数据库。

package initialize

import (
	"os"

	"github.com/flipped-aurora/gin-vue-admin/server/global"
	"github.com/flipped-aurora/gin-vue-admin/server/model/example"
	"github.com/flipped-aurora/gin-vue-admin/server/model/system"
	"github.com/flipped-aurora/gin-vue-admin/server/model/test"

	"go.uber.org/zap"
	"gorm.io/gorm"
)

// Gorm 初始化数据库并产生数据库全局变量
// Author SliverHorn
func Gorm() *gorm.DB {
	switch global.GVA_CONFIG.System.DbType {
	case "mysql":
		return GormMysql()
	case "pgsql":
		return GormPgSql()
	case "oracle":
		return GormOracle()
  case "mssql":
		return GormMssql()
	default:
		return GormMysql()
	}
}

// RegisterTables 注册数据库表专用
// Author SliverHorn
func RegisterTables(db *gorm.DB) {
	err := db.AutoMigrate(
		// 系统模块表
		system.SysApi{},
		system.SysUser{},
		system.SysBaseMenu{},
		system.JwtBlacklist{},
		system.SysAuthority{},
		system.SysDictionary{},
		system.SysOperationRecord{},
		system.SysAutoCodeHistory{},
		system.SysDictionaryDetail{},
		system.SysBaseMenuParameter{},
		system.SysBaseMenuBtn{},
		system.SysAuthorityBtn{},
		system.SysAutoCode{},

		// 示例模块表
		example.ExaFile{},
		example.ExaCustomer{},
		example.ExaFileChunk{},
		example.ExaFileUploadAndDownload{},

		// 测试模块表
		myTestPkg.Test{},

		// 自动化模块表
		// Code generated by github.com/flipped-aurora/gin-vue-admin/server Begin; DO NOT EDIT.

		// Code generated by github.com/flipped-aurora/gin-vue-admin/server End; DO NOT EDIT.
	)
	if err != nil {
		global.GVA_LOG.Error("register table failed", zap.Error(err))
		os.Exit(0)
	}
	global.GVA_LOG.Info("register table success")
}
server/initialize/plugin.go

如果开发了plugin插件，那么也别忘了初始化

package initialize

import (
	"fmt"

	"github.com/flipped-aurora/gin-vue-admin/server/global"
	"github.com/flipped-aurora/gin-vue-admin/server/middleware"
	"github.com/flipped-aurora/gin-vue-admin/server/plugin/email"

	"github.com/flipped-aurora/gin-vue-admin/server/utils/plugin"
	"github.com/gin-gonic/gin"
)

func PluginInit(group *gin.RouterGroup, Plugin ...plugin.Plugin) {
	for i := range Plugin {
		PluginGroup := group.Group(Plugin[i].RouterPath())
		Plugin[i].Register(PluginGroup)
	}
}

func InstallPlugin(Router *gin.Engine) {
	PublicGroup := Router.Group("")
	fmt.Println("无鉴权插件安装==》", PublicGroup)
	PrivateGroup := Router.Group("")
	fmt.Println("鉴权插件安装==》", PrivateGroup)
	PrivateGroup.Use(middleware.JWTAuth()).Use(middleware.CasbinHandler())
	//  添加跟角色挂钩权限的插件 示例 本地示例模式于在线仓库模式注意上方的import 可以自行切换 效果相同
	PluginInit(PrivateGroup, email.CreateEmailPlug(
		global.GVA_CONFIG.Email.To,
		global.GVA_CONFIG.Email.From,
		global.GVA_CONFIG.Email.Host,
		global.GVA_CONFIG.Email.Secret,
		global.GVA_CONFIG.Email.Nickname,
		global.GVA_CONFIG.Email.Port,
		global.GVA_CONFIG.Email.IsSSL,
	))
}

总结

代码要求还是很统一的，创建同样的目录文件，放在同一个包下，告诉enter.go有几个组（本文就一个，都是开头用MyTest1命名，比如MyTest1Api），先创建service，再给api调用，然后给router分配，最后initialize初始化路由。

go build main.go

生成执行文件打开后，如图，表示api接口已经对外发布。
在这里插入图片描述

在这里插入图片描述

暂时先用这个名字
关注
  • 3
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
基于Gin+Vue+ElementUI低代码开发平台
weixin_50196917的博客
03-05 1531
是一款基于Golang、Gin、Xorm、Vue、ElementUI、MySQL等技术栈开发平台框架，拥有完善的(RBAC)权限架构和基础核心管理模块，为了缩短研发周期，系统框架集成了代码生成器，内置平台自定义研发的模板引擎，可以一键CRUD生成整个模块的全部代码，本框架为一站式系统框架开发平台，可以帮助开发者提升开发效率、降低研发成本，同时便于后期的系统维护升级。......
go-admin:基于go + gin + vue + element admin后台管理系统，支持用户管理，认证，内容管理等
03-11
去管理员 go-admin是一个go语言开发的后台管理系统，该系统以角色为基础的权限管理设计（RBAC），完成了系统管理模块功能的开发（其他示例模块替代合并），采用前替代分离实现方式，服务端基于go开源gin框架，前端开源框架 。使用Swagger 2.0自动生成API文档。 设计原则 采用比较流行的开源框架 ， （这里下载的多语言版 ，不是master分支），这些项目维护和更新比较好。 尽量少修改vue-element-admin框架的代码，以便以后升级。 前一级分离，前一级可以独立开发互不影响。 服务端控制前端菜单显示以及相应权限。 系统环境 golang语言：go1.13.3 +， 数据库：mysql5.7 缓存：redis3.0 项目地址 github的： 编码云（国内）： 介绍 本项目相关源代码分析相关文章如下： 快速开始 1，克隆项目源代码 git clone https:
Go-Admin后台管理系统源码(GO+VUE)编译与部署
最新发布
05-31 382
下载并安装nodejs 17。5. 编译完成后,启动服务。3.编译管理后台后端。修改依赖库版本并安装。
gin-vue-admin 框架详解
热门推荐
weixin_43878297的博客
04-02 1万+
gin-vue-admin 后台启动逻辑详解
Golang: gin-vue-admin框架介绍
owenzhang的博客
11-08 5433
我参与11月更文挑战的第5天，活动详情查看：2021最后一次更文挑战 先给大家看看我上个月的礼品呗 嘻嘻 gin-vue-admin基于gin+vue搭建的后台管理系统框架，集成jwt鉴权，权限管理，动态路由，分页封装，多点登录拦截，资源权限，上传下载，代码生成器，表单生成器，通用工作流等基础功能，五分钟一套CURD前后端代码，目前已支持VUE3，欢迎issue和pr~ gitee地...
推荐开源项目：Gin-Vue-Admin —— 快速构建后端管理系统的理想框架
gitblog_00074的博客
03-19 525
推荐开源项目：Gin-Vue-Admin —— 快速构建后端管理系统的理想框架 项目地址:https://gitcode.com/flipped-aurora/gin-vue-admin 项目简介 Gin-Vue-Admin 是一个基于 Gin 和 Vue.js 的前后端分离的管理后台模板，旨在帮助开发者快速搭建起具有权限控制、数据展示和表单操作等功能的管理系统。它将现代Web开发中的两大流行技术...
基于Go的后台管理框架Gin-vue-admin
yftyzs的博客
04-24 2077
gin-vue-admin: 基于vite+vue3+gin搭建的开发基础平台（支持TS,JS混用），集成jwt鉴权，权限管理，动态路由，显隐可控组件，分页封装，多点登录拦截，资源权限，上传下载，代码生成器，表单生成器,chatGPT自动查表等开发必备功能。
gin-vue-admin学习（后端篇）—— 4.Casbin权限管理
liangdongld的博客
08-13 3538
对于此项目的权限管理。在前面阅读中间件源码时候提到了这个。经过这几周的研究，逐渐理解了此项目的权限管理系统。
【go】ginadmin项目安装文档
大白菜啊
03-28 202
ginadmin 运行不起来解决方法
go快速开发框架gin+vue快速开发后台管理(前后端分离)，极快接口api生成器，快到不写一行代码，10秒接口就可以调用
GoFLy开发者的博客
06-03 5083
​用 Go 语言基于Gin、Vue、Typescript、vite、Arco Design、MySQL等框架精心打造的一款模块化、插件化、高度自动化、高性能的前后端分离架构敏捷开发框架，可快速搭建前后端分离后台管理系统。本着简化开发、提升开发效率的初衷，框架自研了一套个性化的组件，实现了可插拔的组件式开发方式，同时为了敏捷快速开发，框架特地集成了代码生成器一键生成管理后台的前后端代码，快速开发或生成api接口代码和接口文档、测试api接口等编辑，完全自主研发了自定义GO后端服务模板和前端Vue自定义模板
go语言有哪些web框架
weixin_50196917的博客
07-06 3197
由于工作需要，这些年来也接触了不少的开发框架，Golang的开发框架比较多，不过基本都是Web”框架”为主。这里稍微打了个引号，因为大部分”框架”从设计和功能定位上来讲，充其量都只能算是一个组件，需要项目使用的话得自己四处再去找找其他的组件，或者自己造轮子。如果用于Web开发，这些”框架”的Web开发能力均已完备，无太大差别，且均是自标准库net/http.Server的二次封装。由于框架众多，这里笔者只选择了几个曾做过技术选型评估、较为熟悉，且目前比较流行和典型的Golang”框架”，从适用于业务项目开发
Golang学习日志 ━━ gin-vue-admin换机重新配置的记录，很愚蠢，很傻瓜，很机械...自己使用
暂时先用这个名字
06-24 1158
最近一直在弄AI，没时间搞gin-vue-admin，所以有点忘记了，代码升级管它呢，全部重来一遍·~根据经验和个人喜好，我特别不喜欢在框架下把一个应用分散在module、api、service等等目录下，这种目录方法将把一个应用拆得七零八落，迁移特别麻烦。
gin-vue-admin学习（后端篇）—— 1. Login登录
liangdongld的博客
07-10 2701
问渠那得清如许？为有源头活水来
探索 Gin-Vue-Admin：一个高效可复用的后台管理系统框架
gitblog_00060的博客
03-29 657
探索 Gin-Vue-Admin：一个高效可复用的后台管理系统框架 项目地址:https://gitcode.com/Bingjian-Zhu/gin-vue-admin 项目简介 Gin-Vue-Admin 是一套基于现代化前后端技术栈构建的后台管理模板，集成了 Gin 框架（Go 语言）与 Vue.js（前端 JavaScript 框架），并辅以 Element UI 提供美观的界面组件。这个...
gin框架下创建代码生成器
祥富大大的博客
03-16 514
最近在用Go 的gin框架重构之前PHP开发的老项目，由于基础不扎实，打算从零开始进行开发，在写Model和Service时感觉效率比较低，并且大量代码重复，所以就自己用template模板来实现代码的生成。上述模板文件集成了swagger Api文档注解，控制台swag init 即可生成对应的接口文档。经过上述三个操作，代码已经生成了，访问时直接在路由文件中添加对应的路由地址即可。一：在使用模板时不能使用 gin中的模板定义标签如。上述标签如果存在则获取不到模板数据。接下来的是生成Service代码。
Golang学习日志 ━━ gin-vue-admin插件开发记录
暂时先用这个名字
06-27 1328
gin-vue-admin是一套国人用golang开发的后台管理系统，本文记录插件开发内容。
【不断更新】Go-admin学习小结（gorm+gin+swagger+casbin）
qq_44330459的博客
10-16 3049
go-admin学习 goland使用 swagger api jwt鉴权 gorm使用 postman在token情况下测试
GinAdmin：基于Gin的高效能Web后台框架
gitblog_00032的博客
03-29 606
GinAdmin：基于Gin的高效能Web后台框架 项目地址:https://gitcode.com/gphper/ginadmin GinAdmin 是一个用Go语言编写的、基于流行的Gin框架构建的强大Web后台管理系统。它旨在简化开发过程，提供一套完整的权限管理、数据操作和前后端分离的解决方案，让开发者能够快速构建稳定且功能丰富的后台系统。 技术分析 基于Gin框架 Gin是Go语言中广泛使...
【Gin-Vue-Admin】后台管理系统脚手架
码农印象
11-14 1346
Gin-Vue-Admin GIN-VUE-ADMIN 是一个基于 vue 和 gin 开发的全栈前后端分离的后台管理系统，拥有 jwt 鉴权，动态路由，动态菜单，casbin 鉴权，表单生成器，代码生成器等功能，新版本增加了从数据库表一键创建前后端 curd 代码功能，方便大家从老系统迁移，大大减少了开发工作量，真正做到 5 分钟一套基础业务，让大家把更多时间专注在复杂业务开发上。 项目地址 演示 demo: http://demo.gin-vue-admin.com (如提示备案中请使用备用站点) 备.
gin-vue-admin
03-31
Gin-Vue-Admin is a full-stack (frontend and backend) admin panel framework built with Gin (a Golang web framework) and Vue.js (a JavaScript frontend framework). It provides a wide range of features ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值