【手撸一个ORM】MyOrm的使用说明

1. 【手撸一个ORM】第一步、约定和实体描述
2. 【手撸一个ORM】第二步、封装实体描述和实体属性描述
3. 【手撸一个ORM】第三步、SQL语句构造器和SqlParameter封装
4. 【手撸一个ORM】第四步、Expression（表达式目录树）扩展
5. 【手撸一个ORM】第五步、查询条件表达式目录树解析和插入、更新查询目录树解析
6. 【手撸一个ORM】第六步、对象表达式解析和Select表达式解析
7. 【手撸一个ORM】第七步、SqlDataReader转实体
8. 【手撸一个ORM】第八步、实体查询和按需查询
9. 【手撸一个ORM】第九步、orm默认配置类
10. 【手撸一个ORM】第十步、数据库查询工具类 MyDb

---

 约定

数据实体对象继承自 IEntity 接口，该接口定义了一个 int 类型的Id属性。

public interface IEntity
{
    int Id { get; set; }
}

// 数据实体类
public class Student : IEntity
{
    public int Id { get; set; }
    public string Name { get; set; }
    public int ClazzId { get; set; }
    public Clazz Clazz { get; set; }

    // 更新时忽略该属性
    [MyColumn(UpdateIgnore = true)]
    public DateTime CreateAt { get; set; }
}

public class Clazz : IEntity
{
    public int Id { get; set; }
    public string Name { get; set; }
}

导航属性

如上面定义的Student类，导航属性Clazz默认外键为ClazzId，如需显式指定外键，可使用[MyForeignKey("FKClazzId")]修饰Clazz属性，这样查询时就可以通过Include(s => s.Clazz)查找到相关的Clazz信息，默认仅支持Left Join。

实体描述

MyTableAttribute(string tableName)

用于描述实体类，若实体名称与表名不同，需要使用此描述指定表名

MyKeyAttribute(string keyName)

用于描述实体的主键，若主键列不为Id，需使用词描述指定主键对应的列名

MyColumnAttribute(string ColumnName,bool Ignore,bool InsertIgnore, bool UpdateIgnore)

列描述，可指定对应的列名，Ignore=true 插入和修改时都忽略此字段，InsertIgnore=true 插入时忽略， UpdateIgnore=true 修改时忽略

MyForeignKeyAttribute(string ForeignKey, string MasterKey)

若外键名非 导航属性名+"Id"，则需通过ForeignKey指定，MasterKey默认为Id，若不是通过Id进行关联或关联表的主键名不是Id，则需要通过此MasterKey指定

用法

实例化对象：

var db = new MyDb("DataSource=.;Database=Test;USER ID=sa;Password=1234");

// 或者在global中定义默认配置，使用时只要 var db = MyDb.New(); 即可。
// MyDb.New()等同于 new MyDb();
MyMiniOrmConfiguration.Init(ConfigurationManager.AppSettings["DefaultConnectionString"]);

查询单个实体：

var student = db.Load<Student>(1);
var student = db.Load<Student>(s => s.Name == "张三");

查询多个实体：

var student = db.Fetch<Student>();
var student = db.PageList<T>(2, 10, out var recordCount, s => s.Name.Contains("张三"), s=>s.Name);

Fluent 查询

var query = db.Query<Student>()
    .Include(s => s.Clazz)
    .Where(s => s.CreateAt > DateTime.Today.AddDays(-1))
    .OrderBy(s => s.Clazz.Id)
    .ThenOrderByDesc(s => s.Name);

var student = query.FirstOrDefault();
var students = query.ToList();
var students2 = query.ToPageList(2, 2, out var recordCount);

Select 查询

var query = db.Query<Student>()
    .Include(s => s.Clazz)
    .Where(s => s.CreateAt > DateTime.Today.AddDays(-1))
    .OrderBy(s => s.Clazz.Id)
    .ThenOrderByDesc(s => s.Name);

var student = query.Select<StudentDto>(s => new StudentDto { s.Id, s.StudentName, SchoolName = s.School.Name }).ToList();
var student = query.Select<StudentDto>(s => new StudentDto { s.Id, s.StudentName, SchoolName = s.School.Name }).ToPageList(2, 2, out var recordCount);

插入

var student = new Student
{
    Name = "张三",
    ClazzId = 1,
    CreateAt = DateTime.Now
};
db.Insert(student);    // 会将新产生的Id赋值到student.Id属性
Console.WriteLine($"{student.Id}");

// 批量插入
var students = new List<Student>
{
    new Student {Name = "张三", ClazzId = 1, CreateAt = DateTime.Now},
    new Student {Name = "李四", ClazzId = 1, CreateAt = DateTime.Now},
    new Student {Name = "王五", ClazzId = 1, CreateAt = DateTime.Now},
    new Student {Name = "赵六", ClazzId = 1, CreateAt = DateTime.Now}
};

db.Insert(students);

foreach (var stu in students)
{
    Console.WriteLine($"{stu.Id}-{stu.Name}");
}

// 如果不存在，则插入
// 如限制用户名不能重复 InsertIfNotExist(user, u => u.Name == user.Name)
int InsertIfNotExists<T>(T entity, Expression<Func<T, bool>> where) where T : class, IEntity, new()

更新

var student = db.Load<Student>(1);
student.Name = student.Name + "修改过";
var result = db.Update(student);

// 批量更新
var students = db.Fetch<Student>(s => s.Id > 1);
foreach (var student in students)
{
    student.Name += student.Name + "批量修改过";
}
var count = db.Update(students);
Console.WriteLine($"修改了 {count} 行");

// 如果不存在则更新
// UpdateIfNotExists(user, u=>u.Name == user.Name && u.Id != user.Id)
int UpdateIfNotExits<T>(T entity, Expression<Func<T, bool>> where)

更新

// 通过Id修改指定列
db.Update<Student>(1, DbKvs.New().Add("Name", "张三"));

var student = db.Load<Student>(1);
student.Name = student.Name + "测试修改";
student.ClazzId = 2;

// 更新指定对象的指定属性（指定忽略属性）
// 注意，下面方法传入的是属性名而不是列名

var count = db.UpdateInclude<Student>(student, new[] {"Name", "ClazzId"});
var count2 = db.UpdateInclude<Student>(student, s => new { s.Name, s.ClazzId };
var count3 = db.UpdateIgnore<Student>(student, new[] {"CreateAt"});
var count4 = db.UpdateInclude<Student>(student, s => new { s.CreateAt, s.Creator, s.IsDel };

// 通过指定条件修改指定列，注意第一个参数传入的是属性名而不是列名
db.Update<Student>(DbKvs.New().Add("ClazzId", 2), s => s.ClazzId == 1);

删除

// 如果实体继承ISoftDelete，此方法将IsDel列赋值为0，可通过传入 isForce=true，强制delete

// int Delete<T>(int id, bool isForce = false) where T : class, IEntity, new()
db.Delete<Student>(1, true);

// int Delete<T>(IEnumerable<int> idList, bool isForce = false) where T : class, IEntity, new()
db.Delete<Student>(new[] {1,2,3}, true);