Sie sind hier: Startseite | Wissen
BASTA 2016

Was ist Model Binding?

Model Binding ist eine Datenbindungsform, die zuerst in ASP.NET MVC und seit .NET 4.5 auch in ASP.NET Webforms zum Einsatz kommt.

Microsoft spricht von "codefokussierter Datenbindung.". Anders als bei dem ObjectDataSource-Steuerelement gibt es bei dem neuen Model Binding keinen Intermediär zwischen Datensteuerelement und dem Programmcode. Vielmehr hat Microsoft die Datensteuerelemente um bis zu vier Eigenschaften erweitert, die jeweils auf den Namen einer Methode in der Code-Behind-Datei verweisen können:

  • SelectMethod: Name einer Methode, die Objekte in Form einer aufzählbaren Menge als IEnumerable, IQueryable, IEnumerable<Typ> oder IQueryable<Typ> liefert. Sie kann ggf. Parameter für Filtern und Sortieren besitzen.
  • InsertMethod: Name einer Methode, die ein einzufügendes Objekt als Parameter empfängt.
  • DeleteMethod: Name einer Methode, die ein löschendes Objekt als Parameter empfängt.
  • UpdateMethod: Name einer Methode, die ein aktualisierendes Objekt als Parameter empfängt.

Beispiel

Das Listing 1 zeigt ein GridView-Steuerelement, das drei dieser Properties verwendet. Da ein GridView-Steuerelement wie bisher auch schon keine neuen Zeilen anfügen kann, ist die Angabe einer InsertMethod hier nicht erlaubt.
Die zugehörige Implementierung der SelectMethod, DeleteMethod oder UpdateMethod liegt in der Code-Behind-Datei, siehe Listing 2. Die drei Methoden sind mit Hilfe des ADO.NET Entity Frameworks realisiert, das hier nicht gezeigt wird.

  <asp:GridView ID="GridView1" runat="server" DataKeyNames="FlugNr"
   SelectMethod="GetFlug" UpdateMethod="UpdateFlug" DeleteMethod="DeleteFlug"
   CellPadding="4" ForeColor="#333333"
   GridLines="None" AllowPaging="True" AllowSorting="True" PageSize="5" AutoGenerateColumns="false"
   ItemType="de.WWWings.GO.Flug">
   <AlternatingRowStyle BackColor="White" />
   <Columns>
   <asp:CommandField ShowDeleteButton="True" ShowEditButton="True" />
   <asp:BoundField DataField="FlugNr" HeaderText="FlugNr">
   <ItemStyle HorizontalAlign="Left" />
   </asp:BoundField>
   <asp:BoundField DataField="Datum" HeaderText="Datum">
   <ItemStyle HorizontalAlign="Left" />
   </asp:BoundField>
   <asp:BoundField DataField="Abflugort" HeaderText="Abflugort" SortExpression="Abflugort">
   <ItemStyle HorizontalAlign="Left" />
   </asp:BoundField>
   <asp:BoundField DataField="ZielOrt" HeaderText="Zielort" SortExpression="Zielort">
   <ItemStyle HorizontalAlign="Left" />
   </asp:BoundField>
   <asp:BoundField DataField="Plaetze" HeaderText="Plaetze" SortExpression="Plaetze">
   <ItemStyle HorizontalAlign="Left" />
   </asp:BoundField>
   <asp:BoundField DataField="FreiePlaetze" HeaderText="FreiePlaetze" SortExpression="FreiePlaetze" />

   <asp:TemplateField HeaderText="Auslastung" ItemStyle-HorizontalAlign="Right">
   <ItemTemplate>
   <%# Math.Round(((double)Item.FreiePlaetze / (double)Item.Plaetze)*100,2) + "%" %>
   </ItemTemplate>

   <ItemStyle HorizontalAlign="Right"></ItemStyle>
   </asp:TemplateField>
   </Columns>
  </asp:GridView>
Listing 1: Model Binding in der .aspx-Datei

using System;
using System.Linq;
using de.WWWings.GO;

public partial class ModelBinding2 : System.Web.UI.Page
{

   WWWings6Entities model = new WWWings6Entities();

   // Select-Methode für GridView: Holt alle Flüge
   public IQueryable<Flug> GetFlug()
   {
   return model.Flug;
   }

   // Update-Methode für GridView
   public void UpdateFlug(Flug flug)
   {
   if (ModelState.IsValid)
   {
   model.AttachTo("Flug", flug);
   model.ObjectStateManager.ChangeObjectState(flug, System.Data.EntityState.Modified);
   model.SaveChanges();
   }
   }

   // Delete-Methode für GridView
   public void DeleteFlug(Flug flug)
   {
   if (ModelState.IsValid)
   {
   model.AttachTo("Flug", flug);
   model.ObjectStateManager.ChangeObjectState(flug, System.Data.EntityState.Deleted);
   model.SaveChanges();
   }
   }
}
Listing 2: Model Binding in Code-Behind-Datei

IQueryable

Wichtig ist an dieser Stelle der Rückgabetyp von GetFlug(): IQueryable<Flug> sorgt dafür, dass das Datensteuerelement nicht bereits die Ergebnismenge von Form von Flug-Objekten erhält, sondern eine noch nicht abgeschlossene LINQ-to-Entities-Abfrage. Das Datensteuerelement kann sodann noch Sortieren, Blättern oder Filterbedingungen zu dieser Abfrage ergänzen, sodass diese Operationen dann auch in der Datenbank erfolgen und nicht im Client. Das Listing 3 zeigt den SQL-Befehl, den die Datenbank vom ADO.NET Entity Framework erhält, wenn der Benutzer in dem GridView nach "Plaetze" sortiert und die fünfte Seite anfordert. Während also bei dem ObjectDataSource-Steuerelement die Zusammenarbeit auf Basis von einigen wenigen starren Methodensignaturen erfolgte, sind beim Model Binding alle Möglichkeiten der LINQ-Syntax erlaubt.

Theoretisch könnte GetFlug() auch ein IEnumerable<Flug> zurückgeben. Dadurch erhielte das Datensteuerelement direkt die Ergebnismenge, dann aber greift das ModelBinding genau wie das ObjectDataSource-Steuerelement auf Konventionen zurück, die GetFlug() erfüllen müsste. Wenn die Konventionen nicht erfüllt werden, erhält man die Fehlermeldung: "When the DataBoundControl has paging enabled, either the SelectMethod should return an IQueryable<ItemType> or should have all these mandatory parameters : int startRowIndex, int maximumRows, out int totalRowCount".

SELECT TOP (5)
[Extent1].[FlugNr] AS [FlugNr],
[Extent1].[Abflugort] AS [Abflugort],
[Extent1].[Datum] AS [Datum],
[Extent1].[Zielort] AS [Zielort],
[Extent1].[NichtRaucherFlug] AS [NichtRaucherFlug],
[Extent1].[Plaetze] AS [Plaetze],
[Extent1].[Memo] AS [Memo],
[Extent1].[FreiePlaetze] AS [FreiePlaetze],
[Extent1].[Pilot_PersonID] AS [Pilot_PersonID],
[Extent1].[Ankunft] AS [Ankunft],
[Extent1].[test] AS [test]
FROM ( SELECT [Extent1].[FlugNr] AS [FlugNr], [Extent1].[Abflugort] AS [Abflugort], [Extent1].[Zielort] AS [Zielort], [Extent1].[Datum] AS [Datum], [Extent1].[NichtRaucherFlug] AS [NichtRaucherFlug], [Extent1].[Plaetze] AS [Plaetze], [Extent1].[FreiePlaetze] AS [FreiePlaetze], [Extent1].[Pilot_PersonID] AS [Pilot_PersonID], [Extent1].[Ankunft] AS [Ankunft], [Extent1].[Memo] AS [Memo], [Extent1].[test] AS [test], row_number() OVER (ORDER BY [Extent1].[Plaetze] ASC) AS [row_number]
FROM [dbo].[Flug] AS [Extent1]
) AS [Extent1]
WHERE [Extent1].[row_number] > 20
ORDER BY [Extent1].[Plaetze] ASC
Listing 3: Beispiel einer von dem obigen Beispiel produzierten SQL-Abfrage

Typisierte Datenbindungsausdrücke

Hervorzuheben in Listing 1 ist auch die Verwendung der Eigenschaft ItemType in der ASPX-Seite. ItemType ist ebenfalls neu in ASP.NET 4.5. Datensteuerelemente in ASP.NET Webforms besitzen seit den ersten Tagen von ASP.NET neben fest definierten Spalten- und Zeilenvorlagen die Möglichkeit, über sogenannte freie Vorlagen (Template Fields) die Gestaltung einer Spalte (z.B. im GridView-Steuerelement) bzw. Zeile (z.B. im DetailsView-Steuerelement) frei mit HTML-Tags zu definieren. Ein Template Field enthält verschiedene Vorlagenarten, z.B. Header Template, Item Template, Alternating Item Template, Edit Item Template und Footer Template. Jede Vorlage besteht aus festen und dynamischen Bestandteilen, wobei die dynamischen Bestandteile durch ein <%# %> einzurahmen sind und die Verweise auf Eigenschaften des aktuellen Datenelements mit Eval() oder Bind() abzurufen sind. Dabei ist Eval() eine Ein-Wege- und Bind() eine Zwei-Wege-Datenbindung.

Das folgende Fragment zeigt ein Template Field mit Item Template in dem mit Eval() auf die Eigenschaft "FreiePlaetze" aus den angebundenen Flug-Objekten Bezug genommen wird. Dabei sind Datentypkonvertierungen zwingend notwendig, da Eval() als Rückgabetyp nur das universelle System.Object deklariert.

   <asp:TemplateField HeaderText="Auslastungtext" ItemStyle-HorizontalAlign="Right">
   <ItemTemplate>
   <%# Convert.ToInt32(Eval("FreiePlaetze")) < 10 ?
   "gut" : (Convert.ToInt32(Eval("FreiePlaetze")) < 100 ? "mittel" : "schlecht") %>
   </ItemTemplate>
   </asp:TemplateField>

In ASP.NET 4.5 kann dies eleganter definiert werden, indem man in dem Datensteuerelemente mit der Eigenschaft ItemType deklariert, welcher Klasse die gebundenen Objekte angehören und in der Vorlage mit Item.Eigenschaftname Bezug auf das gebundene Objekt nimmt (siehe Listing 1). Typkonvertierungen entfallen dabei. Visual Studio 2012 stellt IntelliSence-Eingabeunterstützung sowohl für die Eingabe von ItemType als auch die Eigenschaften von Item bereit. Freilich funktionieren typisierte Datenbindungsausdrücke nur mit expliziten Geschäftsobjektklassen – bei untypisierten Datacontainern wie einem DataSet ist dies nicht möglich, da die Entwicklungsumgebung den Inhalt nicht kennen kann und Item.Eigenschaftname auch nicht zum Ziel führen kann.

Abfrageparameter beim Model Binding

Bei der Vorstellung der SelectMethod wurde schon erwähnt, dass diese Filterparameter besitzen kann. Diese Filterparameter können mit Werten befüllt werden, wenn das Datensteuerelement die SelectMethod aufruft. Dafür gibt es beim Model Binding sogenannte Value Provider, die die Werte aus verschiedenen Quellen akquirieren: Control, Cookie, QueryString, Form, Profile, ViewState, Session. Man kann auch eigene Value Provider schreiben (Basisklasse ValueProvider).

Der Value Provider hat die Aufgabe, den Wert aus der jeweiligen Quelle zu extrahieren. Wenn das nicht gelingt, muss er null übergeben. Daher sollten die Parameter einen "nullable" Datentyp besitzen. Der zu verwendende Value Provider wird vor einem Methodenparameter als .NET-Attribut deklariert, z.B.
Public IQueryable<Flug> GetFluege([System.Web.ModelBinding.Control] string Ort)
oder
public IQueryable<Flug> GetFluege([System.Web.ModelBinding.QueryString] string Ort)

Das Model Binding-Beispiel soll nun um zwei weitere Steuerelemente auf der Webseite erweitert werden:
  • Über ein DropDown-Steuerelement kann der Benutzer die Flugtabelle auf bestimmte Abflugorte beschränken.
  • In einem DetailsView-Steuerelement sieht der Benutzer Details zu einem gewählten Flug. Listing 4 zeigt den ASPX-Code für das Beispiel.


<%--Auswahl--%>
Ort:
   <asp:DropDownList ID="Ort" runat="server" SelectMethod="GetOrte"
   AutoPostBack="True" AppendDataBoundItems="true">
   <asp:ListItem>Bitte wählen</asp:ListItem>
   </asp:DropDownList><br />

<%--Tabelle--%>
<asp:ValidationSummary runat="server" ShowModelStateErrors="true" HeaderText="Bitte korrigieren Sie folgende Eingabefehler:" />
<asp:GridView ID="FlugTabelle" runat="server" DataKeyNames="FlugNr"
  SelectMethod="GetFluege" UpdateMethod="UpdateFlug" DeleteMethod="DeleteFlug"
  CellPadding="4" ForeColor="#333333"
  GridLines="None" AllowPaging="True" AllowSorting="True" PageSize="5" AutoGenerateColumns="false"
  ItemType="de.WWWings.GO.Flug">
  <AlternatingRowStyle BackColor="White" />
  <Columns>
   <asp:CommandField ShowDeleteButton="True" ShowEditButton="True" ShowSelectButton="true" />
   <asp:BoundField DataField="FlugNr" HeaderText="FlugNr">
   <ItemStyle HorizontalAlign="Left" />
   </asp:BoundField>
   <asp:BoundField DataField="Datum" HeaderText="Datum">
   <ItemStyle HorizontalAlign="Left" />
   </asp:BoundField>
   <asp:BoundField DataField="Abflugort" HeaderText="Abflugort" SortExpression="Abflugort">
   <ItemStyle HorizontalAlign="Left" />
   </asp:BoundField>
   <asp:BoundField DataField="ZielOrt" HeaderText="Zielort" SortExpression="Zielort">
   <ItemStyle HorizontalAlign="Left" />
   </asp:BoundField>
   <asp:BoundField DataField="Plaetze" HeaderText="Plaetze" SortExpression="Plaetze">
   <ItemStyle HorizontalAlign="Left" />
   </asp:BoundField>
   <asp:BoundField DataField="FreiePlaetze" HeaderText="FreiePlaetze" SortExpression="FreiePlaetze" />

   <asp:TemplateField HeaderText="Auslastung" ItemStyle-HorizontalAlign="Right">
   <ItemTemplate>
   <%# Math.Round(((double)Item.FreiePlaetze / (double)Item.Plaetze)*100,2) + "%" %>
   </ItemTemplate>

   <ItemStyle HorizontalAlign="Right"></ItemStyle>
   </asp:TemplateField>
  </Columns>

</asp:GridView>

<%--Detailansicht--%>

<asp:DetailsView ID="Detailsview1" runat="Server"
  SelectMethod="GetFlug" UpdateMethod="UpdateFlug" DeleteMethod="DeleteFlug" CellPadding="4" ForeColor="#333333" GridLines="None">
  <AlternatingRowStyle BackColor="White" />
  <CommandRowStyle BackColor="#C5BBAF" Font-Bold="True" />
</asp:DetailsView>
Listing 4: Erweiterter ASPX-Code mit drei Datensteuerelementen

In der Code-Behind-Klasse gilt es nun zu realisieren (siehe Listing 5):
1. Eine Methode GetOrte(), die eine Liste von Zeichenketten mit allen Ortsnamen für das DropDown-Steuerelement liefert.
2. Die Methode GetFluege() muss um einen Parameter für den gewählten Ort ergänzt werden.
3. Für das DetailsView-Steuerelement braucht man eine Methode GetFlug(), die als Parameter die Information über den aktuell in der Tabelle gewählten Flug erhält.

Model Binding arbeitet nach dem Prinzip "Konventionen vor Konfiguration" bei den Value Providern: wenn der Wert im Provider genauso heißt wie der Parametername in der Methode, dann erfolgt konventionsgemäß die Bindung. Andersfalls kann der Entwickler in einem .NET-Attribut den Namen des Werts benennen. So erfolgt im Fall von
public IQueryable<Flug> GetFluege([System.Web.ModelBinding.Control] string Ort)
die Bindung auf Basis der Konvention, während eine explizite Konfiguration bei
public Flug GetFlug([Control("FlugTabelle")] int? aktuelleFlugNr)
erfolgt. Das macht Sinn, denn "FlugTabelle" wäre ein schlechter Name für einen Parameter, in dem die aktuelle Flugnummer steht.

Using System;
using System.Linq;
using System.Web.ModelBinding;
using de.WWWings.GO;


public partial class ModelBinding2 : System.Web.UI.Page
{
   WWWings6Entities model = new WWWings6Entities();

   // Select-Methode für DropDown
   public IQueryable<string> GetOrte()
   {
   WWWings6Entities model = new WWWings6Entities();
   return (from f in model.Flug select f.Abflugort).Distinct();
   }


   // Select-Methode für GridView: Holt alle Flüge
   public Flug GetFlug([Control("FlugTabelle")] int? aktuelleFlugNr)
   {
   return model.Flug.Where(f => f.FlugNr == aktuelleFlugNr).SingleOrDefault();
   }
   // Select-Methode für Grid mit Parameter aus Control
   public IQueryable<Flug> GetFluege([System.Web.ModelBinding.Control] string Ort)
   {
   WWWings6Entities model = new WWWings6Entities();
   return model.Flug.Where(x => x.Abflugort == Ort);
   }

   // Update-Methode für GridView
   public void UpdateFlug(Flug flug)
   {
   if (ModelState.IsValid)
   {
   model.AttachTo("Flug", flug);
   model.ObjectStateManager.ChangeObjectState(flug, System.Data.EntityState.Modified);
   model.SaveChanges();
   }
   }

   // Delete-Methode für GridView
   public void DeleteFlug(Flug flug)
   {
   if (ModelState.IsValid)
   {
   model.AttachTo("Flug", flug);
   model.ObjectStateManager.ChangeObjectState(flug, System.Data.EntityState.Deleted);
   model.SaveChanges();
   }
   }
}
Listing 5: Code-Behind-Klasse für das erweiterte Beispiel mit drei Datensteuerelementen

Beratung & Support:

Schulungen zu diesem Thema:

 Anfrage für eine individuelle Schulung zum Thema Model Binding  Gesamter Schulungsthemenkatalog