XORM 框架的使用

2024-05-07 14:20
文章标签 使用 框架 xorm

本文主要是介绍XORM 框架的使用，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

1、xorm

1.1、xorm 简介

xorm 是一个简单而强大的Go语言ORM库. 通过它可以使数据库操作非常简便。

特性

  • 支持 struct 和数据库表之间的灵活映射，并支持自动同步
  • 事务支持
  • 同时支持原始SQL语句和ORM操作的混合执行
  • 使用连写来简化调用
  • 支持使用ID, In, Where, Limit, Join, Having, Table, SQL, Cols等函数和结构体等方式作为条件

1.2、安装环境

go get xorm.io/xorm

 1.3、快速开始

基本的连接信息

    var (username string = "root"password string = "xxxxxx"ip string = "127.0.0.1"port int = 3306dbName = "go_web"charset string = "utf8mb4")dataSource := fmt.Sprintf("%s:%s@tcp(%s:%d)/%s?charset=%s",username ,password,ip ,port ,dbName ,charset )

1.3.1、同步结构体到数据库

1. 创建引擎
    // 1. 创建引擎engine, err := xorm.NewEngine("mysql", dataSource)if err!=nil {println("连接失败")}
2. 创建结构体

        结构体中的每个字段都将对应一个表的字段，我们可以通过标签来告诉 xorm 同步到数据库或使用什么数据类型：

    // 2. 创建结构体type User struct {Id int64Name stringAge intPassword string `xorm:"varchar(200)"`Created time.Time `xorm:"created"`Updated time.Time `xorm:"updated"`}
3. 同步结构体
    // 3. 同步结构体err = engine.Sync(new(User))if err!=nil {println("创建表格失败")}

        同步结构体这个操作可以执行多次，如果我们删除了字段，只需要重新同步即可。但是如果修改了字段，就会把修改后的字段作为一个新的字段，所以一定要注意。

1.3.1、单条数据的插入

        插入数据需要使用 Insert 方法，这个方法需要传入一个对象的指针，因为我们知道，方法中的参数是形参，而且结构体类型是值类型，所以进入 Insert 方法后会拷贝一份，而不是操作我们的实参。

我们可以试着打印插入前后，我们实参的变化：

	// 1. 插入单条数据user1 := User{ Id: 2, Name: "李大喜", Age: 22, Password: "123456",}fmt.Println(user1)res,err := engine.InsertOne(&user1)if err != nil {println("插入失败",err)}else {fmt.Printf("成功插入 %d 条数据\n",res)}fmt.Println(user1)

运行结果：

        可以看到，对象未进入 insert 方法之前，它的两个 time 类型的字段是默认值，但是进入 insert 方法后，被赋值为当前时间。

1.3.2、多条数据的插入

1. 传入多个结构体对象插入
    // 1. 插入多条数据user1 := User{ Id: 3, Name: "刘能", Age: 52, Password: "123456",}user2 := User{ Id: 4, Name: "赵四", Age: 52, Password: "123456",}res,err := engine.Insert(&user1,&user2)if err != nil {println("插入失败",err)}else {fmt.Printf("成功插入 %d 条数据\n",res)}
2. 通过切片插入
	users := make([]User,2)user1 := User{ Id: 3, Name: "刘能", Age: 52, Password: "123456",}user2 := User{ Id: 4, Name: "赵四", Age: 52, Password: "123456",}users[0] = user1users[2] = user2res,err := engine.Insert(&users)if err != nil {println("插入失败",err)}else {fmt.Printf("成功插入 %d 条数据\n",res)}

虽然Go语言中的切片是引用类型，但在我们这里仍然需要传入切片的地址（指针）。

这是因为xorm的Insert方法在处理切片时，如果接收到的是切片的指针，它能够通过该指针获取到切片的实时长度信息。这个长度信息对于数据库的批量插入操作是非常重要的，因为它可以帮助xorm确定一次性能插入多少条记录，从而提高效率。

1.3.3、更新与删除

更新数据
    // 修改用户user := User{Name: "谢永强"}res,_ := engine.ID(1).Update(&user)fmt.Println(res)
删除数据
	// 1. 删除单条数据user := User{Name: "谢永强"}res,_ := engine.ID(1).Delete(&user)fmt.Println(res)
执行 SQL
	// 1. 执行 SQLres,_ := engine.Exec("UPDATE user SET name = '刘海柱' WHERE id = ?",1)fmt.Println(res)

1.3.4、查询与遍历

1. SQL 查询（不常用）
  • Query 最原始的也支持SQL语句查询，返回的结果类型为 []map[string][]byte。
  • QueryString 返回 []map[string]string, QueryInterface 返回 []map[string]interface{}。
	res1,_ := engine.Query("SELECT * FROM user");fmt.Println(res1)res2,_ := engine.QueryString("SELECT * FROM user");fmt.Println(res2)res3,_ := engine.QueryInterface("SELECT * FROM user");fmt.Println(res3)

运行结果：

[map[age:[50 50] created:[50 48 50 52 45 48 52 45 51 48 32 50 48 58 53 53 58 51 53] id:[49] name:[229 136 152 230 181 183 230 159 177] password:[49 50 51 52 53 54] updated:[50 48 50 52 45 48 52 45 51 48 32 50 49 58 49 52 58 50 57]] map[age:[50 50] created:[50 48 50 52 45 48 52 45 51 48 32 50 48 58 53 56 58 52 55] id:[50] name:[230 157 142 229 164 167 229 150 156] password:[49 50 51 52 53 54] updated:[50 48 50 52 45 48 52 45 51 48 32 50 48 58 53 56 58 52 55]] map[age:[53 50] created:[50 48 50 52 45 48 52 45 51 48 32 50 49 58 48 52 58 49 49] id:[51] name:[229 136 152 232 131 189] password:[49 50 51 52 53 54] updated:[50 48 50 52 45 48 52 45 51 48 32 50 49 58 48 52 58 49 49]] map[age:[53 50] created:[50 48 50 52 45 48 52 45 51 48 32 50 49 58 48 52 58 49 49] id:[52] name:[232 181 181 229 155 155] password:[49 50 51 52 53 54] updated:[50 48 50 52 45 48 52 45 51 48 32 50 49 58 48 52 58 49 49]]]
[map[age:22 created:2024-04-30 20:55:35 id:1 name:刘海柱 password:123456 updated:2024-04-30 21:14:29] map[age:22 created:2024-04-30 20:58:47 id:2 name:李大喜 password:123456 updated:2024-04-30 20:58:47] map[age:52 created:2024-04-30 21:04:11 id:3 name:刘能 password:123456 updated:2024-04-30 21:04:11] map[age:52 created:2024-04-30 21:04:11 id:4 name:赵四 password:123456 updated:2024-04-30 21:04:11]]
[map[age:22 created:2024-04-30 20:55:35 id:1 name:刘海柱 password:123456 updated:2024-04-30 21:14:29] map[age:22 created:2024-04-30 20:58:47 id:2 name:李大喜 password:123456 updated:2024-04-30 20:58:47] map[age:52 created:2024-04-30 21:04:11 id:3 name:刘能 password:123456 updated:2024-04-30 21:04:11] map[age:52 created:2024-04-30 21:04:11 id:4 name:赵四 password:123456 updated:2024-04-30 21:04:11]]
2. GET 查询（单行查询）
    // GET 查询user := User{}engine.Get(&user) // 默认查询第一条数据fmt.Println(user) // {1 刘海柱 22 123456 2024-04-30 20:55:35 +0800 CST 2024-04-30 21:14:29 +0800 CST}

指定条件来查询

    user := User{Name: "刘海柱"}// 查询指定用户名 且 根据id降序后的第一条数据engine.Where("name=?",user.Name).Desc("id").Get(&user)fmt.Println(user)

查询指定字段：

    // 获取指定字段值user := User{}var name string// Table(&user) 代表表结构和结构体 User 相同engine.Table(&user).Where("id = 1").Cols("name").Get(&name)fmt.Println(name)
3. Find 查询（多行查询）
    var users []Userengine.Where("id < 5").And("password = 123456").Limit(10).Find(&users)for i := 0; i < len(users);i++ {fmt.Println(users[i])}// 或者使用 range 遍历切片for _,user := range users{fmt.Println(user)}

运行结果： 

{1 刘海柱 22 123456 2024-04-30 20:55:35 +0800 CST 2024-04-30 21:14:29 +0800 CST}
{2 李大喜 22 123456 2024-04-30 20:58:47 +0800 CST 2024-04-30 20:58:47 +0800 CST}
{3 刘能 52 123456 2024-04-30 21:04:11 +0800 CST 2024-04-30 21:04:11 +0800 CST}
{4 赵四 52 123456 2024-04-30 21:04:11 +0800 CST 2024-04-30 21:04:11 +0800 CST}
4. Count 查询
    // 查询所有 password="123456" 的用户user := User{Password: "123456"}count,_ := engine.Count(&user)fmt.Println(count) // 4
5. Iterate 迭代查询

Iterate 方法有两个参数：

  1. 查询条件（哪个结构体对应的表以及过滤条件）
  2. 匿名函数（第一个参数代表查询到的当前元素的索引，第二个参数代表当前元素对象）
    engine.Iterate(&User{Password: "123456"}, func(idx int, bean interface{}) error {// 类型断言user := bean.(*User)fmt.Println(user)return nil})
6. Rows 迭代查询
    rows,_ := engine.Rows(&User{Password: "123456"})defer rows.Close()user := new(User) // 传递指针给userfor rows.Next(){rows.Scan(user)fmt.Println(user)}

        这里的 Scan 方法需要一个指针，所以我们上面使用 new(User) 来初始化一个指针给 user，我们也可以通过下面的方法，都是一样的：

	rows,_ := engine.Rows(&User{Password: "123456"})defer rows.Close()user := User{}for rows.Next(){rows.Scan(&user)fmt.Println(user)}

1.3.5、事务

        要使用事务的话，必须使用 session 类进行数据的增删改，并结合 panic 和 recover 来进行异常的处理，一旦出现异常就回滚所有事务：

	session := engine.NewSession()defer session.Close()// 通过 panic 和 recover 进行异常的处理defer func() {err := recover()if err != nil {fmt.Println("Rollback")session.Rollback()}else {session.Commit()}}()session.Begin() // 开启事务user := User{Id: 5,Name: "王老七",Age: 40}if _,err := session.Insert(&user);err!=nil{panic(err)}

这篇关于XORM 框架的使用的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/967598。

相关文章

Java使用ANTLR4对Lua脚本语法校验详解

Java使用ANTLR4对Lua脚本语法校验详解

《Java使用ANTLR4对Lua脚本语法校验详解》ANTLR是一个强大的解析器生成器,用于读取、处理、执行或翻译结构化文本或二进制文件,下面就跟随小编一起看看Java如何使用ANTLR4对Lua脚本... 目录什么是ANTLR？第一个例子ANTLR4 的工作流程Lua脚本语法校验准备一个Lua Gramm
阅读更多...
Java Optional的使用技巧与最佳实践

Java Optional的使用技巧与最佳实践

《JavaOptional的使用技巧与最佳实践》在Java中,Optional是用于优雅处理null的容器类,其核心目标是显式提醒开发者处理空值场景,避免NullPointerExce... 目录一、Optional 的核心用途二、使用技巧与最佳实践三、常见误区与反模式四、替代方案与扩展五、总结在 Java
阅读更多...
使用Java将DOCX文档解析为Markdown文档的代码实现

使用Java将DOCX文档解析为Markdown文档的代码实现

《使用Java将DOCX文档解析为Markdown文档的代码实现》在现代文档处理中,Markdown（MD）因其简洁的语法和良好的可读性,逐渐成为开发者、技术写作者和内容创作者的首选格式,然而,许多文... 目录引言1. 工具和库介绍2. 安装依赖库3. 使用Apache POI解析DOCX文档4. 将解析
阅读更多...
Qt中QUndoView控件的具体使用

Qt中QUndoView控件的具体使用

《Qt中QUndoView控件的具体使用》QUndoView是Qt框架中用于可视化显示QUndoStack内容的控件,本文主要介绍了Qt中QUndoView控件的具体使用,具有一定的参考价值,感兴趣的... 目录引言一、QUndoView 的用途二、工作原理三、 如何与 QUnDOStack 配合使用四、自
阅读更多...
C++使用printf语句实现进制转换的示例代码

C++使用printf语句实现进制转换的示例代码

《C++使用printf语句实现进制转换的示例代码》在C语言中,printf函数可以直接实现部分进制转换功能,通过格式说明符（formatspecifier）快速输出不同进制的数值,下面给大家分享C+... 目录一、printf 原生支持的进制转换1. 十进制、八进制、十六进制转换2. 显示进制前缀3. 指
阅读更多...
使用Python构建一个Hexo博客发布工具

使用Python构建一个Hexo博客发布工具

《使用Python构建一个Hexo博客发布工具》虽然Hexo的命令行工具非常强大,但对于日常的博客撰写和发布过程,我总觉得缺少一个直观的图形界面来简化操作,下面我们就来看看如何使用Python构建一个... 目录引言Hexo博客系统简介设计需求技术选择代码实现主框架界面设计核心功能实现1. 发布文章2. 加
阅读更多...
shell编程之函数与数组的使用详解

shell编程之函数与数组的使用详解

《shell编程之函数与数组的使用详解》：本文主要介绍shell编程之函数与数组的使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录shell函数函数的用法俩个数求和系统资源监控并报警函数函数变量的作用范围函数的参数递归函数shell数组获取数组的长度读取某下的
阅读更多...
使用Python开发一个带EPUB转换功能的Markdown编辑器

使用Python开发一个带EPUB转换功能的Markdown编辑器

《使用Python开发一个带EPUB转换功能的Markdown编辑器》Markdown因其简单易用和强大的格式支持,成为了写作者、开发者及内容创作者的首选格式,本文将通过Python开发一个Markd... 目录应用概览代码结构与核心组件1. 初始化与布局 (__init__)2. 工具栏 (setup_t
阅读更多...
Python虚拟环境终极(含PyCharm的使用教程)

Python虚拟环境终极(含PyCharm的使用教程)

《Python虚拟环境终极(含PyCharm的使用教程)》：本文主要介绍Python虚拟环境终极(含PyCharm的使用教程),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,... 目录一、为什么需要虚拟环境？二、虚拟环境创建方式对比三、命令行创建虚拟环境（venv）3.1 基础命令3
阅读更多...
Python Transformer 库安装配置及使用方法

Python Transformer 库安装配置及使用方法

《PythonTransformer库安装配置及使用方法》HuggingFaceTransformers是自然语言处理（NLP）领域最流行的开源库之一,支持基于Transformer架构的预训练模... 目录python 中的 Transformer 库及使用方法一、库的概述二、安装与配置三、基础使用：Pi
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2