一起谈.NET技术,一句代码实现批量数据绑定[上篇]

简介:   对于一个以数据处理为主的应用中的UI层,我们往往需要编写相当多的代码去实现数据绑定。如果界面上的控件和作为数据源的实体类型之间存储某种约定的映射关系,我们就可以实现批量的数据绑定。为了验证这种想法,我写了一个小小的组件。

  对于一个以数据处理为主的应用中的UI层,我们往往需要编写相当多的代码去实现数据绑定。如果界面上的控件和作为数据源的实体类型之间存储某种约定的映射关系,我们就可以实现批量的数据绑定。为了验证这种想法,我写了一个小小的组件。这个小玩意仅仅是我花了两个小时写的,其中还有很多问题没有解决,比如对于空值的处理,特殊控件属性值的HTML编码问题,以及频繁反射的性能问题,仅仅演示一种解决思路而已。本篇着重介绍如何通过这个组件来解决我们在进行数据绑定过程中的常见问题,下篇会介绍它的设计。[源代码从这里下载]

目录:
一、基于控件ID/实体属性名映射的数据绑定
二、一句代码实现批量数据绑定
三、修正绑定数据的显示格式
四、过滤不需要绑定的属性
五、多个控件对应同一个实体属性

  一、基于控件ID/实体属性名映射的数据绑定

  我的这个组件暂时命名为DataBinder好了(注意和System.Web.UI.DataBinder区分),我们用它来将一个实体对象绑定给指定的容器控件中的所有子控件。下面是DataBinder的定义,两个BindData方法实现具体的绑定操作。

 
 
public class DataBinder
{
public event EventHandler < DataBindingEventArgs > DataItemBinding;
public event EventHandler < DataBindingEventArgs > DataItemBound;

public static IEnumerable < BindingMapping > BuildBindingMappings(Type entityType, Control container, string suffix = "" );

public void BindData( object entity, Control container, string suffix = "" );
public void BindData( object entity,IEnumerable < BindingMapping > bindingMappings);
}

  本文开头所说,自动批量的数据绑定依赖于控件和作为数据源实体类型的映射关系。在这里,我直接采用控件ID和实体属性名之间的映射。也就是说,在对于界面上控件进行命名的时候,应该根据对应的实体类型属性名进行规范命名。

  另一方面,作为数据源的对象来说,它的所有属性并不都是为数据绑定而涉及。为了让DataBinder能够自动筛选用于绑定的属性,我在相应的属性上应用了一个自定义特性:DataPropertyAttribute。比如,下面的Customer对象会在后续的演示中用到,它的每一个数据属性都应用了这样一个DataPropertyAttribute特性。

 
 
public class Cutomer
{
[DataProperty]
public string ID { get ; set ; }
[DataProperty]
public string FirstName { get ; set ; }
[DataProperty]
public string LastName { get ; set ; }
[DataProperty]
public string Gender { get ; set ; }
[DataProperty]
public int ? Age { get ; set ; }
[DataProperty]
public DateTime ? BirthDay { get ; set ; }
[DataProperty]
public bool ? IsVip { get ; set ; }
}

  二、一句代码实现批量数据绑定

  现在我们就来演示如何通过我们定义的DataBinder实现“一句代码的数据批量绑定”,而作为数据源就是我们上面定义的Customer对象。我们先来设计我们的页面,下面是主体部分的HTML,这是一个表格。需要注意的是:所有需要绑定到Customer对象的空间都和对应的属性具有相同的ID。

 
 
< table >
< tr >
< td style ="width:20%;text-align:right" > ID: </ td >
< td >< asp:Label ID ="ID" runat ="server" ></ asp:Label ></ td >
</ tr >
< tr >
< td style ="width:20%;text-align:right" > First Name: </ td >
< td >< asp:TextBox ID ="FirstName" runat ="server" ></ asp:TextBox ></ td >
</ tr >
< tr >
< td style ="width:20%;text-align:right" > Last Name: </ td >
< td >< asp:TextBox ID ="LastName" runat ="server" ></ asp:TextBox ></ td >
</ tr >
< tr >
< td style ="width:20%;text-align:right" > Gender: </ td >
< td >
< asp:RadioButtonList ID ="Gender" runat ="server" RepeatDirection ="Horizontal" >
< asp:ListItem Text ="Male" Value = "Male" />
< asp:ListItem Text ="Female" Value = "Female" />
</ asp:RadioButtonList >
</ td >
</ tr >
< tr >
< td style ="width:20%;text-align:right" > Age: </ td >
< td >< asp:TextBox ID ="Age" runat ="server" ></ asp:TextBox ></ td >
</ tr >
< tr >
< td style ="width:20%;text-align:right" > Birthday: </ td >
< td >< asp:TextBox ID ="Birthday" runat ="server" Width ="313px" ></ asp:TextBox ></ td >
</ tr >
< tr >
< td style ="width:20%;text-align:right" > Is VIP: </ td >
< td >< asp:CheckBox ID ="IsVip" runat ="server" ></ asp:CheckBox ></ td >
</ tr >
< tr >
< td colspan ="2" align ="center" >
< asp:Button ID ="ButtonBind" runat ="server" Text ="Bind" onclick ="ButtonBind_Click" />
</ td >
</ tr >
</ table >

  为了编成方便,将DataBinder对象作为Page类型的一个属性,该属性在构造函数中初始化。

 
 
public partial class Default : System.Web.UI.Page
{
public Artech.DataBinding.DataBinder DataBinder { get ; private set ; }
public Default()
{
this .DataBinder = new Artech.DataBinding.DataBinder();
}
}

  然后我将数据绑定操作实现的Bind按照的Click事件中,对应所有的代码如下所示——真正的用于数据绑定的代码只有一句。

 
 
protected void ButtonBind_Click( object sender, EventArgs e)
{
var customer
= new Customer
{
ID
= Guid.NewGuid().ToString(),
FirstName
= " Zhang " ,
LastName
= " San " ,
Age
= 30 ,
Gender
= " Male " ,
BirthDay
= new DateTime( 1981 , 1 , 1 ),
IsVip
= true
};
this .DataBinder.BindData(customer, this );
}

  在浏览器中打开该Web页面,点击Bind按钮,你会发现绑定的数据已经正确显示在了对应的控件中:

image  三、修正绑定数据的显示格式

  虽然通过DataBinder实现了对多个控件的批量绑定,但是并不完美。一个显著的问题是:作为生日的字段不仅仅显示了日期,还显示了时间。我们如何让日期按照我们要求的格式进行显示呢?DataBinder为了提供了三种选择。

  如果你注意看DataBinder定义了,你会发现它定义了两个事件:DataItemBinding和DataItemBound(命名有待商榷),它们分别在对某个控件进行绑定之前和之后触发。我们的第一种方案就是注册DataItemBinding时间,为Birthday指定一个格式化字符串。假设我们需要的格式是“月-日-年”,那么我们指定的格式化字符串:MM-dd-yyyy。事件注册我方在了Page的构造函数中:

 
 
public Default()
{
this .DataBinder = new Artech.DataBinding.DataBinder();
this .DataBinder.DataItemBinding += (sender, args) =>
{
if (args.BindingMapping.Control == this .Birthday)
{
args.BindingMapping.FormatString
= " MM-dd-yyyy " ;
}
};
}

  运行程序,你会发现作为生日的字段已经按照我们希望的格式显示出来:

image

  上面介绍了通过注册DataItemBinding事件在绑定前指定格式化字符串的解决方案,你也可以通过注册DataItemBound事件在绑定后修正显示的日期格式,相应的代码如下:

 
 
public Default()
{
this .DataBinder = new Artech.DataBinding.DataBinder();
this .DataBinder.DataItemBound += (sender, args) =>
{
if (args.BindingMapping.Control == this .Birthday && null != args.DataValue)
{
this .Birthday.Text = ((DateTime)Convert.ChangeType(args.DataValue, typeof (DateTime))).
ToString(
" MM-dd-yyyy " );
}
};
}

  DataBinder定义了两个BindData重载,我们使用的是通过指定数据源和容器控件的方式,而另一个重载的参数为IEnumerable<BindingMapping>类型。而BindingMapping是我们自定义的类型,用于表示控件和实体属性之间的运行时映射关系。而这样一个BindingMapping集合,可以通过DataBinder的静态方法BuildBindingMappings来创建。BindingMapping具有一个FormatString表示格式化字符串(实际上面我们指定的格式化字符串就是为这个属性指定的)。那么,我们也可以通过下面的代码来进行数据绑定:

 
 
protected void ButtonBind_Click( object sender, EventArgs e)
{
var customer
= new Customer
{
ID
= Guid.NewGuid().ToString(),
FirstName
= " Zhang " ,
LastName
= " San " ,
Age
= 30 ,
Gender
= " Male " ,
BirthDay
= new DateTime( 1981 , 1 , 1 ),
IsVip
= true
};
var bindingMappings
= Artech.DataBinding.DataBinder.BuildBindingMappings( typeof (Customer), this );
bindingMappings.Where(mapping
=> mapping.Control == this .Birthday).First().FormatString = " MM-dd-yyyy " ;
this .DataBinder.BindData(customer, bindingMappings);
}

  四、过滤不需要绑定的属性

  在默认的情况下,第一个BindData方法(指定容器控件)会遍历实体的所有属性,将其绑定到对应的控件上。可能在有的时候,对于某些特殊的属性,我们不需要进行绑定。比如,某个控件的ID虽然符合实体属性的映射,但是它们表示的其实根本不是相同性质的数据。

  为了解决在这个问题,在BindingMapping类型中定义了一个布尔类型的AutomaticBind属性。如果你在绑定前将该属性设置成False,那么基于该BindingMapping的数据绑定将被忽略。如果你调用BindData(object entity, Control container, string suffix = "")这个重载,你可以通过注册DataItemBinding事件将相应BindingMapping的AutomaticBind属性设置成False。如果你调用BindData( object entity,IEnumerable<BindingMapping> bindingMappings)这个重载,你只需要在调用之间将相应BindingMapping的AutomaticBind属性设置成False。

  我们将我们的程序还原成最初的状态,现在通过注册BindingMapping事件将基于Birthday的BindingMapping的AutomaticBind属性设置成False:

 
 
public Default()
{
this .DataBinder = new Artech.DataBinding.DataBinder();
this .DataBinder.DataItemBinding += (sender, args) =>
{
if (args.BindingMapping.Control == this .Birthday)
{
args.BindingMapping.AutomaticBind
= false ;
}
};
}

  程序执行后,Birthday对应的TextBox将不会被绑定:

image  五、多个控件对应同一个实体属性

  在上面的例子中,我们的控件的ID和对应的实体属性是相同的。但是在很多情况下,相同的页面上有不止一个控件映射到实体的同一个属性上。而控件ID的唯一性决定了我们不能为它们起相同的ID。在这种情况下,我们采用“基于后缀”的映射。也就是为,在为控件进行命名的时候,通过“实体属性名+后缀”形式来指定。

  如果你仔细看了DataBinder的定义,不论是实例方法BindData(接受Control类型参数的),还是静态方法BuildBindingMappings,都具有一个缺省参数suffix,这就是为这种情况设计的。在默认的情况下,这个参数的值为空字符串,所以我们需要控件和实体属性具有相同的名称。如果控件是基于“实体属性名+后缀”来命名的,就需要显式指定这个参数了。为了演示这种情况,我们将例子中的所有需要绑定的空间ID加上一个“_Xyz”字符作为后缀。

 
 
< table >
< tr >
< td style ="width:20%;text-align:right" > ID: </ td >
< td >< asp:Label ID ="ID_Xyz" runat ="server" ></ asp:Label ></ td >
</ tr >
< tr >
< td style ="width:20%;text-align:right" > First Name: </ td >
< td >< asp:TextBox ID ="FirstName_Xyz" runat ="server" ></ asp:TextBox ></ td >
</ tr >
< tr >
< td style ="width:20%;text-align:right" > Last Name: </ td >
< td >< asp:TextBox ID ="LastName_Xyz" runat ="server" ></ asp:TextBox ></ td >
</ tr >
< tr >
< td style ="width:20%;text-align:right" > Gender: </ td >
< td >
< asp:RadioButtonList ID ="Gender_Xyz" runat ="server" RepeatDirection ="Horizontal" >
< asp:ListItem Text ="Male" Value = "Male" />
< asp:ListItem Text ="Female" Value = "Female" />
</ asp:RadioButtonList >
</ td >
</ tr >
< tr >
< td style ="width:20%;text-align:right" > Age: </ td >
< td >< asp:TextBox ID ="Age_Xyz" runat ="server" ></ asp:TextBox ></ td >
</ tr >
< tr >
< td style ="width:20%;text-align:right" > Birthday: </ td >
< td >< asp:TextBox ID ="Birthday_Xyz" runat ="server" Width ="313px" ></ asp:TextBox ></ td >
</ tr >
< tr >
< td style ="width:20%;text-align:right" > Is VIP: </ td >
< td >< asp:CheckBox ID ="IsVip_Xyz" runat ="server" ></ asp:CheckBox ></ td >
</ tr >
< tr >
< td colspan ="2" align ="center" >
< asp:Button ID ="ButtonBind" runat ="server" Text ="Bind" onclick ="ButtonBind_Click" />
</ td >
</ tr >
</ table >

  如果采用指定容器控件进行直接绑定的话,就可以这样编程:

 
 
protected void ButtonBind_Click( object sender, EventArgs e)
{
var customer
= new Customer
{
ID
= Guid.NewGuid().ToString(),
FirstName
= " Zhang " ,
LastName
= " San " ,
Age
= 30 ,
Gender
= " Male " ,
BirthDay
= new DateTime( 1981 , 1 , 1 ),
IsVip
= true
};
this .DataBinder.BindData(customer, this , " _Xyz " );
}

  如果通过预先创建的BindingMapping集合进行数据绑定,那么代码将是这样:

 
 
protected void ButtonBind_Click( object sender, EventArgs e)
{
var customer
= new Customer
{
ID
= Guid.NewGuid().ToString(),
FirstName
= " Zhang " ,
LastName
= " San " ,
Age
= 30 ,
Gender
= " Male " ,
BirthDay
= new DateTime( 1981 , 1 , 1 ),
IsVip
= true
};

var bindingMappings
= Artech.DataBinding.DataBinder.BuildBindingMappings( typeof (Customer), this , " _Xyz " );
this .DataBinder.BindData(customer, bindingMappings);
}
目录
相关文章
|
12天前
|
人工智能 开发框架 量子技术
【专栏】.NET 技术:驱动创新的力量
【4月更文挑战第29天】.NET技术,作为微软的开发框架,以其跨平台、开源和语言多样性驱动软件创新。它在云计算、AI/ML、混合现实等领域发挥关键作用,通过Azure、ML.NET等工具促进新兴技术发展。未来,.NET将涉足量子计算、微服务和无服务器计算,持续拓宽软件开发边界,成为创新的重要推动力。掌握.NET技术,对于开发者而言,意味着握有开启创新的钥匙。
|
12天前
|
开发框架 .NET C#
【专栏】理解.NET 技术,提升开发水平
【4月更文挑战第29天】本文介绍了.NET技术的核心概念和应用,包括其跨平台能力、性能优化、现代编程语言支持及Web开发等特性。文章强调了深入学习.NET技术、关注社区动态、实践经验及学习现代编程理念对提升开发水平的重要性。通过这些,开发者能更好地利用.NET构建高效、可维护的多平台应用。
|
12天前
|
机器学习/深度学习 vr&ar 开发者
【专栏】.NET 技术:引领开发新方向
【4月更文挑战第29天】本文探讨了.NET技术如何引领软件开发新方向,主要体现在三方面:1) 作为跨平台开发的先锋,.NET Core支持多操作系统和移动设备,借助.NET MAUI创建统一UI,适应物联网需求;2) 提升性能和开发者生产力,采用先进技术和优化策略,同时更新C#语言特性,提高代码效率和可维护性;3) 支持现代化应用架构,包括微服务、容器化,集成Kubernetes和ASP.NET Core,保障安全性。此外,.NET还不断探索AI、ML和AR/VR技术,为软件开发带来更多创新可能。
|
12天前
|
开发框架 Cloud Native 开发者
【专栏】剖析.NET 技术的核心竞争力
【4月更文挑战第29天】本文探讨了.NET框架在软件开发中的核心竞争力:1) .NET Core实现跨平台与云原生技术的融合,支持多操作系统和容器化;2) 提升性能和开发者生产力,采用JIT、AOT优化,提供C#新特性和Roslyn编译器平台;3) 支持现代化应用架构,包括微服务和容器化,内置安全机制;4) 丰富的生态系统和社区支持,拥有庞大的开发者社区和微软的持续投入。这些优势使.NET在竞争激烈的市场中保持领先地位。
|
12天前
|
开发框架 .NET 开发者
【专栏】领略.NET 技术的创新力量
【4月更文挑战第29天】.NET技术自ASP.NET起历经创新,现以.NET Core为核心,展现跨平台能力,提升性能与生产力,支持现代化应用架构。.NET Core使开发者能用同一代码库在不同操作系统上构建应用,扩展至移动和物联网领域。性能提升,C#新特性简化编程,Roslyn编译器优化代码。拥抱微服务、容器化,内置安全机制,支持OAuth等标准。未来.NET 6将引入更快性能、Hot Reload等功能,预示着.NET将持续引领软件开发潮流,为开发者创造更多机会。
|
12天前
|
物联网 vr&ar 开发者
【专栏】.NET 技术:为开发注入活力
【4月更文挑战第29天】本文探讨了.NET技术的创新,主要体现在三个方面:1) .NET Core实现跨平台开发革命,支持多种操作系统和硬件,如.NET MAUI用于多平台UI;2) 性能提升与生产力飞跃,C#新特性简化编程,JIT和AOT优化提升性能,Roslyn提供代码分析工具;3) 引领现代化应用架构,支持微服务、容器化,内置安全机制。未来,.NET 7将带来更多新特性和前沿技术整合,如量子计算、AI,持续推动软件开发创新。开发者掌握.NET技术将赢得竞争优势。
|
12天前
|
人工智能 前端开发 Cloud Native
【专栏】洞察.NET 技术的开发趋势
【4月更文挑战第29天】本文探讨了.NET技术的三大发展趋势:1) 跨平台与云原生技术融合,通过.NET Core支持轻量级、高性能应用,适应云计算和微服务;2) 人工智能与机器学习的集成,如ML.NET框架,使开发者能用C#构建AI模型;3) 引入现代化前端开发技术,如Blazor,实现前后端一致性。随着.NET 8等新版本的发布,期待更多创新技术如量子计算、AR/VR的融合,.NET将持续推动软件开发的创新与进步。
|
12天前
|
人工智能 前端开发 Devops
【专栏】洞察.NET 技术在现代开发中的作用
【4月更文挑战第29天】本文探讨了.NET技术在现代软件开发中的核心价值、应用及挑战。.NET提供语言统一性与多样性,强大的Visual Studio工具,丰富的类库,跨平台能力及活跃的开发者社区。实际应用包括企业级应用、Web、移动、云服务和游戏开发。未来面临性能优化、容器化、AI集成等挑战,需持续创新。开发者应深入理解.NET,把握技术趋势,参与社区,共创美好未来。
|
12天前
|
开发工具 C# 开发者
【专栏】理解.NET 技术,开创美好未来
【4月更文挑战第29天】本文探讨了.NET技术在软件开发中的关键作用,强调其核心优势,如语言多样性、丰富类库、强大的开发工具和跨平台能力。.NET在现代应用开发中涉及企业级应用、云服务集成、微服务、移动应用和游戏开发。未来,.NET将持续创新,提升性能,拓展应用场景,并促进更紧密的社区合作,通过跨平台框架扩大应用范围。开发者应深入学习.NET,抓住技术趋势,共创美好未来。
|
12天前
|
机器学习/深度学习 人工智能 开发者
【专栏】.NET 技术:为开发带来新机遇
【4月更文挑战第29天】本文探讨了.NET技术如何为软件开发带来新机遇,分为三个部分:首先,.NET的跨平台革命,包括.NET Core的兴起、Xamarin与.NET MAUI的移动应用开发、开源社区的推动及性能优化;其次,介绍了云服务与微服务架构的集成,如Azure云服务、微服务支持、DevOps与CI/CD,以及Docker容器化;最后,讨论了AI与机器学习集成,如ML.NET、认知服务、TensorFlow和ONNX,使开发者能构建智能应用。面对这些机遇,开发者应不断学习和适应新技术,以创造更多价值。