同步OpenAuth.Core最新代码

OpenAuth.Repository/Interface/IUnitWork.cs

@@ -4,7 +4,7 @@
 // Created          : 04-29-2016
 //
 // Last Modified By : yubaolee
-// Last Modified On : 04-29-2016
+// Last Modified On : 12-15-2020
 // Contact : Microsoft
 // File: IUnitWork.cs
 // ***********************************************************************
@@ -12,12 +12,14 @@
 using System;
 using System.Linq;
 using System.Linq.Expressions;
+using System.Threading.Tasks;
 using OpenAuth.Repository.Core;
 
 namespace OpenAuth.Repository.Interface
 {
     /// <summary>
     /// 工作单元接口
+    /// 使用详见：http://doc.openauth.me/core/unitwork.html
     /// <para> 适合在一下情况使用:</para>
     /// <para>1 在同一事务中进行多表操作</para>
     /// <para>2 需要多表联合查询</para>
@@ -25,18 +27,39 @@ namespace OpenAuth.Repository.Interface
     /// </summary>
     public interface IUnitWork
     {
+        /// <summary>
+        /// EF默认情况下，每调用一次SaveChanges()都会执行一个单独的事务
+        /// 本接口实现在一个事务中可以多次执行SaveChanges()方法
+        /// </summary>
+        void ExecuteWithTransaction(Action action);
+        /// <summary>
+        /// 返回DbContext,用于多线程等极端情况
+        /// </summary>
+        /// <returns></returns>
         OpenAuthDBContext GetDbContext();
-        T FindSingle<T>(Expression<Func<T, bool>> exp = null) where T:class;
-        bool IsExist<T>(Expression<Func<T, bool>> exp) where T:class;
+        /// <summary>
+        /// 返回一个单独的实体，如果记录多于1个则取第一个
+        /// </summary>
+        T FirstOrDefault<T>(Expression<Func<T, bool>> exp = null) where T:class;
+        /// <summary>
+        /// 判断指定条件的记录是否存在
+        /// </summary>
+        bool Any<T>(Expression<Func<T, bool>> exp) where T:class;
         IQueryable<T> Find<T>(Expression<Func<T, bool>> exp = null) where T:class;
 
         IQueryable<T> Find<T>(int pageindex = 1, int pagesize = 10, string orderby = "",
             Expression<Func<T, bool>> exp = null) where T:class;
 
-        int GetCount<T>(Expression<Func<T, bool>> exp = null) where T:class;
+        int Count<T>(Expression<Func<T, bool>> exp = null) where T:class;
 
+        /// <summary>
+        /// 新增对象，如果Id为空，则会自动创建默认Id
+        /// </summary>
         void Add<T>(T entity) where T:BaseEntity;
 
+        /// <summary>
+        /// 批量新增对象，如果对象Id为空，则会自动创建默认Id
+        /// </summary>
         void BatchAdd<T>(T[] entities) where T:BaseEntity;
 
         /// <summary>
@@ -49,18 +72,25 @@ namespace OpenAuth.Repository.Interface
 
         /// <summary>
         /// 实现按需要只更新部分更新
-        /// <para>如：Update<T>(u =>u.Id==1,u =>new User{Name="ok"}) where T:class;</para>
+        /// <para>如：Update&lt;User&gt;(u =>u.Id==1,u =>new User{Name="ok"})</para>
+        /// <para>该方法内部自动调用了SaveChanges()，需要ExecuteWithTransaction配合才能实现事务控制</para>
         /// </summary>
         /// <param name="where">更新条件</param>
         /// <param name="entity">更新后的实体</param>
         void Update<T>(Expression<Func<T, bool>> where, Expression<Func<T, T>> entity) where T:class;
         /// <summary>
         /// 批量删除
+        /// <para>该方法内部自动调用了SaveChanges()，需要ExecuteWithTransaction配合才能实现事务控制</para>
         /// </summary>
         void Delete<T>(Expression<Func<T, bool>> exp) where T:class;
 
         void Save();
-
+        
+        /// <summary>
+        /// 该方法不支持EF自带的事务,需要ExecuteWithTransaction配合才能实现事务控制,详见：http://doc.openauth.me/core/unitwork.html
+        /// </summary>
+        /// <param name="sql"></param>
+        /// <returns></returns>
         int ExecuteSql(string sql);
         
         /// <summary>
@@ -75,5 +105,15 @@ namespace OpenAuth.Repository.Interface
         /// <typeparam name="T"> T为非数据库实体，需要在DbContext中增加对应的DbQuery</typeparam>
         /// <returns></returns>
         IQueryable<T> Query<T>(string sql, params object[] parameters) where T : class;
+        
+        #region 异步接口
+
+        Task<int> ExecuteSqlRawAsync(string sql);
+        Task<int> SaveAsync();
+        Task<int> CountAsync<T>(Expression<Func<T, bool>> exp = null) where T : class;
+        Task<bool> AnyAsync<T>(Expression<Func<T, bool>> exp) where T : class;
+        Task<T> FirstOrDefaultAsync<T>(Expression<Func<T, bool>> exp) where T : class;
+
+        #endregion
     }
 }