SqlSugar 开源项目使用教程

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

SqlSugar 是一个 .NET 的开源 ORM 框架，其 GitHub 仓库的目录结构清晰，便于开发者理解和使用。以下是主要的目录结构及其介绍：

SqlSugar/
├── src/
│   ├── SqlSugar/
│   │   ├── Attributes/
│   │   ├── Cache/
│   │   ├── DataBase/
│   │   ├── DbAdo/
│   │   ├── DbMaintenance/
│   │   ├── DbQuery/
│   │   ├── DbSeed/
│   │   ├── DbUpdate/
│   │   ├── Exts/
│   │   ├── IDbMethods/
│   │   ├── Interfaces/
│   │   ├── Mapping/
│   │   ├── Metadata/
│   │   ├── SqlBuilder/
│   │   ├── SqlSugarClient.cs
│   │   ├── SqlSugarScope.cs
│   │   ├── SugarColumn.cs
│   │   ├── SugarTable.cs
│   │   └── ...
│   └── SqlSugar.AspNetCore/
│       └── ...
├── test/
│   ├── SqlSugar.Tests/
│   │   └── ...
│   └── SqlSugar.AspNetCore.Tests/
│       └── ...
├── .gitignore
├── LICENSE
├── README.md
└── ...

主要目录介绍：

• src/SqlSugar/: 包含 SqlSugar 框架的核心代码，如数据库操作、缓存管理、映射配置等。
• src/SqlSugar.AspNetCore/: 包含与 ASP.NET Core 集成的相关代码。
• test/: 包含单元测试和集成测试的代码。

2. 项目的启动文件介绍

SqlSugar 的启动文件主要涉及初始化数据库连接和配置。以下是一个典型的启动文件示例：

using SqlSugar;

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddSqlSugar(new ConnectionConfig()
        {
            ConnectionString = "your_connection_string",
            DbType = DbType.SqlServer, // 根据需要选择数据库类型
            IsAutoCloseConnection = true
        });
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        // 其他配置
    }
}

关键点：

• ConnectionConfig: 配置数据库连接字符串、数据库类型等。
• services.AddSqlSugar: 将 SqlSugar 服务添加到依赖注入容器中。

3. 项目的配置文件介绍

SqlSugar 的配置文件通常包含数据库连接字符串和其他相关配置。以下是一个典型的配置文件示例（appsettings.json）：

{
  "ConnectionStrings": {
    "DefaultConnection": "your_connection_string"
  },
  "SqlSugarSettings": {
    "DbType": "SqlServer",
    "IsAutoCloseConnection": true
  }
}

关键点：

• ConnectionStrings: 存储数据库连接字符串。
• SqlSugarSettings: 存储 SqlSugar 的其他配置，如数据库类型和是否自动关闭连接。

通过以上配置，可以确保 SqlSugar 在项目中正确初始化和运行。