从java到Go搭建Go的ORM框架Gorm

Posted 2022-11-10 幽灵雾

【提问】

如何使用Goland软件，搭建一个ORM框架GORM？

【解答】

具体步骤如下：

1、检查Go的安装

在任意目录执行如下命令：

go version

若有如下返回，则安装成功；如果报异常，则重新安装golang

go version go1.19.1 darwin/arm64

2、安装Gorm

在你的golang工程目录下，执行如下命令安装grom：

go get -u gorm.io/gorm

3、安装对应数据库的驱动

根据你的数据库，在任意目录执行如下命令安装驱动：

//mysql
go get -u gorm.io/driver/mysql
//sqlite
go get -u gorm.io/driver/sqlite
//sqlserver
go get -u gorm.io/driver/sqlserver
//clickhouse
go get -u gorm.io/driver/clickhouse

4、编写「数据库连接」代码

这里以连接mysql为例，在工程中创建用于数据库连接的go文件，其中dsn中内容需要根据自己数据库的信息进行替换,如下：

package db

import (
	"fmt"
	"gorm.io/driver/mysql"
	"gorm.io/gorm"
)

var DB *gorm.DB

func InitGormDB() (err error) 
	dsn := "user:pwd@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local"
	db, err := gorm.Open(mysql.Open(dsn), &gorm.Config)
	if err != nil 
		fmt.Printf("数据库连接失败：%v\\n", err)
	 else 
		fmt.Printf("数据库连接成功\\n")
		DB = db
	
	return err

同时在main.go中增加对其的调用，在服务启动时就进行数据库连接：

package main

import (
	"fullstars/src/common/db"
)

func main() 

	db.InitGormDB()

启动服务后，可以看到连接成功的日志：

5、编写「数据Model」代码

数据库连接后，我们就对这个数据库进行一些表映射和简单查询操作。
首先，看一下我们需要操作的数据库表：

CREATE TABLE `config`  (
  `id` int(11) UNSIGNED NOT NULL AUTO_INCREMENT,
  `type` varchar(16) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '类型',
  `key` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL,
  `value` varchar(2000) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL,
  `createtime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `modifytime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
  `deleteflag` tinyint(3) NOT NULL DEFAULT 0 COMMENT '逻辑删除标识',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 4 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;

然后在工程中，新建Model文件：configModel.go，如下：

type Config struct 
	ID         int
	TYPE       string
	KEY        string
	VALUE      string
	CREATETIME time.Time
	MODIFYTIME time.Time
	DELETEFLAG int


func (Config) TableName() string 
	return "config"

需要说明的，gorm中的Model应与数据表一一对应，gorm会进行自动转换映射。

6、编写「数据查询」代码

在工程中，新建文件：configService.go，用于操作数据库和逻辑处理，如下：
其中「.Debug()」是为了在日志中打印Gorm真实拿去数据库执行的sql，方便我们查看和核对。

package config

import (
	"fullstars/src/common/db"
)

func ConfigService() 
	var configs []Config
	db.DB.Debug().Find(&configs)

	var config Config
	db.DB.Debug().Where("id = ?", 2).Find(&config)

同样在main.go中增加对其的调用：

package main

import (
	"fullstars/src/common/db"
)

func main() 
	db.InitGormDB()
	config.ConfigService()

调试启动后，我们可以看一下变量的结果，数据已经被查询出来了：