这是我参与「第五届青训营 」伴学笔记创作活动的第5天。

GORM框架的安装与使用

GORM是一款面向GO开发的ORM库

ORM

对象关系映射（英语：Object Relational Mapping，简称ORM，或O/RM，或O/R mapping），是一种程序设计技术，用于实现面向对象编程语言里不同类型系统的数据之间的转换。从效果上说，它其实是创建了一个可在编程语言里使用的“虚拟对象数据库”。简单来说，GORM可以让你直接通过修改类 / 结构体实例的方式操纵数据库中的数据表，实现增删查改。

GORM的安装

使用以下命令安装 GORM 及需要连接对应数据库的驱动。官方支持的数据库类型有：MySQL, PostgreSQL, SQlite, SQL Server，这里以使用较多的MySQL为例。

go get -u gorm.io/gorm
go get -u gorm.io/driver/mysql

使用GORM操纵数据库

package main

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

type Product struct {
  gorm.Model
  Code  string
  Price uint
}

func main() {
  dsn := "user:pass@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 {
    panic("failed to connect database")
  }

  // Migrate the schema
  db.AutoMigrate(&Product{})

  // Create
  db.Create(&Product{Code: "D42", Price: 100})

  // Read
  var product Product
  db.First(&product, 1) // find product with integer primary key
  db.First(&product, "code = ?", "D42") // find product with code D42

  // Update - update product's price to 200
  db.Model(&product).Update("Price", 200)
  // Update - update multiple fields
  db.Model(&product).Updates(Product{Price: 200, Code: "F42"}) // non-zero fields
  db.Model(&product).Updates(map[string]interface{}{"Price": 200, "Code": "F42"})

  // Delete - delete product
  db.Delete(&product, 1)
}

我们慢慢解读这些代码
首先

type Product struct {
  gorm.Model
  Code  string
  Price uint
}

这段代码表示声明了一个数据库模型。模型是标准的struct。由go的基本数据类型、实现了Scanner和Valuer接口的自定义类型以及其指针或别名组成。数据库模型的结构将被对应到数据表中，相当于MySQL中：

CREATE TABLE IF NOT EXISTS `products` (
  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
  `created_at` datetime(3) DEFAULT NULL,
  `updated_at` datetime(3) DEFAULT NULL,
  `deleted_at` datetime(3) DEFAULT NULL,
  `code` longtext DEFAULT NULL,
  `price` bigint(20) unsigned DEFAULT NULL,
  PRIMARY KEY (`id`),
  KEY `idx_products_deleted_at` (`deleted_at`)
) 

值得注意的是，GORM使用按约定编程设计范例，默认情况下，GORM 使用 ID 作为主键，使用结构体名的 蛇形复数 作为表名，字段名的 蛇形 作为列名，并使用 CreatedAt、UpdatedAt 字段追踪创建、更新时间。因此，当我们在数据模型中指定 gorm.Model 时，ID、 CreatedAt、UpdatedAt 、 DeletedAt 会被自动创建，并按其名字那样工作，例如 CreatedAt 字段会在我们创建一个记录时自动填充创建时间。同时,GORM也允许你配置自己配置，详情可见GORM的官方文档。

接下来，在main函数中，我们调用 gorm.Open 开启了一个数据库连接，并为可能产生的异常进行处理。随后，使用AutoMigrate方法，为指定数据库自动迁移数据模型结构。这会为指定数据模型创建 GORM 可用的数据表结构。这一步是可选的，即使不迁移 schema，数据表也会在创建新记录的时候被创建。

随后，我们可以看到分别调用了create、First、Update、Delete方法，对应着数据库的增、查、改、删

引用

GORM官方文档
HikariLan's Blog

分发

This work is licensed under CC BY-SA 4.0