SqlSugar官网地址：https://www.donet5.com/Home/Doc
一：下载
直接使用NuGet管理即可，根据项目选择SqlSugar或者SqlSugarCore
image.png
二：知识点
其实在官网中都有教程，这里只列举几个讲解
//原生模式：SqlSugarClient.
//每次请求new一个新对象，db禁止跨上下文使用.
//禁止单例，每个上下文都要是新的对象拥有超高性能，使用不当出现偶发错误通过IOC或者db.CopyNew()创建新的对象避免同一个对象在多个上下文使用
//单例模式：SqlSugarScope.
//原理是通过AsyncLocal实现，异步并发Task.WhenAll或者异步不写await需要db.CopyNew()保证线程安全。
//只能单例，不能一致new，该对象是不会清空的，一致new会有内存问题
// 1.DbFirst:映射迁移方式，从数据库中把表生成实体对象，数据库先行（先设计数据库）
// IsCreateAttribute代表生成SqlSugar特性
db.DbFirst.IsCreateAttribute().CreateClassFile("D:\\sqlsugar", "Models");// 根据数据库中的表创建实体类保存到指定路径，并以Models为命名空间
db.DbFirst.FormatFileName(x => x.ToLower()).CreateClassFile("D:\\sqlsugar", "Models");// 格式化文件名
db.DbFirst.StringNullable().CreateClassFile("D:\\sqlsugar", "Models"); // 强制可以为空类型string加上？
db.DbFirst.Where("Student").CreateClassFile("D:\\sqlsugar", "Models"); // 只生成student表
db.DbFirst.IsCreateDefaultValue().CreateClassFile("D:\\sqlsugar", "Models");// 生成实体类带有默认值
// 2.CodeFirst:代码先行，现有代码，然后有数据库，只关注业务
db.DbMaintenance.CreateDatabase();// 建库：如何不存在在创建数据库，存在则不会重复创建
db.CodeFirst.InitTables<UserTest>();// 创建表：根据实体类数据表，存在则不会重复创建
db.CodeFirst.SetStringDefaultLength(200).InitTables(typeof(UserTest));// 单个表
db.CodeFirst.SetStringDefaultLength(200).InitTables(typeof(UserTest), typeof(User));// 多个表
/***批量创建表***/
//语法1：
Type[] types = Assembly
.LoadFrom("XXX.dll")//如果 .dll报错，可以换成 xxx.exe 有些生成的是exe
.GetTypes()
.Where(it => it.FullName.Contains("OrmTest."))//命名空间过滤，可以写其他条件
.ToArray();//断点调试一下是不是需要的Type，不是需要的在进行过滤
//Type[] ass = Assembly.LoadFrom("bin/Debug/net6.0/model.dll").GetTypes().Where(p => p.Namespace == nspace).ToArray();
db.CodeFirst.SetStringDefaultLength(200).InitTables(types);//根据types创建表
//语法2：
Type[] types2 = typeof(UserTest).Assembly
.GetTypes()
.Where(it => it.FullName.Contains("OrmTest."))//命名空间过滤，当然你也可以写其他条件过滤
.ToArray();
db.CodeFirst.SetStringDefaultLength(200).InitTables(types2);//根据types创建表
// 动态设置表名
db.CodeFirst.As<UserTest>("userform").InitTables<UserTest>();// 重命名
////查询表的所有
//var list = SqlSugarHelper.Db.Queryable<Student>().ToList();
//// WhereIF使用
//string str = "";
//int age = 0;
//var Lgroup = db.Queryable<Student>()
// .WhereIF(str == "条件1", it => it.Age == age)
// .WhereIF(str == "条件2", it => it.Age == age)
// .ToList()[0];
////插入
//SqlSugarHelper.Db.Insertable(new Student() { SchoolId = 1, Name = "jack" }).ExecuteCommand();
////更新
//SqlSugarHelper.Db.Updateable(new Student() { Id = 1, SchoolId = 2, Name = "jack2" }).ExecuteCommand();
////删除
//SqlSugarHelper.Db.Deleteable<Student>().Where(it => it.Id == 1).ExecuteCommand();
三：示例使用
由于在官网里对SqlSugar使用已经讲解的很详细了，这里就主要使用三层架构方式设计来做个演示
- 首先创建SqlSugarHelper类
namespace DAL
{
internal class SqlSugarHelper
{
// 数据库路径
//private static readonly string dbFile = Path.Combine(@"D:\sqlitedb", "testDB.db");
private static readonly string dbFile = Path.Combine(Environment.CurrentDirectory, "YZLidar.sqlite");
// 数据库连接字符串,FailIfMissing=false时若文件不存在也会自动创建
private static readonly string connectionString = "DataSource=" + dbFile + ";Pooling=true;FailIfMissing=false;";
internal static readonly SqlSugarScope Db = new SqlSugarScope(new ConnectionConfig()
{
ConnectionString = connectionString,//连接符字串
DbType = DbType.Sqlite,//数据库类型
IsAutoCloseConnection = true //不设成true要手动close
});
internal static readonly SqlSugarScope Db2 = new SqlSugarScope(new ConnectionConfig()
{
ConnectionString = connectionString,//连接符字串
DbType = DbType.Sqlite,//数据库类型
IsAutoCloseConnection = true //不设成true要手动close
},
it => {
// 在执行前记录 SQL 语句和参数
it.Aop.OnLogExecuted = (sql, para) =>
{
Console.WriteLine(UtilMethods.GetNativeSql(sql, para));
};
});
}
}
- 创建数据库操作类
namespace DAL
{
public class DBService
{
/// <summary>
/// 根据数据表创建实体类
/// </summary>
public void CreateClassFiles()
{
//SqlSugarHelper.Db.DbFirst.IsCreateAttribute().CreateClassFile(@"D:\ClassFile", "Models");
SqlSugarHelper.Db.DbFirst.IsCreateAttribute().IsCreateDefaultValue().StringNullable().Where("Lidar").CreateClassFile(@"D:\ClassFile", "Models");
}
/// <summary>
/// 初始化数据库和数据表
/// </summary>
public void InitDataBase()
{
// 建库
SqlSugarHelper.Db.DbMaintenance.CreateDatabase();
// 建表
Type[] types = Assembly
.LoadFrom("Models.dll")//如果 .dll报错，可以换成 xxx.exe 有些生成的是exe
.GetTypes()
.Where(it => it.FullName.Contains("Models.Entitys"))//命名空间过滤，可以写其他条件
.ToArray();//断点调试一下是不是需要的Type，不是需要的在进行过滤
SqlSugarHelper.Db.CodeFirst.SetStringDefaultLength(200).InitTables(types);
}
}
}
- 创建实体类
namespace Models.Entitys
{
/// <summary>
/// 软件配置实体类
/// </summary>
[SugarTable("Config")]
public partial class Config
{
/// <summary>
/// 主键
/// </summary>
[SugarColumn(IsPrimaryKey = true, IsIdentity = true)]
public int Id { get; set; }
/// <summary>
/// 点位抽稀值
/// </summary>
public int LiDarDilution { get; set; }
/// <summary>
/// 鼠标延迟值
/// </summary>
public int MouseDelay { get; set; }
/// <summary>
/// 是否自启动
/// </summary>
public bool IsSelfStart { get; set; }
}
}
- 创建实体数据服务类示例
namespace DAL
{
public class ConfigService
{
#region 添加配置信息
// 添加一条配置信息并返回自增列
public int AddConfigReturnIdentity(Config config)
{
return SqlSugarHelper.Db.Insertable(config).ExecuteReturnIdentity();
}
#endregion
#region 更新配置信息
public int UpdateConfig(Config config)
{
return SqlSugarHelper.Db.Updateable(config).ExecuteCommand();
}
#endregion
#region 查询配置信息
public Config QueryConfig()
{
return SqlSugarHelper.Db.Queryable<Config>().First();
}
#endregion
}
}
- 业务逻辑层调用示例
namespace BLL
{
public class ConfigManager
{
// 创建数据访问对象
private ConfigService objService = new ConfigService();
// 添加一条配置信息并返回自增列
public int AddConfigReturnIdentity(Config config)
{
try
{
var result = objService.AddConfigReturnIdentity(config);
return result;
}
catch (Exception)
{
// 添加失败
return 0;
}
}
// 更新配置信息
public string UpdateConfig(Config config)
{
try
{
var result = objService.UpdateConfig(config);
if (result > 0) { return "success"; }
return "failure";
}
catch (Exception ex)
{
return ex.Message;
}
}
// 查询配置信息
public Config QueryConfig()
{
try
{
return objService.QueryConfig();
}
catch (Exception ex)
{
return null;
throw ex;
}
}
}
}
