上一篇介绍了 MVC中实现动态自定义路由 的实现,本篇将介绍Razor视图中以全局方式调用后台方法输出页面代码的三种方法。

框架最新的升级实现了一个页面部件功能,其实就是通过后台方法查询数据库内容,把查询结果的 HTML 代码呈现到 Razor 视图中,考虑到灵活性,需要能在任意 Razor 视图中调用该方法,这样任意 Razor 页面都能以统一的方式方便地共享该页面部件的 HTML 内容,这对于代码的重用性和可维护性都是非常有必要的。

为实现上述要求,本文介绍如下可供选择的三种方式。

  1、扩展静态类 Helper 方法,返回 HtmlString

  1)可参考如下代码:

public static class ImageHelper
{
  public static HtmlString Image(this HtmlHelper helper, string id, string url, string alternateText)
    {
        return Image(helper, id, url, alternateText, null);
    }

    public static HtmlString Image(this HtmlHelper helper, string id, string url, string alternateText, object htmlAttributes)
    {
        // Instantiate a UrlHelper
        var urlHelper = new UrlHelper(helper.ViewContext.RequestContext);

        // Create tag builder
        var builder = new TagBuilder("img");

        // Create valid id
        builder.GenerateId(id);

        // Add attributes
        builder.MergeAttribute("src", urlHelper.Content(url));
        builder.MergeAttribute("alt", alternateText);
        builder.MergeAttributes(new RouteValueDictionary(htmlAttributes));

        // Render tag
        var ret = new MvcHtmlString(builder.ToString(TagRenderMode.SelfClosing));

        return ret;
    }
}

  2)此时界面可以这样调用:

@Html.Image("my-id", "~/Content/my-img.png", "Alt Text")

  总结:此方式最简单,但缺点也非常明显,因为是静态类,无法方便的进行依赖注入以调用其他实例方法。

  2、继承 WebViewPage<TModel> 实现自定义的 WebViewPage ,在子类中实现返回界面 HTML 字符串的方法。

此种方式可参照Abp框架中多语言的本地化实现过程,步骤如下:

  1)继承 WebViewPage 类

public abstract class AbpWebViewPage<TModel> : WebViewPage<TModel>

  2)实现方法,返回指定 Key 名称的本地化语言字符串

/// <summary>
/// Gets localized string for given key name and current language.
/// </summary>
/// <param name="name">Key name</param>
/// <returns>
/// Localized string
/// </returns>
protected virtual string L(string name)
{
    return this._localizationSource.GetString(name);
}

  3)在 Web.config 中配置视图基类

<system.web.webPages.razor>
<host factoryType="System.Web.Mvc.MvcWebRazorHostFactory, System.Web.Mvc, Version=5.2.3.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35" />
<pages pageBaseType="Yb.AbpZero.Web.Views.AbpZeroTemplateWebViewPageBase">
<namespaces>
<add namespace="System.Web.Mvc" />
<add namespace="System.Web.Mvc.Ajax" />
<add namespace="System.Web.Mvc.Html" />
<add namespace="System.Web.Routing" />
<add namespace="System.Web.Optimization" />
<add namespace="Yb.AbpZero.Web" />
<add namespace="Yb.AbpZero.Localization" />
</namespaces>
</pages>
</system.web.webPages.razor>

  4)这样视图页面上就可以方便的调用 @L("Dashboard") 代码输出对应语言的字符串内容

  总结:此种方式需要在指定文件夹下的 Web.config 中配置页面视图的基类,在未配置的页面中无法进行方法的调用

  3、推荐的最佳方案

我们换种方式实现 Helper 方法,通过使用全局 Razor 视图中的 Helper 代码去访问后台方法并输出结果

  1)继承 System.Web.WebPages.HelperPage ,并重写 Html 属性

此处需要注意的是 System.Web.WebPages.HelperPage 的 Html 对象和如下重写的 Html 对象不是同一个类,为便于记忆、统一以 MVC Razor 中的关键字进行界面调用,我们此处还是把属性名称定义为 Html 。

public class HelperPage : System.Web.WebPages.HelperPage
{
    // Workaround - exposes the MVC HtmlHelper instead of the normal helper
    public static new HtmlHelper Html
    {
      get { return ((WebViewPage) WebPageContext.Current.Page).Html; }
    }
}

  2)把 Helper 方法放到 App_Code 文件夹下的 Razor 视图中

我们已经知道Razor可以访问本路径下其他 Razor 视图中定义的 Helper 方法,但现在我们考虑的是任意路径下 Razor 视图可均共享该 Helper 方法。

首先在 App_Code 文件夹下创建一个 Razor 视图,该视图将会被进行动态编译,通过 Razor 的视图引擎调用后台方法输出界面所需的 HTML 代码,代码如下:

@inherits YbRapidSolution.Mvc.HelperPage
@using System.Web.Mvc.Html
@helper Partial(string id)
{
    Html.RenderAction("_Widget", "Home", new { id });
}

  3)我们在 _Widget 的后台方法中来访问数据库,然后生成页面部分视图并返回至界面,代码如下:

#region CMS部件呈现

/// <summary>
/// CMS部件呈现
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[ChildActionOnly]
public PartialViewResult _Widget(string id)
{
  if (string.IsNullOrEmpty(id))
  {
    return PartialView("E404");
  }

  var widget = _widgetService.GetById(id);
  if (widget == null)
  {
    return PartialView("E404");
  }
  if (string.IsNullOrWhiteSpace(widget.TemplatePath))
  {
    return PartialView("_Widget", widget);
  }
  return PartialView(widget.TemplatePath, widget);
}

#endregion 

  4)这样就可在任意页面进行调用如下代码生成界面所需的 Html 字符串,而字符串的内容则可放到数据库中,可在需要的时候在后台进行修改和维护:

@_Widget.Partial("31dbfb04b41e4883bab880ceec2cfef3")

  总结:此种方式无需额外配置即可实现 Helper 方法的全局共享,调用的时候可以使用自己定义的标签,代码可读性更强。

YbSoftwareFactory 代码生成插件【二十五】:Razor视图中以全局方式调用后台方法输出页面代码的三种方法的更多相关文章

  1. YbSoftwareFactory 代码生成插件【十五】:Show 一下最新的动态属性扩展功能与键值生成器功能

    YbSoftwareFactory 各种插件的基础类库中又新增了两个方便易用的功能:动态属性扩展与键值生成器,本章将分别介绍这两个非常方便的组件. 一.动态属性扩展 在实际的开发过程中,你肯定会遇到数 ...

  2. YbSoftwareFactory 代码生成插件【十四】:通过 DynamicLinq 简单实现 N-Tier 部署下的服务端数据库通用分页

    YbSoftwareFactory 的 YbRapidSolution for WinForm 插件使用CSLA.NET作为业务层,CSLA.NET的一个强大的特性是支持 N-Tiers 部署.只需非 ...

  3. YbSoftwareFactory 代码生成插件【十八】:树形结构下的查询排序的数据库设计

    树形结构的排序在中国特色下十分普遍也非常重要,例如常说的五大班子,党委>人大>政府>政协>纪委,每个班子下还有部门,岗位,人员,最终排列的顺序通常需要按权力大小.重要性等进行排 ...

  4. YbSoftwareFactory 代码生成插件【十九】:实体类配合数据库表字段进行属性扩展的小技巧

    实体类通常需要和数据库表进行了ORM映射,当你需要添加新的属性时,往往同时也需要在数据库中添加相应的字段并配置好映射关系,同时可能还需对数据访问组件进行重新编译和部署才能有效.而当你开始设计一个通用数 ...

  5. YbSoftwareFactory 代码生成插件【十六】:Web 下灵活、强大的审批流程实现(含流程控制组件、流程设计器和表单设计器)

    程序=数据结构+算法,而企业级的软件=数据+流程,流程往往千差万别,客户自身有时都搞不清楚,随时变化的情况更是家常便饭,抛开功能等不谈,需求变化很大程度上就是流程的变化,流程的变化会给开发工作造成很大 ...

  6. MyEclipse安装插件的三种方法和使用心得

    本文讲解MyEclipse(MyEclipse10)的三种方法,以TestNG为例 Eclipse update site URL:  http://beust.com/eclipse. 一.通过My ...

  7. Bootstrap入门(二十五)JS插件2:过渡效果

    Bootstrap入门(二十五)JS插件2:过渡效果 对于简单的过渡效果,只需将 transition.js 和其它 JS 文件一起引入即可.如果你使用的是编译(或压缩)版的bootstrap.js  ...

  8. Bootstrap &lt;基础二十五&gt;警告(Alerts)

    警告(Alerts)以及 Bootstrap 所提供的用于警告的 class.警告(Alerts)向用户提供了一种定义消息样式的方式.它们为典型的用户操作提供了上下文信息反馈. 您可以为警告框添加一个 ...

  9. WCF技术剖析之二十五: 元数据(Metadata)架构体系全景展现[元数据描述篇]

    原文:WCF技术剖析之二十五: 元数据(Metadata)架构体系全景展现[元数据描述篇] 在[WS标准篇]中我花了很大的篇幅介绍了WS-MEX以及与它相关的WS规范:WS-Policy.WS-Tra ...

随机推荐

  1. 关于ARC下需要dealloc的相关内容

    今天在项目中使用KVO添加观察者模式的时候,在返回上一级的时候竟然崩了.可是,看了很久,代码没有问题.最后,终于知道了需要添加dealloc 防止以后再出错,所以,便纪录下来.关于ARC下需要手动释放 ...

  2. java学习第14天(集合的框架和基本遍历)

    今天主要是接触了集合的概念,集合简单意义上来说就是类对象的集合,我们一般用Collection 这个接口来表示,集合主要体系为: Collection |--List |--ArrayList |-- ...

  3. if..elif语句

    根据用户输入内容打印其权限 # alex --> 超级管理员 # eric --> 普通管理员 # tony,rain --> 业务主管 # 其他 --> 普通用户 name ...

  4. Hadoop2.x Permission denied: user=dr.who, access=READ_EXECUTE inode=&quot;/tmp&quot;

    在hadoop2中查看网页中的/tmp目录出现下面的错误: Permission denied: user=dr.who, access=READ_EXECUTE inode="/tmp&q ...

  5. C++map类型

    map是键-值对的集合,可以理解为关联数组,可以使用键作为下标来获取一个值 本文地址:http://www.cnblogs.com/archimedes/p/cpp-map.html,转载请注明源地址 ...

  6. AngularJs遇到的小坑与技巧

    1. templateURL和路由之类的要在web server下运行. 2. 使用模板replace设为true,模板里也要有相应的标签,否则不出现任何数据. 3. 1.2版本之后,ngRoute模 ...

  7. 【HDOJ】2242 考研路茫茫——空调教室

    tarjan缩点,然后树形dp一下可解.重点是重边的处理. /* 2242 */ #include <iostream> #include <sstream> #include ...

  8. Codeforces Round #197 (Div. 2) : A

    水题一个: 直接贴代码: #include<cstdio> #include<algorithm> #include<cstring> using namespac ...

  9. Spring MVC中一般 普通类调用service

    在Spring MVC中,Controller中使用service只需使用注解@Resource就行,但是一般类(即不使用@Controller注解的类)要用到service时,可用如下方法: 1.S ...

  10. JAVA-基础语法篇

    JAVA-基础语法篇 一.     基础语法: 对大小写敏感 类名的首字母大写 方法名首字母小写,后面用驼峰发命名 源文件名和类名要相同 主方法入口: public static void main( ...