Ентити Фрамеворк 8 – Трикови за делимичне класе које треба да знате

Овај чланак демонстрира неколико техника за коришћење делимичних Ц# класа за решавање уобичајених проблема у ЕФ 8/АСП.НЕТ8.

Апстракт: У приступу ЕФ 8 – Датабасе Фирст генерисане ЕФ класе не могу се директно проширити додатном функционалношћу јер се преписују када се модел регенерише. Да бисмо ово превазишли, можемо искористити делимичне Ц# класе. Овај чланак представља корисне трикове за проширење функционалности у ЕФ/АСП.НЕТ окружењу.

1 Ентити Фрамеворк Цоре – први приступ бази података

У мом Ц#/АСП.НЕТ 8 МВЦ пројекту, користим приступ Ентити Фрамеворк Цоре Датабасе Фирст . Ово је неопходно јер се неколико апликација у различитим технологијама ослања на исту СКЛ Сервер базу података. За генерисање модела из базе података користим ЕФЦореПоверТоолс.

Проблем настаје када генерисани ЕФ модел треба да се ажурира да би одражавао промене у шеми базе података. Пошто ће генерисане ЕФ класе ентитета бити преписане, све модификације које су направљене на њима се губе. Ово је проблем јер, с времена на време, морамо да проширимо ЕФ ентитете за употребу у оквиру апликације.

Да бих решио овај проблем, ослањам се на трикове који укључују делимичне Ц# класе , што ће бити објашњено у наставку.

2 Типична ситуација у апликацији Ц#/ЕФ/АСП.НЕТ

У типичној Ц#/ЕФ/АСП.НЕТ 8 МВЦ апликацији, ситуација може изгледати као следећи код:

 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //this is typical class generated by EF Core Power Tools //in EF-Database-First approach // <auto-generated> This file has been auto generated by EF Core Power Tools. </auto-generated> [PrimaryKey("Id")] public partial class Customer { //Customer-partial-class-1 [Key] [StringLength(15)] public string? Id { get; set; } [StringLength(15)] public string? NAME { get; set; } public short? Language { get; set; } } //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //this is typical model calls for ASP.NET MVC public class CustomerEdit_ViewModel { //model public string? Id { get; set; } = null; //view model // this is our Customer Entity from EF Core public Customer? Customer1 { get; set; } = null; //this is flag for submit button public bool IsSubmit { get; set; } = false; } //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //this is typical controller for ASP.NET MVC public class CustomersController : Controller { // some Controller code here public async Task<ActionResult> CustomerEdit(CustomerEdit_ViewModel model) { if (model.IsSubmit) { // Model validation is done during model binding // we have to check if model is valid if (ModelState.IsValid) { if (model.Customer1 != null) { //we update existing customer in database //redirect to the list of customers } } else { // we go for presentation of validation errors ModelState.AddModelError("", "PleaseCorrectAllErrors"); } } else { ModelState.Clear(); //go for presentation of original data if (model.Id != null) { //get Customer by Id from database } } return View("CustomerEdit", model); } }

Овде, Цустомер-партиал-цласс-1 је класа коју генерише ЕФ (преко обрнутог инжењеринга из базе података). Укључује неке атрибуте валидације који одговарају ограничењима базе података. Ова класа се обично користи у класи модела (нпр. ЦустомерЕдит_ВиевМодел ), где се атрибути валидације обрађују током акције или методе (нпр. ЦустомерЕдит ).

3 Трик 1 – Користите делимичне класе да додате прилагођена својства

Ако треба да додамо својства у генерисану класу, не можемо директно да изменимо Цустомер-партиал-цласс-1 , јер би то довело до тога да промене буду замењене. Уместо тога, можемо да креирамо Цустомер-партиал-цласс-2 и тамо додамо наша прилагођена својства. Да бисмо спречили ЕФ да укључи ова својства у модел, морамо користити атрибут [НотМаппед] .

Ево примера:

 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //this is typical class generated by EF Core Power Tools //in EF-Database-First approach // <auto-generated> This file has been auto generated by EF Core Power Tools. </auto-generated> [PrimaryKey("Id")] public partial class Customer { //Customer-partial-class-1 [Key] [StringLength(15)] public string? Id { get; set; } [StringLength(15)] public string? NAME { get; set; } public short? Language { get; set; } } //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //this is our partial class that extends our generated class //and is not overwritten by EF Core Power Tools //we use it to add some additional properties public partial class Customer { //Customer-partial-class-2 [NotMapped] public int NumberOfCreditCards { get; set; } = 0; [NotMapped] public string? LanguageString { get { string? result = "Unknown"; if (Language == 1) { result = "English"; } else if (Language == 2) { result = "German"; } return result; } } } //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //this is typical model calls for ASP.NET MVC public class CustomerEdit_ViewModel { //model public string? Id { get; set; } = null; //view model // this is our Customer Entity from EF Core public Customer? Customer1 { get; set; } = null; //this is flag for submit button public bool IsSubmit { get; set; } = false; } //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //this is typical controller for ASP.NET MVC public class CustomersController : Controller { // some Controller code here //............. //this is typical action for editing customer public async Task<ActionResult> CustomerEdit(CustomerEdit_ViewModel model) { if (model.IsSubmit) { // Model validation is done during model binding // we have to check if model is valid if (ModelState.IsValid) { if (model.Customer1 != null) { //we update existing customer in database //redirect to the list of customers } } else { // we go for presentation of validation errors ModelState.AddModelError("", "PleaseCorrectAllErrors"); } } else { ModelState.Clear(); //go for presentation of original data if (model.Id != null) { //get Customer by Id from database } } return View("CustomerEdit", model); } }

Код, са детаљним коментарима, треба да буде разумљив сам по себи.

4 Трик 2 – Користите делимичне класе за додавање прилагођених атрибута за проверу

Понекад аутоматски генерисани атрибути валидације у ЕФ-у нису довољни и морамо да додамо прилагођена правила провере. Опет, парцијална настава долази у помоћ. Испод је пример:

 //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //this is typical class generated by EF Core Power Tools //in EF-Database-First approach // <auto-generated> This file has been auto generated by EF Core Power Tools. </auto-generated> [PrimaryKey("Id")] public partial class Customer { //Customer-partial-class-1 [Key] [StringLength(15)] public string? Id { get; set; } [StringLength(15)] public string? NAME { get; set; } public short? Language { get; set; } } //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //this is our partial class that extends our generated class //and is not overwritten by EF Core Power Tools //we use it to add some additional properties //and do some additional validation [MetadataType(typeof(Customer_MetaData))] public partial class Customer { //Customer-partial-class-2 public Customer() { TypeDescriptor.AddProviderTransparent( new AssociatedMetadataTypeTypeDescriptionProvider( typeof(Customer), typeof(Customer_MetaData)), typeof(Customer)); } [NotMapped] public int NumberOfCreditCards { get; set; } = 0; [NotMapped] public string? LanguageString { get { string? result = "Unknown"; if (Language == 1) { result = "English"; } else if (Language == 2) { result = "German"; } return result; } } } //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //this is our metadata class for our partial class //purpose of this class is to add validation attributes to our partial class //in addition to those that are already in generated class public class Customer_MetaData { //main trick here is that we are adding more validation attributes //in addition to those in generated class [Required] [MinLength(5)] public string? Id { get; set; } = string.Empty; //main trick here is that we are adding more validation attributes //in addition to those in generated class [Required] [MinLength(3)] public string? NAME { get; set; } = string.Empty; } //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //this is typical model calls for ASP.NET MVC public class CustomerEdit_ViewModel { //model public string? Id { get; set; } = null; //view model // this is our Customer Entity from EF Core public Customer? Customer1 { get; set; } = null; //this is flag for submit button public bool IsSubmit { get; set; } = false; } //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //this is utility class for validation public class ValidationUtil { /// <summary> /// Validates the specified model object against custom validation rules. /// </summary> /// <param name="model">The model object to validate.</param> /// <param name="modelState">The ModelStateDictionary to store validation errors.</param> /// <param name="logger">The logger to log errors.</param> /// <param name="prefix">An optional prefix for error keys in the ModelStateDictionary.</param> /// <returns>True if validation is successful; otherwise, false.</returns> /// <exception cref="ArgumentNullException">Thrown when the model is null.</exception> public static bool ValidateModelForCustomRules( object model, ModelStateDictionary modelState, ILogger? logger, string? prefix = null) { bool validationSuccessful = false; try { if (model == null) { throw new ArgumentNullException(nameof(model)); } else { var validationContext = new ValidationContext(model); var validationResults = new List<ValidationResult>(); Validator.TryValidateObject(model, validationContext, validationResults, true); foreach (var result in validationResults) { foreach (var memberName in result.MemberNames) { string key = string.IsNullOrEmpty(prefix) ? memberName : $"{prefix}.{memberName}"; modelState.AddModelError(key, result.ErrorMessage ?? "Error"); } } //Go recursively into depth for all properties of the model object that are objects themselves //we must go manually recursively into depth because API Validator.TryValidateObject does validation //only for class properties on first level foreach (var property in model.GetType().GetProperties()) { if (property.PropertyType.IsClass && property.PropertyType != typeof(string)) { var propertyValue = property.GetValue(model); if (propertyValue != null) { validationSuccessful &= ValidateModelForCustomRules(propertyValue, modelState, logger, property.Name); } } } } } catch (Exception ex) { string methodName = $"Type: {System.Reflection.MethodBase.GetCurrentMethod()?.DeclaringType?.FullName}, " + $"Method: ValidateModel; "; logger?.LogError(ex, methodName); validationSuccessful = false; } return validationSuccessful; } } //+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //this is typical controller for ASP.NET MVC public class CustomersController : Controller { // some Controller code here //............. //this is typical action for editing customer public async Task<ActionResult> CustomerEdit(CustomerEdit_ViewModel model) { if (model.IsSubmit) { // Model validation is done during model binding but we need more //validating for custom validation rules ValidationUtil.ValidateModelForCustomRules(model, ModelState, null); // we have to check if model is valid if (ModelState.IsValid) { if (model.Customer1 != null) { //we update existing customer in database //redirect to the list of customers } } else { // we go for presentation of validation errors ModelState.AddModelError("", "PleaseCorrectAllErrors"); } } else { ModelState.Clear(); //go for presentation of original data if (model.Id != null) { //get Customer by Id from database } } return View("CustomerEdit", model); } }

Као што видите, изменили смо Цустомер-партиал-цласс-2 и додали класу Цустомер_МетаДата . Сврха је да се дода додатна валидација за својство НАМЕ, која захтева најмање 3 знака.

У АСП.НЕТ МВЦ, можемо да користимо МоделСтате за проверу и преузимање порука о грешци. Имајте на уму да смо такође морали да користимо услужни метод ВалидатионУтил.ВалидатеМоделФорЦустомРулес да бисмо ручно покренули прилагођену валидацију.

Код и коментари треба да пруже све потребне детаље за разумевање ове технике.

5 Закључак

У мојој Ц#/ЕФ/АСП.НЕТ 8 МВЦ апликацији, користим горње технике са делимичним Ц# класама да бих проширио функционалност класа које је генерисао ЕФ. Ови трикови поједностављују уобичајене сценарије, чинећи код концизнијим и лакшим за одржавање.