Leistungssoptimierung durch Output-Caching in ASP.NET Webforms

Bei Aufruf einer ASP.NET-Webforms-Website wird viel Programmcode ausgeführt. Nachdem die Steuerelemente instanziiert wurden, Skin- und Ressourcen-Dateien berücksichtigt wurden und der HTTP-Request inklusive Viewstate ausgewertet wurden, werden zahlreiche Ereignisse gefeuert in denen (umfangreicher) Programmcode liegen kann. Manchmal ändern sich aber Inhalte einer Website gar nicht so häufig. Einige Sekunden oder gar Minuten lang kann man immer dieselbe Ausgabe liefert. ASP.NET Webforms bieten hier einen einfach anzuwendenden Mechanismus zur Zwischenspeicherung der „gerenderten“ Seiten.

Grundsätzlich ist zu prüfen, ob die Benutzer des Systems immer den letzten Stand der Daten sehen müssen oder ob ein Stand, der wenige Sekunden bzw. Minuten oder Stunden zurückliegt, nicht ausreichend ist. Oftmals fordern Benutzer den »top-aktuellen« Stand. Tatsächlich kann in einigen Fällen darauf aber verzichtet werden und der Server bzw. die Serverfarm dann kleiner ausfallen, weil weniger Rechenleistung gebraucht wird.

Dem Output-Caching handelt es sich um einen in ASP.NET Webforms eingebauten Mechanismus zur Optimierung der Leistung durch das Vorhalten von Webseiten, die bereits zu einem früheren Zeitpunkt angefordert wurden. Bei der Seitenzwischenspeicherung werden ganze Seiten auf dem Webserver vorrätig gehalten, ohne sie bei jedem Aufruf dynamisch zu erzeugen. Normalerweise verwirft der Webserver die Ausgabe sofort nach der Weiterleitung an den Webclient.

Im Rahmen einer Seitendirektive (<%@OutputCache> direkt unterhalb von <%@Page>) kann definiert werden, dass die Ausgabe eine definierbare Zeit lang im Speicher zur Beantwortung gleichartiger Anfragen vorgehalten wird. Ob zwei Anfragen als »gleich« betrachtet werden, kann dabei definiert werden. So lässt sich beispielsweise festlegen, dass die übergebenen Parameter berücksichtigt werden (die Seiten also für jede Parameterkombination einzeln zwischengespeichert werden) oder dass zwei unterschiedliche Browser bzw. Browserversionen nicht den gleichen HTML-Code erhalten (die Seiten also für jeden Browser einzeln zwischengespeichert werden).

Das Verhalten und die Regeln für das Unterdrücken der Neuerzeugung einer Webseite können über die @OutputCache-Direktive flexibel konfiguriert werden. So ist es z. B. über die Parameter VaryByParamoder VaryByCustom möglich, abhängig von übertragenen Parametern oder Browsern unterschiedliche Versionen ein und derselben Webseite vorrätig zu halten.

Die Seitendirektive

<%@ OutputCache
Duration="30"
VaryByParam="Abflugort;Zielort" %>

sorgt für die Zwischenspeicherung für 30 Sekunden. Eigene Zwischenspeicher werden in Abhängigkeit von den Querystring-Parametern „Abflugort“ und „Zielort“ gebildet.

Die Seitendirektive

<%@ OutputCache
Duration="90"
VaryByParam="*"
VaryByCustom="browser" %>

sorgt für die Zwischenspeicherung für 90 Sekunden. Alle übergebenen Parameter haben Einfluss auf den Seiteninhalt und es gibt auch für jeden Browsertyp eine eigene zwischengespeicherte Seite.

Caching-Profile

Mit ASP.NET 2.0 wurde die Möglichkeit eingeführt, dass der Entwickler in der web.config-Datei Zwischenspeicherungsprofile für die Seitenzwischenspeicherung definieren kann, die er über ihren Namen auf Seiten anwenden kann. Das folgende Fragment aus der web.config zeigt die Definition eines Zwischenspeicherungsprofils für browserabhängige Zwischenspeicherung für 60 Sekunden mit dem Namen „BrowserCacheProfil“.
<caching>
<outputCacheSettings>
<outputCacheProfiles>
<add name="BrowserCacheProfil"
duration="90"
varyByCustom="browser"
location="Server" />
</outputCacheProfiles>
</outputCacheSettings>
</caching>

Dieses Profil „BrowserCacheProfil“ kann dann mit folgender Seitendirekte verwendet werden:
<%@ OutputCache CacheProfile="BrowserCacheProfil" %>

Caching einzelner Steuerelemente

Steuerelemente (sowohl Custom Controls als auch User Controls) können eigene Anweisungen für das Caching besitzen. User Controls erlauben es auch, die auf Seitenebene verwendete @OutputCache-Direktive zur Definition des Caching-Verhaltens einzusetzen. Für User Controls stehen über die @OutputCache-Direktive die gleichen Zwischenspeichermöglichkeiten zur Verfügung, wie sie für ganze Web Forms möglich sind.
Damit die Daten innerhalb eines Benutzersteuerelements im Zwischenspeicher vorgehalten und nicht bei jeder Verwendung neu erstellt werden müssen, reicht die Verwendung der @OutputCache-Direktive:

<%@ OutputCache Duration="60" VaryByParam="*" %>

Gegenüber der @OutputCache-Direktive auf Seitenebene gibt es hier ein weiteres Attribut: VaryByControl. Dieses Attribut darf eine Liste von Attributen des Steuerelements enthalten, die Einfluss darauf hat, ob zwei Seiten in Bezug auf das Caching gleich sind.

Das folgende User Control wird für 10 Minuten im Zwischenspeicher gehalten (Duration="600") und in dieser Zeit nicht neu generiert:

<%@ Control Language="c#" AutoEventWireup="false" CodeFile="SeitenInformation.ascx.cs"
Inherits="SeitenInformation"%>
<%@ OutputCache Duration="600" VaryByParam="none" %>
<hr width="80%">
<P align="center">Letzes Mal aktualisiert:
<asp:Label id="LetztesUpdate" runat="server"></asp:Label></P>

Alternativ zum Einsatz der @OutputCache-Direktive kann die Annotation auf die Hintergrundcodeklasse angewendet werden. Bei Custom Controls steht nur diese Möglichkeit zur Verfügung, da es bei diesen selbsterstellten Steuerelementen keine Datei mit Deklarationen gibt, in der man eine Seitendirektive unterbringen könnte.
[System.Web.UI.PartialCaching(600, "none", "", "")]
public class PostBackZaehler : WebControl { …

Auf großen Webseiten mit vielen Daten, die bei jedem Aufruf neu erstellt werden müssen, und einem ähnlich großen Anteil an Daten, die nur selten oder weniger häufig aktualisiert werden, ist es sinnvoll, die seltener zu aktualisierenden Daten in ein User Control oder Custom Control auszulagern und dort die @OutputCache-Direktive bzw. die Annotation [System.Web.UI.PartialCaching] zu verwenden.