登录 注册

Go 对象关系映射框架 GORM 使用示例

子兮子兮 No can, but will. 本文由博客端 https://zixizixi.cn 主动推送
本贴最后更新于 555 天前，其中的信息可能已经水流花落

前提条件

  • 安装 PostgreSql，创建好数据库（GORM 自动迁移表结构）
  • 安装 GoLand 和 Go SDK
  • 获取 GORM：go get -u gorm.io/gorm
  • 获取 Postgres 驱动：go get -u gorm.io/driver/postgres

使用说明

  1. 复制本代码，打开 GoLand
  2. 按 Ctrl + Shift + Alt + Insert 创建草稿文件
  3. 将代码粘贴到草稿文件中，修改数据库连接地址，按 Ctrl + Shift + F10 运行代码查看效果
package main

import (
	"database/sql"
	"encoding/json"
	"errors"
	"fmt"
	"gorm.io/driver/postgres"
	"gorm.io/gorm"
	"gorm.io/gorm/logger"
	"gorm.io/gorm/schema"
	"log"
	"os"
	"strconv"
	"time"
)

// 系统参数表结构体（实体类），GORM 约定参考： https://gorm.io/zh_CN/docs/conventions.html
type TSysParam struct {
	// gorm.Model
	ID                   string     `gorm:"type:varchar(32);not null;primaryKey;<-:create;comment:流水号参数唯一 ID"`
	DataTableName        string     `gorm:"type:varchar(128);<-;comment:数据库表名，如“t_sys_user”"`
	DataTableDescription string     `gorm:"type:varchar(255);<-;comment:数据库表名（中文）说明信息"`
	SerialValue          int        `gorm:"size:32;<-;comment:流水号当前最大值"`
	SerialLength         int        `gorm:"size:32;<-;comment:流水号长度，不足前缀以“0”补齐"`
	Remark               string     `gorm:"type:varchar(1024);<-;comment:备注信息"`
	Enabled              bool       `gorm:"<-;default:true;comment:是否可用"`
	CreateTime           *time.Time `gorm:"type:timestamptz;<-:create;autoCreateTime:milli;comment:创建时间"`
	CreateBy             string     `gorm:"type:varchar(32);<-:create;comment:创建人 ID，t_sys_user.id"`
	LastUpdateTime       *time.Time `gorm:"type:timestamptz;<-;comment:最后修改时间"`
	LastUpdateBy         string     `gorm:"type:varchar(32);<-;comment:最后修改人 ID，t_sys_user.id"`
}

// 为 TSysParam 结构体实现获取表名方法，单独设置 TSysParam 结构体的表名为 `t_sys_param`，未配置全局禁用复数表名时可使用此方法
//func (TSysParam) TableName() string {
//	return "t_sys_param"
//}

// GORM 参考文档： https://gorm.io/zh_CN/docs/
func main() {
	initDbConn()

	// CRUD 示例
	createExample()
	readExample()
	updateExample()
	deleteExample()

	printStats()
}

// GORM 数据库定义
var GormDB *gorm.DB

// 连接池数据库句柄
var SqlDB *sql.DB

// 错误信息
var err error

// 初始化数据库连接
func initDbConn() {
	GormDB, err = gorm.Open(postgres.New(postgres.Config{
		// 通过一个现有的数据库连接来初始化，无需使用 DSN
		// Conn: SqlDB,
		// 数据源名称
		DSN: "host=192.168.1.1 port=5432 user=test password=test dbname=db_test sslmode=disable TimeZone=Asia/Shanghai",
		// 禁用隐式预处理语句
		PreferSimpleProtocol: true,
	}), &gorm.Config{
		// 日志配置
		Logger: getLogger(),
		// 自定义命名策略
		NamingStrategy: schema.NamingStrategy{
			// 全局使用单数表，禁止自动转换为复数形式表名
			SingularTable: true,
		},
		// 插入数据默认批处理大小
		CreateBatchSize: 1000,
	})
	if err != nil {
		panic("数据库连接失败！")
	}

	// 数据库连接池
	SqlDB, err = GormDB.DB()
	if err != nil {
		panic("数据库连接池获取失败！")
	}
	// 设置空闲连接池中连接的最大数量
	SqlDB.SetMaxIdleConns(10)
	// 设置打开数据库连接的最大数量
	SqlDB.SetMaxOpenConns(1e3)
	// 设置连接可复用的最大时间
	SqlDB.SetConnMaxLifetime(time.Hour)
	printStats()

	// 自动迁移给定模型为数据库表结构，未创建表或需要修改表结构的情况下可以启用
	// _ = GormDB.AutoMigrate(&TSysParam{})
}

// 获取当前时间指针
func nowTime() *time.Time {
	now := time.Now()
	return &now
}

// 添加数据，参考 https://gorm.io/zh_CN/docs/create.html
func createExample() {
	// 添加单条数据
	sysParam := TSysParam{
		ID:                   "test_001",
		DataTableName:        "test_table",
		DataTableDescription: "测试表",
		SerialValue:          0,
		SerialLength:         10,
		Enabled:              true,
		CreateBy:             "00000",
		CreateTime:           nowTime(),
	}

	result := GormDB.Create(&sysParam)
	printData(&sysParam, result, "Create")

	// 向指定(Select)字段中保存数据，忽略未指定的字段(NULL)
	sysParam = TSysParam{
		ID:                   "test_002",
		DataTableName:        "test_table_002",
		DataTableDescription: "测试表",
		SerialValue:          0,
		SerialLength:         10,
		Enabled:              true,
		CreateBy:             "00000",
	}
	result = GormDB.
		Select("ID", "DataTableName", "DataTableDescription", "SerialValue", "SerialLength").
		Create(&sysParam)
	printData(&sysParam, result, "Create")

	// 添加多条数据
	dataSize := 3
	sysParams := make([]TSysParam, dataSize)
	for i := 0; i < dataSize; i++ {
		index := strconv.Itoa(i)
		sysParams[i] = TSysParam{
			ID:                   "test_list_" + index,
			DataTableName:        "test_table_" + index,
			DataTableDescription: "测试表_" + index,
			SerialValue:          0,
			SerialLength:         10,
			Enabled:              true,
			CreateBy:             "00000",
		}
	}
	// 未配置全局 CreateBatchSize 参数的情况下，一次性批量保存全部数据
	result = GormDB.Create(&sysParams)
	// 指定单次批量保存的条数分批保存，每循环到 batchSize 条保存一次直至全部完成，保存大量数据可用此方法分批保存
	// result = GormDB.CreateInBatches(&sysParams, dataSize)
	printData(&sysParams, result, "Create", "(batch)")
}

// 查询数据，参考 https://gorm.io/zh_CN/docs/query.html  https://gorm.io/zh_CN/docs/advanced_query.html
func readExample() {
	var sysParam *TSysParam
	// 根据主键查询单条数据，默认根据主键正序排序
	result := GormDB.First(&sysParam, "00001")
	printData(sysParam, result, "First")
	sysParam = nil

	// 根据自定义条件查询最后一条数据，默认根据主键倒序排序
	result = GormDB.Last(&sysParam, "enabled = ?", false)
	printData(sysParam, result, "Last")
	sysParam = nil

	// 获取一条数据，未指定排序字段
	result = GormDB.Take(&sysParam, "create_by = ?", "00000")
	printData(sysParam, result, "Take")
	sysParam = nil

	// 不使用结构体查询，直接使用表名
	result = GormDB.Table("t_sys_param").First(&sysParam)
	printData(sysParam, result, "Table", "First")
	sysParam = nil

	// 查询全部
	sysParams := new([]TSysParam)
	result = GormDB.Find(&sysParams, "enabled = ?", true)
	// 查询可用数据
	// result = GormDB.Find(&sysParams, "enabled = ?", true)
	printData(&sysParams, result, "Find", "(all)")

	// 按 AND 条件查询多条
	sysParams = new([]TSysParam)
	result = GormDB.Find(&sysParams, TSysParam{Enabled: true, CreateBy: "00000"})
	// 不使用结构体，直接使用字段 Map
	// result = GormDB.Find(&sysParams, map[string]interface{}{"enabled": true, "create_by": "00000"})
	printData(&sysParams, result, "Find", "(AND)")

	// 按 OR 条件查询多条
	sysParams = new([]TSysParam)
	result = GormDB.Where("enabled", true).Or("create_by", "00000").Find(&sysParams)
	printData(&sysParams, result, "Find", "(OR)")

	// 按 IN 条件查询多条
	sysParams = new([]TSysParam)
	result = GormDB.Find(&sysParams, "id IN ?", []string{"00001", "00002"})
	printData(&sysParams, result, "Find", "(IN)")

	// 按 NOT 条件查询多条
	sysParams = new([]TSysParam)
	result = GormDB.Not("serial_value", 0).Find(&sysParams)
	printData(&sysParams, result, "Find", "(NOT)")

	// 分页排序查询指定字段
	sysParams = new([]TSysParam)
	allSysParams := new([]TSysParam)
	result = GormDB.
		// 每页 5 条，第二页
		Offset(5).Limit(5).
		Order("serial_value DESC, id").
		Select("data_table_name", "serial_value", "serial_length").
		Find(&sysParams)
	printData(&sysParams, result, "Find", "(select-order-paging)")

	// 消除分页，获取全部
	unpageResult := result.Offset(-1).Limit(-1).Find(&allSysParams)
	// 总条数 pagingResult.RowsAffected
	printData(&allSysParams, unpageResult, "Find", "(select-order-paging-all)")
}

// 修改数据，参考 https://gorm.io/zh_CN/docs/update.html
func updateExample() {
	sysParam := TSysParam{
		ID:                   "test_001", // 根据主键修改指定数据
		DataTableName:        "test_table_001",
		DataTableDescription: "测试表-001",
		SerialValue:          1,
		SerialLength:         10,
		Enabled:              true,
		CreateTime:           nowTime(), // CreateTime 和 CreateBy 已在标签中配置为可读、可创建、不可修改
		CreateBy:             "00001",
		LastUpdateTime:       nowTime(),
		LastUpdateBy:         "00000",
	}
	// 更新所有字段，包含零值
	result := GormDB.Save(&sysParam).
		// 查询修改结果重新赋值给 sysParam
		Find(&sysParam)
	printData(&sysParam, result, "UPDATE", "Save")

	// 更新单个字段
	result = GormDB.Model(&sysParam).
		Where("enabled", true).
		Update("serial_value", sysParam.SerialValue+1).
		Find(&sysParam)
	printData(&sysParam, result, "UPDATE", "Model", "WhereUpdate")

	// 更新多个字段，使用结构体只会更新非零值字段，要更新零值字段需要使用 Select 指定要修改的字段，或者直接使用 Select("*") 更新全部字段
	sysParam = TSysParam{
		ID:             "test_001", // 根据主键修改指定数据
		SerialValue:    sysParam.SerialValue + 1,
		SerialLength:   10,
		Enabled:        false, // false 为 GORM Model 结构体零值，不会修改此字段
		LastUpdateTime: nowTime(),
		LastUpdateBy:   "00000",
	}
	result = GormDB.Model(&sysParam).
		Where("enabled", true).
		Updates(&sysParam).
		Find(&sysParam)
	printData(&sysParam, result, "UPDATE", "Model", "Updates")

	// 使用 map 可修改零值字段
	result = GormDB.Model(&sysParam).
		Updates(map[string]interface{}{"serial_value": sysParam.SerialValue + 1, "enabled": false}).
		Find(&sysParam)
	printData(&sysParam, result, "UPDATE", "Model", "UpdatesMap")

	// 使用 Omit 忽略更新指定字段
	result = GormDB.Model(&sysParam).
		Omit("serial_value").
		Updates(map[string]interface{}{"serial_value": sysParam.SerialValue + 1, "enabled": true}).
		Find(&sysParam)
	printData(&sysParam, result, "UPDATE", "Model", "UpdatesOmit")
}

// 删除数据，参考 https://gorm.io/zh_CN/docs/delete.html
func deleteExample() {
	// !!! 注意，删除数据时如果未指定主键或其他条件，将会触发无条件的批量删除
	sysParam := TSysParam{
		ID: "test_002", // 主键
	}

	// 根据主键删除指定数据
	result := GormDB.Delete(&sysParam)
	sysParam = TSysParam{}
	result.Find(&sysParam)
	printData(&sysParam, result, "Delete")

	// 通过复合条件删除数据
	result = GormDB.Where("id LIKE ? AND data_table_name LIKE ?", "test_%", "test_table_%").
		Delete(&sysParam).
		Find(&sysParam)
	printData(&sysParam, result, "DeleteWhere")
}

// 获取 GORM 日志接口
func getLogger() logger.Interface {
	gormLogger := logger.New(
		// io writer
		log.New(os.Stdout, "\r\n", log.LstdFlags),
		logger.Config{
			// 慢 SQL 阈值
			SlowThreshold: 3 * time.Second,
			// 日志级别
			LogLevel: logger.Info,
			// 是否启用彩色打印
			Colorful: true,
		},
	)

	return gormLogger
}

// 打印数据
func printData(sysParam interface{}, result *gorm.DB, morInfo ...interface{}) {
	jsonByte, _ := json.Marshal(&sysParam)

	result.Logger.Info(nil, string(jsonByte))
	fmt.Println("条数：", result.RowsAffected,
		"\t错误信息：[", result.Error,
		"]\t是否为无记录错误：", errors.Is(result.Error, gorm.ErrRecordNotFound))

	if len(morInfo) > 0 {
		fmt.Println(morInfo)
	}
}

// 打印数据库统计信息
func printStats() {
	dbStats := SqlDB.Stats()
	jsonByte, _ := json.Marshal(dbStats)
	fmt.Println(string(jsonByte))

	/*fmt.Printf(`
	空闲连接数： %d
	使用中的连接数： %d
	由于达到设置的空闲连接池的最大数量而关闭的连接数： %d
	由于达到设置的连接可空闲的最长时间而关闭的连接数： %d
	由于达到设置的可重用连接的最长时间而关闭的连接数： %d
	数据库的最大打开连接数： %d
	等待的连接总数： %d
	等待新连接被阻止的总时间： %d`, dbStats.Idle, dbStats.InUse, dbStats.MaxIdleClosed, dbStats.MaxIdleTimeClosed,
	dbStats.MaxLifetimeClosed, dbStats.MaxOpenConnections, dbStats.WaitCount, dbStats.WaitDuration)*/
}
  • golang

    Go 语言是 Google 推出的一种全新的编程语言，可以在不损失应用程序性能的情况下降低代码的复杂性。谷歌首席软件工程师罗布派克（Rob Pike）说：我们之所以开发 Go，是因为过去 10 多年间软件开发的难度令人沮丧。Go 是谷歌 2009 发布的第二款编程语言。

    481 引用 • 1383 回帖 • 539 关注
  • GORM
    7 引用 • 19 回帖
成都 位置
440 16 88 16 13 17 290

相关帖子

回帖
Go 对象关系映射框架 GORM 使用示例

欢迎来到这里！

我们正在构建一个小众社区，大家在这里相互信任，以平等 • 自由 • 奔放的价值观进行分享交流。最终，希望大家能够找到与自己志同道合的伙伴，共同成长。

注册 关于
请输入回帖内容 ...
iTanken
飘风不终朝，骤雨不终日。 成都
回帖
773
 帖子
89
 积分
57740

近期热议

推荐标签 标签

  • Flume

    Flume 是一套分布式的、可靠的，可用于有效地收集、聚合和搬运大量日志数据的服务架构。

    9 引用 • 6 回帖 • 556 关注
  • 安全

    安全永远都不是一个小问题。

    169 引用 • 809 回帖 • 347 关注
  • JSON

    JSON （JavaScript Object Notation）是一种轻量级的数据交换格式。易于人类阅读和编写。同时也易于机器解析和生成。

    51 引用 • 189 回帖 • 3 关注
  • SQLite

    SQLite 是一个进程内的库，实现了自给自足的、无服务器的、零配置的、事务性的 SQL 数据库引擎。SQLite 是全世界使用最为广泛的数据库引擎。

    4 引用 • 7 回帖 • 1 关注
  • DNSPod

    DNSPod 建立于 2006 年 3 月份，是一款免费智能 DNS 产品。 DNSPod 可以为同时有电信、网通、教育网服务器的网站提供智能的解析，让电信用户访问电信的服务器，网通的用户访问网通的服务器，教育网的用户访问教育网的服务器，达到互联互通的效果。

    6 引用 • 26 回帖 • 497 关注
  • 博客

    记录并分享人生的经历。

    262 引用 • 2367 回帖
  • sts
    2 引用 • 2 回帖 • 59 关注
  • Tomcat

    Tomcat 最早是由 Sun Microsystems 开发的一个 Servlet 容器，在 1999 年被捐献给 ASF（Apache Software Foundation），隶属于 Jakarta 项目，现在已经独立为一个顶级项目。Tomcat 主要实现了 JavaEE 中的 Servlet、JSP 规范，同时也提供 HTTP 服务，是市场上非常流行的 Java Web 容器。

    155 引用 • 528 回帖 • 5 关注
  • 大数据

    大数据（big data）是指无法在一定时间范围内用常规软件工具进行捕捉、管理和处理的数据集合，是需要新处理模式才能具有更强的决策力、洞察发现力和流程优化能力的海量、高增长率和多样化的信息资产。

    84 引用 • 112 回帖
  • RabbitMQ

    RabbitMQ 是一个开源的 AMQP 实现，服务器端用 Erlang 语言编写，支持多种语言客户端，如：Python、Ruby、.NET、Java、C、PHP、ActionScript 等。用于在分布式系统中存储转发消息，在易用性、扩展性、高可用性等方面表现不俗。

    49 引用 • 60 回帖 • 460 关注
  • 链滴

    链滴是一个记录生活的地方。

    记录生活，连接点滴

    77 引用 • 3377 回帖
  • SEO

    发布对别人有帮助的原创内容是最好的 SEO 方式。

    35 引用 • 200 回帖
  • MyBatis

    MyBatis 本是 Apache 软件基金会 的一个开源项目 iBatis，2010 年这个项目由 Apache 软件基金会迁移到了 google code，并且改名为 MyBatis ，2013 年 11 月再次迁移到了 GitHub。

    166 引用 • 410 回帖 • 556 关注
  • OAuth

    OAuth 协议为用户资源的授权提供了一个安全的、开放而又简易的标准。与以往的授权方式不同之处是 oAuth 的授权不会使第三方触及到用户的帐号信息（如用户名与密码），即第三方无需使用用户的用户名与密码就可以申请获得该用户资源的授权，因此 oAuth 是安全的。oAuth 是 Open Authorization 的简写。

    34 引用 • 103 回帖 • 10 关注
  • PHP

    PHP（Hypertext Preprocessor）是一种开源脚本语言。语法吸收了 C 语言、 Java 和 Perl 的特点，主要适用于 Web 开发领域，据说是世界上最好的编程语言。

    160 引用 • 402 回帖 • 583 关注
  • GitLab

    GitLab 是利用 Ruby 一个开源的版本管理系统，实现一个自托管的 Git 项目仓库，可通过 Web 界面操作公开或私有项目。

    43 引用 • 72 回帖
  • IBM

    IBM（国际商业机器公司）或万国商业机器公司，简称 IBM（International Business Machines Corporation），总公司在纽约州阿蒙克市。1911 年托马斯·沃森创立于美国，是全球最大的信息技术和业务解决方案公司，拥有全球雇员 30 多万人，业务遍及 160 多个国家和地区。

    16 引用 • 53 回帖 • 42 关注
  • 设计模式

    设计模式（Design pattern）代表了最佳的实践，通常被有经验的面向对象的软件开发人员所采用。设计模式是软件开发人员在软件开发过程中面临的一般问题的解决方案。这些解决方案是众多软件开发人员经过相当长的一段时间的试验和错误总结出来的。

    190 引用 • 120 回帖
  • SpaceVim

    SpaceVim 是一个社区驱动的模块化 vim/neovim 配置集合，以模块的方式组织管理插件以
    及相关配置，为不同的语言开发量身定制了相关的开发模块，该模块提供代码自动补全，
    语法检查、格式化、调试、REPL 等特性。用户仅需载入相关语言的模块即可得到一个开箱
    即用的 Vim-IDE。

    4 引用 • 31 回帖 • 41 关注
  • Hexo

    Hexo 是一款快速、简洁且高效的博客框架，使用 Node.js 编写。

    20 引用 • 140 回帖 • 54 关注
  • 开源

    Open Source, Open Mind, Open Sight, Open Future!

    376 引用 • 3329 回帖 • 144 关注
  • ReactiveX

    ReactiveX 是一个专注于异步编程与控制可观察数据（或者事件）流的 API。它组合了观察者模式，迭代器模式和函数式编程的优秀思想。

    1 引用 • 2 回帖 • 64 关注
  • SQLServer

    SQL Server 是由 [微软] 开发和推广的关系数据库管理系统（DBMS），它最初是由 微软、Sybase 和 Ashton-Tate 三家公司共同开发的，并于 1988 年推出了第一个 OS/2 版本。

    19 引用 • 31 回帖 • 2 关注
  • 反馈

    Communication channel for makers and users.

    113 引用 • 874 回帖 • 128 关注
  • JWT

    JWT（JSON Web Token）是一种用于双方之间传递信息的简洁的、安全的表述性声明规范。JWT 作为一个开放的标准（RFC 7519），定义了一种简洁的，自包含的方法用于通信双方之间以 JSON 的形式安全的传递信息。

    19 引用 • 15 回帖 • 9 关注
  • JavaScript

    JavaScript 一种动态类型、弱类型、基于原型的直译式脚本语言，内置支持类型。它的解释器被称为 JavaScript 引擎，为浏览器的一部分，广泛用于客户端的脚本语言，最早是在 HTML 网页上使用，用来给 HTML 网页增加动态功能。

    700 引用 • 1147 回帖 • 485 关注
  • wolai

    我来 wolai：不仅仅是未来的云端笔记！

    9 引用 • 117 回帖

最新标签