使用 Gorm 框架进行 CRUD

2023-12-08后端4 分钟163 次阅读
AI 摘要鱼粮不足,AI 今天先歇着 · 正文在下面

前言

在数据库管理中,CRUD 操作是应用程序的支柱,它们使数据的创建、检索、更新和删除成为可能。

Go 中的框架 GORM,通过抽象 SQL 语句的复杂性,使这些操作变得轻松。

其中ORM,指的就是Object-Relationl Mapping,它的作用是映射数据库和对象之间的关系,方便我们在实现数据库操作的时候不用去写复杂的sql语句,把对数据库的操作上升到对于对象的操作。

本文将用 Gorm + MySQL 为示例进行讲解。

教程

1、安装 Gorm

sh 复制代码
go get -u gorm.io/gorm
go get -u gorm.io/driver/mysql
image.png

2、创建测试表

这里简单的创建张表,增加些测试数据

sql 复制代码
-- ----------------------------
-- Table structure for student
-- ----------------------------
DROP TABLE IF EXISTS `student`;
CREATE TABLE `student` (
  `sno` char(9) NOT NULL,
  `sname` char(20) DEFAULT NULL,
  `ssex` char(2) DEFAULT NULL,
  `sage` smallint DEFAULT NULL,
  `sdept` char(20) DEFAULT NULL,
  PRIMARY KEY (`sno`)
) ENGINE=InnoDB DEFAULT CHARSET=utf32;

-- ----------------------------
-- Records of student
-- ----------------------------
BEGIN;
INSERT INTO `student` (`sno`, `sname`, `ssex`, `sage`, `sdept`) VALUES ('2000012', '王林', '男', 19, '计算机');
INSERT INTO `student` (`sno`, `sname`, `ssex`, `sage`, `sdept`) VALUES ('2000014', '葛波', '女', 18, '计算机');
INSERT INTO `student` (`sno`, `sname`, `ssex`, `sage`, `sdept`) VALUES ('2000113', '张大民', '男', 18, '管理');
INSERT INTO `student` (`sno`, `sname`, `ssex`, `sage`, `sdept`) VALUES ('2000256', '顾芳', '女', 19, '管理');
INSERT INTO `student` (`sno`, `sname`, `ssex`, `sage`, `sdept`) VALUES ('2000278', '姜凡', '男', 19, '管理');
COMMIT;

SET FOREIGN_KEY_CHECKS = 1;

3、增删改查

定义配置文件

yml 复制代码
Mysql:
  Host: "127.0.0.1"
  Port: 3306
  Username: "root"
  Password: "123456"
  Database: "st"

定义连接数据库的配置

go 复制代码
package conf

import (
	"go.uber.org/zap"
	"gorm.io/driver/mysql"
	"gorm.io/gorm"
	"os"
	"time"
)

var Db *gorm.DB

func InitMysql() {
	dsn := Config.Mysql.Username + ":" + Config.Mysql.Password + "@tcp(" + Config.Mysql.Host + ":" +
		Config.Mysql.Port + ")/" + Config.Mysql.Database + "?charset=utf8mb4&parseTime=True&loc=Local"
	db, err := gorm.Open(mysql.New(mysql.Config{
		DSN:                       dsn,   // DSN data source name
		DefaultStringSize:         256,   // string 类型字段的默认长度
		DisableDatetimePrecision:  true,  // 禁用 datetime 精度,MySQL 5.6 之前的数据库不支持
		DontSupportRenameIndex:    true,  // 重命名索引时采用删除并新建的方式,MySQL 5.7 之前的数据库和 MariaDB 不支持重命名索引
		SkipInitializeWithVersion: false, // 根据版本自动配置
	}), &gorm.Config{})
	if err != nil {
		Logger.Error("InitMysql() error!", zap.Error(err))
		os.Exit(101)
	}
	Db = db
	sqlDB, _ := db.DB()
	// SetMaxIdleCons 设置连接池中的最大闲置连接数。
	sqlDB.SetMaxIdleConns(10)

	// SetMaxOpenCons 设置数据库的最大连接数量。
	sqlDB.SetMaxOpenConns(100)

	// SetConnMaxLifetiment 设置连接的最大可复用时间。
	sqlDB.SetConnMaxLifetime(10 * time.Second)
}

定义学生的数据结构与操作函数

go 复制代码
package models

import (
	"fmt"
	"gorm.io/gorm"
	"gorm_study/conf"
)

type Student struct {
	Sno   string `gorm:"type:char(9);column:sno;primaryKey" json:"sno"`
	Sname string `gorm:"type:char(20);column:sname" json:"sname"`
	Ssex  string `gorm:"type:char(2);column:ssex" json:"ssex"`
	Sage  int    `gorm:"type:smallint;column:sage" json:"sage"`
	Sdept string `gorm:"type:char(20);column:sdept" json:"sdept"`
}

func (s *Student) TableName() string {
	return "student"
}

func (s *Student) BeforeCreate(tx *gorm.DB) (err error) {
	fmt.Println("Student对象的钩子--BeforeCreate()!")
	return
}

// CreateStudent 新增学生
func (s *Student) CreateStudent() error {
	err := conf.Db.Create(&s).Error
	if err != nil {
		return err
	}
	return nil
}

// GetStudentList 查询学生列表
func (s *Student) GetStudentList(pageNum int, pageSize int) []*Student {
	var studentList []*Student
	err := conf.Db.Limit(pageSize).Offset((pageNum - 1) * pageSize).Find(&studentList).Error
	if err != nil {
		panic(err)
	}
	return studentList
}

// UpdateStudent 修改学生
func (s *Student) UpdateStudent() error {
	err := conf.Db.Save(s).Error
	if err != nil {
		return err
	}
	return nil
}

// DeleteStudent 删除学生
func (s *Student) DeleteStudent(sno uint) error {
	err := conf.Db.Where("sno=?", sno).Delete(s).Error
	if err != nil {
		return err
	}
	return nil
}

编写测试方法

go 复制代码
package main

import (
	"encoding/json"
	"fmt"
	"go.uber.org/zap"
	"gorm_study/conf"
	"gorm_study/models"
)

func main() {
	//加载配置
	conf.InitViper()
	//加载日志
	if conf.Config.Log.IsConsole {
		conf.Logger, _ = conf.NewJSONLogger(conf.WithDebugLevel(), conf.WithFileRotationP(conf.Config.Log.LogPath+"/test.log"))
	} else {
		conf.Logger, _ = conf.NewJSONLogger(conf.WithDebugLevel(), conf.WithFileRotationP(conf.Config.Log.LogPath+"/test.log"), conf.WithDisableConsole())
	}
	defer conf.Logger.Sync()
	//初始化数据库连接
	conf.InitMysql()
	var student models.Student
	pageNum, pageSize := 1, 15
	list := student.GetStudentList(pageNum, pageSize)
	// 序列化为 json
	jsonData, err := json.Marshal(list)
	if err != nil {
		fmt.Println("Error marshalling to JSON:", err)
		return
	}
	fmt.Println(string(jsonData))

	defer func() {
		sqlDB, _ := conf.Db.DB()
		err := sqlDB.Close()
		if err != nil {
			conf.Logger.Error("数据库关连接失败", zap.Error(err))
		}
	}()
}

4、测试结果

image.png

5、常用 api

First

go 复制代码
var student Student
// 按照主键顺序的第一条记录
conf.Db.First(&student)
fmt.Println("sno: ", student.Sno)

Last

go 复制代码
var student Student
// 按照主键顺序的最后一条记录
conf.Db.Last(&student)
fmt.Println("sno: ", student.Sno)

Find

go 复制代码
var students []Student
// 所有记录
conf.Db.Find(&students)
fmt.Println("students: ", students)

Where

go 复制代码
var student Student
// 根据条件查询得到满足条件的第一条记录
conf.Db.Where("sno = ?", "2000014").First(&student)
fmt.Println("where sno: ", student.Sno)

var student1 []Student
// 根据条件查询得到满足条件的所有记录
conf.Db.Where("sdept = ?", "计算机").Find(&student1)
fmt.Println("where student1: ", student1)

var student2 []Student
// like模糊查询
conf.Db.Where("sno like ?", "%2").Find(&student2)
fmt.Println("where student2: ", student2)

var student3 []Student
conf.Db.Where("sage > ?", "18").Find(&student3)
fmt.Println("where student3: ", student3)

var student4 Student
// struct结构查询条件
conf.Db.Where(&Student{Sno: "2000014", Ssex: "女"}).First(&student4)
fmt.Println("where student4: ", student4)

var student5 Student
// map结构查询条件
conf.Db.Where(map[string]interface{}{"sno": "2000012", "sage": "19"}).Find(&student5)
fmt.Println("where student5: ", student5)

image.png
Not

go 复制代码
var student Student
conf.Db.Not("sno", []string{"200012", "200014"}).First(&student)
fmt.Println("not student: ", student)

Or

go 复制代码
var students []Student
conf.Db.Where(&Student{Sname: "张大民"}).Or(map[string]interface{}{"sno": "200012"}).Find(&students)
fmt.Println("or students: ", students)

FirstOrCreate

go 复制代码
var student Student
// 如果记录存在则返回结果,如果不存在则创建
db.Where(&Student{sno: "2000014", name: "王林"}).FirstOrCreate(&student)
fmt.Println("firstOrCreate student: ", student)

Order

go 复制代码
var students []Student
conf.Db.Order("sno desc").Find(&students) // 注意这里的order要在find前面,否则不生效
fmt.Println("order students: ", students)

Limit和Offset

go 复制代码
var students []Student
conf.Db.Limit(10).Offset(2).Find(&students) // 如果只有offset没有limit则不会生效
fmt.Println("offset students: ", students)

Scan

go 复制代码
type Result struct {
        Id int64
}
var results []Result
conf.Db.Select("sno").Where("sno in (?)", []string{"2000012", "2000014"}).Find(&students).Scan(&results)
fmt.Println("ids: ", results)

原生sql

go 复制代码
var students []Student
conf.Db.Exec("select * from student").Find(&students)
fmt.Println("sql students: ", students)

事务

go 复制代码
// 开启事务
tx := conf.Db.Begin()
defer func() {
	// 捕捉panic的异常
	if r := recover(); r != nil {
		tx.Rollback()
	}
	// 有错误,事务回滚
	if err != nil {
		tx.Rollback()
	} else {
		// 提交事务
		tx.Commit()
	}
}()
if err = tx.Create(&Student{UserId: "8", RoleId: "8"}).Error; err != nil {
	// tx.Rollback()
	// return
}

if err = tx.Create(&Student{UserId: "9", RoleId: "9"}).Error; err != nil {
	// tx.Rollback()
	// return
}

错误处理

go 复制代码
var student Student
err = conf.Db.Where("sno = ?", 2000014).First(&student).Error
if err == gorm.ErrRecordNotFound {
  fmt.Println("ErrRecordNotFound, record not found")
} else {
  fmt.Println("err: ", err)
}
fmt.Println("err student: ", student)
觉得有用就点个赞,不用登录也能读

评论

0 条
登录 之后才能评论
—
还没有评论,来说第一句