一步一步封装自己的HtmlHelper组件BootstrapHelper（二）
前言：介绍了下封装BootstrapHelper的一些基础知识，这篇继续来完善下。参考HtmlHelper的方式，这篇博主先来封装下一些常用的表单组件。关于BootstrapHelper封装的意义何在，上篇评论里面已经讨论得太多，这里也不想过多纠结。总之一句话：凡事有得必有失，就看你怎么去取舍。有兴趣的可以看看，没兴趣的权当博主讲了个“笑话”吧。
BootstrapHelper系列文章目录
一、新增泛型的BootstrapHelper
上篇博主只定义了一个BootstrapHelper的普通类型去继承HtmlHelper，由于考虑到需要使用lamada的方式去定义组件，博主又增加了一个BootstrapHelper的泛型类型。于是BootstrapHelper变成了这样。
namespace BootstrapExtensions
{
public class BootstrapHelper : System.Web.Mvc.HtmlHelper
{
///
/// 使用指定的视图上下文和视图数据容器来初始化 BootstrapHelper 类的新实例。
///
/// <param name="viewContext">视图上下文
/// <param name="viewDataContainer">视图数据容器
public BootstrapHelper(ViewContext viewContext,IViewDataContainer viewDataContainer)
: base(viewContext,viewDataContainer)
{ }
///
/// 使用指定的视图上下文、视图数据容器和路由集合来初始化 BootstrapHelper 类的新实例。
///
/// <param name="viewContext">视图上下文
/// <param name="viewDataContainer">视图数据容器
/// <param name="routeCollection">路由集合
public BootstrapHelper(ViewContext viewContext,IViewDataContainer viewDataContainer,RouteCollection routeCollection)
: base(viewContext,viewDataContainer,routeCollection)
{ }
}
///
/// 表示支持在强类型视图中呈现 Bootstrap 控件。
///
/// <typeparam name="TModel">
public class BootstrapHelper : BootstrapHelper
{
///
/// 使用指定的视图上下文和视图数据容器来初始化 <![CDATA[Net.Web.Mvc.BootstrapHelper]]> 类的新实例。
///
/// <param name="viewContext">视图上下文。
/// <param name="viewDataContainer">视图数据容器。
public BootstrapHelper(ViewContext viewContext,viewDataContainer)
{ }
///
/// 使用指定的视图上下文、视图数据容器和路由集合来初始化 <![CDATA[Net.Web.Mvc.BootstrapHelper]]> 类的新实例。
///
/// <param name="viewContext">视图上下文。
/// <param name="viewDataContainer">视图数据容器。
/// <param name="routeCollection">路由集合。
public BootstrapHelper(ViewContext viewContext,routeCollection)
{ }
}
}
我们的Bootstrap对象也定义成泛型对象
: System.Web.Mvc.WebViewPage
{
//在cshtml页面里面使用的变量
public BootstrapHelper Bootstrap { get; set; }
///
/// 初始化Bootstrap对象
///
public override void InitHelpers()
{
base.InitHelpers();
Bootstrap = new BootstrapHelper(ViewContext,this);
}
public override void Execute()
{
//throw new NotImplementedException();
}
}
这样做的意义就是为了在cshtml页面里面可以使用@Bootstrap.TextBoxFor(x => x.Name)这种写法。这个后面介绍，这里先埋个伏笔。
二、TextBoxExtensions
TextBoxExtensions.cs的实现代码如下：
<div class="jb51code">
<pre class="brush:csharp;">
using System;
using System.Collections.Generic;
using System.Linq;
using System.Linq.Expressions;
using System.Reflection;
using System.Web;
using System.Web.Mvc;
using System.Web.Mvc.Html;
namespace BootstrapExtensions
{
///
/// bootstrap TextBox文本框的所有扩展
///
public static class TextBoxExtensions
{
///
/// 通过使用指定的 HTML 帮助器和窗体字段的名称，返回文本框标签
///
/// <param name="html">扩展方法实例
/// <param name="name">表单元素的name属性值
/// 返回input type='text'标签
public static MvcHtmlString TextBox(this BootstrapHelper html,string name)
{
return InputExtensions.Helper(html,InputType.Text,null,name,false,null);
}
///
/// 通过使用指定的 HTML 帮助器和窗体字段的名称，返回文本框标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">表单元素的name属性值
/// 返回input type='text'标签
public static MvcHtmlString TextBox(this BootstrapHelper html,string id,id,null);
}
///
/// 通过使用指定的 HTML 帮助器和窗体字段的名称，返回文本框标签
///
/// <param name="html">扩展方法实例
/// <param name="name">单元素的name属性值
/// <param name="value">表单元素的value值
/// 返回input type='text'标签
public static MvcHtmlString TextBox(this BootstrapHelper html,string name,object value)
{
return InputExtensions.Helper(html,value,null);
}
///
/// 通过使用指定的 HTML 帮助器和窗体字段的名称，返回文本框标签
///
/// <param name="html">扩展方法实例
/// <param name="name">单元素的name属性值
/// <param name="value">表单元素的value值
/// <param name="placeholder">bootstrap自带的文本框的提示输入值
/// 返回input type='text'标签
public static MvcHtmlString TextBox(this BootstrapHelper html,object value,string placeholder)
{
IDictionary<string,object> attributes = new Dictionary<string,object>();
if (!string.IsNullOrEmpty(placeholder))
{
attributes.Add("placeholder",placeholder);
}
return InputExtensions.Helper(html,attributes);
}
///
/// 通过使用指定的 HTML 帮助器和窗体字段的名称，返回文本框标签
///
/// <param name="html">扩展方法实例
/// <param name="name">单元素的name属性值
/// <param name="value">表单元素的value值
/// <param name="htmlAttributes">额外属性
/// 返回input type='text'标签
public static MvcHtmlString TextBox(this BootstrapHelper html,object htmlAttributes)
{
IDictionary<string,object> attributes = BootstrapHelper.AnonymousObjectToHtmlAttributes(htmlAttributes);
return InputExtensions.Helper(html,attributes);
}
///
/// 通过使用指定的 HTML 帮助器和窗体字段的名称，返回文本框标签
///
/// <param name="html">扩展方法实例
/// <param name="name">表单元素的name属性值
/// <param name="value">表单元素的value值
/// <param name="placeholder">bootstrap自带的文本框的提示输入值
/// <param name="htmlAttributes">额外属性
/// 返回input type='text'标签
public static MvcHtmlString TextBox(this BootstrapHelper html,string placeholder,object> attributes = BootstrapHelper.AnonymousObjectToHtmlAttributes(htmlAttributes);
if (!string.IsNullOrEmpty(placeholder))
{
attributes.Add("placeholder",attributes);
}
public static MvcHtmlString TextBoxFor<TModel,TProperty>(this BootstrapHelper html,Expression<Func<TModel,TProperty>> expression)
{
var model = (TModel)html.ViewData.Model;
string propertyName;
object value;
InputExtensions.GetValueByExpression<TModel,TProperty>(expression,model,out propertyName,out value);
return InputExtensions.Helper(html,propertyName,null);
}
}
}
InputExtensions.cs
<div class="jb51code">
<pre class="brush:csharp;">
using System;
using System.Collections.Generic;
using System.Linq;
using System.Linq.Expressions;
using System.Reflection;
using System.Web;
using System.Web.Mvc;
namespace BootstrapExtensions
{
///
/// Bootstrap表单元素Input扩展方法集合
///
public static class InputExtensions
{
public static MvcHtmlString Helper(BootstrapHelper html,InputType inputType,bool isCheck,IDictionary<string,object> htmlAttributes)
{
//定义标签的名称
TagBuilder tag = new TagBuilder("input");
if (htmlAttributes == null)
{
htmlAttributes = new Dictionary<string,object>();
}
//添加name
if (!string.IsNullOrEmpty(name))
{
htmlAttributes.Add("name",name);
}
//添加id
if (!string.IsNullOrEmpty(id))
{
htmlAttributes.Add("id",id);
}
//添加value
if (value != null)
{
htmlAttributes.Add("value",value.ToString());
}
//添加input的类型
tag.MergeAttribute("type",HtmlHelper.GetInputTypeString(inputType));
//添加默认样式
tag.AddCssClass("form-control");
tag.MergeAttributes(htmlAttributes);
if (inputType == InputType.Radio || inputType == InputType.CheckBox)
{
if (isCheck)
tag.MergeAttribute("checked","checked");
}
return MvcHtmlString.Create(tag.ToString());
}
///
/// 返回表单radio标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="value">input的value值
/// <param name="text">显示文本
/// <param name="labelClass">label标签的样式
/// <param name="isCheck">是否选中
/// <param name="isDisabled">是否禁用
/// <param name="oAttributes">额外标签
/// 返回radio标签
public static MvcHtmlString CheckBox(BootstrapHelper html,string text,string labelClass,bool isDisabled,object> htmlAttributes)
{
//定义标签的名称
TagBuilder tag = new TagBuilder("label");
if (!string.IsNullOrEmpty(labelClass))
{
htmlAttributes.Add("class",labelClass);
}
System.Text.StringBuilder sbInput = new System.Text.StringBuilder();
var strInputType = HtmlHelper.GetInputTypeString(inputType);
sbInput.Append("<input type='").Append(strInputType).Append("'");
if (!string.IsNullOrEmpty(name))
{
sbInput.Append(" name = '").Append(name).Append("'");
}
if (!string.IsNullOrEmpty(id))
{
sbInput.Append(" id = '").Append(id).Append("'");
}
if (value != null)
{
sbInput.Append(" value = '").Append(value.ToString()).Append("'");
}
if (isCheck)
{
sbInput.Append(" checked = 'checked'");
}
if (isDisabled)
{
sbInput.Append(" disabled");
}
sbInput.Append(" />");
if (!string.IsNullOrEmpty(text))
{
sbInput.Append(text);
}
tag.InnerHtml = sbInput.ToString();
tag.MergeAttributes(htmlAttributes);
return MvcHtmlString.Create(tag.ToString());
}
//通过表达式取当前的属性值
public static void GetValueByExpression<TModel,TProperty>(Expression<Func<TModel,TProperty>> expression,TModel model,out string propertyName,out object value)
{
MemberExpression body = (MemberExpression)expression.Body;
var lamadaName = (body.Member is PropertyInfo) ? body.Member.Name : null;
propertyName = lamadaName;
value = null;
System.Reflection.PropertyInfo[] lstPropertyInfo = typeof(TModel).GetProperties(BindingFlags.Public | BindingFlags.Instance);
var oFind = lstPropertyInfo.FirstOrDefault(x => x.Name == lamadaName);
if (oFind != null)
{
value = oFind.GetValue(model,null);
}
}
}
}
1、考虑到项目中所有基于bootstrap的TextBox文本框都有一个class="form-control"样式，所以在封装文本框的时候直接将它放到了标签里面。当然，如果你的项目里面不需要这么用，或者自定义了文本框样式，这里也可以写入自己的样式，这样就不用每次声明文本框的时候都去添加这些样式了。
2、TextBoxFor()方法里面融合了使用lamada的方式生成文本框，上面声明的泛型BootstrapHelper类型对象就派上用场了，通过反射和泛型去读取lamada里面的属性名和属性值，这里只定义了一个方法，如果还需要其他重载，可以自己新增方法。
3、在使用的时候又遇到一个问题，由于BootstrapHelper是继承至HtmlHelper类型，那么MVC里面原来封装的一些HtmlHelper的扩展方法对于我们的Bootstrap对象也是可以直接调用的，所以很多重载可能出现重复和找不到对应的重载，比如：
这样的话很容易会出现如下错误：
那么，既然问题出现了，我们就要想办法解决。博主想到的一种解决方案是：将view的web.config里面的Html对象所在的命名空间注释掉。比如：
这样的话就能够解决我们上面的问题，运行效果：
将上面的命名空间注释掉之后，在cshtml页面里面我们将不能再使用Html变量的相关扩展方法，如果你自己的Helper够用，不用原生的扩展方法问题应该也不大。
三、RadioExtensions和CheckBoxExtensions
关于bootstrap里面的radio和checkBox组件，博主参考了下
RadioExtensions.cs
namespace BootstrapExtensions
{
public static class Ra
dioExtensions
{
///
/// 返回表单radio标签
///
/// <param name="html">扩展
方法实例
/// <param name="name">name
属性
///
返回radio标签
public static MvcHtmlString Ra
dio(this BootstrapHelper html,string name)
{
return Ra
dio(html,null);
}
///
/// 返回表单radio标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// 返回radio标签
public static MvcHtmlString Radio(this BootstrapHelper html,null);
}
///
/// 返回表单radio标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="isCheck">是否选中
/// 返回radio标签
public static MvcHtmlString Radio(this BootstrapHelper html,bool isCheck)
{
return Radio(html,isCheck,null);
}
///
/// 返回表单radio标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="value">input的value值
/// 返回radio标签
public static MvcHtmlString Radio(this BootstrapHelper html,object value)
{
return Radio(html,null);
}
///
/// 返回表单radio标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="value">input的value值
/// <param name="text">显示文本
/// 返回radio标签
public static MvcHtmlString Radio(this BootstrapHelper html,string text)
{
return Radio(html,text,null);
}
///
/// 返回表单radio标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="value">input的value值
/// <param name="text">显示文本
/// <param name="isCheck">是否选中
/// 返回radio标签
public static MvcHtmlString Radio(this BootstrapHelper html,null);
}
///
/// 返回表单radio标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="value">input的value值
/// <param name="text">显示文本
/// <param name="labelClass">label标签的样式
/// 返回radio标签
public static MvcHtmlString Radio(this BootstrapHelper html,string labelClass)
{
return Radio(html,labelClass,null);
}
///
/// 返回表单radio标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="value">input的value值
/// <param name="text">显示文本
/// <param name="labelClass">label标签的样式
/// <param name="isCheck">是否选中
/// 返回radio标签
public static MvcHtmlString Radio(this BootstrapHelper html,null);
}
///
/// 返回表单radio标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="value">input的value值
/// <param name="text">显示文本
/// <param name="labelClass">label标签的样式
/// <param name="isCheck">是否选中
/// <param name="isDisabled">是否禁用
/// 返回radio标签
public static MvcHtmlString Radio(this BootstrapHelper html,bool isDisabled)
{
return Radio(html,isDisabled,null);
}
///
/// 返回表单radio标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="value">input的value值
/// <param name="text">显示文本
/// <param name="labelClass">label标签的样式
/// <param name="isCheck">是否选中
/// <param name="isDisabled">是否禁用
/// <param name="oAttributes">额外标签
/// 返回radio标签
public static MvcHtmlString Radio(this BootstrapHelper html,object oAttributes)
{
IDictionary<string,object> htmlAttributes = null;
if (oAttributes != null)
{
htmlAttributes = BootstrapHelper.AnonymousObjectToHtmlAttributes(oAttributes);
}
else
{
htmlAttributes = new Dictionary<string,object>();
}
return InputExtensions.CheckBox(html,InputType.Radio,htmlAttributes);
}
}
}
CheckBoxExtensions.cs
<div class="jb51code">
<pre class="brush:csharp;">
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
namespace BootstrapExtensions
{
public static class CheckBoxExtensions
{
///
/// 返回表单CheckBox标签
///
/// <param name="html">扩展方法实例
/// <param name="name">name属性
/// 返回CheckBox标签
public static MvcHtmlString CheckBox(this BootstrapHelper html,string name)
{
return CheckBox(html,null);
}
///
/// 返回表单CheckBox标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// 返回CheckBox标签
public static MvcHtmlString CheckBox(this BootstrapHelper html,null);
}
///
/// 返回表单CheckBox标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="isCheck">是否选中
/// 返回CheckBox标签
public static MvcHtmlString CheckBox(this BootstrapHelper html,bool isCheck)
{
return CheckBox(html,null);
}
///
/// 返回表单CheckBox标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="value">input的value值
/// 返回CheckBox标签
public static MvcHtmlString CheckBox(this BootstrapHelper html,object value)
{
return CheckBox(html,null);
}
///
/// 返回表单CheckBox标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="value">input的value值
/// <param name="text">显示文本
/// 返回CheckBox标签
public static MvcHtmlString CheckBox(this BootstrapHelper html,string text)
{
return CheckBox(html,null);
}
///
/// 返回表单CheckBox标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="value">input的value值
/// <param name="text">显示文本
/// <param name="isCheck">是否选中
/// 返回CheckBox标签
public static MvcHtmlString CheckBox(this BootstrapHelper html,null);
}
///
/// 返回表单CheckBox标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="value">input的value值
/// <param name="text">显示文本
/// <param name="labelClass">label标签的样式
/// 返回CheckBox标签
public static MvcHtmlString CheckBox(this BootstrapHelper html,string labelClass)
{
return CheckBox(html,null);
}
///
/// 返回表单CheckBox标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="value">input的value值
/// <param name="text">显示文本
/// <param name="labelClass">label标签的样式
/// <param name="isCheck">是否选中
/// 返回CheckBox标签
public static MvcHtmlString CheckBox(this BootstrapHelper html,null);
}
///
/// 返回表单CheckBox标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="value">input的value值
/// <param name="text">显示文本
/// <param name="labelClass">label标签的样式
/// <param name="isCheck">是否选中
/// <param name="isDisabled">是否禁用
/// 返回CheckBox标签
public static MvcHtmlString CheckBox(this BootstrapHelper html,bool isDisabled)
{
return CheckBox(html,null);
}
///
/// 返回表单CheckBox标签
///
/// <param name="html">扩展方法实例
/// <param name="id">id
/// <param name="name">name属性
/// <param name="value">input的value值
/// <param name="text">显示文本
/// <param name="labelClass">label标签的样式
/// <param name="isCheck">是否选中
/// <param name="isDisabled">是否禁用
/// <param name="oAttributes">额外标签
/// 返回CheckBox标签
public static MvcHtmlString CheckBox(this BootstrapHelper html,InputType.CheckBox,htmlAttributes);
}
}
}
