From 39ac2d8286b93646f95dfa9280322ce7b49ac832 Mon Sep 17 00:00:00 2001 From: AlexLEWIS Date: Wed, 11 Aug 2021 13:38:06 +0800 Subject: [PATCH 1/3] Add English comments for JsonMap extension package. --- .../DataAnnotations/JsonMapAttribute.cs | 12 +++++------- Extensions/FreeSql.Extensions.JsonMap/JsonMapCore.cs | 11 +++++------ 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/Extensions/FreeSql.Extensions.JsonMap/DataAnnotations/JsonMapAttribute.cs b/Extensions/FreeSql.Extensions.JsonMap/DataAnnotations/JsonMapAttribute.cs index 44f5d8a1..77878720 100644 --- a/Extensions/FreeSql.Extensions.JsonMap/DataAnnotations/JsonMapAttribute.cs +++ b/Extensions/FreeSql.Extensions.JsonMap/DataAnnotations/JsonMapAttribute.cs @@ -1,13 +1,11 @@ using System; -using System.Linq; +// ReSharper disable once CheckNamespace namespace FreeSql.DataAnnotations { - /// - /// 当实体类属性为【对象】时，以JSON形式映射存储 + /// When the entity class property is , map storage in JSON format.
+ /// 当实体类属性为【对象】时，以 JSON 形式映射存储 /// - public class JsonMapAttribute : Attribute - { - } -} + public class JsonMapAttribute : Attribute { } +} \ No newline at end of file diff --git a/Extensions/FreeSql.Extensions.JsonMap/JsonMapCore.cs b/Extensions/FreeSql.Extensions.JsonMap/JsonMapCore.cs index 42c61462..60b0e0b1 100644 --- a/Extensions/FreeSql.Extensions.JsonMap/JsonMapCore.cs +++ b/Extensions/FreeSql.Extensions.JsonMap/JsonMapCore.cs @@ -5,7 +5,6 @@ using System.Collections.Concurrent; using System.Linq; using System.Linq.Expressions; using System.Reflection; -using System.Text; using System.Threading; public static class FreeSqlJsonMapCoreExtensions @@ -19,11 +18,12 @@ public static class FreeSqlJsonMapCoreExtensions public static ColumnFluent JsonMap(this ColumnFluent col) { _dicJsonMapFluentApi.GetOrAdd(col._entityType, et => new ConcurrentDictionary()) - .GetOrAdd(col._property.Name, pn => true); + .GetOrAdd(col._property.Name, pn => true); return col; } /// + /// When the entity class property is and the attribute is marked as , map storage in JSON format.
/// 当实体类属性为【对象】时，并且标记特性 [JsonMap] 时，该属性将以JSON形式映射存储 /// /// @@ -43,7 +43,7 @@ public static class FreeSqlJsonMapCoreExtensions }); } - that.Aop.ConfigEntityProperty += new EventHandler((s, e) => + that.Aop.ConfigEntityProperty += (s, e) => { var isJsonMap = e.Property.GetCustomAttributes(typeof(JsonMapAttribute), false).Any() || _dicJsonMapFluentApi.TryGetValue(e.EntityType, out var tryjmfu) && tryjmfu.ContainsKey(e.Property.Name); if (isJsonMap) @@ -61,7 +61,6 @@ public static class FreeSqlJsonMapCoreExtensions }); } } - }); + }; } -} - +} \ No newline at end of file From 907141a57debd77c4e440ab88720adf195dcb34a Mon Sep 17 00:00:00 2001 From: AlexLEWIS Date: Wed, 11 Aug 2021 14:06:09 +0800 Subject: [PATCH 2/3] Add English version of README.MD --- .../README.zh-CN.md | 25 +++++++++++++++++++ .../FreeSql.Extensions.JsonMap/readme.md | 6 +++-- 2 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 Extensions/FreeSql.Extensions.JsonMap/README.zh-CN.md diff --git a/Extensions/FreeSql.Extensions.JsonMap/README.zh-CN.md b/Extensions/FreeSql.Extensions.JsonMap/README.zh-CN.md new file mode 100644 index 00000000..8bd20d1d --- /dev/null +++ b/Extensions/FreeSql.Extensions.JsonMap/README.zh-CN.md @@ -0,0 +1,25 @@ +**中文** | [English](README.MD) + +FreeSql 扩展包，将值对象映射成 `typeof(string)`，安装扩展包： + +> dotnet add package FreeSql.Extensions.JsonMap + +```csharp +fsql.UseJsonMap(); //开启功能 + +class TestConfig +{ + public int clicks { get; set; } + public string title { get; set; } +} + +[Table(Name = "sysconfig")] +public class S_SysConfig +{ + [Column(IsPrimary = true)] + public string Name { get; set; } + + [JsonMap] + public T Config { get; set; } +} +``` \ No newline at end of file diff --git a/Extensions/FreeSql.Extensions.JsonMap/readme.md b/Extensions/FreeSql.Extensions.JsonMap/readme.md index 96906cd8..572deca2 100644 --- a/Extensions/FreeSql.Extensions.JsonMap/readme.md +++ b/Extensions/FreeSql.Extensions.JsonMap/readme.md @@ -1,9 +1,11 @@ -FreeSql 扩展包，将值对象映射成 typeof(string)，安装扩展包： +[中文](README.zh-CN.MD) | **English** + +FreeSql extension package, map *ValueObject* to `typeof(string)`, install the extension package: > dotnet add package FreeSql.Extensions.JsonMap ```csharp -fsql.UseJsonMap(); //开启功能 +fsql.UseJsonMap(); //Turn on function class TestConfig { From f302199e0ea623457c113054ed06e7a463767bd1 Mon Sep 17 00:00:00 2001 From: AlexLEWIS Date: Wed, 11 Aug 2021 14:06:13 +0800 Subject: [PATCH 3/3] Add English version of README.MD --- .../README.zh-CN.md | 128 ++++++++++++++++++ .../FreeSql.Extensions.BaseEntity/readme.md | 75 +++++----- 2 files changed, 167 insertions(+), 36 deletions(-) create mode 100644 Extensions/FreeSql.Extensions.BaseEntity/README.zh-CN.md diff --git a/Extensions/FreeSql.Extensions.BaseEntity/README.zh-CN.md b/Extensions/FreeSql.Extensions.BaseEntity/README.zh-CN.md new file mode 100644 index 00000000..4314961b --- /dev/null +++ b/Extensions/FreeSql.Extensions.BaseEntity/README.zh-CN.md @@ -0,0 +1,128 @@ +**中文** | [English](README.MD) + +# 前言 + +尝试过 ado.net、dapper、ef，以及Repository仓储，甚至自己还写过生成器工具，以便做常规CRUD操作。 + +它们日常操作不方便之处： + +- 每次使用前需要声明，再操作； + +- 很多人一个实体类，对应一个操作类（或DAL、DbContext、Repository）； + +BaseEntity 是一种极简单的 CodeFirst 开发方式，特别对单表或多表CRUD，利用继承节省了每个实体类的重复属性（创建时间、ID等字段），软件删除等功能，进行 crud 操作时不必时常考虑仓储的使用； + +本文介绍 BaseEntity 一种极简约的 CRUD 操作方法。 + +# 功能特点 + +- 自动迁移实体结构（CodeFirst），到数据库； + +- 直接操作实体的方法，进行 CRUD 操作； + +- 简化用户定义实体类型，省去主键、常用字段的配置（如CreateTime、UpdateTime）； + +- 实现单表、多表查询的软删除逻辑； + +# 声明 + +> dotnet add package FreeSql.Extensions.BaseEntity + +> dotnet add package FreeSql.Provider.Sqlite + +1、定义一个主键 int 并且自增的实体类型，BaseEntity TKey 指定为 int/long 时，会认为主键是自增； + +```csharp +public class UserGroup : BaseEntity +{ + public string GroupName { get; set; } +} +``` + +如果不想主键是自增键，可以重写属性： + +```csharp +public class UserGroup : BaseEntity +{ + [Column(IsIdentity = false)] + public override int Id { get; set; } + public string GroupName { get; set; } +} +``` +> 有关更多实体的特性配置，请参考资料：https://github.com/dotnetcore/FreeSql/wiki/%e5%ae%9e%e4%bd%93%e7%89%b9%e6%80%a7 + +2、定义一个主键 Guid 的实体类型，保存数据时会自动产生有序不重复的 Guid 值（不用自己指定 Guid.NewGuid()）； + +```csharp +public class User : BaseEntity +{ + public string UserName { get; set; } +} +``` + +# CRUD 使用 + +```csharp +//添加 +var item = new UserGroup { GroupName = "组一" }; +item.Insert(); + +//更新 +item.GroupName = "组二"; +item.Update(); + +//添加或更新 +item.Save(); + +//软删除 +item.Delete(); + +//恢复软删除 +item.Restore(); + +//根据主键获取对象 +var item = UserGroup.Find(1); + +//查询数据 +var items = UserGroup.Where(a => a.Id > 10).ToList(); +``` + +实体类型.Select 是一个查询对象，使用方法和 FreeSql.ISelect 一样； + +支持多表查询时，软删除条件会附加在每个表中； + +> 有关更多查询方法，请参考资料：https://github.com/2881099/FreeSql/wiki/%e6%9f%a5%e8%af%a2 + +# 事务建议 + +由于 AsyncLocal 平台兼容不好，所以交给外部管理事务。 + +```csharp +static AsyncLocal _asyncUow = new AsyncLocal(); + +BaseEntity.Initialization(fsql, () => _asyncUow.Value); +``` + +在 Scoped 开始时： _asyncUow.Value = fsql.CreateUnitOfWork(); (也可以使用 UnitOfWorkManager 对象获取 uow) + +在 Scoped 结束时：_asyncUow.Value = null; + +如下： + +```csharp +using (var uow = fsql.CreateUnitOfWork()) +{ + _asyncUow.Value = uow; + + try + { + //todo ... BaseEntity 内部 curd 方法保持使用 uow 事务 + } + finally + { + _asyncUow.Value = null; + } + + uow.Commit(); +} +``` diff --git a/Extensions/FreeSql.Extensions.BaseEntity/readme.md b/Extensions/FreeSql.Extensions.BaseEntity/readme.md index bd1a0749..9f850945 100644 --- a/Extensions/FreeSql.Extensions.BaseEntity/readme.md +++ b/Extensions/FreeSql.Extensions.BaseEntity/readme.md @@ -1,34 +1,37 @@ -# 前言 +[中文](README.zh-CN.md) | **English** -尝试过 ado.net、dapper、ef，以及Repository仓储，甚至自己还写过生成器工具，以便做常规CRUD操作。 +# Preface -它们日常操作不方便之处： +I have tried ADO.NET, Dapper, EF, and Repository storage, and even wrote a generator tool myself to do common CRUD operations. -- 每次使用前需要声明，再操作； +Their operation is inconvenient: -- 很多人一个实体类，对应一个操作类（或DAL、DbContext、Repository）； +- Need to declare before use; -BaseEntity 是一种极简单的 CodeFirst 开发方式，特别对单表或多表CRUD，利用继承节省了每个实体类的重复属性（创建时间、ID等字段），软件删除等功能，进行 crud 操作时不必时常考虑仓储的使用； +- Each entity class corresponds to an operation class (or DAL, DbContext, Repository). -本文介绍 BaseEntity 一种极简约的 CRUD 操作方法。 +BaseEntity is a very simple way of CodeFirst development, especially for single-table or multi-table CRUD operations. BaseEntity uses "inheritance" to save the repetitive code (creation time, ID and other fields) and functions of each entity class, and at the same time, it is not necessary to consider the use of repository when performing CURD operations. -# 功能特点 -- 自动迁移实体结构（CodeFirst），到数据库； +This article will introduce a very simple CRUD operation method of BaseEntity. -- 直接操作实体的方法，进行 CRUD 操作； +# Features -- 简化用户定义实体类型，省去主键、常用字段的配置（如CreateTime、UpdateTime）； +- Automatically migrate the entity structure (CodeFirst) to the database; -- 实现单表、多表查询的软删除逻辑； +- Directly perform CRUD operations on entities; -# 声明 +- Simplify user-defined entity types, eliminating hard-coded primary keys, common fields and their configuration (such as CreateTime, UpdateTime); + +- Logic delete of single-table and multi-table query; + +# Declaring > dotnet add package FreeSql.Extensions.BaseEntity > dotnet add package FreeSql.Provider.Sqlite -1、定义一个主键 int 并且自增的实体类型，BaseEntity TKey 指定为 int/long 时，会认为主键是自增； +1. Define an auto-increment primary key of type `int`. When the `TKey` of `BaseEntity` is specified as `int/long`, the primary key will be considered as auto-increment; ```csharp public class UserGroup : BaseEntity @@ -37,7 +40,7 @@ public class UserGroup : BaseEntity } ``` -如果不想主键是自增键，可以重写属性： +If you don't want the primary key to be an auto-increment key, you can override the attribute: ```csharp public class UserGroup : BaseEntity @@ -47,9 +50,9 @@ public class UserGroup : BaseEntity public string GroupName { get; set; } } ``` -> 有关更多实体的特性配置，请参考资料：https://github.com/2881099/FreeSql/wiki/%e5%ae%9e%e4%bd%93%e7%89%b9%e6%80%a7 +> For more information about the attributes of entities, please refer to: https://github.com/dotnetcore/FreeSql/wiki/Entity-Attributes -2、定义一个主键 Guid 的实体类型，保存数据时会自动产生有序不重复的 Guid 值（不用自己指定 Guid.NewGuid()）； +2. Define an entity whose primary key is Guid type, when saving data, it will automatically generate ordered and non-repeated Guid values (you don't need to specify `Guid.NewGuid()` yourself); ```csharp public class User : BaseEntity @@ -58,42 +61,42 @@ public class User : BaseEntity } ``` -# CRUD 使用 +# Usage of CRUD ```csharp -//添加 -var item = new UserGroup { GroupName = "组一" }; +//Insert Data +var item = new UserGroup { GroupName = "Group One" }; item.Insert(); -//更新 -item.GroupName = "组二"; +//Update Data +item.GroupName = "Group Two"; item.Update(); -//添加或更新 +//Insert or Update Data item.Save(); -//软删除 +//Logic Delete item.Delete(); -//恢复软删除 +//Recover Logic Delete item.Restore(); -//根据主键获取对象 +//Get the object by the primary key var item = UserGroup.Find(1); -//查询数据 +//Query Data var items = UserGroup.Where(a => a.Id > 10).ToList(); ``` -实体类型.Select 是一个查询对象，使用方法和 FreeSql.ISelect 一样； +`{ENTITY_TYPE}.Select` returns a query object, the same as `FreeSql.ISelect`. -支持多表查询时，软删除条件会附加在每个表中； +In the multi-table query, the logic delete condition will be attached to the query of each table. -> 有关更多查询方法，请参考资料：https://github.com/2881099/FreeSql/wiki/%e6%9f%a5%e8%af%a2 +> For more information about query data, please refer to: https://github.com/2881099/FreeSql/wiki/Query-Data -# 事务建议 +# Transaction Suggestion -由于 AsyncLocal 平台兼容不好，所以交给外部管理事务。 +Because the `AsyncLocal` platform is not compatible, the transaction is managed by the outside. ```csharp static AsyncLocal _asyncUow = new AsyncLocal(); @@ -101,11 +104,11 @@ static AsyncLocal _asyncUow = new AsyncLocal(); BaseEntity.Initialization(fsql, () => _asyncUow.Value); ``` -在 Scoped 开始时： _asyncUow.Value = fsql.CreateUnitOfWork(); (也可以使用 UnitOfWorkManager 对象获取 uow) +At the beginning of `Scoped`: `_asyncUow.Value = fsql.CreateUnitOfWork();` (You can also use the `UnitOfWorkManager` object to get uow) -在 Scoped 结束时：_asyncUow.Value = null; +At the end of `Scoped`: `_asyncUow.Value = null;` -如下： +as follows: ```csharp using (var uow = fsql.CreateUnitOfWork()) @@ -114,7 +117,7 @@ using (var uow = fsql.CreateUnitOfWork()) try { - //todo ... BaseEntity 内部 curd 方法保持使用 uow 事务 + //todo ... BaseEntity internal CURD method keeps using uow transaction } finally {