[转载]ASP.NET MVC 最佳开发实践（1）

[转载]ASP.NET MVC 最佳开发实践（1） – Rickie is back …. 人生·工作的结果=思维方式×热情×能力 – 博客园.

本文提供了一些代码设计准则，目标是帮助ASP.NET MVC 开发人员创建可靠的应用程序，当然，你可根据实际应用程序选择合适的标准。本文由EntLib.com 小组翻译，欢迎分享和交流ASP.NET MVC 项目开发设计思路。

Model建议 – Model Recommendations

Model是定义业务领域相关的对象，应该包含业务逻辑（对象如何动作和关联），验证逻辑（验证对象的有效值），数据逻辑（数据对象如何持久化），和会话逻辑（跟踪用户状态）。

创建独立的Model项目，在ASP.NET MVC 项目中引用Model程序集。

将所有业务逻辑放置在Model中。

如将所有业务逻辑放置在Model项目中，可根据实际业务数据来生成View和Controller。有如下好处：

• 减少重复的业务逻辑。
• 在View中减少业务逻辑，View易于理解。
• 业务逻辑的测试仅仅和Model有关。

例如，下面需要显示用户的用户名 – 先显示Last Name，在View中代码如下：

<% if (String.Compare((string)TempData["displayLastNameFirst"], "on") == 0)        { %>
Welcome, <%= Model.lastName%>, <%= Model.firstName%>
<% }        else        { %>
Welcome, <%= Model.firstName%> <%= Model.lastName%>
<% } %>

然而你需要在每一个地方重复这一逻辑。如将这一业务逻辑放置在Model中，可在Model中添加一个属性封装这一逻辑。

public string combinedName
{
get
{
return (displayLastNameFirst ? lastName + " " + firstName : firstName + " " + lastName);
}
private set
{
;
}
}

样，可大大简化视图代码：

<% Welcome, <%= Model.combinedName %> %>

将所有验证逻辑放置在Model中

所有输入验证应该在Model层，包括Client-side 验证。

可使用ModelState 添加验证检查，代码如下所示：

if (String.IsNullOrEmpty(userName))

{

ModelState.AddModelError(“username”, Resources.SignUp.UserNameError);

}

不过，更好的办法是使用 System.ComponentModel.DataAnnotations，在Model类的属性上添加attribute，如下所示：

public class User

{

[Required(ErrorMessageResourceName = “nameRequired”, ErrorMessageResourceType = typeof(Resources.User))]

public String userName { get; set; }

…

}

为数据访问定义接口

接口用来暴露数据访问类的方法，强化ASP.NET MVC 的松散耦合设计。

可考虑使用Entity Framework 或 LINQ to SQL 创建对数据库的访问类，Entity Framework 和 LINQ to SQL 都支持存储过程。

将所有会话逻辑放置在Model中。

View 建议 – View Recommendations

View用来展示Model数据，Controller负责选择View。业务逻辑不属于View，Model负责业务逻辑。View非常灵活，如Model的View可通过HTML显示，同样的Model也可通过XML 视图来呈现。

将HTML放置在View和Partial View中（不要在Controller中）

默认的ASP.NET视图引擎提供了如下视图文件：HTML View（.aspx），Partial HTML View（.ascx）和Master page（.master）

如下视图演示了对partial view的调用：

<%@ Page Title=”” Language=”C#” MasterPageFile=”~/Views/Shared/Site.Master” Inherits=”System.Web.Mvc.ViewPage” %>

…

Below is a list of items submitted by <b>

<%= Html.Encode(ViewData[“name”]) %></b>.

<p>

…

<div id=”items”>

<% Html.RenderPartial(“ItemsByName”);%>

</div>

</asp:content>

Partial view（ItemsByName.ascx）如下所示：

<%@ Control Language=”C#” %>

…

<% foreach (Seller.Controllers.Items item in (IEnumerable)ViewData.Model)

{ %>

<tr>

<td>

<%= Html.Encode(item.title)%>

</td>

<td>

<%= Html.Encode(item.price)%>

</td>

</tr>

<% } %>

</table>

<% } %>

Partial View 是一个强大的扩展和重用机制。你可在不同的地方包含相同的View，不必编写重复的代码。

在View中使用ViewData访问数据

ASP.NET 提供了如下机制在View模板中访问数据：

ViewData.Model 对象 – 在Controller的action方法中，在return语句中传入一个Model对象（return View(myModelObject)）。

ViewData Dictionary – 在action方法中存入数据（ViewData[“key”] = value），接着在View中方法相同的dictionary。

在可能的情况下，应该是一ViewData Model，而不是ViewData 来访问数据，因为Model 提供了类型安全。此外，你应在View模板中，使用数据访问机制，而不是Request / Session 来访问。

如需要显示一个对象的多个属性，可使用ViewData.Model，并创建一个强类型View。针对seller详细页面，seller类有name、phone、address、email等等属性，在呈现View之前，你可在Controller中对ViewData.Model 赋值seller对象实例。但是如果是一些零散的数据，如page#、用户名和current time，则一般使用ViewData字典。

在使用模型绑定（Model bingding）时，避免在view中访问数据。

在Controller 中访问数据库，在执行View之前，将从数据库中检索的数据复制给轻量的View Model对象，这样，轻量的View Model对象不必在视图执行时检索数据。

使用（自动生成）客户端验证

从ASP.NET MVC 2 开始，可以很容易添加客户端验证。

(1) 如前所述，在Model层中添加数据验证逻辑；

(2) 确保项目中Scripts目录有如下JavaScript 文件：MicrosoftAjax.js 和 MicrosoftMvcValidation.js；

(3) 在表单提交页面，添加如下代码：

<script src=”<%= Url.Content(“~/Scripts/MicrosoftAjax.js”) %>” type=”text/JavaScript”></script>

<script src=”<%= Url.Content(“~/Scripts/MicrosoftMvcValidation.js”) %>” type=”text/JavaScript”></script>

(4) 在表单中添加如下代码：

<% Html.EnableClientValidation(); %>

现在如果编辑表单内容，当输入值不合格时，客户端马上进行验证提醒。

在模板中插入server-side 注释

在View模板中使用服务端注释，在HTML呈现时，会剔除。

如下是server-side注释：

<%– This is a server side template comment –%>

不要在View模板中使用HTML 注释，因为这些注释会呈现在web浏览器中，可被用户看到。

使用HTMLHelper 扩展方法。

System.Web.Mvc.Html 类中包含了很多有用的HTML 扩展方法。

Form 表单生成（BeginForm）

输入字段生成（checkbox、hidden、radio button、textbox）

链接URL生成（ActionLink）

XSS保护（Encode）

尽可能使用这些HTML扩展方法，如下是使用route table创建一个链接：

<%= Html.ActionLink(“Home page”, “Default”) %>

后续相关文章，可参考如下链接：