服务端的TigerApi 框架,基于.NET6 2024 版本
Ben Lin
2025-03-04 990807a09cf35a73b20e213a4df82acddec40f4b
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
using Rhea.Common;
using SqlSugar;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management;
using System.Text;
using System.Threading.Tasks;
using Tiger.Model;
 
namespace Tiger.IBusiness
{
    /// <summary>
    /// 数据库操作基础类
    /// </summary>
    public interface IDbBase
    {
        #region 添加操作
        /// <summary>
        /// 把单个实体往数据库添加一行数据
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="entity">实体</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<T>> AddAsync<T>(T entity, bool isAsync = true) where T : class, new();
 
        /// <summary>
        /// 把实体List往数据库批量添加数据
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="list">实体List</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<T>> AddListAsync<T>(List<T> list, bool isAsync = true) where T : class, new();
        #endregion
 
        #region 保存操作
        /// <summary>
        /// 把单个实体往数据库保存一行数据,如果存在就更新,不存在就插入
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="entity">实体</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<T>> SaveAsync<T>(T entity, bool isAsync = true) where T : class, new();
 
        /// <summary>
        /// 把实体List往数据库批量保存数据,如果存在就更新,不存在就插入
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="list">实体List</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<T>> SaveListAsync<T>(List<T> list, bool isAsync = true) where T : class, new();
 
        /// <summary>
        /// 把单个实体往数据库保存一行数据,如果存在就更新,不存在就插入
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="entity">实体</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<T>> StorageableAsync<T>(T entity, bool isAsync = true) where T : class, new();
 
        /// <summary>
        /// 把实体List往数据库批量保存数据,如果存在就更新,不存在就插入
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="list">实体List</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<T>> StorageableListAsync<T>(List<T> list, bool isAsync = true) where T : class, new();
        #endregion
 
        #region 修改操作
        /// <summary>
        /// 从数据库中修改单个实体
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="entity">实体</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction> UpdateAsync<T>(T entity, bool isAsync = true) where T : class, new();
 
        /// <summary>
        /// 根据实体List在数据库批量修改数据
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="list">实体List</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction> UpdateAsync<T>(List<T> list, bool isAsync = true) where T : class, new();
 
        /// <summary>
        /// 按UpdaterAble&lt;T>对象从数据库中修改多个实体的某些字段
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="updater">实体List</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction> UpdateAsync<T>(UpdateAble<T> updater, bool isAsync = true) where T : class, new();
        #endregion
 
        #region 删除操作
        /// <summary>
        /// 从数据库中删除多个实体
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="newEntity">固定用法:通过ApiAction.NewDataEntity()创建ApiAction中指定类型对象</param>
        /// <param name="primaryKeys">实体的主键ID数组</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction> DeleteAsync<T>(T newEntity, string[] primaryKeys, bool isAsync = true) where T : class, new();
 
        /// <summary>
        /// 从数据库中删除单个实体
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="entity">实体</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction> DeleteAsync<T>(T entity, bool isAsync = true) where T : class, new();
 
        /// <summary>
        /// 从数据库中删除实体List
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="list">实体List</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction> DeleteAsync<T>(List<T> list, bool isAsync = true) where T : class, new();
 
        /// <summary>
        /// 根据Where语句删除满足条件的数据
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="newEntity">固定用法:通过ApiAction.NewDataEntity()创建ApiAction中指定类型对象</param>
        /// <param name="where">Where语句</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction> DeleteAsync<T>(T newEntity, string where, bool isAsync = true) where T : class, new();
        #endregion
 
        #region 查询操作
        /// <summary>
        /// 从数据库中查询实体
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="newEntity">固定用法:通过ApiAction.NewDataEntity()创建ApiAction中指定类型对象</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<List<T>>> QueryAsync<T>(T newEntity, bool isAsync = true, bool needInclude = false);
 
        /// <summary>
        /// 根据Where语句从数据库中查询实体
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="newEntity">固定用法:通过ApiAction.NewDataEntity()创建ApiAction中指定类型对象</param>
        /// <param name="where">Where语句</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<List<T>>> QueryAsync<T>(T newEntity, string where, bool isAsync = true, bool needInclude = false) where T : class, new();
 
        /// <summary>
        /// 按PageAble&lt;T>对象返回实体当前Page的数据
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="page">分页的参数实体</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<PageAble<T>>> QueryAsync<T>(PageAble<T> page, bool isAsync = true, bool needInclude = false);
 
        /// <summary>
        /// 分页直接返回PageAble&lt;T>
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="page"></param>
        /// <param name="isAsync"></param>
        /// <returns></returns>
        public Task<ApiAction<PageAble<T>>> QueryPageAsync<T>(PageAble<T> page, bool isAsync = true, bool needInclude = false);
 
        /// <summary>
        /// 按QueryAble&lt;T>对象从数据库查询满足条件的数据
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="query">QueryAble的参数实体</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<QueryAble<T>>> QueryAsync<T>(QueryAble<T> query, bool isAsync = true, bool needInclude = false);
 
        /// <summary>
        /// 根据SQL语句从数据库中查询实体
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="newEntity">固定用法:通过ApiAction.NewDataEntity()创建ApiAction中指定类型对象</param>
        /// <param name="sqlcmd">SQL语句</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<List<T>>> QuerySqlAsync<T>(T newEntity, string sqlcmd, bool isAsync = true, bool needInclude = false) where T : class, new();
 
        /// <summary>
        /// 根据SQL语句从数据库中查询并按PageAble&lt;T>对象返回当前Page的数据
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="page">分页的参数实体</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<PageAble<T>>> QuerySqlAsync<T>(PageAble<T> page, bool isAsync = true, bool needInclude = false) where T : class, new();
 
        /// <summary>
        /// 从数据库中查询实体
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="newEntity">固定用法:通过ApiAction.NewDataEntity()创建ApiAction中指定类型对象</param>
        /// <param name="options">授权查询配置项</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<List<T>>> QueryByAuthAsync<T>(T newEntity, AuthOption options, bool isAsync = true, bool needInclude = false) where T : iTableHasAuth, new();
 
        /// <summary>
        /// 根据Where语句从数据库中查询实体
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="newEntity">固定用法:通过ApiAction.NewDataEntity()创建ApiAction中指定类型对象</param>
        /// <param name="where">Where语句</param>
        /// <param name="options">授权查询配置项</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<List<T>>> QueryByAuthAsync<T>(T newEntity, string where, AuthOption options, bool isAsync = true, bool needInclude = false) where T : iTableHasAuth, new();
 
        /// <summary>
        /// 按PageAble&lt;T>对象返回实体当前Page的数据
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="page">分页的参数实体</param>
        /// <param name="options">授权查询配置项</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<PageAble<T>>> QueryByAuthAsync<T>(PageAble<T> page, AuthOption options, bool isAsync = true, bool needInclude = false) where T : iTableHasAuth, new();
 
        /// <summary>
        /// 分页直接返回PageAble&lt;T>
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="page"></param>
        /// <param name="options">授权查询配置项</param>
        /// <param name="isAsync"></param>
        /// <returns></returns>
        public Task<ApiAction<PageAble<T>>> QueryByAuthPageAsync<T>(PageAble<T> page, AuthOption options, bool isAsync = true, bool needInclude = false) where T : iTableHasAuth, new();
 
        /// <summary>
        /// 按QueryAble&lt;T>对象从数据库查询满足条件的数据
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="query">QueryAble的参数实体</param>
        /// <param name="options">授权查询配置项</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction<QueryAble<T>>> QueryByAuthAsync<T>(QueryAble<T> query, AuthOption options, bool isAsync = true, bool needInclude = false) where T : iTableHasAuth, new();
 
        #endregion
 
        #region 查询 Count
        /// <summary>
        /// 根据Where语句查询满足条件的实体的Count数量
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="newEntity">固定用法:通过ApiAction.NewDataEntity()创建ApiAction中指定类型对象</param>
        /// <param name="where">Where语句</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction> CountAsync<T>(T newEntity, string where, bool isAsync = true);
 
        /// <summary>
        /// 根据Where语句查询满足条件的实体的Count数量
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="newEntity">固定用法:通过ApiAction.NewDataEntity()创建ApiAction中指定类型对象</param>
        /// <param name="where">Where语句</param>
        /// <param name="options">授权查询配置项</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction> CountByAuthAsync<T>(T newEntity, string where, AuthOption options, bool isAsync = true) where T : iTableHasAuth, new();
        #endregion
 
        #region 查询 Exist
        /// <summary>
        /// 根据Where语句查询满足条件的Data实体是否存在
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="newEntity">固定用法:通过ApiAction.NewDataEntity()创建ApiAction中指定类型对象</param>
        /// <param name="where">Where语句</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction> IsExistAsync<T>(T newEntity, string where, bool isAsync = true);
 
        /// <summary>
        /// 根据Where语句查询满足条件的Data实体是否存在
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="newEntity">固定用法:通过ApiAction.NewDataEntity()创建ApiAction中指定类型对象</param>
        /// <param name="where">Where语句</param>
        /// <param name="options">授权查询配置项</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction> IsExistByAuthAsync<T>(T newEntity, string where, AuthOption options, bool isAsync = true) where T : iTableHasAuth, new();
        #endregion
 
        #region 执行SQL
        /// <summary>
        /// 执行SQL语句返回影响行数
        /// </summary>
        /// <param name="sqlcmd">要执行的SQL语句</param>
        /// <param name="parameters">SQL语句的参数</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction> ExecuteSqlCommandAsync(string sqlcmd, List<SugarParameter> parameters, bool isAsync = true);
 
        /// <summary>
        /// 执行SQL语句返回影响行数
        /// </summary>
        /// <param name="sqlcmd">要执行的SQL语句</param>
        /// <param name="parameters">SQL语句的参数</param>
        /// <param name="isAsync">是否以异步方式执行</param>
        /// <returns></returns>
        public Task<ApiAction> ExecuteSqlCommandAsync(string sqlcmd, bool isAsync = true, params SugarParameter[] parameters);
 
        /// <summary>
        /// 异步方式执行SQL语句返回影响行数
        /// </summary>
        /// <param name="sqlcmd">要执行的SQL语句</param>
        /// <param name="parameters">SQL语句的参数</param>
        /// <returns></returns>
        public Task<ApiAction> ExecuteSqlCommandAsync(string sqlcmd, params SugarParameter[] parameters);
        #endregion
 
        #region 先删除后新增
        public Task<ApiAction> AddAfterDeleteAsync<T>(QueryAble<T> query) where T : class, new();
 
        #endregion
 
    }
}