EDP .Net开发框架--业务模型

骨头豆腐饭

平台下载地址：https://gitee.com/alwaysinsist/edp

业务模型概述

业务模型管理中所涉及的业务模型，业务模型的属性，业务模型的视图都是可以通过权限设置来实现数据的行（视图），列（属性）权限管控。业务模型是整个EDP平台的核心基础，数据的查询、新增、修改、删除、行列权限都是通过业务模型来实现的。
业务模型管理

按分类管理系统内各个业务模型，对应系统中各个业务对象。
业务模型分类

管理业务模型分类。

业务模型

• 新增业务模型
  
  
  
  
  
• 编辑业务模型
  
  
  
  
  
  
  
• 业务模型代码生成
  
  
  
  
  表设计文档模板，可以包含多个表结构设计
  
  
  

业务模型开发

定义业务模型

创建业务模型类，继承基类ModelPermissionBase。定义好的业务模型可以在上述的业务模型管理功能中进行管理，实现数据行、列权限的管控。
点击查看代码

1. using System;
3. namespace School.Model
4. {   
5.     using EDP.Common.Model;
6.     using EDP.Common.Help;
8.     using EDP.Database;
9.     using EDP.Framework;
11.     using EDP.Authentication;   
13.     /// <summary>
14.     /// 学生业务对象
15.     /// </summary>
16.     [ModelEnitity(TableName = "t_school_student", KeyName = "ID")]
17.     public class StudentModel: ModelPermissionBase
18.     {
19.         /// <summary>
20.         /// 构造函数
21.         /// </summary>
22.         public StudentModel() {
23.             this.SetDefaultQuerySQL(@"select *
24.         from (select a.ID
25.                         ,a.Name
26.                         ,a.Number
27.                         ,a.GenderId
28.                         ,a.Age
29.                         ,a.Contact
30.                         ,a.ContactMobile
31.                         ,a.Hobby
32.                         ,a.CampusId
33.                         ,a.ClassId
34.                         ,a.CreateUserId
35.                         ,a.CreateUserName
36.                         ,a.CreateDepartmentId
37.                         ,a.CreateOrganizationId
38.                         ,a.CreateTime
39.                         ,a.ModifyUserId
40.                         ,a.ModifyUserName
41.                         ,a.ModifyTime
42.                         ,a.Remarks
43.                         ,b.Name CampusName
44.                         ,c.Name ClassName
45.                         ,d.Name SchoolName
46.                         ,c.FullCode ClassFullCode
47.                 from t_school_student a
48.                 left join t_sys_organization_unit b on a.CampusId = b.ID
49.                 left join t_sys_organization_unit c on a.ClassId = c.ID
50.                 left join t_sys_organization_unit d on c.FullCode like d.FullCode + '%' and d.Levels = c.Levels - 3) tab");
51.         }
53.         #region **----实体属性---------------------------**
54.         /// <summary>
55.         /// 主键ID
56.         /// </summary>
57.         [ModelEnitity(ColumnName = "ID")]
58.         public string ID { get; set; }
60.         /// <summary>
61.         /// 姓名
62.         /// </summary>
63.         [ModelEnitity(ColumnName = "Name", IsRequired = true, MaxLength = 50)]
64.         public string Name { get; set; }
66.         /// <summary>
67.         /// 编号
68.         /// <summary>
69.         [ModelEnitity(ColumnName = "Number")]
70.         public string Number { get; set; }
72.         /// <summary>
73.         /// 性别ID
74.         /// </summary>
75.         [ModelEnitity(ColumnName = "GenderId", IsRequired = true)]
76.         public int? GenderId { get; set; }
78.         /// <summary>
79.         /// 年龄
80.         /// </summary>
81.         [ModelEnitity(ColumnName = "Age", IsRequired = true)]
82.         public int? Age { get; set; }
84.         /// <summary>
85.         /// 联系人
86.         /// </summary>
87.         [ModelEnitity(ColumnName = "Contact", MaxLength = 50)]
88.         public string Contact { get; set; }
90.         /// <summary>
91.         /// 联系人手机
92.         /// </summary>
93.         [ModelEnitity(ColumnName = "ContactMobile", Regex = @"^[1]([3-9])[0-9]{9}$")]
94.         public string ContactMobile { get; set; }
96.         /// <summary>
97.         /// 兴趣爱好
98.         /// </summary>
99.         [ModelEnitity(ColumnName = "Hobby", MaxLength = 500)]
100.         public string Hobby { get; set; }
102.         /// <summary>
103.         /// 校区ID
104.         /// </summary>
105.         [ModelEnitity(ColumnName = "CampusId")]
106.         public string CampusId { get; set; }
108.         /// <summary>
109.         /// 班级ID
110.         /// </summary>
111.         [ModelEnitity(ColumnName = "ClassId", IsRequired = true)]
112.         public string ClassId { get; set; }
114.         /// <summary>
115.         /// 创建人ID
116.         /// </summary>
117.         [ModelEnitity(ColumnName = "CreateUserId")]
118.         public string CreateUserId { get; set; }
120.         /// <summary>
121.         /// 创建人
122.         /// </summary>
123.         [ModelEnitity(ColumnName = "CreateUserName")]
124.         public string CreateUserName { get; set; }
126.         /// <summary>
127.         /// 创建部门ID
128.         /// </summary>
129.         [ModelEnitity(ColumnName = "CreateDepartmentId")]
130.         public string CreateDepartmentId { get; set; }
132.         /// <summary>
133.         /// 创建机构ID
134.         /// </summary>
135.         [ModelEnitity(ColumnName = "CreateOrganizationId")]
136.         public string CreateOrganizationId { get; set; }
138.         /// <summary>
139.         /// 创建时间
140.         /// </summary>
141.         [ModelEnitity(ColumnName = "CreateTime")]
142.         public DateTime? CreateTime { get; set; }
144.         /// <summary>
145.         /// 修改人ID
146.         /// </summary>
147.         [ModelEnitity(ColumnName = "ModifyUserId")]
148.         public string ModifyUserId { get; set; }
150.         /// <summary>
151.         /// 修改人
152.         /// </summary>
153.         [ModelEnitity(ColumnName = "ModifyUserName")]
154.         public string ModifyUserName { get; set; }
156.         /// <summary>
157.         /// 修改时间
158.         /// </summary>
159.         [ModelEnitity(ColumnName = "ModifyTime")]
160.         public DateTime? ModifyTime { get; set; }
162.         /// <summary>
163.         /// 备注
164.         /// </summary>
165.         [ModelEnitity(ColumnName = "Remarks", MaxLength = 1000)]
166.         public string Remarks { get; set; }
167.         #endregion
169.         #region **----扩展属性---------------------------**
170.         /// <summary>
171.         /// 校区名称
172.         /// </summary>
173.         public string CampusName { get; set; }
175.         /// <summary>
176.         /// 学校名称
177.         /// </summary>
178.         public string SchoolName { get; set; }
180.         /// <summary>
181.         /// 班级名称
182.         /// </summary>
183.         public string ClassName { get; set; }
185.         /// <summary>
186.         /// 性别@readonly
187.         /// </summary>
188.         public GenderEnum Gender {
189.             get {
190.                 GenderEnum ret = GenderEnum.None;
191.                 if (this.GenderId.HasValue) {
192.                     try { ret = (GenderEnum)this.GenderId; }
193.                     catch { }
194.                 }
195.                 return ret;
196.             }
197.         }
199.         /// <summary>
200.         /// 性别显示@readonly
201.         /// </summary>
202.         public string GenderDisplay {
203.             get {
204.                 return EnumHelp.GetEnumDescription(this.Gender);
205.             }
206.         }
208.         /// <summary>
209.         /// 班级全编码
210.         /// </summary>
211.         public string ClassFullCode { get; set; }
213.         /// <summary>
214.         /// 学校
215.         /// </summary>
216.         public Organization.OrganizationModel School { get; set; } = new Organization.OrganizationModel();
217.         #endregion
219.         #region **----方法-------------------------------**
220.         /// <summary>
221.         /// 创建当前实体对象
222.         /// </summary>
223.         /// <param name="db">数据库接口</param>
224.         public void Create(IDBInstance db = null) {
225.             if (string.IsNullOrWhiteSpace(this.ID))
226.                 this.ID = Guid.NewGuid().ToString();
228.             var loginUser = AuthenticationHelp.GetLoginUser(db);
229.             if (loginUser != null && loginUser.IsLogin) {
230.                 this.CreateUserId = loginUser.UserInfo.ID;
231.                 this.CreateUserName = loginUser.UserInfo.Name;
232.                 this.CreateDepartmentId = loginUser.UserInfo.DepartmentId;
233.                 this.CreateOrganizationId = loginUser.UserInfo.OrganizationId;
234.             }
236.             this.CreateTime = DateTime.Now;
237.             this.ModifyTime = null;
238.             this.ModifyUserId = null;
239.             this.ModifyUserName = null;
240.         }
242.         /// <summary>
243.         /// 修改当前实体对象
244.         /// </summary>
245.         /// <param name="db">数据库接口</param>
246.         public void Modify(IDBInstance db = null) {
247.             this.ModifyTime = DateTime.Now;
249.             var loginUser = AuthenticationHelp.GetLoginUser(db);
250.             if (loginUser != null && loginUser.IsLogin) {
251.                 this.ModifyUserId = loginUser.UserInfo.ID;
252.                 this.ModifyUserName = loginUser.UserInfo.Name;
253.             }
255.             this.ModifyTime = DateTime.Now;
256.             this.CreateDepartmentId = null;
257.             this.CreateOrganizationId = null;
258.             this.CreateTime = null;
259.             this.CreateUserId = null;
260.             this.CreateUserName = null;
261.         }
263.         /// <summary>
264.         /// 修改当前实体对象
265.         /// </summary>
266.         /// <param name="keyValue">主键值</param>
267.         /// <param name="db">数据库接口</param>
268.         public void Modify(string keyValue, IDBInstance db = null) {
269.             this.ID = keyValue;
270.             this.Modify(db);
271.         }
272.         #endregion
273.     }
274. }

复制代码

[ModelEnitity(TableName = "t_school_student", KeyName = "ID")]
TableName：表名
KeyName：主键对应的属性名
[ModelEnitity(ColumnName = "Name", IsRequired = true, MaxLength = 50)]
ColumnName：字段名称
IsRequired：是否必须，用于验证属性值是否必须有值
MaxLength：最大长度，属性值的最大长度
[ModelEnitity(ColumnName = "ContactMobile", Regex = @"^[1]([3-9])[0-9]{9}$")]
Regex：正则表达式，用于验证属性值格式
点击查看代码

1. /// <summary>
2. /// 构造函数
3. /// </summary>
4. public StudentModel() {
5.             this.SetDefaultQuerySQL(@"select *
6.         from (select a.ID
7.                         ,a.Name
8.                         ,a.Number
9.                         ,a.GenderId
10.                         ,a.Age
11.                         ,a.Contact
12.                         ,a.ContactMobile
13.                         ,a.Hobby
14.                         ,a.CampusId
15.                         ,a.ClassId
16.                         ,a.CreateUserId
17.                         ,a.CreateUserName
18.                         ,a.CreateDepartmentId
19.                         ,a.CreateOrganizationId
20.                         ,a.CreateTime
21.                         ,a.ModifyUserId
22.                         ,a.ModifyUserName
23.                         ,a.ModifyTime
24.                         ,a.Remarks
25.                         ,b.Name CampusName
26.                         ,c.Name ClassName
27.                         ,d.Name SchoolName
28.                         ,c.FullCode ClassFullCode
29.                 from t_school_student a
30.                 left join t_sys_organization_unit b on a.CampusId = b.ID
31.                 left join t_sys_organization_unit c on a.ClassId = c.ID
32.                 left join t_sys_organization_unit d on c.FullCode like d.FullCode + '%' and d.Levels = c.Levels - 3) tab");
34.             //引入命名空间 using EDP.Common;
35.             //default:注册表配置中数据库连接配置所对应的"Key"值
36.             //若没有设置连线字串,则取注册表配置中的默认数据库连接
37.             //this.SetConnectionString(Config.Database["default"]); 示例项目使用默认数据库连接,不需要设置
38.         }

复制代码

在构造函数中通过SetDefaultQuerySQL()方法设置默认查询SQL，通过SetConnectionString()方法设置数据库连接字符串（若没设置则取默认数据库连接字串）。public string CampusName { get; set; }
扩展属性是默认查询SQL中所查询的非业务模型映射的表中的字段。
点击查看代码

1. /// <summary>
2. /// 创建当前实体对象
3. /// </summary>
4. /// <param name="db">数据库接口</param>
5. public void Create(IDBInstance db = null) {
6.     if (string.IsNullOrWhiteSpace(this.ID))
7.         this.ID = Guid.NewGuid().ToString();
9.     var loginUser = AuthenticationHelp.GetLoginUser(db);
10.     if (loginUser != null && loginUser.IsLogin) {
11.         this.CreateUserId = loginUser.UserInfo.ID;
12.         this.CreateUserName = loginUser.UserInfo.Name;
13.         this.CreateDepartmentId = loginUser.UserInfo.DepartmentId;
14.         this.CreateOrganizationId = loginUser.UserInfo.OrganizationId;
15.     }
17.     this.CreateTime = DateTime.Now;
18.     this.ModifyTime = null;
19.     this.ModifyUserId = null;
20.     this.ModifyUserName = null;
21. }
23. /// <summary>
24. /// 修改当前实体对象
25. /// </summary>
26. /// <param name="db">数据库接口</param>
27. public void Modify(IDBInstance db = null) {
28.     this.ModifyTime = DateTime.Now;
30.     var loginUser = AuthenticationHelp.GetLoginUser(db);
31.     if (loginUser != null && loginUser.IsLogin) {
32.         this.ModifyUserId = loginUser.UserInfo.ID;
33.         this.ModifyUserName = loginUser.UserInfo.Name;
34.     }
36.     this.ModifyTime = DateTime.Now;
37.     this.CreateDepartmentId = null;
38.     this.CreateOrganizationId = null;
39.     this.CreateTime = null;
40.     this.CreateUserId = null;
41.     this.CreateUserName = null;
42. }
44. /// <summary>
45. /// 修改当前实体对象
46. /// </summary>
47. /// <param name="keyValue">主键值</param>
48. /// <param name="db">数据库接口</param>
49. public void Modify(string keyValue, IDBInstance db = null) {
50.     this.ID = keyValue;
51.     this.Modify(db);
52. }

复制代码

在业务对象上提供Create()和Modify()扩展方法，用于在创建和修改业务时调用，给业务对象必要属性赋值。定义查询对象

查询对象是用来实现业务对象的查询，通过属性来设置查询条件。需要继承QueryModelBase基类。
点击查看代码

1. using System;
3. namespace School.Model
4. {
5.     using EDP.Common;
6.     using EDP.Common.Model;
8.     /// <summary>
9.     /// 学生信息查询对象
10.     /// </summary>
11.     [QueryModel] //标记类的查询对象特性
12.     public class StudentQueryModel : QueryModelBase //继承QueryModelBase
13.     {
14.         /// <summary>
15.         /// 姓名
16.         /// </summary>
17.         [QueryModel(Operator = QueryOperator.like, ColumnName = "Name")]
18.         public string Name { get; set; }
20.         /// <summary>
21.         /// 性别
22.         /// </summary>
23.         [QueryModel(Operator = QueryOperator.eq, ColumnName = "GenderId")]
24.         public int? GenderId { get; set; }
26.         /// <summary>
27.         /// 校区
28.         /// </summary>
29.         [QueryModel(Operator = QueryOperator.eq, ColumnName = "CampusId")]
30.         public string CampusId { get; set; }
32.         /// <summary>
33.         /// 班级
34.         /// </summary>
35.         [QueryModel(Operator = QueryOperator.eq, ColumnName = "ClassId")]
36.         public string ClassId { get; set; }
38.         /// <summary>
39.         /// 班级全编码
40.         /// </summary>
41.         /// <example>ClassFullCode like '值%'</example>
42.         [QueryModel(Operator = QueryOperator.likeRight, ColumnName = "ClassFullCode")]
43.         public string ClassFullCode { get; set; }
45.         /// <summary>
46.         /// 编号姓名关键字
47.         /// Number和Name都进行like查询
48.         /// </summary>
49.         /// <example>Number like '%关键字%' or Name like '%值%'</example>
50.         [QueryModel(Operator = QueryOperator.like, ColumnNameList = "Number;Name")]
51.         public string NumberNameKeywrod { get; set; }
53.         /// <summary>
54.         /// 分页对象
55.         /// </summary>
56.         public PageModel Page { get; set; } = new PageModel();
57.     }
58. }

复制代码

[QueryModel(Operator = QueryOperator.like, ColumnName = "Name")]
Operator：查询操作符（=、>、=、like等）
ColumnName：对应业务对象的属性（实体属性，扩展属性），只要是默认查询SQL中包含的字段都可以作为查询对象的属性（查询条件）
业务模型使用

详见示例项目StudentBLL.cs

• 业务模型属性验证
  var verify = item.Verify(keyValue);
  此处通过Verify()方法验证业务模型各属性值，通过属性验证标记（IsRequired，MaxLength, Regex）进行验证。
  
• 业务模型新增
  

点击查看代码

1. item.Create(db);
2. item.ValidateSQL = string.Format("where not exists (select 1 from t_school_student where Number = '{0}')", item.Number);
3. result = item.InsertModel(db);

复制代码

1. 通过业务模型Create()方法创建当前实体对象。
2. 通过ValidateSQL属性值确保不会有重复的Number值插入到数据库。
3. 调用InsertModel()方法新增业务模型数据。

复制代码

• 修改业务模型
  

点击查看代码

1. item.Modify(keyValue, db);
2. item.Number = null; //编号不能修改
3. result = item.UpdateModel(db);

复制代码

1. 通过业务模型Modify()方法修改当前实体对象。
2. 调用UpdateModel()方法修改业务模型数据。

复制代码

• 业务模型查询
  

点击查看代码

1. ResultModel<StudentModel> ret = new ResultModel<StudentModel>();
2. ret.Content = new StudentModel();
3. ret.KeyValue = keyValue;
4. ret.Content.ID = keyValue;
5. ret.Content.Query(db);

复制代码

1. 使用统一的返回对象 ResultModel<StudentModel>。
2. 实例化ret.Content并设置操作的主键值ret.KeyValue = keyValue。
3. 设置查询的主键值 ret.Content.ID = keyValue。
4. 调用业务对象Query()方法 ret.Content.Query(db)。
5. 执行Query()查询后，根据权限设置给ret.Content赋值。
6. ret.Content.AccessPropertyList中返回有权限的属性名称。

复制代码

• 业务模型列表查询
  

点击查看代码

1. ResultModel<List<StudentModel>> ret = new ResultModel<List<StudentModel>>();
2. ret.Content = new List<StudentModel>();
3. ret.Content.Query(queryModel.Page, queryModel, db);
4. ret.Page = queryModel.Page;

复制代码

1. 使用统一的返回对象 ResultModel<List<StudentModel>>。
2. 实例化 ret.Content = new List<StudentModel>()。
3. 调用业务对象Query()方法 ret.Content.Query(queryModel.Page, queryModel, db)。
4. queryModel为查询对象StudentQueryModel的实例。
5. 执行Query()查询后，根据权限设置给ret.Content赋值（有权限的数据集合）。
6. ret.Content[0].AccessPropertyList中返回有权限的属性名称。

复制代码

• 业务模型删除
  

点击查看代码

1. StudentModel item = new StudentModel();
2. item.Id = keyValue;
3. item.DeleteModel();

复制代码

1. 实例化StudentModel。
2. 设置主键值 item.Id = keyValue。
3. 调用业务对象DeleteModel()方法 item.DeleteModel()。

复制代码

来源:https://www.cnblogs.com/alwaysinsist/p/18190582
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！