18. HtmlHelper 扩展

首先，参考一下 Rob Conery 的这篇文章，我完全同意他的观点，你应该为每种情况创建 Helper 方法，此外我还建议你像 ASP.NET MVC 团队那样为可重用的 UI 元素创建 Helper 方法，但是对于在哪里放置我们正在实践的这些方法，我有不同的建议。

应用程序开发者

只为你需要在多个视图中重复使用的HtmlHealper创建单独的扩展方法。对于只在一个视图中使用的帮助方法，你可以为整个视图创建一个Helper类，然后创建一个HtmlHelper来返回这个视图Helper类，而把只在这个视图中使用的扩展方法作为类内部的方法。（这部分未按原文翻译，请自行参照原文）例如：

public class DashboardHtmlHelper {
    private readonly HtmlHelper _htmlHelper;

    public DashboardHtmlHelper(HtmlHelper htmlHelper) {
        _htmlHelper = htmlHelper;
    }

    public string DoThis() {
        //Your Code
    }

    public string DoThat() {
        //Your Code
    }
}

public static class HtmlHelperExtension {
    public static DashboardHtmlHelper Dashboard(this HtmlHelper htmlHelper) {
        return new DashboardHtmlHelper(htmlHelper);
    }
}

然后在视图中这样调用：

<%= Html.Dashboard().DoThis() %>

UI 组件开发人员

如果你在开发的是可以在多个 ASP.NET MVC 应用程序中重用的 UI 组件系列，你可以像上面那样为你的整个系列组件创建一个单一名字的Helper。假如你开发的是商业组件，那你可以用你的公司名字来为这个单一的Helper命名，然后在这个Helper中添加方法。否则很容易出现方法的命名冲突。

要是你正在学习 MVCContrib.org 的做法，为 IViewDataContainer 做扩展的话，道理也是一样的。

19. Html编码

在从用户端获取信息的任何情况下，总是使用 Html.Encode(“User Input”) 来编码文本节点，用 Html.AttributeEncode(“User Input”) 来编码Html 元素属性。

20. 不要把Javascript脚本放在你的视图中

不要把你的javascript脚本和html混杂在一起，创建一个单独的 js 文件，把脚本代码放在里面。有时候你可能需要在你的 javascript 代码中传递视图数据，这种特殊的情况下，也只把初始化代码放在视图中。例如，你正在开发 web 2.0 风格的应用，你需要在这个应用中传递 ajax 方法的url，并且需要在 javascript 脚本中传递一些其它的模型数据，这种情况下，你可以参考下面的方式：

视图：

<div id="sideBar" class="column"></div>
        <script type="text/javascript">
            $(document).ready(function(){
                Story.init('<%= Model.UrlFormat %>', '<%= Url.NoIcon() %>', <%= Model.PageCount %>, <%= Model.StoryPerPage %>, <%= Model.CurrentPage %>, '<%= Model.SelectedTab %>', '<%= Model.SelectedOrderBy %>');
            });
        </script>
    </div>
</asp:Content>

Javascript：

var Story = {
    _urlFormat: '',
    _noIconUrl: '',
    _pageCount: 0,
    _storyPerPage: 0,
    _currentPage: 0,
    _currentTab: '',
    _currentOrderBy: '',

    init: function(urlFormat, noIconUrl, pageCount, storyPerPage, currentPage, currentTab, currentOrderBy) {
        Story._urlFormat = urlFormat;
        Story._noIconUrl = noIconUrl;
        Story._pageCount = pageCount;
        Story._storyPerPage = storyPerPage;
        Story._currentPage = currentPage;
        Story._currentTab = currentTab;
        Story._currentOrderBy = currentOrderBy;

        //More Codes
    }
}

这里要为不太熟悉上面的 javascript 的同学解释一下，这是一个在javascript中创建静态类的示例代码。对了，我还差点忘了提一点，永远不要在你的javascript文件中硬编码 ajax 方法的url，虽然 Rob Conery 和 Phil Haack 在他们的教程中是这样干的。这是一个很不好的方式，它破坏了 ASP.NET 路径重写的优雅性。

21. 使用 jQuery 和 jQuery UI

使用 jQuery 和 jQuery UI，它是最好的js库，并且可以使用 Google CDN 托管服务来加载这些库（对于国内用户，如果使用 google 托管的库一定要有承担风险的准备，具体原因嘛，看看国内6月24日左右的IT新闻就知道了）。

<link type="text/css" href="http://ajax.googleapis.com/ajax/libs/jqueryui/1.7.1/themes/{YOUR Prefered Theme}/jquery-ui.css" rel="stylesheet"/>
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js"></script>
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jqueryui/1.7.1/jquery-ui.js"></script>

还有一种更好的方式：

<link type="text/css" href="http://ajax.googleapis.com/ajax/libs/jqueryui/1.7.1/themes/{YOUR Prefered Theme}/jquery-ui.css" rel="stylesheet"/>
<script type="text/javascript" src="http://www.google.com/jsapi"></script>
<script type="text/javascript">
    google.load("jquery", "1.3.2");
    google.load("jqueryui", "1.7.1");
</script>

以上就是这一次的全部内容。

最后，我要祝贺 ASP.NET MVC 团队开发了如此杰出的框架，尤其是他们从社区接受反馈的方式。我希望能用这个框架开发出更多杀手级的应用（注：杀手级的应用程序，一般指极其优秀的应用程序，这类程序超越了语言本身，比语言更有吸引力而且能增加语言的吸引力）。

相关日志

• 2009-07-07 -- ASP.NET MVC 最佳实践（三）
• 2009-07-01 -- ASP.NET MVC 最佳实践（二）
• 2009-06-28 -- ASP.NET MVC 最佳实践（一）
• 2009-04-13 -- [翻译]ASP.NET MVC动手实验1-3：开发ASP.NET MVC应用
• 2009-04-09 -- [翻译]ASP.NET MVC动手实验1-2：创建ASP.NET MVC应用
• 2009-04-09 -- [翻译]ASP.NET MVC动手系列1-1：ASP.NET MVC概述
• 2011-03-14 -- 对《优化浏览器渲染》的补充【译】
• 2011-03-10 -- CSS边框实现“无图化”设计【译】
• 2010-10-31 -- CSS技巧:如何避免IE6中的"浮动下坠"【译】
• 2010-10-25 -- 借助jQuery和Google分析服务的事件追踪深入了解用户行为【译】

15. 关于路由的思考

如果你在开发的是一个纯 ASP.NET MVC 的应用程序，可以先关闭已有的路由文件检查，这样可以去除不必要的文件系统检查。如果你这样做了，那么就还需要考虑另外的一些事情。请记住如果你的应用程序运行于 IIS 7集成模式，那么 ASP.NET 应用程序将会拦截所有的请求，不管文件的后缀名是什么。所以你必须要在过滤列表中加一些东西，以便让 ASP.NET MVC 应用程序不处理它们。这其中可能包括静态文件，例如 html、htm、文本文件(尤其是robots.txt)、favicon.ico、脚本、图片和css等等。这也是我在第一部分第2节中提到不喜欢默认文件结构的原因之一。以下是我为 IIS7 定制的路由定义标准模板：

_routes.Clear();

// Turns off the unnecessary file exists check
_routes.RouteExistingFiles = true;

// Ignore text, html, files.
_routes.IgnoreRoute("{file}.txt");
_routes.IgnoreRoute("{file}.htm");
_routes.IgnoreRoute("{file}.html");

// Ignore axd files such as assest, image, sitemap etc
_routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

// Ignore the assets directory which contains images, js, css & html
_routes.IgnoreRoute("assets/{*pathInfo}");

// Ignore the error directory which contains error pages
_routes.IgnoreRoute("ErrorPages/{*pathInfo}");

//Exclude favicon (google toolbar request gif file as fav icon which is weird)
_routes.IgnoreRoute("{*favicon}", new { favicon = @"(.*/)?favicon.([iI][cC][oO]|[gG][iI][fF])(/.*)?" });

//Actual routes of my application

接下来是我的一些不同于手册指南的个人偏好。默认情况下 ASP.NET MVC 产生的 url 形如 {controller}/{action}，在你开发一个多模块的应用程序是这是不错的选择，但是对于一些很小的应用程序，我通常喜欢从 url 中去掉控制器(controller)只留下方法名(action name)。如此一来，原来的“www.yourdomain.com/Story/Dashboard” 及 “www.yourdomain.com/Membership/Signin” 就会变成 “www.yourdomain.com/Dashboard” 和“www.yourmain.com/Signin”。所以我要添加一些新路由：

_routes.MapRoute("SignUp", "SignUp", new { controller = "Membership", action = "SignUp" });
_routes.MapRoute("SignIn", "SignIn", new { controller = "Membership", action = "SignIn" });
_routes.MapRoute("ForgotPassword", "ForgotPassword", new { controller = "Membership", action = "ForgotPassword" });
_routes.MapRoute("SignOut", "SignOut", new { controller = "Membership", action = "SignOut" });
_routes.MapRoute("Profile", "Profile", new { controller = "Membership", action = "Profile" });
_routes.MapRoute("ChangePassword", "ChangePassword", new { controller = "Membership", action = "ChangePassword" });

_routes.MapRoute("Dashboard", "Dashboard/{tab}/{orderBy}/{page}", new { controller = "Story", action = "Dashboard", tab = StoryListTab.Unread.ToString(), orderBy = OrderBy.CreatedAtDescending.ToString(), page = 1 });
_routes.MapRoute("Update", "Update", new { controller = "Story", action = "Update" });
_routes.MapRoute("Submit", "Submit", new { controller = "Story", action = "Submit" });

_routes.MapRoute("Home", "{controller}/{action}/{id}", new { controller = "Home", action = "Index", id = string.Empty });

16. 如果需要的话，创建新的ActionResult

ASP.NET MVC 包含有很多种用于不同目的的 ActionResult，但我们仍有可能会需要新的 ActionResult。例如xml、rss、atom等等。在这种情况下，我的建议是不要使用通用的 ContentResult， 而是创建一种新的 ActionResult. MVCContrib 项目中有一个 XmlResult，你可以用它来返回 xml，但是不支持 feed。显然依靠它来将未知对象转换为 rss/atom 是很困难的，这时你就可以创建一个定义ActionResult的模型。例如：

public class AtomResult : ActionResult {
    public AtomResult(string siteTitle, string feedTitle, IEnumerable<IStory> stories) {
        SiteTitle = siteTitle;
        FeedTitle = feedTitle;
        Stories = stories;
    }

    public string SiteTitle {
        get;
        private set;
    }

    public string FeedTitle {
        get;
        private set;
    }

    public IEnumerable<IStory> Stories {
        get;
        private set;
    }

    public override void ExecuteResult(ControllerContext context) {
        string xml = Build(context);

        HttpResponseBase response = context.HttpContext.Response;
        response.ContentType = "application/atom+xml";
        response.Write(xml);
    }
}

然后在控制器中就可以这样写：

[AcceptVerbs(HttpVerbs.Get), OutputCache(CacheProfile = "Atom")]
public ActionResult Shared() {
    IEnumerable<stories> stories = GetSharedStories();

    return new AtomResult("My Site", "My shared stories in atom", stories);
}

17. 把你的视图拆分为多个视图控件

如果你的视图文件变得越来越大，那你可以考虑把它拆分为多个视图控件。至于视图空间是否在多个页面中重用，并没有关系。因为这样做可以让真正的视图文件变得更加具有可读性。考虑一下下面的视图：

<asp:Content ID="Content1" ContentPlaceHolderID="TitleContent" runat="server">
    My Secret App : Dashboard
</asp:Content>
<asp:Content ID="Content2" ContentPlaceHolderID="MainContent" runat="server">
    <div id="heading"></div>
    <div class="columns">
        <div id="main" class="column">
            <div id="storyListTabs" class="ui-tabs ui-widget ui-widget-content ui-corner-all">
                <% Html.RenderPartial("TabHeader", Model);%>
                <div id="tabContent" class="ui-tabs-panel ui-widget-content ui-corner-bottom">
                    <div id="storyList">
                        <% Html.RenderPartial("SortBar", Model);%>
                        <div class="clear"></div>
                        <% Html.RenderPartial("NoLinkMessage", Model);%>
                        <form id="update" action="<%= Url.Update()%>" method="post">
                            <% Html.RenderPartial("List", Model);%>
                            <% Html.RenderPartial("ActionBar", Model);%>
                            <% Html.RenderPartial("Pager", Model);%>
                        </form>
                    </div>
                </div>
            </div>
            <%Html.RenderPartial("Submit", new StorySubmitViewModel());%>
        </div>
        <div id="sideBar" class="column"></div>
    </div>
</asp:Content>

继续阅读：《ASP.NET MVC 最佳实践（四）》

相关日志

• 2009-07-08 -- ASP.NET MVC 最佳实践（四）
• 2009-07-01 -- ASP.NET MVC 最佳实践（二）
• 2009-06-28 -- ASP.NET MVC 最佳实践（一）
• 2009-04-13 -- [翻译]ASP.NET MVC动手实验1-3：开发ASP.NET MVC应用
• 2009-04-09 -- [翻译]ASP.NET MVC动手实验1-2：创建ASP.NET MVC应用
• 2009-04-09 -- [翻译]ASP.NET MVC动手系列1-1：ASP.NET MVC概述
• 2011-03-14 -- 对《优化浏览器渲染》的补充【译】
• 2011-03-10 -- CSS边框实现“无图化”设计【译】
• 2010-10-31 -- CSS技巧:如何避免IE6中的"浮动下坠"【译】
• 2010-10-25 -- 借助jQuery和Google分析服务的事件追踪深入了解用户行为【译】

7. 不要在控制器中使用HttpContext类及其派生类

在你的控制器中不要引用到HttpContext以及它的派生类。这让你能比较容易地进行控制器的单元测试。如果你需要访问与HttpContext相关的对象比如User、QueryString、Cookie等，你可以使用自定义的行为过滤器（博客园的老赵有一篇文章对这一条进行了深入的论述，并提出了自己的解决方案，建议阅读）或者创建一些接口和容器，并把它传入控制器的构造函数。例如，下面的路由：

routes.MapRoute(
    "Dashboard",
    "Dashboard/{tab}/{orderBy}/{page}",
    new {
        controller = "Story",
        action = "Dashboard",
        tab = StoryListTab.Unread.ToString(),
        orderBy = OrderBy.CreatedAtDescending.ToString(),
        page = 1
    }
);

而控制器的行为方法则定义为：

[AcceptVerbs(HttpVerbs.Get),OutputCache(CacheProfile = "Dashboard"),UserNameFilter]
public ActionResult Dashboard(string userName, StoryListTab tab, OrderBy orderBy, int? page) {
}

UserNameFilter这个过滤器负责传递UserName：

public class UserNameFilter : ActionFilterAttribute {
    public override void OnActionExecuting(ActionExecutingContext filterContext) {
        const string Key = "userName";

        if (filterContext.ActionParameters.ContainsKey(Key)) {
            if (filterContext.HttpContext.User.Identity.IsAuthenticated) {
                filterContext.ActionParameters[Key] = filterContext.HttpContext.User.Identity.Name;
            }
        }

        base.OnActionExecuting(filterContext);
    }
}

[更新：一定要明确你已经对控制器或者是对控制器中的行为添加了 Authorize 属性，参见原文评论。]

8. 用行为控制器来转换行为方法参数

用行为过滤器来把传入值转换为你的控制器行为方法参数，再看一下 Dashboard方法的代码，我们以 Enum 类型接受 tab 和 orderBy这两个参数。

[AcceptVerbs(HttpVerbs.Get), OutputCache(CacheProfile = "Dashboard"), StoryListFilter]
public ActionResult Dashboard(string userName, StoryListTab tab, OrderBy orderBy, int? page) {
}

过滤器 StoryListFilter 将负责把它由 路由的值/查询字符串 转换为适当的数据类型。

public class StoryListFilter : ActionFilterAttribute {
    public override void OnActionExecuting(ActionExecutingContext filterContext) {
        const string TabKey = "tab";
        const string OrderByKey = "orderBy";

        NameValueCollection queryString = filterContext.HttpContext.Request.QueryString;

        StoryListTab tab = string.IsNullOrEmpty(queryString[TabKey]) ?
                            filterContext.RouteData.Values[TabKey].ToString().ToEnum(StoryListTab.Unread) :
                            queryString[TabKey].ToEnum(StoryListTab.Unread);

        filterContext.ActionParameters[TabKey] = tab;

        OrderBy orderBy = string.IsNullOrEmpty(queryString[OrderByKey]) ?
                            filterContext.RouteData.Values[OrderByKey].ToString().ToEnum(OrderBy.CreatedAtDescending) :
                            queryString[OrderByKey].ToEnum(OrderBy.CreatedAtDescending);

        filterContext.ActionParameters[OrderByKey] = orderBy;

        base.OnActionExecuting(filterContext);
    }
}

你也可以用自定义模型绑定器来达到同样的目的。如果要那样做的话，你需要为每个枚举创建一个独立的模型绑定器，而不是用一个行为过滤器来处理所有的枚举参数。用模型绑定器还有一个问题，一旦你注册了一个类型，在行为中它就总是被使用，而行为过滤器则是可以根据需要选择使用的。

9. 行为过滤器的位置

如果你要对你的控制器的所有行为方法应用同一个行为过滤器，你可以把这个过滤器放在控制器的定义上而不必给每个行为方法应用。如果你要对你的所有控制器应用同一个行为过滤器，你应该创建一个基控制器，对它应用该过滤器，并让所有的控制器继承这个基控制器。例如 story 控制器应该只在用户已经登陆的情况下才可以使用，并且我们需要把当前用户的用户名传入 story 控制器下的方法，另外Story控制器应该压缩返回的数据：

[Authorize, UserNameFilter]
public class StoryController : BaseController {
}

[CompressFilter]
public class BaseController : Controller {
}

但是如果继承的层次达到或者高于2层，应该另找方法来应用过滤器。最新的 Oxite 代码里有一些非常出色的动态应用过滤器的方法，我强烈推荐你去看一下。

10. 小心使用UpdateModel

我要再次强调 Justin Ethredge 在他的文章中已经提过的这个问题，开发中一定小心，避免陷进UpdateModel的陷阱里去。

11.控制器不要包含任何域逻辑

控制器应该只负责：

• 验证输入
• 调用Model层来为显示视图准备数据
• 返回视图或者跳转到另一个行为

如果你在控制器中坐了其它的事情，那就说明你把它们放错了地方。你在控制器中坐的这些事情或许更应该交给模型去处理。只要你遵守了这条规则，你的每个控制器方法代码应该不会超过20到25行。 Ian Cooper 有一篇很棒的文章《Skin Controller Fat Model》，有空的时候你一定要读一下。

12. 避免使用 ViewData，尽量使用ViewData.Model

依赖于数据字典不仅使你的代码难以重构，而且你还不得不在试图中编写转换代码。实际上即使你给你的控制器的每个方法都单独编写一个类作为数据模型，那也是完全可以的。如果你觉得编写这些视图数据模型类是一项非常乏味的工作的话，你可以使用 MVCContrib 项目中 ViewDataExtensions，它包含一些用于返回强类型对象的不错的扩展。但是如果你的视图数据的数据字典中包含了多个数据类型的话，你还是没办法摆脱数据字典和他的字符串名。

13. 用 PRG 模式来修改数据

Tim Barcz, Matt Hawley, Stephen Wather 甚至 Scott Gu 都写了这方面的文章，你可以在 这里、这里、这里和这里找到它们。这个模式的一个问题是当一项验证失败或者发生任何错误的时候，你不得不把ModelState复制到TempData里面。如果你是手动来做这件事，请不要再那样做了，你可以用行为过滤器自动处理它，就像下面这样：

[AcceptVerbs(HttpVerbs.Get), OutputCache(CacheProfile = "Dashboard"), StoryListFilter, ImportModelStateFromTempData]
public ActionResult Dashboard(string userName, StoryListTab tab, OrderBy orderBy, int? page)
{
    //Other Codes
    return View();
}

[AcceptVerbs(HttpVerbs.Post), ExportModelStateToTempData]
public ActionResult Submit(string userName, string url)
{
    if (ValidateSubmit(url))
    {
        try
        {
            _storyService.Submit(userName, url);
        }
        catch (Exception e)
        {
            ModelState.AddModelError(ModelStateException, e);
        }
    }

    return Redirect(Url.Dashboard());
}

还有行为过滤器的代码：

public abstract class ModelStateTempDataTransfer : ActionFilterAttribute {
    protected static readonly string Key = typeof(ModelStateTempDataTransfer).FullName;
}

public class ExportModelStateToTempData : ModelStateTempDataTransfer {
    public override void OnActionExecuted(ActionExecutedContext filterContext) {
        //Only export when ModelState is not valid
        if (!filterContext.Controller.ViewData.ModelState.IsValid) {
            //Export if we are redirecting
            if ((filterContext.Result is RedirectResult) || (filterContext.Result is RedirectToRouteResult)) {
                filterContext.Controller.TempData[Key] = filterContext.Controller.ViewData.ModelState;
            }
        }

        base.OnActionExecuted(filterContext);
    }
}

public class ImportModelStateFromTempData : ModelStateTempDataTransfer {
    public override void OnActionExecuted(ActionExecutedContext filterContext) {
        ModelStateDictionary modelState = filterContext.Controller.TempData[Key] as ModelStateDictionary;

        if (modelState != null) {
            //Only Import if we are viewing
            if (filterContext.Result is ViewResult) {
                filterContext.Controller.ViewData.ModelState.Merge(modelState);
            } else {
                //Otherwise remove it.
                filterContext.Controller.TempData.Remove(Key);
            }
        }

        base.OnActionExecuted(filterContext);
    }
}

MVCContrib 项目也有这个功能，但是我不喜欢他们在用一个单独类来处理的方式，我喜欢对“哪个方法输出”和“哪个方法输入”有更多的控制权。

14. 为你的视图模型创建父类层并用行为过滤器来构成公共部分

为你的视图模型类编写一个父类层，并用过滤器来构成它的公共部分。例如我正在开发的这个非常小的应用程序，我需要知道用户是否已经认证，已及用户名。

public class ViewModel {
    public bool IsUserAuthenticated {
        get;
        set;
    }

    public string UserName {
        get;
        set;
    }
}

还有行为过滤器的代码：

public class UserNameFilter : ActionFilterAttribute {
    public override void OnActionExecuting(ActionExecutingContext filterContext) {
        const string Key = "userName";

        if (filterContext.ActionParameters.ContainsKey(Key)) {
            if (filterContext.HttpContext.User.Identity.IsAuthenticated) {
                filterContext.ActionParameters[Key] = filterContext.HttpContext.User.Identity.Name;
            }
        }

        base.OnActionExecuting(filterContext);
    }
}

public class ViewModelUserFilter : ActionFilterAttribute {
    public override void OnActionExecuted(ActionExecutedContext filterContext) {
        ViewModel model;

        if (filterContext.Controller.ViewData.Model == null) {
            model = new ViewModel();
            filterContext.Controller.ViewData.Model = model;
        } else {
            model = filterContext.Controller.ViewData.Model as ViewModel;
        }

        if (model != null) {
            model.IsUserAuthenticated = filterContext.HttpContext.User.Identity.IsAuthenticated;

            if (model.IsUserAuthenticated) {
                model.UserName = filterContext.HttpContext.User.Identity.Name;
            }
        }

        base.OnActionExecuted(filterContext);
    }
}

正如你所看到的，如果在控制器里预先设定它的话，它并没有替换模型，而是在它发现模型与它符合的时候，才作为控制器的公共部分起作用。另一个好处是，由于视图只依赖于父类层，你可以不必返回具体的model，而只需要返回 View()。

继续阅读：《ASP.NET MVC 最佳实践（三）》

相关日志

• 2009-07-08 -- ASP.NET MVC 最佳实践（四）
• 2009-07-07 -- ASP.NET MVC 最佳实践（三）
• 2009-06-28 -- ASP.NET MVC 最佳实践（一）
• 2009-04-13 -- [翻译]ASP.NET MVC动手实验1-3：开发ASP.NET MVC应用
• 2009-04-09 -- [翻译]ASP.NET MVC动手实验1-2：创建ASP.NET MVC应用
• 2009-04-09 -- [翻译]ASP.NET MVC动手系列1-1：ASP.NET MVC概述
• 2011-03-14 -- 对《优化浏览器渲染》的补充【译】
• 2011-03-10 -- CSS边框实现“无图化”设计【译】
• 2010-10-31 -- CSS技巧:如何避免IE6中的"浮动下坠"【译】
• 2010-10-25 -- 借助jQuery和Google分析服务的事件追踪深入了解用户行为【译】

1. 创建UrlHelper的扩展方法来生成url

尽量避免以字符串方式直接传递controller, action 或者 route name，最好是为创建为UrlHelper创建扩展方法来封装url。例如：

public static class UrlHelperExtension {
    public static string Home(this UrlHelper helper) {
        return helper.Content("~/");
    }

    public static string SignUp(this UrlHelper helper) {
        return helper.RouteUrl("Signup");
    }

    public static string Dashboard(this UrlHelper helper) {
        return Dashboard(helper, StoryListTab.Unread);
    }

    public static string Dashboard(this UrlHelper helper, StoryListTab tab) {
        return Dashboard(helper, tab, OrderBy.CreatedAtDescending, 1);
    }

    public static string Dashboard(this UrlHelper helper, StoryListTab tab, OrderBy orderBy, int page) {
        return helper.RouteUrl("Dashboard", new { tab = tab.ToString(), orderBy = orderBy.ToString(), page });
    }

    public static string Update(this UrlHelper helper) {
        return helper.RouteUrl("Update");
    }

    public static string Submit(this UrlHelper helper) {
        return helper.RouteUrl("Submit");
    }
}

这样，如果在你的视图中有类似这样的代码：

    <%= Html.ActionLink("Dashboard", "Dashboard", "Story") %>
    <a href="<%= Url.RouteUrl("Profile")%>">Profile</a>

你就可以用下面的这种方式来代替它们：

<a href="<%= Url.Dashboard() %>">Dashboard</a>
<a href="<%= Url.Profile() %>">Profile</a>

在控制器里也可以用，原来的代码：

return RedirectToAction(
    "Dashboard",
    "Story",
    new {
        tab = StoryListTab.Favorite,
        orderBy = OrderBy.CreatedAtAscending,
        page = 1
    }
);

可以写成：

return Redirect(Url.Dashboard(StoryListTab.Favorite,
                                OrderBy.CreatedAtAscending, 1));

当然了，你也可以使用 future assembly 中的强类型版本来获得控制器、方法以及参数值，或者创建你自己的强类型版本以免将来进行重构时太过于痛苦，但是请一定记住，它没有官方支持并且将来有可能会发生改变。上面的方式也可以和强类型版本搭配使用。当然“另外增加一个间接层”（Scott Ha 喜欢用的引语）有一些好处，在编写单元测试的时候还有一个好处是你只需处理 RedirectResult 而无须同时处理 RedirectResult 和 RedirectToRouteResult。

2. Create Extension Method of UrlHelper to map your JavaScript, Stylesheet and Image Folder

默认情况下 ASP.NET MVC 创建Content、Scripts文件夹来做这些事，这一点我不喜欢，我更喜欢下面的这种文件夹结构，这样在IIS里我可以只让静态文件缓存在Assets文件夹而不是多个文件夹：

• Assets
• +images
• +scripts
• +stylesheets

无论是结构是什么样的，还是要为UrlHelper创建一些扩展方法来映射这些文件夹，以便你在视图中可以很方便地指向它们，这样以后如果你要改变目录结构，你就无须做大量查找替换的工作。我还建议你为所有经常在视图中用到的资源创建UrlHelper的扩展方法。例如：

public static string Image(this UrlHelper helper, string fileName) {
    return helper.Content("~/assets/images/{0}".FormatWith(fileName));
}

public static string Stylesheet(this UrlHelper helper, string fileName) {
    return helper.Content("~/assets/stylesheets/{0}".FormatWith(fileName));
}

public static string NoIcon(this UrlHelper helper) {
    return Image(helper, "noIcon.png");
}

然后当需要用到这些路径的时候，原来的代码

<link href="../../Content/Site.css" rel="stylesheet" type="text/css" />

就可以写成这样：

<link href="<%= Url.Stylesheet("site.css")%>" rel="stylesheet" type="text/css" />

3. 中使用启动加载器

我在以前的文章中已经提到过这一点，总的来说就是：如果你要在 Global.asax 的 Application_Start 中做很多处理，比如 注册路由规则(Routers)、注册控制器工厂(Controller Factory)、模型绑定(Model Binders)、视图引擎(View Engine)、启动程序级的特定后台服务或者为特定部分创建独立任务等，那就用启动加载器来执行这些操作。这会让你的代码更简洁，更可测。这一点在用 ASP.NET MVC 构建门户级应用时尤其有用，因为这类应用中的每个模块都可能有一些不影响到其他模块的启动初始化操作。但是如果你只是开发一个小应用，上面提到的这些对你来说都不是问题，你当然也可以继续用默认的 global.asax。

4. 不要硬编码对依赖注入容器的调用，用通用服务定位器来代替。

不要让任何特定的依赖注入容器(DI Container)打乱你的代码，更好的办法是使用通用服务定位器(Common Service Locator)，它是对底层依赖注入进行的抽象，已经支持几乎所有流行的依赖注入容器，它让你可以任意替换底层的依赖注入对象而无须修改代码，因为每个依赖注入容器都具有一些不同于其它容器的特性。Tim Barcz 最近写了一篇关于这个话题的很棒的文章，我不太明白他为什么没有提到我们对我们偏爱的依赖注入容器有多痴迷。通用服务定位器对绝大部分常用情景都提供了支持，而对一些特殊情况比如对已实体化对象的依赖注入，我印象里有 StructureMap、Ninject 和 Unity，你可以调用静态方法 ServiceLocator.Current.GetInstance 来代替。 通用服务定位器 是 Jeremy D Miller 发起的 依赖注入容器开发者(the DI Containers creators)的集体作品。

用通用服务定位器创建控制器工厂非常容易：

public class CommonServiceLocatorControllerFactory : DefaultControllerFactory {
    protected override IController GetControllerInstance(Type controllerType) {
        return (controllerType == null) ? base.GetControllerInstance(controllerType) : ServiceLocator.Current.GetInstance(controllerType) as IController;
    }
}

我希望 MVCContrib 的成员们也用这样的方式，而不是为每个容器创建一个独立的控制器工厂。

5. 用恰当的的AcceptVerbs属性来修饰你的控制器方法

ASP.NET MVC 比 Web Forms 更容易遭受攻击。所以务必让对数据进行修改的控制器方法只接受 Post 方式请求（HttpVerbs.Post）。如果安全对你来说至关重要，你还可以用 ValidateAntiForgeryToken 或者 Captcha。我强烈推荐 Derik Whittaker 写的一篇 很好的文章 以及视频介绍了怎么把 reCaptcha 整合到 ASP.NET MVC 应用程序（作者注：不要错过了 DimeCasts.net 的另一个短片，我从中学到了很多）。我的经验法则是对所有数据修改方法使用 HttpVerbs.Post，对所有数据读取操作使用 HttpVerbs.Get。

6. 用OutputCache修饰你的频繁调用的操作方法

当你需要返回不频繁更新的数据时使用 OutputCache 属性，最常见的例子是首页、Feed等。你在返回Html以及Json数据类型的方法中都可以使用这个属性。在使用的时候，注意只指定CacheProfile参数，不要指定任何其它东西，用 web.config 输出缓存控制节可以很好地调整它。例如：

[AcceptVerbs(HttpVerbs.Get), OutputCache(CacheProfile = "Dashboard")]
public ActionResult Dashboard(string userName, StoryListTab tab, OrderBy orderBy, int? page) {
}

在 web.config 文件中的配置：

<system.web>
    <caching>
        <outputCacheSettings>
            <outputCacheProfiles>
                <clear/>
                <!-- 15 Seconds -->
                <add
                    name="Dashboard"
                    duration="15"
                    varyByParam="*"
                    location="Client"
                    />
            </outputCacheProfiles>
        </outputCacheSettings>
    </caching>
</system.web>

请继续阅读：《ASP.NET MVC 最佳实践（二）》

相关日志

• 2009-07-08 -- ASP.NET MVC 最佳实践（四）
• 2009-07-07 -- ASP.NET MVC 最佳实践（三）
• 2009-07-01 -- ASP.NET MVC 最佳实践（二）
• 2009-04-13 -- [翻译]ASP.NET MVC动手实验1-3：开发ASP.NET MVC应用
• 2009-04-09 -- [翻译]ASP.NET MVC动手实验1-2：创建ASP.NET MVC应用
• 2009-04-09 -- [翻译]ASP.NET MVC动手系列1-1：ASP.NET MVC概述
• 2011-03-14 -- 对《优化浏览器渲染》的补充【译】
• 2011-03-10 -- CSS边框实现“无图化”设计【译】
• 2010-10-31 -- CSS技巧:如何避免IE6中的"浮动下坠"【译】
• 2010-10-25 -- 借助jQuery和Google分析服务的事件追踪深入了解用户行为【译】

通过这次练习，要创建一个分页显示用户列表的 ASP.NET MVC应用。具有显示用户资料，以及创建、修改、删除用户地址的功能。该应用共有三个控制器：用户控制器处理用户信息列表和显示用户信息；地址控制器负责用户地址的创建、编辑和删除；主页控制器负责显示站点的欢迎页面。

提示：为了确保每个步骤都正常运行，最好在每个任务结束的时候都编译整个解决方案。

任务1 – 创建实体数据模型

在本任务中你要用 实体数据模型（Entity Data Model）创建可编程实体类到数据存储结构（通常是SQL Server数据库或者其他数据库）的映射。Entity Data Model (EDM) 是在 实体框架 (Entity Framework）中专门设计来作为程序中的数据定义的。

1. 点击 开始 | 所有程序 | Microsoft Visual Studio 2008 | Microsoft Visual Studio 2008 启动 VS 2008。
2. 打开 AspNetMvcEx02-DevelopingMvcAppbegin 目录下的解决方案文件 MvcSampleApp.sln。
3. 在 解决方案浏览器 中， 打开 Views 目录下的 Shared 目录。步骤：点击目录名字前面的加号图标，选择 Site.Master 文件， 右键点击它并选择 删除 。
4. 导入提供的 Site.Master。 步骤：右键点击 Shared 文件夹， 指向 添加 然后选择 现有项。在 添加现有项 对话框中，转到 AspNetMvcAssetsShared 目录，然后选中该目录下的所有文件（实际就只有一个 Site.Master 文件），点 添加。 

   提示：与传统的 ASP.NET Web 页面一样， ASP.NET 页面视图 (.aspx 文件)可以使用母版页来为站点的通用部分提供统一的样式。

5. 创建 AdventureWorks 实体数据模型。步骤：在 解决方案浏览器 中， 在 MvcSampleApp 项目中右键点击 Models 文件夹， 指向 添加， 然后点击 新建项。

6. 在 新建项 对话框里选择 ADO.NET Entity Data Model。将要创建的项命名为 AdventureWorks.edmx，然后点 添加。 

   
   图一 添加 ADO.NET Entity Data Model

7. 在 实体模型数据向导 打开后， 选择 从数据库生成 然后点击 下一步。
8. 点击 新建连接 定义数据库连接。
9. In the Choose Data Source dialog, select Microsoft SQL Server as Data Source and click Continue. 在 选择数据库 对话框中，选择 Microsoft SQL Server 作为数据源，然后点 继续。（这一步在大部分情况下默认不出现）
10. In the Connection Properties dialog window, enter AspNetMvcLabs as Server Name, then select AdventureWorksLT database and click OK.在 连接属性 对话框里，输入你的 本地 SQL Server 安装实例 名称（例如“.”或者“.SQLEXPRESS”），然后在下方选择 AdventureWorksLT 数据库 （没有安装 SQL Server 2005 示例数据库的可以从网上下载安装），然后点击 OK。

    Note:AspNetMvcLabs is the default alias for the database server installed when the SetupEx.cmd script was run at the beginning of this lab.

     
    图二 定义数据连接

11. 回到 实体数据模型向导， 点击 下一步。
12. 在 选择数据库对象 这一步，只需要选择以下三个表： 
    • Address (SalesLT)Address
    • Customer (SalesLT)
    • CustomerAddress (SalesLT)
13. 保持 模型命名空间 这一项为默认值，点击 完成。 

     
    图三 选择要包含在模型中的数据库对象

14. 创建数据容器类 AdventureWorksRepository，这个容器类向其它类暴露数据访问方法，通过这些方法从底层数据模型获取数据实体。在 MvcSampleApp 项目中右击 Models 目录，指向 添加 然后点击 现有项。转到 AspNetMvcAssets 目录， 选择 AdventureWorksRepository.cs 文件，然后点击 添加。
    提示：更多详细信息，参见 实体数据模型 。

（未完待续）

相关日志

• 2009-04-09 -- [翻译]ASP.NET MVC动手实验1-2：创建ASP.NET MVC应用
• 2009-04-09 -- [翻译]ASP.NET MVC动手系列1-1：ASP.NET MVC概述
• 2009-07-08 -- ASP.NET MVC 最佳实践（四）
• 2009-07-07 -- ASP.NET MVC 最佳实践（三）
• 2009-07-01 -- ASP.NET MVC 最佳实践（二）
• 2009-06-28 -- ASP.NET MVC 最佳实践（一）
• 2009-04-30 -- VS2008 中 JS IntelliSense出错的解决
• 2011-03-14 -- 对《优化浏览器渲染》的补充【译】
• 2011-03-10 -- CSS边框实现“无图化”设计【译】
• 2010-10-31 -- CSS技巧:如何避免IE6中的"浮动下坠"【译】

ASP.NET MVC 框架分为 Model， View 和 Controller 三个部分。模型组件（Model）一般用于维护数据库中的持久数据层的状态。视图组件（View）由控制器挑选并渲染到适当的用户界面。默认状态下， ASP.NET MVC 框架用ASP.NET已有的 ASP.NET 页面（.aspx）、 母版页（.master）以及用户控件（.ascx）等类型来作为浏览器呈现。控制器组件（Controller）组件将用户请求定位到适当的控制器（Controller）行为（Action）和方法（Method），从请求中获取用于行为方法运行的参数值， 并处理行为和方法执行中可能产生的错误。 然后控制器用该请求对应的视图进行渲染。 默认状况下，每个组件存放在 MVC WEB 应用工程的一个独立目录下。

任务1 – 创建一个 ASP.NET MVC Web 应用工程

在这个任务中你将通过Visual Studio的MVC模板创建和配置一个空的 ASP.NET MVC 应用工程。

1. 打开 Microsoft Visual Studio 2008：依次点击 开始|所有程序|Microsoft Visual Studio 2008|Microsoft Visual Studio 2008.
2. 点击 文件 菜单， 指向 新建， 然后点击 项目。
3. 在 新建项目 对话框中，确保右上角选中的版本为 .NET Framework 3.5，在 项目类型 下选择 Visual C#，然后在 Visual Studio 已安装的模板 中选择 ASP.NET MVC Web Application 类型。你可以设置项目位置为 你的路径AspNetMvcEx01-CreatingMvcAppbegin 作为项目目录。
4. 修改 名称 为 MvcSampleApp 然后点击 确定 。 图一：创建新项目对话框
   在点击 确定 按钮之后，Visual Studio 会问你是否同时创建测试项目（would you like to create a test project）。选择 Yes， 输入 MvcSampleApp.Test 作为项目名称（Name of the Project）， 然后点击 确定（OK）。注：我安装的是Visual Studio 2008 SP1 简体中文版 + ASP.NET MVC 1.0，在我的系统上，创建测试项目的对话框为英文，因此这里加上英文对照。
   提示：当你创建一个新的MVC Web应用时， Visual Studio 会为你提供同时创建两个项目的选择，第一个项目是Web项目用来实现你的应用，第二个项目是一个测试项目，你可以在其中为你的MVC组件编写单元测试。
   
   图二：创建 MVC 单元测试项目
   提示：测试项目对话框中的 测试框架（Test Framework） 下拉列表现在只有一个 Visual Studio Unit Test，这个列表是可扩展的，在你的机器上安装了其他测试框架的时候，它将会包含其他的测试框架供你选择。由此你可以容易地用你喜欢的单元测试框架来为你的 ASP.NET MVC 应用编写单元测试。
5. 在Visual Studio 中配置站点使用端口 50000。这一步是为了和本动手实验中的后续联系保持一致所必须的。
   1. 在 解决方案浏览器 中，右击 MvcSampleApp 项目，并在上下文菜单中选择 属性 。
   2. 在 属性 页中，打开 Web 标签。
   3. In the Servers section select Specific Port. 在 服务器 设置项下面，选择 使用Visual Studio开发服务器，并选中 特定端口 。
   4. 设置端口号为 50000 。
   5. 按下 Ctr + S 保存所做的改动。

   
   图三：配置本地测试属性

相关日志

• 2009-04-13 -- [翻译]ASP.NET MVC动手实验1-3：开发ASP.NET MVC应用
• 2009-04-09 -- [翻译]ASP.NET MVC动手系列1-1：ASP.NET MVC概述
• 2009-07-08 -- ASP.NET MVC 最佳实践（四）
• 2009-07-07 -- ASP.NET MVC 最佳实践（三）
• 2009-07-01 -- ASP.NET MVC 最佳实践（二）
• 2009-06-28 -- ASP.NET MVC 最佳实践（一）
• 2011-03-14 -- 对《优化浏览器渲染》的补充【译】
• 2009-06-22 -- Whatever:hover – 无需javascript让IE支持丰富伪类
• 2009-04-30 -- VS2008 中 JS IntelliSense出错的解决
• 2011-03-10 -- CSS边框实现“无图化”设计【译】

• 模型（Models）：模型对象一般是在应用中实现逻辑域的部分。通常情况下，模型对象用于在数据库中取得和存储模型状态。
• 视图（Views）：视图是应用中显示用户界面（UI）的组件。典型状况下，用户界面是根据模型数据创建。比如一个产品表的编辑视图中可能包括基于当前产品对象状态的文本框、下拉列表以及单选、复选框等。
• 控制器（Controllers）：控制器是处理用户交互，操作对应模型、最后选择相应视图来渲染用户界面的组件。在一个MVC架构的应用中，视图只用于显示信息；控制器对用户的输入和交互行为进行处理和响应。

MVC模式可以帮助你将应用拆分的不同方面拆分以形成多层结构（输入逻辑、商业逻辑和用户界面逻辑等），并为这些不同的层提供宽松的耦合关系。这样你就能在开发过程中一次只将精力集中于实现其中的一个方面。除了在处理复杂事务的优势外，调试基于MVC模式的应用也比调试传统ASP.NET WEB应用程序更容易， 因此MVC模式鼓励使用测试驱动开发（TDD: Test-driven development）来创建应用程序。

ASP.NET MVC 框架为ASP.NET Web Forms开发人员提供了创建基于MVC的WEB应用的选择。ASP.NET MVC 框架是一个轻量级的、高可测试性的框架，它与基于Web Forms的应用程序一样，结合了现有的ASP.NET特性，例如母版页和基于用户（Membership-based）的认证等。

除此之外，MVC应用程序三个主要组件之间的宽耦合更方便进行多人并行开发。例如，一个开发人员开发试图，另一个开发人员开发逻辑控制器，与此同时还有一个开发人员在模型层进行商业逻辑开发。

目标

在这个动手实验室系列中，你将学习到：

• 认识和了解 ASP.NET MVC 框架；
• 创建一个 ASP.NET MVC 应用程序；
• 在创建 ASP.NET MVC 应用程序的过程中执行测试。

系统需求

为了完成此实验，你必须具备以下的系统配置环境：

• Microsoft Visual Studio 2008 SP1
• Microsoft ASP.NET MVC 1.0
• Microsoft SQL 2005 or Microsoft SQL 2008 (体验版或更高版本)
• Adventure Works 示例数据库
  • Microsoft SQL 2005 下使用: AdventureWorksLT.msi

    备注： 该 msi 安装程序只是将示例数据库文件拷贝到你的文件系统中；你还需要手动在SQL SERVER服务器中附加该数据库。更多信息，请参考 如何：在SQL Server Management Studio 中附加数据库.
    Vista 用户请注意： 确认将数据库文件安装到 “C:Program Files”以外的目录， 因为该文件夹具有额外的权限设置，可能会由于文件的只读属性造成你无法在工程文件中进行保存。

  • Microsoft SQL 2008 下使用: AdventureWorks 2008 sample databases

    备注： 该 msi 安装程序只是将示例数据库拷贝到你的文件系统中；不过，你只需要用到 AdventureWorksLT 数据库。

     

安装

本实验所需的所有必备组件可以用依赖性检测工具来检验。要确定所有项目都已正确配置，请执行以下步骤：

备注：要执行以下安装步骤，你需要在以管理员身份运行的命令提示窗口（cmd.exe）中运行所有脚本。

1. 如果以前从没有进行过依赖性检测，请运行依赖性检测工具。要进行检测，运行 CheckDepenencies.cmd 脚本，该脚本位于 %TrainingKitInstallation%LabsaspNetMvcSetup 目录。根据向导提示扫描并安装任何缺少的组件（安装后，如果需要可以重新扫描）。

   提示：为了方便起见，在这个实验中你将用到的绝大部分代码会安装在Visual Studio 的 代码片段（code snippets）中。CheckDependencies.cmd 结束时会自动加载 Visual Studio 安装管理器来安装代码片段。

练习

这个动手实验中包含以下练习：

1. 创建 ASP.NET MVC 应用程序
2. 开发和完善 ASP.NET MVC 应用程序
3. 测试 ASP.NET MVC 应用程序

完成整个实验预计需要时间: 90分钟。

补充说明:

每个练习中都包含一个起始解决方案，起始解决方案中缺少的代码将在练习工程中完成。因此如果你直接运行起始解决方案，将不能正常执行。
在每个练习中你还可以找到一个 End 目录，其中包括了在整个练习结束时你应该得到的解决方案。在练习过程中如果你需要额外的帮助，可以参考该解决方案。

（文本翻译自 ASP.NET MVC Training Kit，下载地址：http://www.microsoft.com/downloads/details.aspx?FamilyID=1E0BE0B2-910A-4676-9F3A-41E4D9C0FC08&displaylang=en）

相关日志

• 2009-04-13 -- [翻译]ASP.NET MVC动手实验1-3：开发ASP.NET MVC应用
• 2009-04-09 -- [翻译]ASP.NET MVC动手实验1-2：创建ASP.NET MVC应用
• 2009-07-08 -- ASP.NET MVC 最佳实践（四）
• 2009-07-07 -- ASP.NET MVC 最佳实践（三）
• 2009-07-01 -- ASP.NET MVC 最佳实践（二）
• 2009-06-28 -- ASP.NET MVC 最佳实践（一）
• 2009-04-30 -- VS2008 中 JS IntelliSense出错的解决
• 2011-03-14 -- 对《优化浏览器渲染》的补充【译】
• 2011-03-10 -- CSS边框实现“无图化”设计【译】
• 2010-10-31 -- CSS技巧:如何避免IE6中的"浮动下坠"【译】