Entity Factory - 摆脱 ORM 的束缚！

• 下载 EntityFactory_20211104.zip

引言

应用程序

特点

基本向导布局

介绍页面

设置页面

选择数据库页面

发现数据库组件

---

---

为选定组件生成代码

---

---

---

为所有组件生成代码

---

---

检查项和代码

为查询生成代码（新功能，2021.01.01）

生成的代码示例

以下是应用程序生成的模型和视图模型代码的示例。在以下示例中，注释、区域和 CRUD 属性均已打开。此外，数据注释和虚拟化属性也已打开。

模型

//==================================================================================================
// Source object: AEF2.dbo.Alerts (table)
// File generated: 2020.12.09, 07:32:10

// This file was generated by EntityFactory. Do not modify this file. When regenerated, the file    
// may be overwritten if it already exists and EntityFactory was configured to overwrite existing   
// files). Note that the generated class is "partial", so if you need to augment the generated    
// code, create a new partial extension file and put your custom code in that new file.             

// The class name indicates the model (or viewmodel) class name prefix followed by the name of the  
// original database object from which the class was generated.                                     
//==================================================================================================

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

// Auto-incrementing column detected - add the following using to support standard C# attributes.
// If you haven't already, add a reference to System.ComponbentModel.DataAnnotations to the 
// applicable assembly in your application.
using System.ComponentModel.DataAnnotations;

namespace Models
{
	public partial class EntityAlerts
	{
		#region entity properties

		[Key]
		public virtual int      ID               { get; set; }
		[StringLength(32)]
		public virtual string   AlertName        { get; set; }
		[StringLength(128)]
		public virtual string   AlertTitle       { get; set; }
		[StringLength(2147483647)]
		public virtual string   AlertMsg         { get; set; }
		public virtual DateTime AlertStartDate   { get; set; }
		public virtual DateTime AlertExpireDate  { get; set; }
		public virtual int      AlertType        { get; set; }
		public virtual int      AlertClassLevel  { get; set; }
		[StringLength(512)]
		public virtual string   AlertApps        { get; set; }
		[StringLength(64)]
		public virtual string   ActionName       { get; set; }
		[StringLength(64)]
		public virtual string   ControllerName   { get; set; }
		public virtual DateTime DateAdded        { get; set; }
		public virtual int      AddedByUMSUserID { get; set; }

		#endregion entity properties

		public SqlParameter[] SqlParameters
		{
			get
			{
				return new SqlParameter[]
				{
					new SqlParameter("@ID"              , ID              ),
					new SqlParameter("@AlertName"       , AlertName       ),
					new SqlParameter("@AlertTitle"      , AlertTitle      ),
					new SqlParameter("@AlertMsg"        , AlertMsg        ),
					new SqlParameter("@AlertStartDate"  , AlertStartDate  ),
					new SqlParameter("@AlertExpireDate" , AlertExpireDate ),
					new SqlParameter("@AlertType"       , AlertType       ),
					new SqlParameter("@AlertClassLevel" , AlertClassLevel ),
					new SqlParameter("@AlertApps"       , AlertApps       ),
					new SqlParameter("@ActionName"      , ActionName      ),
					new SqlParameter("@ControllerName"  , ControllerName  ),
					new SqlParameter("@DateAdded"       , DateAdded       ),
					new SqlParameter("@AddedByUMSUserID", AddedByUMSUserID),
				};
			}
		}

		#region database properties

		public virtual string CRUDGet
		{
			get
			{
				return "SELECT [ID], [AlertName], [AlertTitle], [AlertMsg], [AlertStartDate],"
						+" [AlertExpireDate], [AlertType], [AlertClassLevel], [AlertApps], [ActionName],"
						+" [ControllerName], [DateAdded], [AddedByUMSUserID] FROM [dbo].[Alerts]"
						+" WITH(NOLOCK);";
			}
		}

		public virtual string CRUDUpsert
		{
			get
			{
				return "UPDATE [dbo].[Alerts] SET [AlertName] = @AlertName , [AlertTitle] ="
						+" @AlertTitle , [AlertMsg] = @AlertMsg , [AlertStartDate] = @AlertStartDate ,"
						+" [AlertExpireDate] = @AlertExpireDate , [AlertType] = @AlertType ,"
						+" [AlertClassLevel] = @AlertClassLevel , [AlertApps] = @AlertApps , [ActionName]"
						+" = @ActionName , [ControllerName] = @ControllerName , [DateAdded] = @DateAdded"
						+" , [AddedByUMSUserID] = @AddedByUMSUserID WHERE [ID] = @ID;"
						+" IF @@ROWCOUNT = 0"
						+" INSERT INTO [dbo].[Alerts] ( [AlertName] , [AlertTitle] , [AlertMsg] ,"
						+" [AlertStartDate] , [AlertExpireDate] , [AlertType] , [AlertClassLevel] ,"
						+" [AlertApps] , [ActionName] , [ControllerName] , [DateAdded] ,"
						+" [AddedByUMSUserID]) VALUES ( @AlertName , @AlertTitle , @AlertMsg ,"
						+" @AlertStartDate , @AlertExpireDate , @AlertType , @AlertClassLevel ,"
						+" @AlertApps , @ActionName , @ControllerName , @DateAdded , @AddedByUMSUserID);";
			}
		}

		public virtual string CRUDDelete
		{
			get
			{
				return "DELETE FROM [dbo].[Alerts] WHERE [ID] = @ID;";
			}
		}


		#endregion database properties

	} // end class

} // end namespace

视图模型

//==================================================================================================
// Source object: AEF2.dbo.Alerts (table)
// File generated: 2020.12.09, 07:39:31

// This file was generated by EntityFactory. Do not modify this file. When regenerated, the file    
// may be overwritten if it already exists and EntityFactory was configured to overwrite existing   
// files). Note that the generated class is "partial", so if you need to augment the generated    
// code, create a new partial extension file and put your custom code in that new file.             

// The class name indicates the model (or viewmodel) class name prefix followed by the name of the  
// original database object from which the class was generated.                                     
//==================================================================================================

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

// The following using was added to support the INotifyPropertyChanged and/or IDataErrorInfo interfaces.
using System.ComponentModel;

// The following using was specified in the Model Namespace setting.
using Models;

// The following usings were specified in the Inerited Namespaces setting.
using WpfCommon;

//----------- Generated from database object dbo.Alerts --------------//

namespace ViewModels
{

	public partial class VMEntityAlerts : INotifyPropertyChanged, IDataErrorInfo
	{
		#region INotifyPropertyChanged implementation

		/// <summary>
		/// Occurs when a property value changes.
		/// </summary>
		public event PropertyChangedEventHandler PropertyChanged;
		
		/// <summary>
		/// Notifies that the property changed, and sets IsModified to true.
		/// </summary>
		/// <param name="propertyName">Name of the property.</param>
		protected void NotifyPropertyChanged([CallerMemberName] String propertyName = "")
		{
			if (this.PropertyChanged != null)
			{
				this.PropertyChanged(this, new PropertyChangedEventArgs(propertyName));
				if (propertyName != "IsModified")
				{
					this.IsModified = true;
				}
			}
		}
		

		#endregion INotifyPropertyChanged implementation

		#region fields

		private int      vm_ID;
		private string   vm_AlertName;
		private string   vm_AlertTitle;
		private string   vm_AlertMsg;
		private DateTime vm_AlertStartDate;
		private DateTime vm_AlertExpireDate;
		private int      vm_AlertType;
		private int      vm_AlertClassLevel;
		private string   vm_AlertApps;
		private string   vm_ActionName;
		private string   vm_ControllerName;
		private DateTime vm_DateAdded;
		private int      vm_AddedByUMSUserID;

		#endregion fields

		#region properties

		/// <summary>
		/// Model (generated from database source object)
		/// </summary>
		protected EntityAlerts Model { get; set; }

		/// <summary>
		/// Get/set ID
		/// </summary>
		public virtual int ID
		{
			get { return this.vm_ID; }
			set
			{
				if (value != this.vm_ID)
				{
					this.vm_ID = value;
					this.NotifyPropertyChanged();
				}
			}
		}

		/// <summary>
		/// Get/set AlertName
		/// </summary>
		[StringLength(32)]
		public virtual string AlertName
		{
			get { return this.vm_AlertName; }
			set
			{
				if (value != this.vm_AlertName)
				{
					this.vm_AlertName = value;
					this.NotifyPropertyChanged();
				}
			}
		}

		/// <summary>
		/// Get/set AlertTitle
		/// </summary>
		[StringLength(128)]
		public virtual string AlertTitle
		{
			get { return this.vm_AlertTitle; }
			set
			{
				if (value != this.vm_AlertTitle)
				{
					this.vm_AlertTitle = value;
					this.NotifyPropertyChanged();
				}
			}
		}

		/// <summary>
		/// Get/set AlertMsg
		/// </summary>
		[StringLength(2147483647)]
		public virtual string AlertMsg
		{
			get { return this.vm_AlertMsg; }
			set
			{
				if (value != this.vm_AlertMsg)
				{
					this.vm_AlertMsg = value;
					this.NotifyPropertyChanged();
				}
			}
		}

		/// <summary>
		/// Get/set AlertStartDate
		/// </summary>
		public virtual DateTime AlertStartDate
		{
			get { return this.vm_AlertStartDate; }
			set
			{
				if (value != this.vm_AlertStartDate)
				{
					this.vm_AlertStartDate = value;
					this.NotifyPropertyChanged();
				}
			}
		}

		/// <summary>
		/// Get/set AlertExpireDate
		/// </summary>
		public virtual DateTime AlertExpireDate
		{
			get { return this.vm_AlertExpireDate; }
			set
			{
				if (value != this.vm_AlertExpireDate)
				{
					this.vm_AlertExpireDate = value;
					this.NotifyPropertyChanged();
				}
			}
		}

		/// <summary>
		/// Get/set AlertType
		/// </summary>
		public virtual int AlertType
		{
			get { return this.vm_AlertType; }
			set
			{
				if (value != this.vm_AlertType)
				{
					this.vm_AlertType = value;
					this.NotifyPropertyChanged();
				}
			}
		}

		/// <summary>
		/// Get/set AlertClassLevel
		/// </summary>
		public virtual int AlertClassLevel
		{
			get { return this.vm_AlertClassLevel; }
			set
			{
				if (value != this.vm_AlertClassLevel)
				{
					this.vm_AlertClassLevel = value;
					this.NotifyPropertyChanged();
				}
			}
		}

		/// <summary>
		/// Get/set AlertApps
		/// </summary>
		[StringLength(512)]
		public virtual string AlertApps
		{
			get { return this.vm_AlertApps; }
			set
			{
				if (value != this.vm_AlertApps)
				{
					this.vm_AlertApps = value;
					this.NotifyPropertyChanged();
				}
			}
		}

		/// <summary>
		/// Get/set ActionName
		/// </summary>
		[StringLength(64)]
		public virtual string ActionName
		{
			get { return this.vm_ActionName; }
			set
			{
				if (value != this.vm_ActionName)
				{
					this.vm_ActionName = value;
					this.NotifyPropertyChanged();
				}
			}
		}

		/// <summary>
		/// Get/set ControllerName
		/// </summary>
		[StringLength(64)]
		public virtual string ControllerName
		{
			get { return this.vm_ControllerName; }
			set
			{
				if (value != this.vm_ControllerName)
				{
					this.vm_ControllerName = value;
					this.NotifyPropertyChanged();
				}
			}
		}

		/// <summary>
		/// Get/set DateAdded
		/// </summary>
		public virtual DateTime DateAdded
		{
			get { return this.vm_DateAdded; }
			set
			{
				if (value != this.vm_DateAdded)
				{
					this.vm_DateAdded = value;
					this.NotifyPropertyChanged();
				}
			}
		}

		/// <summary>
		/// Get/set AddedByUMSUserID
		/// </summary>
		public virtual int AddedByUMSUserID
		{
			get { return this.vm_AddedByUMSUserID; }
			set
			{
				if (value != this.vm_AddedByUMSUserID)
				{
					this.vm_AddedByUMSUserID = value;
					this.NotifyPropertyChanged();
				}
			}
		}


		#endregion properties

		#region constructors

		/// <summary>
		/// Default constructor
		/// </summary>
		public VMEntityAlerts()
		{
		}

		/// <summary>
		/// Default constructor
		/// </summary>
		/// <summary>
		/// Default constructor
		/// </summary>
		public VMEntityAlerts(EntityAlerts model)
		{
			this.Model = model;
		}

		#endregion constructors

	} // end class

} // end namespace

代码，就这样吧

最初，我打算将其作为一篇分为两部分的文章，但说实话，谁想阅读关于普通桌面应用程序中可以找到的代码的细节？毕竟，它就在那里，橙色和白色，以链接的形式呈现。但是，我将继续谈论技术栈，以便您决定是否要自己查看源代码。

就 .Net、WPF 和 ADO 的实现而言，这不一定是一个复杂的应用程序，但我确实希望您对这些有一定程度的经验。请注意，本文**不会**努力教授基本概念。它仅描述所使用的技术，并要求您在需要进一步帮助理解这些技术时自学。（如果我试图为初学者详细解释一切，这可能最终会成为一篇 20 部分的文章系列，而我根本不感兴趣。）

我认为代码已经相当注释了，但可能存在覆盖遗漏，因为文件很多，我可能遗漏了一些（或很多）。

就代码质量而言，我承认组织可能可以更好，或者实现方式不同，并且我没有特别努力地遵循“最佳实践”。再说一遍，大部分代码是我对这个程序应该包含什么的即时反应，而且我的技术在编写代码的过程中有了很大的发展。再加上源代码丢失的灾难，实现可能从一天到另一天发生巨大变化。

技术栈

• **Visual Studio 2017** - 当我开始这个项目的代码时，VS2017 是当时可用的最新发行版。VS2019 很快作为发布候选版本推出，但我们都知道不要将代码库提交给微软的新软件。目前，VS2019 是最新最好的（实际上已经正式发布），如果您想将此应用程序转换为 .Net Core，您应该使用 VS2019 并直接迁移到 .Net 5.0。
   
• **.Net Framework 4.72** - 我不是 .Net Core 的粉丝，而且在我开始编写代码时，WPF 支持很糟糕。据我所知，WPF 支持在 .Net 5 下已经稳定，但我在这方面没有经验。还没有。
   
• **ADO.Net** - 我使用 ADO 是因为我喜欢它，而且我理解它。我有很多代码围绕它编写，我不想放弃它来换取僵化的通用便利代码。对 ORM 说不
   
• **Windows Presentation Foundation (WPF)** - 当 WPF 于 2009 年发布时，我曾抵制在其自己的代码中采用它，但现在，在 2020 年，结合 MVVM 的采用，如果您需要一个有吸引力且健壮的 UI，我无法想象其他桌面开发解决方案。
   
• **Model View Viewmodel (MVVM) 模式** - 虽然在应用程序中实现起来更繁琐，但它肯定能强制关注点分离。这是一个好主意。
   
• **单例模式** - 单例是实例化对象，它们在整个应用程序中静态可用。它们被称为单例，因为它们在应用程序会话的生命周期中只实例化一次。为了方便访问，我在需要访问这些单例对象的任何对象中定义了属性。这允许我如下引用它们

  if (this.AppSettings.SomeProperty == someValue){}

• **反射** - 反射用于检查和操作应用程序中定义的对象的属性。通过反射，您可以确定属性名称、类型、可访问性，甚至可以在运行时将功能注入对象（此应用程序不进行任何注入）。这项技术在代码中得到了广泛的应用。要看到它的实际效果，请在解决方案中查找 `PropertyInfo` 的实例。
   
• ADO.Net 通用 DAL - 重访  [ ^ ] - 本文讨论了我的通用 DAL 对象以及如何使用它。
   
• WPF 向导的另一种方法  [ ^ ] - 本文介绍了用于创建本文中向导的代码。
   
• 可自定义的 WPF MessageBox  [ ^ ] - 本文介绍了一个可自定义的标准 WPF `MessageBox` 版本。
   

代码组织

代码被组织成包含模型对象、视图模型对象、窗口和向导页面的文件夹。根项目文件夹中实际存在的文件很少，所以一切都相当整洁。

WPF

我坚信，仅仅因为你能做某事，并不意味着你必须，甚至不应该。XAML 中有很多事情可以做，但在我看来，在取证模式下，它只会让事情更难弄清楚，因为你无法在 XAML 代码块中停止调试器。出于这个原因，我喜欢在 C# 代码中做很多事情。

所有窗口都派生自基类 `NotifiableWindow`（位于 WPFCommon 程序集中）。这是一个继承了 `INotifyPropertyChanged` 接口的 Window 类，这使得实现窗口可以用来更新 UI 的属性变得容易。我在 WPF 应用程序中经常这样做。当您从 WPF 中的基类继承时，您必须更改 XAML 以适应它。

<wpfctrl:WizardWindowBase x:Class="EntityFactory.MainWindow"
    xmlns...
    xmlns:wpfctrl="clr-namespace:WpfCommon.Controls;assembly=WpfCommon"

您必须添加一个 xml 命名空间 (xmlns) 条目，声明程序集（在您的应用程序中引用），并更改主标签以反映自定义基类（由您分配的 xml 命名空间限定）。

其他 WPF 技术包括自定义模板、静态和动态资源的用法、转换器，以及将一个元素中的绑定属性与另一个（命名）元素中的属性进行绑定。例如，我经常将按钮的 `Width` 绑定到将最宽的按钮（基于按钮 `Content` 中的文本）的 `ActualWidth`。这种技术可以在 `WizPgTablesViews` 类中看到。

生成实体的过程

这是应用程序存在的理由——从表、视图、存储过程或用户查询返回的数据集中生成代码。在生成任何代码之前，我们必须知道将从数据库中检索什么数据。这样做的机制是 ADO `DAL`（有关此工作原理的更多信息，请参阅上面引用的 DAL 文章），并且通过项目数据库文件夹中的 `BLL` 对象来处理。

第一步是发现数据库中包含的数据库组件。对于表和视图，发现过程就到此结束，但存储过程需要更多工作。首先，我们必须发现为给定存储过程可能指定的任何参数。接下来，我们必须确定存储过程是否实际返回数据集。

本质上，我们查询数据库以创建/返回表示返回数据集的 `DataTable`。对于表和视图，使用简单的 `SELECT TOP(0)* FROM [table/view]` 查询从表或视图中检索数据。存储过程需要更精细的方法。

存储过程可以在数据库中执行许多操作。如果某个存储过程有可能以任何方式修改表（使用 `DROP`、`DELETE`、`INSERT`、`UPDATE`、`MERGE` 或 `TRUNCATE`），它将被标记为不返回数据。这是为了保护数据库中的数据免受错误数据或完全删除数据的侵害。如果发现的存储过程被确定为返回数据，则实际上会执行它以创建必要的 `DataTable`，然后可以对其进行解析。

一旦我们有了 `DataTable`，应用程序就可以使用该 `DataTable` 来确定列名、数据类型以及关于该列的其他数据。它使用这些信息来创建生成代码中的属性定义。

为了完全披露，对表和视图的支持是事后考虑，因为在我工作的地方（以及在我自己的数据库访问方法中），我们只使用存储过程来检索数据，因为我们的选择标准非常细微且针对特定需求。我们没有直接查询表或视图的代码。为 CodeProject 写文章的决定促使我重新考虑了整个应用程序的设计，您今天看到的许多功能都是这一设计方向改变的直接结果。不客气。

**更新 2021.01.02** - 为了更全面地披露，对用户查询的支持是事后考虑的。我想有些人可能只是想为特定结果手工编写查询。再说一遍，不客气。

关注点

再次重申，此应用程序旨在供不使用 ORM 框架的程序员使用。但是，这并不排除它用于增强此类系统。我想不到任何会从中受益的用例，但我只是一个拥有非常狭窄（且有偏见）世界观的人。谁知道呢？这个应用程序甚至可能促使更多的程序员使用 ORM。我猜更奇怪的事情都发生过。

如果您看到我做的某件事有问题，请在评论区告诉我。我会尽快以某种方式解决它。请注意，我一定会注意到拼写错误，并会在文章发布后快速更新。

更新 2021.01.02

我曾考虑将 AvalonEdit 添加到应用程序中以提供语法高亮显示，但这增加了太多的工作量，我断定得不偿失。如果您想尝试这项任务，请随意。注意 - 如果您不打算将代码转换为 .Net Core，您将仅限于使用 6.0 之前的某个版本的控件。

我花了一周时间试图让 `IDataErrorInfo` 在新的用户查询向导页面上生效，但我的向导页面代码中存在一些隐藏（且非常奇怪）的交互，导致它无法可靠工作，而且我不想去追踪它，所以我绕过了问题并取得了一些合理的效果。如果您有兴趣，代码在 WizPgQuery.* 中。

历史