MVC ViewModelの例
私はチュートリアルをやっていて、MVC開発に関してはベストプラクティスを学ぼうとしています。以下で使用しているデザインは、Apress/Adam FreemanによるPro ASP.Net MVC5からのものです。これまでのところ、すべてが順調に進んでいます...しかし、私はまだコントローラーでの作業を完全に把握できていません。はい、コントローラーの概念は理解していますが、メソッドの投稿と取得に関してはまだ苦労しています。サンプルMVCアプリケーションのフローを次に示します。
私のapp.Domainプロジェクト
データベースにユーザーテーブルがあり、Entities/Users.csで参照します
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
namespace app.Domain.Entities
{
public class Users
{
[Key]
public int UserID { get; set; }
public string FirstName { get; set; }
public string LastName { get; set; }
public string Email { get; set; }
public string City { get; set; }
public string State { get; set; }
public DateTime CreateDate { get; set; }
public DateTime LastLogin { get; set; }
}
}
次に、インターフェイスがあり、Abstract/IUsersRepository.csにあります
using System;
using System.Collections.Generic;
using app.Domain.Entities;
namespace app.Domain.Abstract
{
public interface IUsersRepository
{
IEnumerable<Users> Users { get; }
}
}
移動して、エンティティConcrete/EFUsersRepository.csを埋めます
using System;
using System.Collections.Generic;
using app.Domain.Entities;
using app.Domain.Abstract;
namespace app.Domain.Concrete
{
public class EFUsersRepository : IUsersRepository
{
private EFDbContext context = new EFDbContext();
public IEnumerable<Users> Users
{
get { return context.Users; }
}
}
}
また、教科書は私が理解しているNinjectを使用しており、すべてが正しくバインドされています。誰かに頼まれない限り、私はそのコードを投稿しません。
ここに私のapp.WebUIソリューションがあります：
教科書では、ViewModelの作成方法を説明しています。これは私にとって物事が少し曖昧になるところです。 ViewModelは、エンティティを取得するための追加のチャネルですか？モデル自体を参照する代わりに、データを選択、更新、挿入、削除するViewModelを常に作成する必要があります（Models/UsersViewModel.cs）。
using System;
using System.Collections.Generic;
using app.Domain.Entities;
namespace app.WebUI.Models
{
public class UsersViewModel
{
//public string FirstName { get; set; }
//public string LastName { get; set; }
//public string Email { get; set; }
//public string City { get; set; }
//public string State { get; set; }
public IEnumerable<Users> Users { get; set; }
}
}
このシナリオでは、ユーザーが電子メールを入力し、コントローラーがデータベースの電子メールをチェックします。存在する場合は、About View（Controllers/HomeController.cs）にリダイレクトします。
using System.Linq;
using System.Web.Mvc;
using app.Domain.Abstract;
using app.WebUI.Models;
namespace app.Controllers
{
public class HomeController : Controller
{
private IUsersRepository repository;
public HomeController(IUsersRepository usersRepository)
{
this.repository = usersRepository;
}
[HttpGet]
public ActionResult Index()
{
return View();
}
[HttpPost]
public ActionResult Index()
{
UsersViewModel userViewModel = new UsersViewModel()
{
Users = repository.Users
.Where(p => p.Email == "[email protected]")
};
return View("About", userViewModel);
}
public ActionResult About()
{
ViewBag.Message = "Your application description page.";
return View();
}
public ActionResult Contact()
{
ViewBag.Message = "Your contact page.";
return View();
}
}
}
そして、ここに私のビュー（Home/Index.cshtml）があります：
@model app.WebUI.Models.UsersViewModel
@{
ViewBag.Title = "Home Page";
Layout = "~/Views/Shared/_LayoutNoMenu.cshtml";
}
@foreach (var p in Model.Users)
{
<div class="container">
@using (Html.BeginForm("About", "Home", FormMethod.Get, new { @class = "begin-form" }))
{
<h1>Welcome</h1>
<div class="required-field-block">
<textarea rows="1" class="form-control" placeholder="Email" id="filter"></textarea>
</div>
<button class="btn btn-primary" type="submit">Login</button>
}
</div>
}
ViewModelを正しく使用する方法に関するアドバイスはありますか？
2014年6月、MVCの学習中にこの質問をしました。今日の時点で、私はビューモデルの概念を理解しています。これが別のMVC初心者に役立つことを願っています：
データベーステーブルを表す私のモデル：
public partial class County : Entity
{
public int CountyID { get; set; }
public string CountyName { get; set; }
public string UserID { get; set; }
public DateTime? CreatedDate { get; set; }
public string ModifiedUserID { get; set; }
public DateTime? ModifiedDate { get; set; }
public virtual IList<Property> Properties { get; set; }
public virtual DistrictOffice DistrictOffice { get; set; }
public virtual IList<Recipient> Recipients { get; set; }
}
2つの1対多の関係と1対1の関係があります。エンティティフレームワークと依存関係の注入。 （これは、ビューモデルの説明には必要ありません。）
最初に、一時ストレージ用のビューモデルを作成して、コントローラーからビューに渡します。 CountyViewModel.cs
public class CountyViewModel
{
[HiddenInput]
public int? CountyId { get; set; }
[DisplayName("County Name")]
[StringLength(25)]
public string CountyName { get; set; }
[DisplayName("Username")]
[StringLength(255)]
public string Username{ get; set; }
}
モデルとは異なる名前とデータ型を使用する柔軟性があります。たとえば、データベース列はUserID、モデルはUserIDですが、viewmodelはUserNameです。使用されないビュー（モデル全体など）にデータを渡す必要はありません。この例では、郡モデルの3つの部分のみが必要です。
コントローラー内で、viewmodelを宣言します。
データが必要です：
var county = _countyService.Get(countyId);
次、
CountyViewModel countyViewModel = new CountyViewModel();
countyViewModel.CountyId = county.CountyID;
countyViewModel.CountyName = county.CountyName;
countyViewModel.UserName = county.UserID;
この方法で宣言することもできます：
CountyViewModel countyViewModel = new CountyViewModel
{
CountyId = county.CountyID,
CountyName = county.CountyName,
UserName = county.UserID
};
次に、ビューを渡す時間です。
return View(countyViewModel);
ビュー内：
@model Project.Web.ViewModels.CountyViewModel
@{
Layout = "~/Views/Shared/_Layout.cshtml";
}
<div>@Model.CountyName</div>
@Html.HiddenFor(model => model.CountyId)
<div>
@Html.TextBoxFor(model => model.CountyName, new { @class = "form-control" })
ビューモデルを使用してデータを渡し、Entity Frameworkでデータベースへのサービス呼び出しを使用する簡単な例を次に示します。
例コントローラー
public class PropertyController : Controller
{
private readonly ICountyService _countyService;
public PropertyController(ICountyService countyService)
: base()
{
_countyService = countyService;
}
[HttpGet]
public ActionResult NewProperty()
{
using (UnitOfWorkManager.NewUnitOfWork())
{
ListAllCountiesViewModel listAllCountyViewModel = new ListAllCountiesViewModel()
{
ListAllCounty = _countyService.ListOfCounties().ToList()
};
PropertyViewModel viewModel = new PropertyViewModel()
{
_listAllCountyViewModel = listAllCountyViewModel,
_countyViewModel = new CountyViewModel(),
};
return View(viewModel);
}
}
}
例 ViewModels
public class CountyViewModel
{
[HiddenInput]
public int? CountyId { get; set; }
[DisplayName("County Name")]
[StringLength(25)]
public string CountyName { get; set; }
[DisplayName("County URL")]
[StringLength(255)]
public string URL { get; set; }
}
public class ListAllCountiesViewModel
{
public string CountyName { get; set; }
public IEnumerable<County> ListAllCounty { get; set; }
}
public class PropertyViewModel
{
public ListAllCountiesViewModel _listAllCountyViewModel { get; set; }
public CountyViewModel _countyViewModel { get; set; }
}
例サービス層
public partial interface ICountyService
{
County Get(int id);
County GetByCompanyCountyID(int id);
IEnumerable<County> ListOfCounties();
void Delete(County county);
IEnumerable<State> ListOfStates();
void Add(County county);
County SearchByName(string county);
}
public partial class CountyService : ICountyService
{
private readonly ICountyRepository _countyRepository;
public CountyService(ICountyRepository countryRepository)
{
_countyRepository = countryRepository;
}
/// <summary>
/// Returns a county
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
public County Get(int id)
{
return _countyRepository.Get(id);
}
/// <summary>
/// Returns a county by County Id
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
public County GetByCountyID(int id)
{
return _countyRepository.GetByMedicaidCountyID(id);
}
/// <summary>
/// Returns all counties
/// </summary>
/// <returns></returns>
public IEnumerable<County> ListOfCounties()
{
return _countyRepository.ListOfCounties();
}
/// <summary>
/// Deletes a county
/// </summary>
/// <param name="county"></param>
public void Delete(County county)
{
_countyRepository.Delete(county);
}
/// <summary>
/// Return a static list of all U.S. states
/// </summary>
/// <returns></returns>
public IEnumerable<State> ListOfStates()
{
var states = ServiceHelpers.CreateStateList();
return states.ToList();
}
/// <summary>
/// Add a county
/// </summary>
/// <param name="county"></param>
public void Add(County county)
{
county.CreatedUserID = System.Web.HttpContext.Current.User.Identity.Name;
county.CreatedDate = DateTime.Now;
_countyRepository.Add(county);
}
/// <summary>
/// Return a county by searching it's name
/// </summary>
/// <param name="county"></param>
/// <returns></returns>
public County SearchByName(string county)
{
return _countyRepository.SearchByName(county);
}
}
例リポジトリ層
public partial class CountyRepository : ICountyRepository
{
private readonly Context _context;
public CountyRepository(IContext context)
{
_context = context as Context;
}
public County Get(int id)
{
return _context.County.FirstOrDefault(x => x.CountyID == id);
}
public County GetByCompanyCountyID(int id)
{
return _context.County.FirstOrDefault(x => x.CountyID == id);
}
public IList<County> ListOfCounties()
{
return _context.County.ToList()
.OrderBy(x => x.CountyName)
.ToList();
}
public void Delete(County county)
{
_context.County.Remove(county);
}
public County Add(County county)
{
_context.County.Add(county);
return county;
}
public County SearchByName(string county)
{
return _context.County.FirstOrDefault(x => x.CountyName == county);
}
}