eorm 开源项目使用教程

1. 项目的目录结构及介绍

eorm 项目的目录结构如下：

eorm/
├── README.md
├── go.mod
├── go.sum
├── examples/
│   ├── basic/
│   └── advanced/
├── internal/
│   ├── dialect/
│   ├── entity/
│   ├── orm/
│   └── session/
├── pkg/
│   ├── logger/
│   └── utils/
└── main.go

目录结构介绍

• README.md: 项目说明文件，包含项目的基本信息和使用指南。
• go.mod 和 go.sum: Go 模块文件，用于管理项目的依赖。
• examples/: 包含基本和高级示例代码，帮助用户快速上手。
• internal/: 内部包，包含项目的核心实现，如数据库方言、实体管理、ORM 操作和会话管理。
• pkg/: 公共包，包含日志和工具类等公共组件。
• main.go: 项目的入口文件。

2. 项目的启动文件介绍

项目的启动文件是 main.go，其主要功能是初始化 ORM 框架并启动示例程序。以下是 main.go 的简要介绍：

package main

import (
    "fmt"
    "github.com/ecodeclub/eorm"
    "github.com/ecodeclub/eorm/internal/entity"
)

func main() {
    // 初始化数据库连接
    db, err := eorm.NewDB("mysql", "user:password@tcp(127.0.0.1:3306)/dbname")
    if err != nil {
        panic(err)
    }

    // 创建表
    err = db.CreateTable(&entity.User{})
    if err != nil {
        panic(err)
    }

    // 插入数据
    user := &entity.User{
        Name: "Alice",
        Age:  25,
    }
    err = db.Insert(user)
    if err != nil {
        panic(err)
    }

    // 查询数据
    var users []entity.User
    err = db.Find(&users)
    if err != nil {
        panic(err)
    }

    fmt.Println(users)
}

启动文件功能介绍

• 初始化数据库连接: 使用 eorm.NewDB 函数连接到数据库。
• 创建表: 使用 db.CreateTable 方法创建数据表。
• 插入数据: 使用 db.Insert 方法插入数据。
• 查询数据: 使用 db.Find 方法查询数据并打印结果。

3. 项目的配置文件介绍

eorm 项目没有独立的配置文件，所有配置信息通过代码传递。例如，在 main.go 中，数据库连接信息直接在 eorm.NewDB 函数中指定：

db, err := eorm.NewDB("mysql", "user:password@tcp(127.0.0.1:3306)/dbname")

配置信息介绍

• 数据库类型: 指定数据库类型，如 mysql。
• 连接字符串: 包含用户名、密码、主机地址和数据库名等信息。

通过这种方式，eorm 项目实现了灵活的数据库配置，用户可以根据需要修改连接字符串以适应不同的数据库环境。

---

以上是 eorm 开源项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 eorm 项目。