Golang实现自己的orm框架实例探索

 更新时间:2024年01月24日 09:32:12   作者:绍纳 nullbody笔记  
这篇文章主要为大家介绍了Golang实现自己的orm框架实例探索,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

引言

本项目相当于gorm的精简版,通过学习本项目可以更好的理解orm框架每个函数都在做什么,以及为什么这么定义框架功能。

通过本项目学到什么?

  • 定义自己的日志库logger
  • 如何将结构体转化成数据库的表信息(字段/字段类型/表名)
  • 如何实现常用的CRUD?
  • 如何实现事务?
  • 如何实现钩子?

Golang orm框架实现

该项目的核心数据结构为 Session

type Session struct {
	db *sql.DB
	tx *sql.Tx

	// table
	tableMeta *table.TableMeta

	dial dialect.Dialect
	// clause

	clause clause.Clause

	// sql query
	sql strings.Builder
	// sql param
	sqlParam []interface{}
}

db: 负责执行sql语句

tx: 通过事务执行sql语句

tableMeta: Golang的结构体转成的 表信息

clause: sql语句构造器(负责生成CRUD SQL 字符串 )

dial: 将Golang数据类型转成 数据库的类型

sql/sqlParam: 待执行的sql和参数

定义自己的日志库logger

特色:就是不同的日志级别有不同的颜色

如何将结构体转化成数据库的表信息(字段/字段类型/表名)

// Parse 将结构体转化成 表/字段/字段类型
func Parse(dest interface{}, d dialect.Dialect) *TableMeta {
	// 是否为nil
	if dest == nil {
		returnnil
	}
	// (*User)(nil)
	value := reflect.ValueOf(dest)
	if value.Kind() == reflect.Ptr && value.IsNil() {
		value = reflect.New(value.Type().Elem()) // 取出类型,构造新对象
	}
	meta := &TableMeta{
		Model:    value.Interface(), // 保存对象
		fieldMap: make(map[string]*Field),
	}
	destValue := reflect.Indirect(value)
	destType := destValue.Type()
	// 结构体类型名:就是表名
	m, ok := value.Interface().(Tabler)
	if ok {
		meta.TableName = m.TableName()
	} else {
		meta.TableName = destType.Name()
	}
	for i := 0; i < destType.NumField(); i++ {
		fieldType := destType.Field(i)
		// 非匿名 && 可导出
		if !fieldType.Anonymous && fieldType.IsExported() {
			// 成员变量:就是字段名
			// 成员变量类型:就是字段类型
			field := &Field{
				FieldName: fieldType.Name,
				FieldType: d.ConvertType2DBType(destValue.Field(i)),
				FieldTag:  fieldType.Tag.Get("easyorm"),
			}
			meta.Fields = append(meta.Fields, field)
			meta.FieldsName = append(meta.FieldsName, field.FieldName)
			meta.fieldMap[field.FieldName] = field
		}
	}
	return meta
}

如何实现常用的CRUD

这里以新增为例:一般的调用方式为 s.Insert(&User{},&User{})

整个代码其实就是基于传入的values,通过 reflect的相关函数提取出其中的字段值,最终的目的在于拼接成 insert into $table ($field) values (?,?),(?,?) 标准的SQL语句,传给底层的驱动执行

// s.Insert(&User{},&User{})
func (s *Session) Insert(values ...interface{}) (int64, error) {
	iflen(values) == 0 {
		return0, errors.New("param is empty")
	}
	// init table
	s.Model(values[0])
	// clause insert:负责生成 insert into $tableName ($FieldName) 字符串
	s.clause.Set(clause.INSERT, s.TableMeta().TableName, s.TableMeta().FieldsName)

	valueSlice := []interface{}{}

	for _, value := range values {
		s.CallMethod(BeforeInsert, value)
        // 提取结构体中对象字段的值,作为sql语言的参数
		valueSlice = append(valueSlice, s.TableMeta().ExtractFieldValue(value))
	}
	// clause values:负责生成 values (?,?,?),(?,?,?)
	s.clause.Set(clause.VALUES, valueSlice...)
    //s.clause.Build: 负责将 insert into $tableName ($FieldName)  拼接上 values (?,?,?),(?,?,?) 形成完整的sql语句
	sql, sqlParam := s.clause.Build(clause.INSERT, clause.VALUES)
	// exec sql : 实际执行sql
	result, err := s.Raw(sql, sqlParam...).Exec()
	if err != nil {
		return0, err
	}
	s.CallMethod(AfterInsert, nil)
	return result.RowsAffected()
}

如何实现事务?

通过SessionBegin方法开启事务,在回调函数 f TxFunc中进行具体的【数据库业务逻辑】,最后基于  f TxFunc是否执行返回 error来决定是Commit还是 Rollback

// TxFunc will be called between tx.Begin() and tx.Commit()
type TxFunc func(*session.Session) (interface{}, error)
// Transaction executes sql wrapped in a transaction, then automatically commit if no error occurs
func (engine *Engine) Transaction(f TxFunc) (result interface{}, err error) {
	s := engine.NewSession()
	if err := s.Begin(); err != nil {
		returnnil, err
	}
	deferfunc() {
		if p := recover(); p != nil {
			_ = s.Rollback()
			panic(p) // re-throw panic after Rollback
		} elseif err != nil {
			_ = s.Rollback() // err is non-nil; don't change it
		} else {
			err = s.Commit() // err is nil; if Commit returns error update err
		}
	}()
	return f(s)
}

如何实现钩子?

其实就是利用reflect.MethodByName,读取 value 对象的函数,然后Call执行该函数,本质就是回调。利用钩子在获取到数据以后,用户可以在回调中对数据进行统一修改,对执行结果进行收口

// CallMethod calls the registered hooks
func (s *Session) CallMethod(method string, value interface{}) {
	fm := reflect.ValueOf(s.TableMeta().Model).MethodByName(method)
	if value != nil {
		fm = reflect.ValueOf(value).MethodByName(method)
	}
	param := []reflect.Value{reflect.ValueOf(s)}
	if fm.IsValid() {
		if v := fm.Call(param); len(v) > 0 {
			if err, ok := v[0].Interface().(error); ok {
				logger.Error(err)
			}
		}
	}
}

项目拖过地址: https://github.com/gofish2020/easyorm 

以上就是Golang实现自己的orm框架实例探索的详细内容,更多关于Golang orm框架的资料请关注脚本之家其它相关文章!

相关文章

  • golang双指针快速排序的实现代码

    golang双指针快速排序的实现代码

    这篇文章主要介绍了golang双指针快速排序的实现代码,通过实例代码补充介绍了Golang实现快速排序和归并排序以及堆排序算法全注释,需要的朋友可以参考下
    2024-03-03
  • Golang观察者模式优化订单处理系统实例探究

    Golang观察者模式优化订单处理系统实例探究

    当涉及到订单处理系统时,观察者设计模式可以用于实现订单状态的变化和通知,在这篇文章中,我们将介绍如何使用Golang来实现观察者设计模式,并提供一个基于订单处理系统的代码示例
    2024-01-01
  • 详解Golang中interface{}的注意事项

    详解Golang中interface{}的注意事项

    学习 golang ,对于 interface{} 接口类型,我们一定绕不过,这篇文章咱们就来一起来看看 使用 interface{} 的时候,都有哪些注意事项吧
    2023-03-03
  • 深入解析Golang中JSON的编码与解码

    深入解析Golang中JSON的编码与解码

    随着互联网的快速发展和数据交换的广泛应用,各种数据格式的处理成为软件开发中的关键问题,本文将介绍 Golang 中 JSON 编码与解码的相关知识,帮助大家了解其基本原理和高效应用,需要的可以收藏一下
    2023-05-05
  • go语言vscode集成开发环境搭建

    go语言vscode集成开发环境搭建

    本文将介绍如何使用VSCode搭建Go语言开发环境,Go语言是一种简洁高效的编程语言,而VSCode是一款轻量级的集成开发环境,二者的结合可以提供良好的开发体验,
    2023-08-08
  • go语言区块链学习调用智能合约

    go语言区块链学习调用智能合约

    这篇文章主要为大家介绍了go语言区块链学习中如何调用智能合约的实现示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步
    2021-10-10
  • 详解Go语言如何使用标准库sort对切片进行排序

    详解Go语言如何使用标准库sort对切片进行排序

    Sort 标准库提供了对基本数据类型的切片和自定义类型的切片进行排序的函数。今天主要分享的内容是使用 Go 标准库 sort 对切片进行排序,感兴趣的可以了解一下
    2022-12-12
  • Go语言实现IP段范围校验示例

    Go语言实现IP段范围校验示例

    这篇文章主要介绍了Go语言实现IP段范围校验示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • 详解golang中的method

    详解golang中的method

    这篇文章主要介绍了golang中的method的相关资料,帮助大家更好的理解和使用golang,感兴趣的朋友可以了解下
    2021-01-01
  • golang远程操作docker api方式

    golang远程操作docker api方式

    文章介绍了Docker监听并处理三种socket形式的API请求:unix、tcp和fd,默认情况下,Docker已经开启了unix socket,并且只有root用户或docker用户组成员才有权限访问,用户可以通过编辑docker守护进程的配置文件,添加tcp参数来开放远程API访问
    2025-12-12

最新评论