Úprava existující entity (jak přidat novou vlastnost)
Tento návod popisuje, jak přidat vlastnost do entity „Category“, která je součástí zdrojového kódu nopCommerce.
Datový model
Entity mají dvě třídy, které se používají k mapování záznamů na tabulku. První třída definuje vlastnosti, pole a metody, které využívá webová aplikace.
File System Location: [Project Root]\Libraries\Nop.Core\Domain\Catalog\Category.cs
Assembly: Nop.Core
Solution Location: Nop.Core.Domain.Catalog.Category.cs
Druhá třída slouží k mapování vlastností definovaných ve výše uvedené třídě na příslušné sloupce SQL. Mapovací třída je také zodpovědná za mapování vztahů mezi různými tabulkami SQL.
File System Location: [Project Root]\Libraries\Nop.Data\Mapping\Builders\Catalog\CategoryBuilder.cs
Assembly: Nop.Data
Solution Location: Nop.Data.Mapping.Builders.Catalog.CategoryBuilder.cs
Doporučujeme ji však používat pouze pro vaše vlastní třídy entit. V našem případě místo mapovací třídy použijeme mechanismus migrací.
Do třídy Category přidejte následující vlastnost.
public string SomeNewProperty { get; set; }
Přidejte novou třídu Nop.Data.Migrations.AddSomeNewProperty s následujícím kódem:
using FluentMigrator;
using Nop.Core.Domain.Catalog;
namespace Nop.Data.Migrations
[NopSchemaMigration("2024-04-20 00:00:00", "Category. Add some new property")]
public class AddSomeNewProperty: ForwardOnlyMigration
{
/// <summary>
/// Collect the UP migration expressions
/// </summary>
public override void Up()
{
var categoryTableName = nameof(Category);
if (!Schema.Table(categoryTableName).Column(nameof(Category.SomeNewProperty)).Exists())
Alter.Table(categoryTableName)
.AddColumn(nameof(Category.SomeNewProperty)).AsInt32().AsString(255).Nullable();
}
}
Poznámka
Procedura aktualizace migrací se provádí během inicializace databáze.
public virtual void InitializeDatabase()
{
var migrationManager = EngineContext.CurrenResolve<IMigrationManager>();
migrationManager.ApplyUpMigrations(typeof(NopDbStartup).Assembly);
}
Prezentační model
Prezentační model slouží k přenosu informací z controlleru do view (více na asp.net/mvc). Modely mají ještě jeden účel: definování požadavků.
Databázi jsme nakonfigurovali tak, aby pro SomeNewProperty ukládala pouze 255 znaků. Pokud se pokusíme uložit SomeNewProperty s 300 znaky, aplikace selže (nebo text zkrátí). Chceme, aby aplikace co nejlépe chránila uživatele před chybami, a naše view modely pomáhají vynucovat požadavky, jako je délka řetězce.
File System Location: [Project Root]\Presentation\Nop.Web\Areas\Admin\Models\Catalog\CategoryModel.cs
Assembly: Nop.Admin
Solution Location: Nop.Web.Areas.Admin.Models.Catalog.CategoryModel.cs
Třída validátoru slouží k ověřování dat uložených ve třídě modelu (např. povinná pole, maximální délka a povolené rozsahy).
File System Location: [Project Root]\Presentation\Nop.Web\Areas\Admin\Validators\Catalog\CategoryValidator.cs
Assembly: Nop.Web
Solution Location: Nop.Web.Areas.Admin.Validators.Catalog.CategoryValidator.cs
Přidejte vlastnost do našeho view modelu.
// The NopResourceDisplayName provides the "key" used during localization
[NopResourceDisplayName("Admin.Catalog.Categories.Fields.SomeNewProperty")]
public string SomeNewProperty { get; set; }
Kód požadavků se přidá do konstruktoru validátoru.
//I think this code can speak for itself
RuleFor(m => m.SomeNewProperty).Length(0, 255);
View
File System Location: [Project Root]\Presentation\Nop.Web\Areas\Admin\Views\Category\_CreateOrUpdate.Info.cshtml
Assembly: Nop.Web
View obsahují HTML pro zobrazení dat modelu. Umístěte toto HTML pod sekci „PictureId“.
<div class="form-group">
<div class="col-md-3">
<nop-label asp-for="SomeNewProperty" />
</div>
<div class="col-md-9">
<nop-editor asp-for="SomeNewProperty" />
<span asp-validation-for="SomeNewProperty"></span>
</div>
</div>
Controller
V tomto případě je controller zodpovědný za mapování doménového datového modelu na náš view model a naopak. Model kategorie jsme pro úpravu zvolili kvůli jeho jednoduchosti.
File System Location: [Project Root]\Presentation\Nop.Web\Areas\Admin\Controllers\CategoryController.cs
Assembly: Nop.Admin
Solution Location: Nop.Web.Areas.Admin.Controllers.CategoryController.cs
Ve třídě CategoryController provedeme tři úpravy.
- Datový model → View model
- Create: View model → Datový model
- Edit: View model → Datový model
Normálně bychom pro následující kód napsali testy a ověřili, že mapování modelu funguje správně, ale pro zjednodušení teď jednotkové testování vynecháme.
Do příslušných metod („Create“, „Edit“ nebo „PrepareSomeModel“) přidejte kód pro nastavení této vlastnosti. Ve většině případů to není nutné, protože to automaticky zajišťuje Mapster v metodě .ToModel().
Ve veřejné metodě pro uložení entity (obvykle metody „Create“ nebo „Edit“ s atributem [HttpPost])
// Edit View Model → Data Model
category.SomeNewProperty = model.SomeNewProperty;
Řešení problémů
- Znovu vytvořte databázi. Buď vlastním SQL skriptem, nebo pomocí instalátoru nopCommerce.
- Mezi změnami schématu zastavte vývojový webový server.
- Napište podrobný komentář na naše fóra.