Options 模式配置
SmartSql.Options 包允许你使用标准的 ASP.NET Core Options 模式，完全从 appsettings.json（或任何 IConfiguration 源）配置 SmartSql。你无需编写和维护 XML 配置文件，而是直接在 JSON 中定义数据库连接、类型处理器、SQL 映射源和设置，并通过 IOptions<SmartSqlConfigOptions> 绑定。
一览表
| 特性 | 描述 |
|---|---|
| 包名 | SmartSql.Options |
| 入口 | SmartSqlBuilder.UseOptions(serviceProvider) |
| Options 类 | SmartSqlConfigOptions |
| 配置构建器 | OptionConfigBuilder（继承 AbstractConfigBuilder） |
| 绑定模式 | 按 alias 键控的 IOptionsSnapshot<SmartSqlConfigOptions> |
| 仍支持 | JSON 中引用的 XML SqlMap 文件 |
配置结构
SmartSqlConfigOptions 类定义了完整的 JSON 结构：
mermaid
classDiagram
class SmartSqlConfigOptions {
+Settings Settings
+IDictionary~string,string~ Properties
+Database Database
+List~TypeHandler~ TypeHandlers
+List~TagBuilder~ TagBuilders
+List~IdGenerator~ IdGenerators
+List~SqlMapSource~ SmartSqlMaps
+List~AutoConverterBuilder~ AutoConverterBuilders
}
class Database {
+DbProvider DbProvider
+DataSource Write
+IEnumerable~DataSource~ Reads
}
class DataSource {
+String Name
+String ConnectionString
+int Weight
}
class TypeHandler {
+String Name
+String Type
+String PropertyType
+String FieldType
+IDictionary Properties
}
class SqlMapSource {
+string Path
+ResourceType Type
}
class IdGenerator {
+String Name
+String Type
+IDictionary Properties
}
SmartSqlConfigOptions --> Database
SmartSqlConfigOptions --> TypeHandler
SmartSqlConfigOptions --> SqlMapSource
SmartSqlConfigOptions --> IdGenerator
Database --> DataSource
style SmartSqlConfigOptions fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
style Database fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
style DataSource fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
style TypeHandler fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
style SqlMapSource fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
style IdGenerator fill:#2d333b,stroke:#6d5dfc,color:#e6edf31
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
JSON 配置示例
json
{
"SmartSqlConfig": {
"Settings": {
"IgnoreParameterCase": true,
"ParameterPrefix": "?"
},
"Properties": {
"ConnectionString": "Server=localhost;Database=SmartSqlDb;Uid=root;Pwd=123456;"
},
"Database": {
"DbProvider": {
"Name": "MySql",
"ParameterPrefix": "?"
},
"Write": {
"Name": "Write",
"ConnectionString": "${ConnectionString}"
},
"Reads": [
{
"Name": "Read",
"ConnectionString": "${ConnectionString}",
"Weight": 100
}
]
},
"TypeHandlers": [
{
"Name": "Json",
"Type": "SmartSql.TypeHandler.JsonTypeHandler, SmartSql.TypeHandler"
}
],
"SmartSqlMaps": [
{
"Path": "Maps",
"Type": "Directory"
}
]
}
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
工作原理
OptionConfigBuilder 继承 AbstractConfigBuilder，将选项转换为与 XML 配置产生的相同的内部 SmartSqlConfig 结构：
mermaid
flowchart TD
subgraph OptionsFlow["Options Pattern Flow"]
style OptionsFlow fill:#161b22,stroke:#30363d,color:#e6edf3
JSON["appsettings.json"] --> Config["IConfiguration"]
Config --> Options["IOptions~SmartSqlConfigOptions~"]
Options --> Builder["OptionConfigBuilder"]
Builder --> BuildDB["BuildDatabase()"]
Builder --> BuildTH["BuildTypeHandlers()"]
Builder --> BuildSM["BuildSqlMaps()"]
Builder --> BuildID["BuildIdGenerators()"]
Builder --> BuildProp["BuildProperties()"]
Builder --> BuildSettings["BuildSettings()"]
BuildDB --> SmartConfig["SmartSqlConfig"]
BuildTH --> SmartConfig
BuildSM --> SmartConfig
BuildID --> SmartConfig
BuildProp --> SmartConfig
BuildSettings --> SmartConfig
end
style JSON fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
style Config fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
style Options fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
style Builder fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
style BuildDB fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
style BuildTH fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
style BuildSM fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
style BuildID fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
style BuildProp fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
style BuildSettings fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
style SmartConfig fill:#2d333b,stroke:#6d5dfc,color:#e6edf31
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
在 ASP.NET Core 中使用
mermaid
sequenceDiagram
autonumber
participant App as Startup
participant DI as IServiceCollection
participant SP as IServiceProvider
participant UseOpts as UseOptions()
participant OCB as OptionConfigBuilder
participant SSB as SmartSqlBuilder
App->>DI: services.AddSmartSql("MyDb", builder => { ... })
App->>DI: Configure("SmartSqlConfig", ...)
App->>SSB: builder.UseOptions(sp)
SSB->>SP: GetRequiredService>()
SP-->>SSB: configOptions
SSB->>OCB: new OptionConfigBuilder(configOptions)
SSB->>SSB: UseConfigBuilder(ocb)
Note over SSB: On Build():<br>OCB processes all options<br>and produces SmartSqlConfig1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
API 参考
SmartSqlOptionsExtensions
| 方法 | 描述 |
|---|---|
SmartSqlBuilder.UseOptions(IServiceProvider) | 将构建器绑定到从 DI 解析的选项，按构建器的 alias 键控 |
OptionConfigBuilder（内部）
| 方法 | 描述 |
|---|---|
BuildDatabase() | 将 Database.Write 和 Database.Reads 映射到 WriteDataSource / ReadDataSource |
BuildTypeHandlers() | 注册每个 TypeHandler 条目，解析泛型类型参数 |
BuildSqlMaps() | 按 ResourceType 和 Path 加载每个 SqlMapSource |
BuildIdGenerators() | 构建并注册命名的 ID 生成器 |
BuildProperties() | 将键值属性导入 SmartSqlConfig.Properties |
BuildSettings() | 应用 Settings（IgnoreParameterCase、ParameterPrefix 等） |
BuildTagBuilders() | 注册自定义标签构建器类型 |
关键类
| 类 | 文件 | 描述 |
|---|---|---|
SmartSqlConfigOptions | SmartSqlConfigOptions.cs | 根选项对象 |
Database | Database.cs | DB 提供程序 + 写/读源 |
DataSource | DataSource.cs | 名称、连接字符串、权重 |
TypeHandler | TypeHandler.cs | 类型处理器注册 |
SqlMapSource | SqlMapSource.cs | SQL 映射文件路径和资源类型 |
IdGenerator | IdGenerator.cs | 命名的 ID 生成器配置 |
TagBuilder | TagBuilder.cs | 自定义标签构建器注册 |
OptionConfigBuilder | OptionConfigBuilder.cs | 将选项转换为 SmartSqlConfig |
交叉参考
- DI 集成 -- 将
AddSmartSql()与UseOptions()结合使用，实现完全基于 DI 的配置。 - 类型处理器 -- 在
TypeHandlers数组中注册类型处理器。 - 配置（XML） -- Options 模式可通过
SmartSqlMaps引用的 XML 配置。