SmartSql 3.0.0-rc6

This is a prerelease version of SmartSql.
There is a newer version of this package available.
See the version list below for details.
dotnet add package SmartSql --version 3.0.0-rc6
NuGet\Install-Package SmartSql -Version 3.0.0-rc6
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SmartSql" Version="3.0.0-rc6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SmartSql --version 3.0.0-rc6
#r "nuget: SmartSql, 3.0.0-rc6"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install SmartSql as a Cake Addin
#addin nuget:?package=SmartSql&version=3.0.0-rc6&prerelease

// Install SmartSql as a Cake Tool
#tool nuget:?package=SmartSql&version=3.0.0-rc6&prerelease

简介

0. Why

  • 拥抱 跨平台 DotNet Core,是时候了。
  • 把你的双手从数据访问层解放出来,少加点班吧。

1. So SmartSql

  • TargetFrameworks: .NETFramework 4.6 & .NETStandard 2.0
  • SmartSql = MyBatis + Cache(Memory | Redis) + ZooKeeper + R/W Splitting + ......

2. 主要特性 (√ 为已完成,未打 √ 为计划特性)

  • 1 ORM
    • 1.1 Sync
    • 1.2 Async
  • 2 XmlConfig & XmlStatement → Sql
    • 2.1 SmartSqlMapConfig & SmartSqlMap √ (是的,你猜对了,和MyBatis一样,通过XML配置分离SQL。)
    • 2.2 Config Hot Update →ConfigWatcher & Reload (配置文件热更新:当你需要修改Sql的时候,直接修改SqlMap配置文件,保存即可。)
  • 3 读写分离 √
    • 3.1 读写分离 √
    • 3.2 多读库 权重筛选 √ (配置多读库,根据读库权重选举读库)
  • 4 日志 √
    • 4.1 基于 Microsoft.Extensions.Logging.Abstractions (当你需要跟踪调试的时候一切都是那么一目了然)
  • 5 Dynamic Repository
    • 5.1 SmartSql.DyRepository √
  • 6 查询缓存 √
    • 6.1 SmartSql.Cache.Memory √
      • 6.1.1 Fifo √
      • 6.1.2 Lru √
    • 6.2 SmartSql.Cache.Redis √
    • 6.3 缓存事务一致性
  • 7 分布式配置插件
    • 7.1 IConfigLoader √ (配置文件加载器)
    • 7.2 LocalFileConfigLoader √ √ (本地文件配置加载器)
      • 7.2.1 Load SmartSqlMapSource Xml √
      • 7.3.1 Load SmartSqlMapSource Directory √
    • 7.3 SmartSql.ZooKeeperConfig √ (ZooKeeper 分布式配置文件加载器)

3. 性能


BenchmarkDotNet=v0.10.14, OS=Windows 10.0.16299.431 (1709/FallCreatorsUpdate/Redstone3)
Intel Core i7-4710MQ CPU 2.50GHz (Haswell), 1 CPU, 8 logical and 4 physical cores
Frequency=2435768 Hz, Resolution=410.5481 ns, Timer=TSC
.NET Core SDK=2.1.201
  [Host]     : .NET Core 2.0.7 (CoreCLR 4.6.26328.01, CoreFX 4.6.26403.03), 64bit RyuJIT
  DefaultJob : .NET Core 2.0.7 (CoreCLR 4.6.26328.01, CoreFX 4.6.26403.03), 64bit RyuJIT

ORM Type Method Mean Error StdDev Rank Gen 0 Gen 1 Gen 2 Allocated
SmartSql SmartSqlBenchmarks Query 101.6 ms 0.2226 ms 0.1738 ms 1 2437.5000 1062.5000 375.0000 13.37 MB
Native NativeBenchmarks Query_IsDBNull_GetValue 101.7 ms 0.4101 ms 0.3635 ms 1 2437.5000 1062.5000 375.0000 13.37 MB
Dapper DapperBenchmarks Query 104.4 ms 1.3195 ms 1.2342 ms 2 3375.0000 1375.0000 625.0000 17.64 MB
SmartSqlDapper SmartSqlDapperBenchmarks Query 105.7 ms 1.1697 ms 1.0941 ms 3 3750.0000 1437.5000 625.0000 19.47 MB
Native NativeBenchmarks Query_GetValue_DbNull 107.4 ms 1.0710 ms 1.0018 ms 4 3062.5000 1187.5000 500.0000 16.42 MB
SqlSugar SqlSugarBenchmarks Query 108.9 ms 0.4048 ms 0.3787 ms 5 2375.0000 1000.0000 312.5000 13.09 MB
EF EFBenchmarks SqlQuery 110.9 ms 0.6922 ms 0.6475 ms 6 11062.5000 - - 34.13 MB
Chloe ChloeBenchmarks Query 14.5 ms 2.2600 ms 5.3711 ms 7 2375.0000 1000.0000 312.5000 13.07 MB
EF EFBenchmarks Query_NoTracking 126.4 ms 1.3197 ms 1.2344 ms 8 5937.5000 2250.0000 1062.5000 30.16 MB
EF EFBenchmarks SqlQuery_NoTracking 148.6 ms 0.8290 ms 0.7755 ms 9 7437.5000 2937.5000 1250.0000 37.79 MB

4. 安装 (NuGet)

Install-Package SmartSql

5. 常规代码

查询

            ISmartSqlMapper SqlMapper = MapperContainer.Instance.GetSqlMapper();
            SqlMapper.Query<T_Test>(new RequestContext
            {
                Scope = "T_Test",
                SqlId = "GetList",
                Request = new { Ids = new long[] { 1, 2, 3, 4 } }
            });

事务

            try
            {
                ISmartSqlMapper SqlMapper = MapperContainer.Instance.GetSqlMapper();
                SqlMapper.BeginTransaction();
                //BizCode
                SqlMapper.CommitTransaction();
            }
            catch (Exception ex)
            {
                SqlMapper.RollbackTransaction();
                throw ex;
            }

6. 最佳实践

6.1 安装 SmartSql.DIExtension

Install-Package SmartSql.DIExtension

6.2 注入依赖

 services.AddSmartSql();
 services.AddRepositoryFactory();
 services.AddRepositoryFromAssembly((options) =>
 {
    options.AssemblyString = "SmartSql.Starter.Repository";
 });

6.3 定义仓储接口

    /// <summary>
    /// 属性可选: [SqlMap(Scope = "User")] ,不设置 则默认 Scope 模板:I{Scope}Repository
    /// 可传入自定义模板
    /// RepositoryBuilder builder=new RepositoryBuilder("I{Scope}DAL");
    /// </summary>
    public interface IUserRepository
    {
        /// <summary>
        /// 属性可选 [Statement(Execute = ExecuteBehavior.Auto,Id = "Query")]
        /// 默认 Execute:Auto ,自动判断 执行类型
        /// 默认 Id : 方法名
        /// </summary>
        /// <param name="reqParams"></param>
        /// <returns></returns>
        IEnumerable<User> Query(object reqParams);
        long GetRecord(object reqParams);
        User Get(object reqParams);
        long Insert(User entity);
        int Update(User entity);
        int Delete(User enttiy);
    }

6.4 尽情享用

    public class UserService
    {
        private readonly ISmartSqlMapper _smartSqlMapper;
        private readonly IUserRepository _userRepository;

        public UserService(
             ISmartSqlMapper smartSqlMapper
            , IUserRepository userRepository)
        {
            _smartSqlMapper = smartSqlMapper;
            _userRepository = userRepository;
        }

        public long Add(AddRequest request)
        {
            int existsNum = _userRepository.Exists(new { request.UserName });
            if (existsNum > 0)
            {
                throw new ArgumentException($"{nameof(request.UserName)} has already existed!");
            }
            return _userRepository.Add(new Entitiy.User
            {
                UserName = request.UserName,
                Password = request.Password,
                Status = Entitiy.UserStatus.Ok,
                CreationTime = DateTime.Now,
            });
        }

        public void UseTransaction()
        {
            try
            {
                _smartSqlMapper.BeginTransaction();
                //Biz();
                _smartSqlMapper.CommitTransaction();
            }
            catch (Exception ex)
            {
                _smartSqlMapper.RollbackTransaction();
                throw ex;
            }
        }
    }

7. 文档地址

8. 技术交流

点击链接加入QQ群【SmartSql 官方交流群】:604762592

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net46 is compatible.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (25)

Showing the top 5 NuGet packages that depend on SmartSql:

Package Downloads
SmartSql.DyRepository

SmartSql = MyBatis + Cache(Memory | Redis) + ZooKeeper + R/W Splitting +Dynamic Repository ....

SmartSql.DIExtension

SmartSql = MyBatis + Cache(Memory | Redis) + ZooKeeper + R/W Splitting +Dynamic Repository ....

SmartSql.Bulk

SmartSql = MyBatis + Cache(Memory | Redis) + ZooKeeper + R/W Splitting +Dynamic Repository ....

SmartSql.ScriptTag

SmartSql = MyBatis + Cache(Memory | Redis) + ZooKeeper + R/W Splitting +Dynamic Repository ....

SmartSql.TypeHandler

SmartSql = MyBatis + Cache(Memory | Redis) + ZooKeeper + R/W Splitting +Dynamic Repository ....

GitHub repositories (4)

Showing the top 4 popular GitHub repositories that depend on SmartSql:

Repository Stars
SkyAPM/SkyAPM-dotnet
The .NET/.NET Core instrument agent for Apache SkyWalking
ElderJames/shriek-fx
An easy-to-use rapid development framework developed on the basis of.NET Core 2.0, following the constraints of domain Driven Design (DDD) specifications, combined with the CQRS architecture to provide the infrastructure for event-driven, event backtracking, responsiveness, and more. Let developers enjoy the true meaning of object-oriented design patterns brought by the aesthetic.
dotnetcore/SmartCode
SmartCode = IDataSource -> IBuildTask -> IOutput => Build Everything!!!
lindexi/lindexi_gd
博客用到的代码
Version Downloads Last updated
4.1.67 4,701 10/19/2023
4.1.66 1,677 9/21/2023
4.1.65 972 9/21/2023
4.1.64 23,308 5/13/2022
4.1.63 6,066 5/4/2022
4.1.62 5,971 4/29/2022
4.1.59 6,789 3/10/2022
4.1.58 6,340 3/3/2022
4.1.57 12,382 11/17/2020
4.1.56 7,970 7/14/2020
4.1.55 5,375 6/18/2020
4.1.54 4,463 6/12/2020
4.1.53 5,455 4/8/2020
4.1.52 5,475 3/27/2020
4.1.51 4,647 3/21/2020
4.1.50 6,826 3/9/2020
4.1.48 4,218 3/5/2020
4.1.46 4,458 12/18/2019
4.1.45 4,151 12/18/2019
4.1.44 4,841 12/5/2019
4.1.43 4,281 11/20/2019
4.1.42 4,575 11/18/2019
4.1.40 4,174 11/12/2019
4.1.39 4,314 11/6/2019
4.1.38 4,259 10/29/2019
4.1.37 4,182 10/29/2019
4.1.36 4,218 10/29/2019
4.1.35 4,185 10/29/2019
4.1.34 4,151 10/28/2019
4.1.33 4,194 10/28/2019
4.1.32 12,589 9/30/2019
4.1.31 4,210 9/29/2019
4.1.30 4,173 9/27/2019
4.1.29 4,121 9/26/2019
4.1.28 4,411 9/2/2019
4.1.27 4,121 8/30/2019
4.1.26 4,219 8/30/2019
4.1.25 4,244 8/30/2019
4.1.24 4,288 8/28/2019
4.1.23 9,385 8/20/2019
4.1.22 4,119 8/19/2019
4.1.21 4,348 8/13/2019
4.1.20 4,243 8/13/2019
4.1.19 4,296 8/13/2019
4.1.18 11,876 8/5/2019
4.1.17 4,257 8/1/2019
4.1.16 4,204 8/1/2019
4.1.15 4,189 7/30/2019
4.1.14 4,108 7/30/2019
4.1.12 4,254 7/30/2019
4.1.11 4,316 7/30/2019
4.1.9 4,212 7/29/2019
4.1.8 4,244 7/29/2019
4.1.7 4,164 7/29/2019
4.1.6 4,171 7/29/2019
4.1.5 4,161 7/27/2019
4.1.3 4,188 7/26/2019
4.1.2 4,180 7/25/2019
4.1.1 3,982 7/25/2019
4.1.0 4,165 7/24/2019
4.0.88 4,111 7/24/2019
4.0.86 4,771 7/22/2019
4.0.85 4,122 7/22/2019
4.0.84 4,122 7/22/2019
4.0.81 4,254 7/19/2019
4.0.80 4,092 7/19/2019
4.0.78 4,094 7/19/2019
4.0.76 4,273 7/17/2019
4.0.75 6,321 7/10/2019
4.0.73 4,298 7/10/2019
4.0.72 4,356 7/5/2019
4.0.71 4,369 6/25/2019
4.0.70 4,214 6/25/2019
4.0.69 4,177 6/25/2019
4.0.68 4,175 6/20/2019
4.0.66 4,296 6/18/2019
4.0.65 4,294 6/17/2019
4.0.63 5,680 6/12/2019
4.0.62 4,292 6/12/2019
4.0.60 4,249 6/11/2019
4.0.59 4,133 6/11/2019
4.0.58 4,337 6/3/2019
4.0.56 4,143 5/31/2019
4.0.55 4,076 5/30/2019
4.0.53 4,005 5/30/2019
4.0.52 4,089 5/30/2019
4.0.51 3,996 5/30/2019
4.0.50 4,118 5/29/2019
4.0.49 4,203 5/29/2019
4.0.48 4,108 5/24/2019
4.0.46 4,917 5/15/2019
4.0.45 3,901 5/10/2019
4.0.44 3,693 5/7/2019
4.0.43 3,626 5/7/2019
4.0.42 3,870 4/28/2019
4.0.41 3,618 4/28/2019
4.0.40 3,676 4/26/2019
4.0.38 3,708 4/26/2019
4.0.36 3,723 4/25/2019
4.0.35 3,739 4/25/2019
4.0.34 3,564 4/23/2019
4.0.33 3,683 4/19/2019
4.0.32 3,694 4/19/2019
4.0.30 3,584 4/19/2019
4.0.29 3,449 4/18/2019
4.0.28 3,458 4/18/2019
4.0.26 3,460 4/18/2019
4.0.25 3,526 4/17/2019
4.0.21 3,468 4/17/2019
4.0.20 3,517 4/16/2019
4.0.19 3,556 4/15/2019
4.0.18 3,467 4/15/2019
4.0.16 3,480 4/11/2019
4.0.15 3,438 4/11/2019
4.0.14 3,522 4/9/2019
4.0.13 3,511 4/9/2019
4.0.12 3,562 4/4/2019
4.0.11 3,486 4/4/2019
4.0.10 1,052 4/3/2019
4.0.9 648 4/3/2019
4.0.8 1,016 4/3/2019
4.0.7 1,003 4/3/2019
4.0.6 958 4/3/2019
4.0.5 1,043 4/2/2019
4.0.4 1,022 4/2/2019
4.0.3 4,736 4/2/2019
4.0.2 1,026 4/1/2019
4.0.1 858 4/1/2019
4.0.0 4,101 4/1/2019
4.0.0-rc999 647 3/31/2019
4.0.0-rc998 590 3/29/2019
4.0.0-rc997 1,113 3/29/2019
4.0.0-rc996 1,620 3/29/2019
4.0.0-rc995 577 3/28/2019
4.0.0-rc994 566 3/28/2019
4.0.0-rc993 1,433 3/28/2019
4.0.0-rc991 611 3/27/2019
4.0.0-rc990 600 3/27/2019
4.0.0-rc99 613 3/27/2019
4.0.0-rc98 596 3/26/2019
4.0.0-rc97 605 3/26/2019
4.0.0-rc96 1,326 3/26/2019
4.0.0-rc95 1,665 3/25/2019
4.0.0-rc93 884 3/25/2019
4.0.0-rc92 844 3/25/2019
4.0.0-rc91 1,174 3/22/2019
4.0.0-rc9 1,116 3/22/2019
4.0.0-rc8 681 3/21/2019
4.0.0-rc6 753 3/21/2019
4.0.0-rc5 595 3/20/2019
4.0.0-rc3 712 3/18/2019
4.0.0-rc2 422 3/18/2019
4.0.0-rc10 581 3/22/2019
4.0.0-rc1 1,890 3/17/2019
4.0.0-beta5 1,131 3/16/2019
4.0.0-beta4 610 3/11/2019
4.0.0-beta3 602 3/9/2019
4.0.0-beta2 1,277 3/8/2019
4.0.0-beta1 1,272 3/7/2019
3.8.15 1,282 4/26/2019
3.8.13 655 4/9/2019
3.8.12 2,218 12/17/2018
3.8.9 644 3/26/2019
3.8.8 1,165 12/5/2018
3.8.6 1,148 11/29/2018
3.8.5 771 11/29/2018
3.8.4 1,879 11/9/2018
3.8.2 2,218 10/30/2018
3.8.0 1,383 10/29/2018
3.7.16 3,377 10/26/2018
3.7.15 1,910 10/24/2018
3.7.15-rc4 591 10/24/2018
3.7.15-rc2 640 10/23/2018
3.7.13 1,167 10/22/2018
3.7.12 805 10/22/2018
3.7.11 1,226 10/21/2018
3.7.10 1,256 10/11/2018
3.7.9 1,030 10/10/2018
3.7.8 1,260 9/30/2018
3.7.6 1,016 9/28/2018
3.7.5 995 9/26/2018
3.7.3 820 9/26/2018
3.7.2 820 9/25/2018
3.7.1 849 9/25/2018
3.7.0 1,233 9/18/2018
3.7.0-pre6 669 9/17/2018
3.6.9 852 9/16/2018
3.6.8.2 865 9/12/2018
3.6.8.1 1,111 9/9/2018
3.6.7 1,249 9/7/2018
3.6.5 2,063 9/1/2018
3.6.4 1,174 8/28/2018
3.6.2 1,062 8/23/2018
3.6.1 1,314 8/13/2018
3.6.0 1,654 8/8/2018
3.6.0-rc2 768 8/7/2018
3.6.0-rc1 761 8/5/2018
3.6.0-pre9 749 8/5/2018
3.6.0-pre8 787 8/5/2018
3.6.0-pre6 794 8/4/2018
3.6.0-pre3 690 8/3/2018
3.6.0-pre1 865 8/3/2018
3.5.14 899 8/2/2018
3.5.13 929 8/2/2018
3.5.12 915 8/2/2018
3.5.11 892 8/2/2018
3.5.10 910 8/1/2018
3.5.9 853 8/1/2018
3.5.8 1,345 7/31/2018
3.5.5 1,296 7/31/2018
3.5.3 1,973 7/25/2018
3.5.2 894 7/25/2018
3.5.1 1,099 7/25/2018
3.5.0 1,256 7/24/2018
3.5.0-pre2 834 7/23/2018
3.5.0-pre1 712 7/21/2018
3.4.8 1,512 7/19/2018
3.4.6 1,272 7/19/2018
3.4.3 1,000 7/19/2018
3.4.2 998 7/18/2018
3.4.0 991 7/18/2018
3.3.18 1,738 7/13/2018
3.3.16 925 7/12/2018
3.3.12 984 7/12/2018
3.3.11 1,158 7/5/2018
3.3.10 973 7/4/2018
3.3.8 1,264 7/1/2018
3.3.6 1,961 6/26/2018
3.3.4 1,957 6/26/2018
3.3.3 1,219 6/25/2018
3.3.1 1,568 6/13/2018
3.2.0 1,631 6/11/2018
3.1.0 1,414 6/9/2018
3.0.1 1,394 6/4/2018
3.0.0 2,411 6/2/2018
3.0.0-rc93 847 6/1/2018
3.0.0-rc92 958 5/31/2018
3.0.0-rc91 895 5/30/2018
3.0.0-rc8 800 5/29/2018
3.0.0-rc6 1,213 5/28/2018
3.0.0-rc5 872 5/27/2018
3.0.0-rc4 787 5/18/2018
3.0.0-rc3 778 5/16/2018
3.0.0-pre8 1,345 5/15/2018
3.0.0-pre4 913 5/12/2018
3.0.0-pre3 882 5/8/2018
3.0.0-pre2 831 5/7/2018
3.0.0-pre1 835 5/6/2018
2.3.2 2,603 3/25/2018
2.3.0 1,268 3/24/2018
2.2.8 1,441 3/8/2018
2.2.6 1,148 3/6/2018
2.2.2 1,318 2/5/2018
2.2.1 1,633 12/27/2017
2.2.0.2 1,295 12/27/2017
2.2.0.1 3,410 11/8/2017
2.2.0 1,259 11/7/2017
2.2.0-preview 898 11/3/2017
2.1.0-preview2 824 11/3/2017
2.0.18.8 1,097 10/24/2017
2.0.18.6 1,214 10/13/2017
2.0.18.5 1,075 10/10/2017
2.0.18.2 1,095 10/8/2017
2.0.18 1,441 9/28/2017
2.0.16 1,502 9/19/2017
2.0.15 1,253 9/19/2017
2.0.13 1,223 9/18/2017
2.0.12 1,205 9/18/2017
2.0.8 1,085 9/14/2017
2.0.6 1,096 9/12/2017
2.0.5 1,184 9/1/2017
2.0.4 1,148 8/30/2017
2.0.3 1,719 8/21/2017
2.0.0 1,361 8/16/2017
2.0.0-preview3-final 836 8/16/2017
2.0.0-preview2-final 945 8/16/2017
1.8.8.2 1,195 8/16/2017
1.8.8.1 1,159 8/15/2017
1.8.6.1 1,228 8/14/2017
1.8.6 1,204 8/11/2017
1.8.5 1,114 8/10/2017
1.8.3 1,145 8/10/2017
1.8.2 1,121 8/10/2017
1.8.0 1,144 8/10/2017
1.7.8 1,125 8/9/2017
1.6.7 1,257 8/8/2017
1.6.6 2,088 7/24/2017
1.6.2 1,364 7/19/2017
1.5.9 1,222 7/11/2017
1.5.8.1 1,411 5/27/2017
1.5.8 1,518 5/25/2017
1.5.5 1,557 5/23/2017
1.5.3 1,567 5/22/2017
1.5.2 1,588 5/22/2017
1.5.0 1,270 5/20/2017
1.4.9 1,567 4/25/2017
1.4.8 2,159 4/25/2017
1.4.4 1,568 4/21/2017
1.4.3 1,840 4/20/2017
1.4.2 1,817 4/20/2017
1.3.1 1,317 4/18/2017
1.2.0 1,558 4/17/2017
1.1.0 1,249 4/13/2017
1.0.4 1,290 4/7/2017
1.0.2 1,607 4/3/2017