.NET ORM框架HiSql实战-第一章-集成HiSql

一、引言
做.Net这么多年，出现了很多很多ORM框架，比如Dapper,Sqlsugar,Freesql等等。在之前的项目中，用到的ORM框架也大多数是这几个老牌的框架。
不过最近园子关于.NET ORM HiSql的讨论挺多的，本系列将通过不断学习 HiSql官网教程，尝试将之前使用SqlSuger ORM的一个项目，使用HiSql框架实现相关功能，看看hisql能带给我们哪些惊喜。
c# 国内外ORM 框架 dapper efcore sqlsugar freesql hisql sqlserver数据常规插入测试性能对比对比
HiSql GitGub地址
HiSql官网教程
项目介绍：项目是一个通用的后台管理系统，包含菜单管理、权限管理、组织架构、用户管理等等。
数据库采用SqlServer 2016；前端使用Element-UI;后端采用.Net5 Web Api。
二、集成HiSql到项目

• 安装 HiSql 核心包、 HiSql.SqlServer。
  
  

2、在项目中新建类文件 HiSqlSetupExtension.cs, 用于注入数据库配置，hisql数据库访问对象。

1. using HiSql;
2. using Microsoft.Extensions.Configuration;
3. using Microsoft.Extensions.DependencyInjection;
4. using System;
6. namespace H.CRM.Action.API.Helper
7. {
9.     public static class HiSqlSetupExtension
10.     {
11.         public static IServiceCollection AddHiSqlSetup(this IServiceCollection services)
12.         {
13.             //注入HiSqlConfig
14.             services.AddTransient<HiSqlConfig>();
15.             //注入HiSqlClient
16.             services.AddTransient<HiSqlClient>((d) =>
17.             {
18.                 var config = d.GetService<HiSqlConfig>();
19.                 var hisql = new HiSqlClient(config);
20.                 return hisql;
21.             });
22.             return services;
23.         }
24.     }
26.     class HiSqlConfig : ConnectionConfig
27.     {
28.         static readonly NLog.Logger logger = NLog.LogManager.GetLogger("HiSqlSetup");
29.         public HiSqlConfig(IConfiguration configuration)
30.         {
31.             DbType = DBType.SqlServer;
32.             DbServer = "HISQL";
33.             ConnectionString = configuration.GetSection("ConnectionStrings:Admin").Value;
34.             Schema = "dbo";
35.             SqlExecTimeOut = 1000 * 5;
36.             AppEvents = new AopEvent()
37.             {
38.                 OnDbDecryptEvent = (connstr) =>
39.                 {
40.                     //解密连接字段
41.                     return connstr;
42.                 },
43.                 OnLogSqlExecuting = (sql, param) =>
44.                 {
45.                     //sql执行前 日志记录 (异步)
46. #if DEBUG
47.                     logger.Trace($"执行前sql:{sql} time:{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss ffff")}");
48. #endif
49.                 },
50.                 OnLogSqlExecuted = (sql, param) =>
51.                 {
52. #if DEBUG
53.                     //sql执行后 日志记录 (异步)
54.                     logger.Trace($"执行后sql：{sql} time:{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss ffff")}");
55. #endif
56.                 },
57.                 OnSqlError = (sqlEx) =>
58.                 {
59.                     //sql执行错误后 日志记录 (异步)
60.                     logger.Error($"执行错误：{sqlEx.Message} sql:{sqlEx.Sql} time:{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss ffff")}");
61.                 },
62.                 OnTimeOut = (int timer) =>
63.                 {
64.                     //logger.Trace($"执行超时：{timer} time:{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss ffff")}");
65.                 }
66.             };
67.         }
68.     }
70. }

复制代码

3、在 Startup 中的ConfigureServices方法中，添加 hisql的使用。

1. //注入Hisql相关
2.             services.AddHiSqlSetup();

复制代码

4、新建 控制器 HiSqlController，添加初始化方法。

1.   using Microsoft.AspNetCore.Mvc;
2. using HiSql;
3. using System.Linq;
5. namespace HSMB.Admin.WebApi.Controllers
6. {
7.     [Route("api/[controller]/[action]")]
8.     [ApiController]
9.     public class HiSqlController : ControllerBase
10.     {
11.         private readonly HiSqlClient sqlClient;
12.       
13.         public HiSqlController(         
14.              HiSqlClient hiSqlClient
15.             )
16.         {
17.             this.sqlClient = hiSqlClient;
18.         }
19.         [HttpGet, HttpPost]
20.         public IActionResult Install()
21.         {
22.             sqlClient.CodeFirst.InstallHisql();
23.             var tables = sqlClient.DbFirst.GetTables().ToList().Where(t=>t.TabName.StartsWith("H"));
24.             return new JsonResult(tables);
25.         }
26.     }
27. }

复制代码

5、启动项目后，访问 项目地址 http://localhost:8868/api/hisql/Install 初始化hisql。
如图表示初始化成功，同时在数据库也可以看到，系统创建了下图的4个基础表：

1.Hi_TabModel  #表结构信息主表
2.Hi_FieldModel #表结构信息明细表
3.Hi_Domain #数据域
4.Hi_DataElement  #数据元素
到此，项目就完成了HiSql的引入了，后面就可以愉快的使用HiSql各个功能。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！