xormplus是xorm的增强版，为xorm提供类似ibatis的配置文件及动态SQL支持

news2024/11/24 14:41:49

简介

xorm是一个简单而强大的Go语言ORM库，通过它可以使数据库操作非常简便。本库是基于原版xorm的定制增强版本，为xorm提供类似ibatis的配置文件及动态SQL支持，支持AcitveRecord操作。

github地址:https://github.com/armingli/xorm

//安装
go get -u github.com/xormplus/xorm

数据库映射

ORM框架最重要的就是将数据映射为程序中的数据结构。在Go中结构体是主要的自定义的数据结构，将数据的表格映射为go的结构体，使go程序中可以实用数据库的数据。

在大多数的orm框架中，如果数据库表名和程序中的数据结构名一致，成员变量和数据库表的字段对应，orm底层的设计就可以自动转化过来，查询的数据直接克隆到程序的变量中中。

但是大多数情况下，这些字段使并不对应的，需要通过一些配置和约定来实现。

在这里插入图片描述

type User struct {
	Id       int
	User     string
	Password string
	Role     string
}

在go语言中首字母大写表示访问权限，但是这就和数据不一样了，xorm底层使用了core.IMapper来试下数据库映射。

https://static.kancloud.cn/xormplus/xorm/167084

mapper描述
core.SnakeMapper支持struct为驼峰式命名，表结构为下划线命名之间的转换
core.SameMapper支持结构体名称和对应的表名称以及结构体field名称与对应的表字段名称相同的命名
core.GonicMapper和SnakeMapper很类似，但是对于特定词支持更好，比如ID会翻译成id而不是i_d

通过引擎来设置：

engine.SetMapper(core.SameMapper{})

更多规则移步

Mapper的映射来操作是最理想的，但是有些情况并不满足需要使用tag标签来定义，同时还具有以下性质：

  • 如果结构体拥有TableName() string的成员方法，那么此方法的返回值即是该结构体对应的数据库表名。

  • engine.Table()方法可以改变struct对应的数据库表的名称

  • 通过sturct中field对应的Tag中使用xorm:"'column_name'"可以使该field对应的Column名称为指定名称

在这里插入图片描述

数据库操作方法

xorm是一个完全的orm框架，使用改框架几乎可以做到不用写sql语句，但是小编习惯写sql，感觉直接写sql更直观。

插入

insert into <tablename> (cols ...) values (cols...)

engine.Insert(user)

user是一个数据库表映射的结构体实例，将实例传入构建一条插入语句。user可以是指针和变量类型。

在插入单条数据成功后，如果该结构体有自增字段(设置为autoincr)，则自增字段会被自动赋值为数据库中的id。这里需要注意的是，如果插入的结构体中，自增字段已经赋值，则该字段会被作为非自增字段插入。

批量插入参数为多个结构体实例。

xorm支持原生sql插入：

engine.Exec() 

sql ="insert into user(username,password) values (?, ?)"
res, err := engine.Exec(sql, "xiaoxu", "123456") 

//  ?会被替换为参数

engine.Sql()

sql ="insert into user(username,password) values (?, ?)"
affected, err := engine.Sql(sql, "xiaoxu", "123456").Execute()

stpl配置文件

类似myabtis的xml配置文件。

sql := "insert.example.stpl"
paramMap := map[string]interface{}{"key": "config_3", "value": "3"}
affected, err := engine.SqlTemplateClient(sql, &paramMap).Execute()

stpl配置文件在查询一节详细介绍

更新

affected, err := engine.Id(id).Update(user)

id指定更新的数据项，update指定更新的数据元素。user是一个结构体实例，内部包含更新的数据，作为一个整体更新，如果没有某些字段就不更新，类型的默认值也不会更新。

一般情况下，直接以映射的结构体作为更新的对象，而不是像下面这样对某些字段更新。
affected, err := engine.Id(id).Cols("age").Update(&user)

数据库一般为假删除，即有状态字段，删除就不再叙述。

查找

  1. ORM查询

xorm查询方法为Get()和Find()相当于SELECT的条件关键字。前者用于单挑数据的查询，后者用于多条数据的查询。

//根据id查询
var user User
engine.Id(1).Get(&user)
// SELECT * FROM user Where id = 1


//where条件查询
has, err := engine.Where("name = ?", name).Get(&user)
// SELECT * FROM user WHERE name = ? LIMIT 1


//数据元素查询
engine.Cols("age", "name").Get(&usr)
// SELECT age, name FROM user limit 1

//数据元素条件查询
has, err := engine.Where("id = ?", id).Cols(cols...).Get(&valuesSlice)
// SELECT col1, col2, col3 FROM user WHERE id = ?

//查询所有
everyone := make([]Userinfo, 0)
err := engine.Find(&everyone)
//SELECT * FROM user

Get()和Find()的区别在于舍去了LIMIT 1其它都是完全一样的，语法规定了两个方法只在末尾为结构体赋值，且参数都为指针类型。

配置文件实现动态SQL（特色）

对于orm操作数据，以及通过engine.Sql()和engine.Exec() 原生sql操作数据库，已经满足大部分要求。但是也有特殊情况，如模糊查询，如果没有查询的参数sql就不能生成对应字段。因此需要使用动态sql。

xorm提供了SqlMap配置和SqlTemplate功能支持类ibatis方式的SQL操作

ibatis就是MyBatis那一套通过xml配置文件来生成和1配置sql的方案。该方案需要手写sql，也是小编习惯的一种方式。

SqlMap和SqlTemplate

armingli/xorm

SqlMap是针对XML文件的sql配置，SqlTemplate是针对.stpl模板的配置（支持动态sql）。

数据库驱动工具创建数据库会话：

package main

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

func db() *xorm.Engine {
	driverName := "mysql"
	dataSource := "root:root@/account?charset=utf8"
	engine, err := xorm.NewEngine(driverName, dataSource)
	if err != nil {
		fmt.Println("数据库连接失败", err)
	}
	return engine

}

func main() {

	//数据项插入
	user1 := User{
		0,
		"test3",
		"admin1",
		"admin",
	}
	db().Insert(user1)

	//元素插入
	db().Table("user").Insert(map[string]interface{}{
		"user":     "test", //map类型的key为数据字段，value为值
		"password": "123",
		"role":     "admin",
	})

	//查询
	var users []User
	err := db().SQL("SELECT * FROM user").Find(&users)
	if err != nil {
		println(err)
	}
	fmt.Println(users)
}

使用sql映射需要先注册sql引擎，SqlMap或者SqlTemplate。

1、使用RegisterSqlMap()注册SqlMap配置
2、RegisterSqlTemplate()方法注册SSqlTemplate模板配置
3、SqlMap配置文件总根目录和SqlTemplate模板配置文件总根目录可为同一目录

//注册SqlMap配置，xml格式
err := engine.RegisterSqlMap(xorm.Xml("./sql/oracle", ".xml"))

//注册SqlTemplate配置，使用Pongo2模板引擎
err := engine.RegisterSqlTemplate(xorm.Pongo2("./sql/oracle", ".stpl"))

//注册SqlTemplate配置，使用html/template模板引擎
err := engine.RegisterSqlTemplate(xorm.Default("./sql/oracle", ".tpl"))

db.RegisterSqlMap()过程:
配置文件中sql配置会读入内存并缓存
xml配置文件中sql标签的id属性值作为SqlMap的key，如有重名id，则后加载的覆盖之前加载的配置sql条目
xml的占位符会被参数特换，该方式只能基于简单的sql配置，无法实现动态sql。

db.RegisterSqlTemplate()过程
RegisterSqlTemplate()方法按指定目录遍历所配置的目录及其子目录及其子目录下的所有stpl模板文件
stpl模板文件名作为SqlTemplate存储的key,内容会读入内存并缓存

不管是哪种方式，sql映射都是基于key-value完成的，因此在程序中加载key框架会自动调用value（sql）。

sqlMap

xormplus引擎加载配置文件的key的方法，执行SqlMap配置文件中的Sql语句，返回的结果类型为[]map[string]interface{}。由于sqlmap必须具有通用性因此返回的结果只能是前者的类型，需要开发者自行转化为结构体类型。

package main

import (
	"fmt"
	"github.com/armingli/xorm"
	_ "gorm.io/driver/mysql"
)

type User struct {
	Id       int
	User     string
	Password string
	Role     string
}

func db() *xorm.Engine {
	//配置数据库驱动
	driverName := "mysql"
	dataSource := "root:root@/account?charset=utf8"
	engine, err := xorm.NewEngine(driverName, dataSource)
	if err != nil {
		fmt.Println("数据库连接失败", err)
	}

	//注册sqlmap
	err = engine.RegisterSqlMap(xorm.Xml("demo/sqlmap", ".xml"))
	if err != nil {
		fmt.Println("注册sqlmap异常", err)
	}
	return engine

}

func main() {
	queryInterface, err := db().SqlMapClient("selectAllUsers").Query().List()
	if err != nil {
		println(err)
	}
	fmt.Println(queryInterface)

}

在这里插入图片描述

在这里插入图片描述

也可以通过?占位符传参：

<sqlMap>
   <sql id="sql_s_1">
       select id,user,password from user where id = ?
   </sql>
</sqlMap>

queryInterface, err := db().SqlMapClient("selectById", 1).Query().List()
if err != nil {
	println(err)
}

fmt.Println(queryInterface)

在这里插入图片描述

sqmap只能配置一些简单的sql语句，实际上还在功能上并没有太大的扩充，但是将sql与程序分析，减低了程序的耦合性。

SqlTemplate

执行SqlTemplate配置文件中的Sql语句，返回的结果类型为[]map[string]interface{}

在这里插入图片描述

package main

import (
	"fmt"
	"github.com/armingli/xorm"
	_ "gorm.io/driver/mysql"
)

type User struct {
	Id       int
	User     string
	Password string
	Role     string
}

func db() *xorm.Engine {
	//配置数据库驱动
	driverName := "mysql"
	dataSource := "root:root@/account?charset=utf8"
	engine, err := xorm.NewEngine(driverName, dataSource)
	if err != nil {
		fmt.Println("数据库连接失败", err)
	}

	//注册sqltemplate
	err = engine.RegisterSqlTemplate(xorm.Pongo2("demo/sqltemplate", ".stpl"))
	if err != nil {
		fmt.Println("注册sqlmap异常", err)
	}
	//engine.ShowSQL(true)
	return engine
}

func main() {
	paramMap_5_2 := map[string]interface{}{"id": 2}
	//paramMap_5_2 := map[string]interface{}{"id": 0, "user": "xiaoxu"}
	results, err := db().SqlTemplateClient("sqltemplate.stpl", &paramMap_5_2).Query().List()

	if err != nil {
		println(err)
	}
	fmt.Println(results)

}

在这里插入图片描述

使用SqlTemplate有三个步骤，

  1. 下载源码

  2. 引擎注册sqltemplate

//注册sqltemplate
err = engine.RegisterSqlTemplate(xorm.Pongo2("demo/sqltemplate", ".stpl"))
if err != nil {
	fmt.Println("注册sqlmap异常", err)
}
  1. 传参并返回数据
// map[string]interface{}定义传递参数
paramMap := map[string]interface{}{"id": 2}
//paramMap:= map[string]interface{}{"id": 0, "user": "xiaoxu"}
//SqlTemplateClient方法加载key，（这里的key就是单个文件）并传入参数
results, err := db().SqlTemplateClient("sqltemplate.stpl", &paramMap).Query().List()

if err != nil {
	println(err)
}
fmt.Println(results)

使用SqlTemplateClient方法时，部分参数未使用，请记得使用对应类型0值（默认值）。

如果SqlTemplateClient执行的为DML（insert，update，delete）时返回的是影响行数，使用Execute()方法。

sql_i_3 := "insert.example.stpl"
paramMap_i_t := map[string]interface{}{"key": "config_3", "value": "3"}
affected, err := engine.SqlTemplateClient(sql_i_3, &paramMap_i_t).Execute()

.stpl是支持pongo2语言的，如下

select *
from user where
{% if id != 0 %}
id=?id
{% else%}
user=?user
{% endif %}

id=?id和user=?user中?后面的字段不能去掉，其和程序中map[string]interface{}参数的字段对应并必须一致，才能自动赋值。否则查询不出数据。

pongo2语法：https://github.com/flosch/pongo2

Django内置模板标签

gin框架也是有模板语法的，SqlTemplate也支持使用gin的模板语法，那么将sql引擎注册为gin-html/template模板引擎。


//注册SqlTemplate配置，使用html/template模板引擎
err := engine.RegisterSqlTemplate(xorm.Default("./sql/oracle", ".tpl"))

更多移步：https://www.kancloud.cn/xormplus/xorm/167081

尝试了一下，没有官网的演示还是找不到头脑，希望会的大佬留言指导。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/518737.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

荷兰国旗问题与快速排序

荷兰国旗问题与快速排序

实现&#xff1a; 当arr[i]小于等于num时&#xff0c;arr[i]和小于等于num区域下一个数进行交换&#xff0c;小于等于区域右扩一个位置&#xff0c;指针 i 指向下一个 当arr[i]大于num时&#xff0c;指针 i 指向下一个 指针 i 越界时完成 升级版本&#xff1a;将小于、等于、…
阅读更多...
存在comsumer group且存在消费行为，但AdminClient获取不到消费offset值

存在comsumer group且存在消费行为，但AdminClient获取不到消费offset值

AdminClient 中的listConsumerGroupOffsets获取不到consumergroup; 网上查找资料说&#xff1a; listConsumerGroupOffsets() 请求返回的消费位移信息未及时更新,仍是稍早时刻的状态。 由于 listConsumerGroupOffsets() 请求需要从 Broker 获取最新的位移信息,如果响应结果的更…
阅读更多...
ABAP SAT使用说明

ABAP SAT使用说明

SAT简介 SAT是SAP提供的用来替代SE30的程序性能优化分析工具( runtime analysis)&#xff0c;功能比SE30更加强大。 创建SAT变式-设置SAT运行属性&#xff0c;默认为default&#xff0c;可以参照创建一个自己的变式。 SAT变式说明 Size Limits&#xff1a; 设置文件最大容量…
阅读更多...
【LeetCode: 279. 完全平方数 | 暴力递归=＞记忆化搜索=＞动态规划 | 背包模型】

【LeetCode: 279. 完全平方数 | 暴力递归=＞记忆化搜索=＞动态规划 | 背包模型】

&#x1f680; 算法题 &#x1f680; &#x1f332; 算法刷题专栏 | 面试必备算法 | 面试高频算法 &#x1f340; &#x1f332; 越难的东西,越要努力坚持&#xff0c;因为它具有很高的价值&#xff0c;算法就是这样✨ &#x1f332; 作者简介&#xff1a;硕风和炜&#xff0c;…
阅读更多...
Goby 漏洞更新 ｜商混ERP系统 DictionaryEdit.aspx 页面存在SQL注入

Goby 漏洞更新 ｜商混ERP系统 DictionaryEdit.aspx 页面存在SQL注入

漏洞名称&#xff1a;商混ERP系统 DictionaryEdit.aspx 页面存在SQL注入 English Name&#xff1a;SQL injection exists on Lotus ERP DictionaryEdit.aspx pag CVSS core: 8.5 影响资产数&#xff1a;616 漏洞描述&#xff1a; 杭州荷花软件有限公司开发的商混ERP系统。…
阅读更多...
开发板和虚拟机socket报错“connect error: No route to host”

开发板和虚拟机socket报错“connect error: No route to host”

学习socket编程时&#xff0c;将服务器程序运行在开发板上&#xff0c;将客户端应用程序运行在 虚拟机Ubuntu16.04 系统&#xff0c;服务器可以正常开启&#xff0c; 但客户端连接时&#xff0c; 报错“connect error: No route to host” 1、网上大多是以下情况&#xff1a; …
阅读更多...
易智编译EaseEditing：计算机顶会不一定比SCI期刊更权威！

易智编译EaseEditing：计算机顶会不一定比SCI期刊更权威！

计算机SCI期刊和学术会议都是评估学术研究水平和影响力的重要指标&#xff0c;但在不同领域、不同学科、不同评价指标下可能会有不同的权威性。 在计算机科学领域&#xff0c;传统上认为顶级学术会议的影响力和权威性更高。 因为计算机科学发展较快&#xff0c;研究领域广泛&a…
阅读更多...
【Linux】8. 环境变量

【Linux】8. 环境变量

1. 环境变量的引入 先描述一个现象&#xff0c;我们在执行二进制可执行程序的时候&#xff0c;是需要找到其所在位置的(程序要运行必须先加载到内存&#xff0c;是因为冯诺依曼体系结构规定CPU只能从内存中读取数据)&#xff0c;所以这也就是为什么我们在运行前带上./的原因&a…
阅读更多...
洛谷P5717-三角形分类

洛谷P5717-三角形分类

洛谷P5717-三角形分类 题目 这道题更像是初中题&#xff0c;但是怎么能完整的按照题目的意思来解决呢&#xff0c;说实话这个题卡了我有一会儿&#xff0c;要做一次性做出这个题&#xff0c;我觉得需要搞清楚if-if 和if-else if-else if&#xff0c;试想这两个的区别是什么&am…
阅读更多...
ChatGPT有意识吗？

ChatGPT有意识吗？

​ 编辑切换为居中 添加图片注释&#xff0c;不超过 140 字&#xff08;可选&#xff09; ChatGPT是一个计算机程序&#xff0c;它没有意识。它只是根据预设的算法和规则来处理输入和输出。虽然它可以模拟人类的对话&#xff0c;但它没有自己的思想或感觉。它只是根据程序设…
阅读更多...
ROS 下 激光扫描仪 YDLidar-G4 使用

ROS 下 激光扫描仪 YDLidar-G4 使用

环境配置&#xff1a; ubuntu20.04 LTS ROS noetic 编程工具&#xff1a;vs code&#xff0c;远程通过ssh访问 扫描仪&#xff1a;YDLidar-G4 YDLidar驱动&#xff1a; YDLidar SDK YDLidar ROS 功能包 1 . YDLidar-SDK通信协议 雷达扫描输出的数据以十六进制格式输出到通信…
阅读更多...
Linux文本之sed流编辑器

Linux文本之sed流编辑器

一、sed的相关知识及其工作流程 1&#xff09;sed编辑器的介绍 sed是一种流编辑器&#xff0c;它一次处理一行内容。处理时&#xff0c;把当前处理的行存储在临时缓冲区中&#xff0c;称为“模式空间”&#xff08;pattern space&#xff09;&#xff0c;接着用sed命令处理缓…
阅读更多...
使用HDFS底层文件进行HBase跨集群数据迁移

使用HDFS底层文件进行HBase跨集群数据迁移

目录 一、概述 二、环境信息 三、HBCK2下载和编译 四、具体操作步骤 4.1 数据同步 4.2 添加元数据 4.3 重新分配region 一、概述 客户集群机房迁移&#xff0c;我们部署的集群也要完成跨集群迁移hbase 表&#xff0c;这里选择迁移Hadoop底层数据来实现hbase的表迁移。 …
阅读更多...
Plant Simulation 模型保存历史记录

Plant Simulation 模型保存历史记录

Plant Simulation 建模是一个长时间的过程&#xff0c;所以做好模型保存历史记录很重要&#xff0c;这次分享一个OOTB&#xff08;开盒即用/系统自带&#xff09;的记录保存历史记录的功能。 文中截图于 Plant Simulation 16.0.5 目录 1.功能设置与说明2.使用场景3.总结 1.功能…
阅读更多...
Selenium自动化测试中的PageObject模式

Selenium自动化测试中的PageObject模式

PageObject模式简介 众所周知&#xff0c;UI页面元素常常是不稳定的&#xff0c;在使用Selenium编写WebUI自动化测试用例时&#xff0c;随着测试脚本的增加&#xff0c;维护和更新这些元素便成为一个令人头疼的问题。 在普通模式下&#xff0c;脚本直接定位并操作元素&#xf…
阅读更多...
链表中的经典问题

链表中的经典问题

一、反转链表 反转一个单链表:一种解决方案是按原始顺序迭代结点&#xff0c;并将它们逐个移动到列表的头部。 方法1:迭代 C struct ListNode* reverseList(struct ListNode* head) {struct ListNode* prev NULL;struct ListNode* curr head;while (curr) {struct ListN…
阅读更多...
字节跳动软件测试面试记：二面被按地上血虐，所幸Offer已到手

字节跳动软件测试面试记：二面被按地上血虐，所幸Offer已到手

在互联网做了几年之后&#xff0c;去大厂“镀镀金”是大部分人的首选。大厂不仅待遇高、福利好&#xff0c;更重要的是&#xff0c;它是对你专业能力的背书&#xff0c;大厂工作背景多少会给你的简历增加几分竞争力。 但说实话&#xff0c;想进大厂还真没那么容易。最近面试字…
阅读更多...
Linux中与“系统网络状态”相关的内核数据结构

Linux中与“系统网络状态”相关的内核数据结构

六、系统网络状态相关的数据结构 6.1 ifconf \linux-2.6.32.63\include\linux\if.h /* Structure used in SIOCGIFCONF request. Used to retrieve interfaceconfiguration for machine (useful for programs which must know allnetworks accessible). */ struct ifcon…
阅读更多...
腾讯云与中电金信发布联合核心方案

腾讯云与中电金信发布联合核心方案

5月11日&#xff0c;以“聚力革新&#xff0c;行稳致远”为主题的 “腾讯金融云国产化战略峰会”在北京举办&#xff0c;来自金融业、科技侧、研究机构的专家学者同聚一堂&#xff0c;共同探讨银行核心下移方法论以及国产化转型实践等话题。会议期间&#xff0c;中电金信副总经…
阅读更多...
Java面试（2）数据类型

Java面试（2）数据类型

数据类型 1. Java有哪些数据类型 Java基本数据类型 这八种基本类型都有对应的包装类分别为&#xff1a;Byte、Short、Integer、Long、Float、Double、Character、Boolean 。 引用数据类型 引用数据类型非常多&#xff0c;大致包括&#xff1a;类、 接口类型、 数组类型、 枚…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023