GOLAND搭建GIN框架以及基础框架搭建
创建GO环境文件夹
终端输入安装GIN
go get -u github.com/gin-gonic/gin
如果遇到超时错误
package golang.org/x/net/html: unrecognized import path "golang.org/x/net/html": https fetch: Get "https://golang.org/x/net/html?go-get=1": dial tcp 142.250.66.113:443: connectex: A connection attempt failed because the connecte
在终端重新输入配置代理
go env -w GO111MODULE=on
go env -w GOPROXY=https://goproxy.cn,direct
go mod init "项目名称自己的"
//安装MySQL驱动
go get -u gorm.io/driver/mysql
go get -u github.com/jinzhu/gorm
最后输入
go get -u github.com/gin-gonic/gin
显示
代表成功下载观看文件夹出现go.mod文件
开始配置基础的Web开发框架
新建main
添加配置
基础的项目结构
swagger依赖
在Gin框架中使用Swagger可以通过gin-swagger这个库来实现。你可以通过以下步骤来安装gin-swagger并集成Swagger:
.使用go get命令安装gin-swagger:
go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/files
在终端输入swag init产生docs文件
我这里带大家完成一个基础的登录业务
创建common文件夹配置相关请求头以及请求状态
ApiResponseEnum.go文件配置相关的请求头
package API
type ApiResponseEnum string
const (
AIREADY_EXISTS ApiResponseEnum = "-4:密码重复"
SUCCESS ApiResponseEnum = "0:成功"
ERROR_PARAM ApiResponseEnum = "-2:参数错误"
ERROR_DATA_EMPTY ApiResponseEnum = "-3:无数据"
FAIL ApiResponseEnum = "-1:失败"
)
func (a ApiResponseEnum) GetCode() string {
codeMap := map[ApiResponseEnum]string{
AIREADY_EXISTS: "-4",
SUCCESS: "0",
ERROR_PARAM: "-2",
ERROR_DATA_EMPTY: "-3",
FAIL: "-1",
}
return codeMap[a]
}
func (a ApiResponseEnum) GetName() string {
codeMsgMap := map[ApiResponseEnum]string{
AIREADY_EXISTS: "密码重复",
SUCCESS: "成功",
ERROR_PARAM: "参数错误",
ERROR_DATA_EMPTY: "无数据",
FAIL: "失败",
}
return codeMsgMap[a]
}
ApiResponseObject获取请求状态
package API
type ApiResponseObject struct {
ErrorCode string `json:"errorCode"`
ErrorMsg string `json:"errorMsg"`
Data interface{} `json:"data"`
}
func (response *ApiResponseObject) GetErrorCode() string {
return response.ErrorCode
}
func (response *ApiResponseObject) SetErrorCode(errorCode string) {
response.ErrorCode = errorCode
}
func (response *ApiResponseObject) GetErrorMsg() string {
return response.ErrorMsg
}
func (response *ApiResponseObject) SetErrorMsg(errorMsg string) {
response.ErrorMsg = errorMsg
}
func (response *ApiResponseObject) GetData() interface{} {
return response.Data
}
func (response *ApiResponseObject) SetData(data interface{}) {
response.Data = data
}
HttpClientTool配置请求接口
package API
const LOGIN string = "/login"
controllers 发布接口文件夹
AbstractApiController.go数据处理文件
package controllerspackage
import (
API "YV/common"
"github.com/gin-gonic/gin"
"net/http"
)
func ReponseJSON(errorCode string, errorMsg string, resData interface{}) API.ApiResponseObject {
apiResponseObject := API.ApiResponseObject{}
apiResponseObject.SetData(resData)
apiResponseObject.SetErrorMsg(errorMsg)
apiResponseObject.SetErrorCode(errorCode)
return apiResponseObject
}
// BindJSONData 判断是否有参数
func BindJSONData(ctx *gin.Context) (map[string]string, error) {
var requestData map[string]string
err := ctx.BindJSON(&requestData)
if err != nil {
ctx.JSON(http.StatusUnprocessableEntity, ReponseJSON(API.FAIL.GetCode(), API.FAIL.GetName(), err))
return nil, err
}
return requestData, nil
}
// ModifyData 判断是否修改成功
func ModifyData(ctx *gin.Context, Status int, error error) bool {
if Status == 1 {
ctx.JSON(http.StatusNotFound, ReponseJSON(API.SUCCESS.GetCode(), API.SUCCESS.GetName(), error))
return false
} else {
ctx.JSON(http.StatusOK, ReponseJSON(API.FAIL.GetCode(), API.FAIL.GetName(), Status))
return true
}
}
根据项目要求创建相应的文件我这里创建LOGIN文件等其他配置完成在写
model数据库配置以及增删改查
请按我这样创建文件夹
V1代表当前测试库
在v1中创建core.go文件
package V1
import (
"fmt"
)
var dsn string
func LV1() string {
// 参考 https://github.com/go-sql-driver/mysql#dsn-data-source-name 获取详情
username := "root" //账号
password := "root" //密码
host := "" //数据库地123456址,可以是Ip或者域名
port := 3306 //数据库端口
Dbname := "" //数据库名
timeout := "10s" //连接超时,10秒
//拼接下dsn参数, dsn格式可以参考上面的语法,这里使用Sprintf动态拼接dsn参数,因为一般数据库连接参数,我们都是保存在配置文件里面,需要从配置文件加载参数,然后拼接dsn。
dsn = fmt.Sprintf("%s:%s@tcp(%s:%d)/%s?charset=utf8&parseTime=True&loc=Local&timeout=%s", username, password, host, port, Dbname, timeout)
return dsn
}
创建DataBase.go
package DataBase
import (
"YV/model/DataBase/V1"
"fmt"
"gorm.io/driver/mysql"
"gorm.io/gorm"
)
var err error
var DB *gorm.DB
var Base string
func init() {
Base = V1.LV1() //切换L1数据库
DB, err = gorm.Open(mysql.Open(Base), &gorm.Config{})
if err != nil {
fmt.Println("连接数据库失败, error=" + err.Error())
}
}
有的兄弟DB下面有波浪线请在头部推荐
package DataBase
import (
"YV/model/DataBase/V1"
_ "YV/model/DataBase/V1"//需要添加
"fmt"
"gorm.io/driver/mysql"
"gorm.io/gorm"
)
var err error
//先命名下划线var _ *gorm.DB 在改回来 然后快速点击 DB指向被使用的地方
var DB *gorm.DB
var Base string
func init() {
Base = V1.LV1() //切换L1数据库
DB, err = gorm.Open(mysql.Open(Base), &gorm.Config{})
if err != nil {
fmt.Println("连接数据库失败, error=" + err.Error())
}
}
创建router文件夹里面创建app.go主要管理所有发布接口
app.go文件
package router
import (
"github.com/gin-gonic/gin"
)
func Router() *gin.Engine {
r := gin.Default()
return r
}
创建services文件夹 管理各自接口
最后修改main文件
package main
import "YV/router"
func main() {
r := router.Router()
err := r.Run()
if err != nil {
return
}
}
好了兄弟们一个我们就搭建完成了大家看成品
接下来带大家完成一个简单的查询使用
1.在HttpClientTool.go文件中生成接口
2.在services文件下生UserService.go文件调用API以及调用还没有创建的方法
3.在app.go声明
4在model文件夹下的user.go文件中启动查询方法 /我还大家使用修改语句可以直接让chatgpt修改
package model
import (
"gorm.io/gorm"
)
type User struct {
Password string `json:"Password" gorm:"column:Password"`
User string `json:"user" gorm:"column:user"`
}
func (User) TableName() string {
return "UserTable"
}
// SelectUser 查询
func SelectUser(db *gorm.DB, UserID, Password string) ([]User, error) {
var user []User
result := db.Where("user = ? AND Password = ?", UserID, Password).First(&user)
if len(user) == 0 {
return user, result.Error
}
return user, nil
}
// UpDataUser 修改
func UpDataUser(db *gorm.DB, UserID, Password string) (int, error) {
var user User
result := db.Model(&user).Where("user = ?",UserID).Update("Password", Password)
if result.Error != nil {
// 创建记录时出现错误
return 0, result.Error
} else {
// 创建记录成功
return 1, nil
}
}
[]如果不使用数据会导致返回只有一个数据
json:"Password" gorm:"column:Password"
表明返回json的参数形式 gorm表名请求数据的真实字段
func (User) TableName() string {
return "UserTable"
}//作用是指到usertable表
4.在controllers创建LoginImpl方法
package controllerspackage
import (
API "YV/common"
"YV/model"
"YV/model/DataBase"
"github.com/gin-gonic/gin"
"net/http"
)
// LoginImpl 查询方法
func LoginImpl(ctx *gin.Context) {
requestData, err := BindJSONData(ctx)
if err != nil {
return
}
Status, err := model.SelectUser(DataBase.DB, requestData["User"], requestData["password"])
if Status == nil {
ctx.JSON(http.StatusNotFound, ReponseJSON(API.FAIL.GetCode(), API.FAIL.GetName(), 0))
} else {
// 打印返回值
ctx.JSON(http.StatusOK, ReponseJSON(API.SUCCESS.GetCode(), API.SUCCESS.GetName(), Status))
}
}
// UpDataImpl 修改
func UpDataImpl(ctx *gin.Context) {
requestData, err := BindJSONData(ctx)
if err != nil {
return
}
Status, err := model.UpDataUser(DataBase.DB,requestData["User"], requestData["password"])
ModifyData(ctx, Status, err)
}
这样我们的GIN基本框架就完成了
启动以后就可以访问了
希望大家通过这篇GIN框架快速了解在使用的过程中满满掌握