为什么想要使用 smartsql?
从 MyBatis 过来的,更多的场景,适合手写 SQL ,而不是使用 EF 这样的完全体 ORM。
而 SQL 语句又希望写在 xml 中,而不是代码中。
文档: 介绍 | SmartSql
首先吐槽一句,文档写得相当不清楚。可以参考 SmartSql 源码中的 sample 来理解如何使用,以下基本是最简可用配置,加一些踩坑说明。
1 SmartSqlMapConfig.xml
<SmartSqlMapConfig xmlns="http://SmartSql.net/schemas/SmartSqlMapConfig.xsd"> <Settings IgnoreParameterCase="false" ParameterPrefix="$" IsCacheEnabled="true" EnablePropertyChangedTrack="true"/>
<Database> <DbProvider Name="MySql"/> <Write Name="WriteDB" ConnectionString="${ConnectionString}"/> <Read Name="ReadDb-1" ConnectionString="${ConnectionString}" Weight="100"/> </Database>
<SmartSqlMaps> <SmartSqlMap Path="Mappers" Type="Directory"></SmartSqlMap> </SmartSqlMaps></SmartSqlMapConfig>
坑1 SQL 语句中的前缀
写的 SQL 大概是这个样子:
SELECT * FROM t_user WHERE c_id= @id
这里的 @id
是需要被替换的参数,那前缀是 @,?,#,: 中的哪一个呢?文档没有说,源码 sample 中用的是 @,于是,我也用 @ ,结果,死活生成不了正确的 SQL。
看源码:
死活生成不了正确的 SQL 的解释是:默认情况下,Sqlite 使用的是 @ ,而 MySql 使用的是 ? . 而我配的是 $,所有,用 @ 当然不行啦。
可是,一开始鬼知道。
可以修改配置吗?可以的,在 SmartSqlMapConfig.xml 中,ParameterPrefix
就是干这个的。
还可以单独给每个数据源进行配置:
<Database> <DbProvider Name="SQLite" ParameterPrefix="#"/> <Write Name="WriteDB" ConnectionString="${ConnectionString}"/> <Read Name="ReadDb" ConnectionString="${ConnectionString}" Weight="100"/></Database>
对应的 SQL 就是:
SELECT * FROM T_User WHERE Id = #id
这是我遇到的最大的坑。
要学 MyBatis 就好好学嘛,只有 #{id} 和 @{id} 两种(功能上有区别),多简单直观。
坑2 SmartSqlMaps 的定义
<SmartSqlMaps> <SmartSqlMap Path="Mappers" Type="Directory"></SmartSqlMap></SmartSqlMaps>
这里定义了 SQL 语句对应的 XML 在 Mappers 这个文件夹中,但是,这个文件夹是需要拷贝输出到输出目录的。也没见文档哪里提了。
你需要在 csproj 文件中加这么一段:
<ItemGroup> <None Update="SmartSqlMapConfig.xml"> <CopyToOutputDirectory>Always</CopyToOutputDirectory> </None> <None Update="Mappers\*.xml"> <CopyToOutputDirectory>Always</CopyToOutputDirectory> </None></ItemGroup>
NUGET 包
在 net core 中使用 smartsql 需要安装哪些 NUGET 包?
文档的入门章节,让你安装的是 SmartSql.Schema
,其它的呢?自己摸索。
如果使用 MySql(asp.net core 下),大概是这些:
<ItemGroup> <PackageReference Include="MySql.Data" Version="8.0.21" /> <PackageReference Include="SmartSql" Version="4.1.56" /> <PackageReference Include="SmartSql.DIExtension" Version="4.1.56" /> <PackageReference Include="SmartSql.DyRepository" Version="4.1.56" /> <PackageReference Include="SmartSql.InvokeSync" Version="4.1.56" /> <PackageReference Include="SmartSql.Schema" Version="4.1.30" /></ItemGroup>
Startup 中的配置
services.AddSmartSql((sp, builder) => { // 使用配置读取链接字符串(而不是将链接字符串写在了 SmartSqlMapConfig.xml 中) builder.UseProperties(Configuration); }) .AddRepositoryFromAssembly(o => { // 扫描 Repository o.AssemblyString = "SmartSqlDemo"; o.Filter = (type) => string.Equals(type.Namespace, "SmartSqlDemo.SmartSqlRepositories", System.StringComparison.Ordinal); }) // 添加 async 支持 .AddInvokeSync(options => { }) ;
其它需要注意的问题
1 连接字符串
mysql 连接字符串,需要设置 AllowUserVariables=True;
2 Repository 接口的命名
默认情况下,使用 I{Scope}Repository 的方式,也可以自己配。
其它技巧
如果想要查看 smartsql 生成的 SQL 语句,将日志输出级别调整为 Debug
更多关于前缀的问题,可以看这篇详细分析:
dotnet 关于 SmartSql 的 SQL 语句的属性替换前缀说明
原文链接: https://blog.jgrass.cc/posts/smartsql-begin-note/
本作品采用 「署名 4.0 国际」 许可协议进行许可,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文链接。