SmartSql 开源项目教程

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

SmartSql 是一个高性能、轻量级的 .NET 数据库访问框架。以下是其主要的目录结构和介绍：

SmartSql/
├── src/
│   ├── SmartSql/
│   │   ├── Caching/
│   │   ├── Configuration/
│   │   ├── Data/
│   │   ├── DbSession/
│   │   ├── IdGenerator/
│   │   ├── Logging/
│   │   ├── Middleware/
│   │   ├── Reflection/
│   │   ├── Resources/
│   │   ├── SmartSql.csproj
│   │   ├── SmartSqlMapConfig.xml
│   │   ├── SmartSqlMap.xsd
│   │   └── SmartSqlMap.xml
│   ├── SmartSql.Abstractions/
│   ├── SmartSql.Annotations/
│   ├── SmartSql.Batch/
│   ├── SmartSql.Cache.Memory/
│   ├── SmartSql.Cache.Redis/
│   ├── SmartSql.DIExtension/
│   ├── SmartSql.Dapper/
│   ├── SmartSql.DataFilter/
│   ├── SmartSql.Fluent/
│   ├── SmartSql.IdGenerator.Snowflake/
│   ├── SmartSql.InvokeSync/
│   ├── SmartSql.Remote/
│   ├── SmartSql.ScriptTag/
│   ├── SmartSql.TypeHandler/
│   └── SmartSql.ZooKeeperConfig/
├── test/
│   ├── SmartSql.Test/
│   └── SmartSql.Test.Unit/
└── README.md

• src/SmartSql/: 核心代码目录，包含 SmartSql 的主要功能实现。
• src/SmartSql.Abstractions/: 定义了 SmartSql 的抽象接口。
• src/SmartSql.Annotations/: 包含 SmartSql 的注解相关代码。
• src/SmartSql.Batch/: 批处理相关功能。
• src/SmartSql.Cache.Memory/ 和 src/SmartSql.Cache.Redis/: 缓存实现，分别支持内存缓存和 Redis 缓存。
• src/SmartSql.DIExtension/: 依赖注入扩展。
• src/SmartSql.Dapper/: Dapper 集成。
• src/SmartSql.DataFilter/: 数据过滤功能。
• src/SmartSql.Fluent/: 流畅接口支持。
• src/SmartSql.IdGenerator.Snowflake/: Snowflake ID 生成器。
• src/SmartSql.InvokeSync/: 同步调用支持。
• src/SmartSql.Remote/: 远程调用支持。
• src/SmartSql.ScriptTag/: 脚本标签支持。
• src/SmartSql.TypeHandler/: 类型处理器。
• src/SmartSql.ZooKeeperConfig/: ZooKeeper 配置支持。
• test/: 包含单元测试和集成测试代码。

2. 项目的启动文件介绍

SmartSql 的启动文件主要是 SmartSqlMapConfig.xml，它位于 src/SmartSql/ 目录下。这个文件是 SmartSql 的配置文件，包含了数据库连接信息、映射文件路径、缓存配置等关键信息。

<SmartSqlMapConfig xmlns="http://SmartSql.net/schemas/SmartSqlMapConfig.xsd">
  <Settings>
    <!-- 配置项 -->
  </Settings>
  <Database>
    <DbProvider Name="SqlServer" />
    <Write Name="WriteDB" ConnectionString="Data Source=.;Initial Catalog=SmartSqlDB;Integrated Security=True" />
    <Read Name="ReadDB" ConnectionString="Data Source=.;Initial Catalog=SmartSqlDB;Integrated Security=True" />
  </Database>
  <TypeHandlers>
    <!-- 类型处理器配置 -->
  </TypeHandlers>
  <SmartSqlMaps>
    <!-- 映射文件路径配置 -->
  </SmartSqlMaps>
</SmartSqlMapConfig>

3. 项目的配置文件介绍

SmartSql 的配置文件主要包括 SmartSqlMapConfig.xml 和 SmartSqlMap.xml。

SmartSqlMapConfig.xml

这个文件是 SmartSql 的主配置文件，包含了数据库连接信息、映射文件路径、缓存配置等。

• <Settings>: 配置全局设置，如是否启用