PageStatePersister Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Poskytuje základní funkce pro ASP.NET zobrazení mechanismů trvalosti stavu.
public ref class PageStatePersister abstract
public abstract class PageStatePersister
type PageStatePersister = class
Public MustInherit Class PageStatePersister
- Dědičnost
-
PageStatePersister
- Odvozené
Příklady
Následující příklad kódu ukazuje, jak vytvořit PageStatePersister objekt, který ukládá zobrazení a stav ovládacího prvku na webovém serveru. Ukazuje StreamPageStatePersister , jak přepsat Load a Save metody extrahovat a uložit informace o stavu zobrazení. Vzhledem k tomu, že mechanismy trvalosti stavu souvisejí s adaptivním vykreslováním a možnostmi klienta, MyPageAdapter je třída poskytována k aktivaci StreamPageStatePersister aplikace ASP.NET. Nakonec je k dispozici soubor funkcí prohlížeče (.browser), který povolí MyPageAdapter adaptér pro konkrétní třídu klientů (v tomto případě výchozí webový prohlížeč).
namespace Samples.AspNet.CS
{
using System;
using System.IO;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
//
// The StreamPageStatePersister is an example view state
// persistence mechanism that persists view and control
// state on the Web server.
//
[AspNetHostingPermission(SecurityAction.Demand, Level = AspNetHostingPermissionLevel.Minimal)]
public class StreamPageStatePersister : PageStatePersister
{
public StreamPageStatePersister(Page page)
: base(page)
{
}
//
// Load ViewState and ControlState.
//
public override void Load()
{
Stream stateStream = GetSecureStream();
// Read the state string, using the StateFormatter.
StreamReader reader = new StreamReader(stateStream);
IStateFormatter formatter = this.StateFormatter;
string fileContents = reader.ReadToEnd();
// Deserilize returns the Pair object that is serialized in
// the Save method.
Pair statePair = (Pair)formatter.Deserialize(fileContents);
ViewState = statePair.First;
ControlState = statePair.Second;
reader.Close();
stateStream.Close();
}
//
// Persist any ViewState and ControlState.
//
public override void Save()
{
if (ViewState != null || ControlState != null)
{
if (Page.Session != null)
{
Stream stateStream = GetSecureStream();
StreamWriter writer = new StreamWriter(stateStream);
IStateFormatter formatter = this.StateFormatter;
Pair statePair = new Pair(ViewState, ControlState);
// Serialize the statePair object to a string.
string serializedState = formatter.Serialize(statePair);
writer.Write(serializedState);
writer.Close();
stateStream.Close();
}
else
{
throw new InvalidOperationException("Session needed for StreamPageStatePersister.");
}
}
}
// Return a secure Stream for your environment.
private Stream GetSecureStream()
{
// You must provide the implementation to build
// a secure Stream for your environment.
return null;
}
}
}
Imports System.IO
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI
Namespace Samples.AspNet.VB
' The StreamPageStatePersister is an example view state
' persistence mechanism that persists view and control
' state on the Web server.
'
<AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class StreamPageStatePersister
Inherits PageStatePersister
Public Sub New(ByVal page As Page)
MyBase.New(page)
End Sub
'
' Load ViewState and ControlState.
'
Public Overrides Sub Load()
Dim stateStream As Stream
stateStream = GetSecureStream()
' Read the state string, using the StateFormatter.
Dim reader As New StreamReader(stateStream)
Dim serializedStatePair As String
serializedStatePair = reader.ReadToEnd
Dim statePair As Pair
Dim formatter As IStateFormatter
formatter = Me.StateFormatter
' Deserilize returns the Pair object that is serialized in
' the Save method.
statePair = CType(formatter.Deserialize(serializedStatePair), Pair)
ViewState = statePair.First
ControlState = statePair.Second
reader.Close()
stateStream.Close()
End Sub
'
' Persist any ViewState and ControlState.
'
Public Overrides Sub Save()
If Not (ViewState Is Nothing) OrElse Not (ControlState Is Nothing) Then
If Not (Page.Session Is Nothing) Then
Dim stateStream As Stream
stateStream = GetSecureStream()
' Write a state string, using the StateFormatter.
Dim writer As New StreamWriter(stateStream)
Dim formatter As IStateFormatter
formatter = Me.StateFormatter
Dim statePair As New Pair(ViewState, ControlState)
Dim serializedState As String
serializedState = formatter.Serialize(statePair)
writer.Write(serializedState)
writer.Close()
stateStream.Close()
Else
Throw New InvalidOperationException("Session needed for StreamPageStatePersister.")
End If
End If
End Sub
' Return a secure Stream for your environment.
Private Function GetSecureStream() As Stream
' You must provide the implementation to build
' a secure Stream for your environment.
Return Nothing
End Function
End Class
End Namespace
Následující příklad kódu ukazuje, jak vytvořit PageAdapter třídu, která vrací instanci StreamPageStatePersister, která se používá k zachování zobrazení a stavu ovládacího prvku pro ASP.NET webové stránky.
namespace Samples.AspNet.CS {
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
[AspNetHostingPermission(SecurityAction.Demand, Level=AspNetHostingPermissionLevel.Minimal)]
public class MyPageAdapter : System.Web.UI.Adapters.PageAdapter {
public override PageStatePersister GetStatePersister() {
return new Samples.AspNet.CS.StreamPageStatePersister(Page);
}
}
}
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI
Namespace Samples.AspNet.VB
<AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class MyPageAdapter
Inherits System.Web.UI.Adapters.PageAdapter
Public Overrides Function GetStatePersister() As PageStatePersister
Return New Samples.AspNet.VB.StreamPageStatePersister(Page)
End Function 'GetStatePersister
End Class
End Namespace
Zkompilujte tyto dvě třídy do sestavení, které můžete použít ke spuštění ukázky pomocí následujícího příkazového řádku kompilátoru. Ujistěte se, že kompilované sestavení je v adresáři \Bin pod kořenem aplikace ASP.NET.
// C:\>csc /t:library /out:C:\inetpub\wwwroot\bin\Samples.AspNet.CS.dll MyPageAdapter.cs TextFilePageStatePersister.cs
//
// C:\>
' C:\>vbc /t:library /out:C:\inetpub\wwwroot\bin\Samples.AspNet.VB.dll MyPageAdapter.vb TextFilePageStatePersister.vb
'
Pokud chcete adaptér povolit MyPageAdapter , musíte vytvořit adresář s názvem Prohlížeče pod kořenem aplikace ASP.NET a zahrnout soubor prohlížeče s konfiguračními informacemi. Element <refid> v konfiguračním souboru označuje, že konfigurace přepíše hodnoty zadané pro výchozí prohlížeč v konfiguračním souboru Default.browser. V tomto příkladu MyPageAdapter se používá pro ASP.NET webové stránky (kde se obvykle nepoužívá žádný adaptér).
<browsers>
<browser refid="Default" >
<controlAdapters>
<adapter
controlType="System.Web.UI.Page"
adapterType="Samples.AspNet.CS.MyPageAdapter" />
</controlAdapters>
</browser>
</browsers>
Poznámky
Požadavky a odpovědi HTTP jsou ze své podstaty bezstavové. Pokud chcete udržovat informace o stavu mezi požadavky HTTP, mohou stránky serveru ASP.NET ukládat Page stav. Tento stav, označovaný jako stav zobrazení, se skládá z nastavení stránky a ovládacího prvku a dat, díky kterým se stránka a ovládací prvky zobrazují stejně jako ty, které uživatel viděl a pracoval s nimi při poslední odezvě na server. Existuje několik mechanismů pro ukládání stavu zobrazení mezi po sobě jdoucími požadavky na stejnou stránku. Abstraktní PageStatePersister třída představuje základní třídu pro tyto mechanismy úložiště informací o stavu.
Výchozí mechanismus trvalosti stavu zobrazení v ASP.NET je udržovat informace o stavu jako řetězec kódovaný base64 ve skrytém elementu HTML (element s type atributem nastaveným "hidden"na ) na stránce. Stránka ASP.NET používá HiddenFieldPageStatePersister objekt k provedení této práce pomocí IStateFormatter instance k serializaci a deserializaci informací o stavu objektu. Případně můžete uložit stav zobrazení pro stránky v objektu Session na serveru pomocí SessionPageStatePersister třídy pro mobilní klienty s omezenou šířkou pásma a prostředky. V některých případech můžete úplně zakázat trvalost zobrazení stavu. Pokud to uděláte, výsledkem je, že se někdy stránky a ovládací prvky, které spoléhají na trvalost stavu, nechovají správně. Další informace o správě stavu stránky a zobrazení stavu naleznete v tématu ASP.NET Přehled správy stavu.
Pokud píšete ovládací prvky, můžete uložit informace o stavu ovládacích prvků ve slovníku ViewState , což je StateBag objekt. Vývojář by prostřednictvím vlastnosti načetl stav ControlState ovládacího prvku. K vlastnosti přiřadíte klíče a hodnoty ViewState a Page objekt serializuje informace o stavu mezi požadavky. Pokud chcete v ovládacím prvku provádět vlastní zpracování stavu, přepište je LoadViewState a SaveViewState metody. Všechny informace o stavu uložené v tomto slovníku se ztratí, když vývojář stránky zakáže stav zobrazení. Pokud chcete tento problém zmírnit, můžete v ASP.NET verze 2.0 ukládat důležité informace o stavu v samostatném objektu označovaném jako stav řízení. Objekt stavu ovládacího prvku není ovlivněn, pokud vývojář stránky zakáže stav zobrazení. Ukládání informací o stavu v objektu stavu ovládacího prvku vyžaduje, aby ovládací prvek přepsal LoadControlState a SaveControlState metody a aby ovládací prvek byl registrován k ukládání informací o stavu do stavu ovládacího prvku při každém inicializaci ovládacího prvku. Ovládací prvek můžete zaregistrovat, aby používal stav řízení přepsáním OnInit metody a voláním RegisterRequiresControlState metody. Další informace o použití ViewState vlastnosti a stavu ovládacího prvku při vývoji ovládacích prvků naleznete v tématu Vývoj vlastních ASP.NET serverových ovládacích prvků.
Chcete-li zachovat stav zobrazení na klientech, kteří nemohou podporovat existující mechanismy trvalosti stavu zobrazení, můžete třídu rozšířit PageStatePersister tak, aby zavedla vlastní metody trvalosti stavu zobrazení a pomocí adaptérů stránky můžete nakonfigurovat ASP.NET aplikaci tak, aby používala různé mechanismy trvalosti zobrazení na základě typu klienta, na kterém je stránka obsluhována. Třídy odvozené z PageStatePersister třídy musí přepsat abstraktní Save metodu pro uložení stavu zobrazení a kontrolního stavu ve médiu trvalosti a přepsat metodu Load extrahování. Pokud potřebujete serializovat stav zobrazení a stav ovládacího prvku do řetězce, můžete použít IStateFormatter objekt, ke kterému se přistupuje pomocí StateFormatter vlastnosti. Efektivně serializuje a deserializuje informace o stavu objektu do řetězce s kódováním Base64. Můžete také přepsat StateFormatter vlastnost zadat vlastní objekt stav serializace mechanismus.
Konstruktory
| Name | Description |
|---|---|
| PageStatePersister(Page) |
Inicializuje novou instanci PageStatePersister třídy. |
Vlastnosti
| Name | Description |
|---|---|
| ControlState |
Získá nebo nastaví objekt, který představuje data, která ovládací prvky obsažené v aktuálním Page objektu použít k zachování napříč požadavky HTTP na webový server. |
| Page |
Získá nebo nastaví Page objekt, pro který je vytvořen mechanismus trvalosti stavu zobrazení. |
| StateFormatter |
IStateFormatter Získá objekt, který se používá k serializaci a deserializaci stav informace obsažené v ViewState a ControlState vlastnosti během volání Save() a Load() metody. |
| ViewState |
Získá nebo nastaví objekt, který představuje data, která ovládací prvky obsažené v aktuálním Page objektu použít k zachování napříč požadavky HTTP na webový server. |
Metody
| Name | Description |
|---|---|
| Equals(Object) |
Určuje, zda je zadaný objekt roven aktuálnímu objektu. (Zděděno od Object) |
| GetHashCode() |
Slouží jako výchozí funkce hash. (Zděděno od Object) |
| GetType() |
Získá Type aktuální instance. (Zděděno od Object) |
| Load() |
Přepsáno odvozenými třídami k deserializaci a načtení trvalých informací o stavu, když Page objekt inicializuje svou řídicí hierarchii. |
| MemberwiseClone() |
Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object) |
| Save() |
Přepsáno odvozenými třídami pro serializaci trvalých informací o stavu při Page uvolnění objektu z paměti. |
| ToString() |
Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object) |