GORM ORM库使用手册

GORM ORM库使用手册

gorm项目地址:https://gitcode.com/gh_mirrors/gorm/gorm

一、项目目录结构及介绍

GORM是一个为Go语言设计的开发者友好的ORM库。下面简要概述其项目结构及其主要文件功能：

- .gitignore           # 忽略特定文件和目录的Git配置文件
- golangci.yml         # Golang CI/Lint配置文件，用于代码质量检查
- LICENSE              # 开源许可证，遵循MIT协议
- README.md            # 项目主读我文件，介绍项目和快速入门指南
- callbacks.go         # 回调函数的实现，如创建、更新前后的处理逻辑
- chainable_api.go     # 支持链式操作的API定义
- errors.go            # 错误处理相关代码
- finisher_api.go      # 完成器API，比如关闭数据库连接
- gorm.go              # GORM的核心库入口
- interfaces.go        # 数据访问对象(DAO)接口定义
- migrator.go          # 数据库迁移工具
- model.go             # 模型相关的定义，关联数据库表结构
- prepare_stmt.go      # 预备语句模式实现
- scan.go              # 扫描查询结果到结构体的实现
- soft_delete.go       # 软删除功能实现
- statement.go         # SQL构建和执行的核心逻辑
- ...                 # 其他辅助文件和测试相关文件

目录说明:

• 核心业务逻辑集中于gorm.go，是开发人员直接交互的主要入口。
• model.go中定义了如何映射Go结构体到数据库表的基础逻辑。
• callbacks.go, interfaces.go, 和其他若干.go文件提供了ORM操作的丰富功能，如钩子函数、事务处理等。
• migrator.go负责数据库迁移，帮助开发者管理数据表结构变更。

二、项目的启动文件介绍

GORM本身不提供一个传统的“启动文件”，因为它作为一个库被导入到你的应用中。但在使用GORM时，你的应用程序中的初始化部分将扮演类似“启动文件”的角色，示例代码如下：

package main

import (
    "github.com/jinzhu/gorm"
    _ "github.com/jinzhu/gorm/dialects/mysql" // 引入对应的数据库驱动
)

func main() {
    db, err := gorm.Open("mysql", "user:password@/dbname?charset=utf8&parseTime=True&loc=Local")
    if err != nil {
        panic("failed to connect database")
    }
    defer db.Close()

    // 进行数据库操作...
}

这段代码通常位于你的应用入口处，用于初始化数据库连接，并且在程序退出前确保资源释放。

三、项目的配置文件介绍

GORM没有内置的配置文件模板，它的配置通常是通过代码动态设置的。例如，通过打开数据库连接字符串来指定数据库类型、地址、用户名、密码等。然而，在实际应用中，为了提高可维护性，开发者可能会选择在外部（如.env文件或YAML/JSON配置文件）存储这些连接细节，并在程序启动时加载它们。这是一个典型的环境变量配置示例：

.env
DB_DRIVER=mysql
DB_CONN=user:password@/dbname?charset=utf8&parseTime=True&loc=Local

然后在代码中加载并使用这些配置：

import (
    "github.com/jinzhu/gorm"
    "github.com/joho/godotenv"
    _ "github.com/jinzhu/gorm/dialects/mysql"
)

func initDB() (*gorm.DB, error) {
    err := godotenv.Load(".env")
    if err != nil {
        return nil, err
    }

    dbDriver := os.Getenv("DB_DRIVER")
    dbConn := os.Getenv("DB_CONN")

    db, err := gorm.Open(dbDriver, dbConn)
    if err != nil {
        return nil, err
    }
    return db, nil
}

通过这种方式，可以根据不同的环境轻松调整数据库配置，保持代码灵活性和清晰度。

gorm项目地址:https://gitcode.com/gh_mirrors/gorm/gorm