知識星球
介紹
SmartSql = MyBatis + Cache(Memory | Redis) + R/W Splitting +Dynamic Repository + Diagnostics ……
簡潔、高效、高效能、擴充套件性、監控、漸進式開發！
她是如何工作的？
SmartSql 借鑒了 MyBatis 的思想，使用 XML 來管理 SQL ，並且提供了若干個篩選器標簽來消除程式碼層面的各種 if/else 的判斷分支。
SmartSql將管理你的 SQL ，並且透過篩選標簽來維護本來你在程式碼層面的各種條件判斷，使你的程式碼更加優美。
為什麼選擇 SmartSql ？
DotNet 體系下大都是 Linq 系的 ORM，Linq 很好，消除了開發人員對 SQL 的依賴。
但卻忽視了一點，SQL 本身並不複雜，而且在複雜查詢場景當中開發人員很難透過編寫Linq來生成良好效能的SQL，相信使用過EF的同學一定有這樣的體驗：“我想好了Sql怎麼寫，然後再來寫Linq,完了可能還要再檢視一下Linq輸出的Sql是什麼樣的“。這是非常糟糕的體驗。要想對Sql做絕對的最佳化，那麼開發者必須對Sql有絕對的控制權。另外Sql本身很簡單，為何要增加一層翻譯器呢？
SmartSql 從正式開源已歷經倆年多的時間，在生產環境經過若干個微服務驗證。
同時也有一部分企業正在使用 SmartSql （如果您也在使用 SmartSql 歡迎提交issue）Who is using SmartSql。
目前已加入 NCC。
未來(Roadmap-2019) SmartSql 也會持續加入一些新的特性來幫助開發者提升效率。歡迎提交 Issue https://github.com/dotnetcore/SmartSql/issues。
那麼為什麼不是 Dapper，或者 DbHelper ？
Dapper 確實很好，並且又很好的效能，但是會讓給你的程式碼裡邊充斥著 SQL 和各種判斷分支，這些將會使程式碼維護難以閱讀和維護。另外 Dapper 只提供了DataReader 到 Entity 的反序列化功能。而 SmartSql 提供了大量的特性來提升開發者的效率。
特性概覽
動態倉儲
動態代理倉儲(SmartSql.DyRepository)元件是 SmartSql 非常獨特的功能，它能簡化 SmartSql 的使用。對業務程式碼幾乎沒有侵入。可以說使用 ISqlMapper 是原始方法，而 DyRepository 自動幫你實現這些方法。
DyRepository 的表現是隻需要定義倉儲介面，透過簡單配置就能自動實現這些介面並註冊到 IoC 容器中，使用時註入即刻獲取實現。原理是透過介面和介面方法的命名規則來獲取 SmartSql 的 xml 檔案中的 Scope 和 SqlId ，用介面方法的引數作為 Request ，透過 xml 中的 sql 自動判斷是查詢還是執行操作，最後實現對 ISqlMapper 的呼叫。
0. 定義倉儲介面
public interface IUserRepository : IRepository<User, long>
{
}1. 註入依賴
services.AddSmartSql()
.AddRepositoryFromAssembly(options => { options.AssemblyString = "SmartSql.Starter.Repository"; });2. 使用
public class UserService
{
IUserRepository userRepository;
public UserService(IActivityRepository userRepository)
{
this.userRepository = userRepository;
}
}SmartSql 最佳實踐 -> SmartCode
透過 SmartCode 開發人員僅需配置好資料庫連線即可生成解決方案所需的一切，包括但不限於：
- 解決方案工程
- 幫你 restore 一下
ReStore:
Type: Process
Parameters:
FileName: powershell
WorkingDirectory: '{{Project.Output.Path}}'
Args: dotnet restore- Docker
- 構建 Docker 映象 & 執行實體
BuildDocker:
Type: Process
Parameters:
FileName: powershell
WorkingDirectory: '{{Project.Output.Path}}'
Args: docker build -t {{Project.Parameters.DockerImage}}:v1.0.0 .
RunDocker:
Type: Process
Parameters:
FileName: powershell
WorkingDirectory: '{{Project.Output.Path}}'
Args: docker run --name {{Project.Parameters.DockerImage}} --rm -d -p 8008:80 {{Project.Parameters.DockerImage}}:v1.0.0 .- 順便開啟個瀏覽器
RunChrome:
Type: Process
Parameters:
FileName: C:\Program Files (x86)\Google\Chrome\Application\chrome.exe
CreateNoWindow: false
Args: http://localhost:8008/swaggerDocker
SmartCode 生成的目錄結構
讀寫分離
SmartSql 讀寫分離特別簡便，僅需提供好配置即可：
<Database>
<DbProvider Name="PostgreSql"/>
<Write Name="WriteDB" ConnectionString="${Master}"/>
<Read Name="ReadDb-1" ConnectionString="${Slave-0}" Weight="100"/>
<Read Name="ReadDb-2" ConnectionString="${Slave-1}" Weight="100"/>
Database>快取
- Lru 最近最少使用演演算法
- Fifo 先進先出演演算法
- RedisCacheProvider
- 其他繼承自ICacheProvider快取型別均可
<Caches>
<Cache Id="LruCache" Type="Lru">
<Property Name="CacheSize" Value="10"/>
<FlushOnExecute Statement="AllPrimitive.Insert"/>
<FlushInterval Hours="1" Minutes="0" Seconds="0"/>
Cache><Cache Id=“FifoCache” Type=“Fifo”>
<Property Name=“CacheSize” Value=“10”/>
Cache>
<Cache Id=“RedisCache” Type=“${RedisCacheProvider}”>
<Property Name=“ConnectionString” Value=“${Redis}” />
<FlushInterval Seconds=“60”/>
Cache>
Caches>
<Statement Id=“QueryByLruCache” Cache=“LruCache”>
SELECT Top 6 T.* From T_User T;
Statement>
型別處理器
SmartSql 內部實現了 DotNet 主要型別的型別處理器，並且提供了部分型別相容的型別轉換處理器，同時還提供了比較常用的 JsonTypeHanlder 。
<TypeHandler PropertyType="SmartSql.Test.Entities.UserInfo,SmartSql.Test" Type="${JsonTypeHandler`}">
<Properties>
<Property Name="DateFormat" Value="yyyy-MM-dd mm:ss"/>
<Property Name="NamingStrategy" Value="Camel"/>
Properties>TypeHandler>
CUD 程式碼生成
SmartSql 同時提供了 CUD 擴充套件函式幫助開發者生成好 CUD-SQL ，方便開發者直接使用，無需編寫任何配置。
public static TEntity GetById(this ISqlMapper);
public static TPrimaryKey Insert(this ISqlMapper sqlMapper, TEntity entity);
public static int DyUpdate(this ISqlMapper sqlMapper, object entity);
public static int Update(this ISqlMapper sqlMapper, TEntity entity);
public static int DeleteById(this ISqlMapper sqlMapper, TPrimaryKey id);
public static int DeleteMany(this ISqlMapper sqlMapper, IEnumerable ids);Id 生成器
SnowflakeId
<IdGenerators>
<IdGenerator Name="SnowflakeId" Type="SnowflakeId">
<Properties>
<Property Name="WorkerIdBits" Value="10"/>
<Property Name="WorkerId" Value="888"/>
<Property Name="Sequence" Value="1"/>
Properties>IdGenerator>
IdGenerators>
<Statement Id="Insert">
<IdGenerator Name="SnowflakeId" Id="Id"/>
INSERT INTO T_UseIdGenEntity
(
Id,
Name
)
VALUES
(
@Id,
@Name
);
Select @Id;
Statement>var id = SqlMapper.ExecuteScalar<long>(new RequestContext
{
Scope = nameof(UseIdGenEntity),
SqlId = "Insert",
Request = new UseIdGenEntity()
{
Name = "SmartSql"
}
});DbSequence
<IdGenerators>
<IdGenerator Name="DbSequence" Type="DbSequence">
<Properties>
<Property Name="Step" Value="10"/>
<Property Name="SequenceSql" Value="Select Next Value For IdSequence;"/>
Properties>IdGenerator>
IdGenerators>
<Statement Id="InsertByDbSequence">
<IdGenerator Name="DbSequence" Id="Id"/>
INSERT INTO T_UseIdGenEntity
(
Id,
Name
)
VALUES
(
@Id,
@Name
);
Select @Id;
Statement> var id = SqlMapper.ExecuteScalar<long>(new RequestContext
{
Scope = nameof(UseIdGenEntity),
SqlId = "InsertByDbSequence",
Request = new UseIdGenEntity()
{
Name = "SmartSql"
}
});AOP 事務
[Transaction]
public virtual long AddWithTran(User user)
{
return _userRepository.Insert(user);
}事務巢狀
當出現事務巢狀時，子函式的事務特性註解將不再開啟，轉而使用上級呼叫函式的事務
[Transaction]
public virtual long AddWithTranWrap(User user)
{
return AddWithTran(user);
}BulkInsert
using (var dbSession= SqlMapper.SessionStore.Open())
{
var data = SqlMapper.GetDataTable(new RequestContext
{
Scope = nameof(AllPrimitive),
SqlId = "Query",
Request = new { Taken = 100 }
});
data.TableName = "T_AllPrimitive";
IBulkInsert bulkInsert = new BulkInsert(dbSession);
bulkInsert.Table = data;
bulkInsert.Insert();
}Skywalking 監控
SmartSql 目前支援 Skywalking 監控，透過安裝 SkyAPM-dotnet 代理來啟用。以下是部分截圖。
監控執行命令
檢視是否快取，以及傳回的記錄數
檢視執行的SQL陳述句
事務
異常
異常堆疊跟蹤
示例專案
SmartSql.Sample.AspNetCore
技術交流
點選連結加入QQ群【SmartSql 官方交流群】：604762592
瞭解更多，請移步官方檔案
朋友會在“發現-看一看”看到你“在看”的內容