VirtualPathProvider Klas

Definitie

public ref class VirtualPathProvider abstract : MarshalByRefObject

public abstract class VirtualPathProvider : MarshalByRefObject

type VirtualPathProvider = class
    inherit MarshalByRefObject

Public MustInherit Class VirtualPathProvider
Inherits MarshalByRefObject

Overname

Object

MarshalByRefObject

VirtualPathProvider

Voorbeelden

Het volgende codevoorbeeld is een VirtualPathProvider klasse-implementatie waarmee een virtueel bestandssysteem wordt gemaakt met behulp van informatie die is opgeslagen in een DataSet object. Het codevoorbeeld werkt met de codevoorbeelden voor de VirtualFile en VirtualDirectory klassen om virtuele resources te bieden uit een gegevensarchief dat in een DataSet object is geladen.

Dit voorbeeld bevat vier onderdelen: de VirtualPathProvider-klasse-implementatie, een XML-gegevensbestand dat wordt gebruikt voor het vullen van het DataSet-object, een AppStart-object dat een AppInitialize methode bevat die wordt gebruikt om de klasse VirtualPathProvider te registreren met het compilatiesysteem en een ASP.NET-pagina die koppelingen naar de virtuele bestanden bevat.

Volg deze stappen om deze voorbeeldcode in een toepassing te gebruiken.

1. Maak een voorbeeldtoepassing op uw webserver.

2. Kopieer de broncode voor het aangepaste VirtualPathProvider object (zie hieronder) naar een bestand in de map van App_Code de toepassing.

3. Kopieer de broncode voor het aangepaste VirtualDirectory object (zie de sectie Voorbeeld in het VirtualDirectory onderwerp Class Overview) naar een bestand in de map van App_Code de toepassing.

4. Kopieer de broncode voor het aangepaste VirtualFile object (zie de sectie Voorbeeld in het VirtualFile onderwerp Class Overview) naar een bestand in de map van App_Code de toepassing.

5. Kopieer de broncode voor het AppStart object (zie hieronder) naar een bestand in de map van App_Code de toepassing.

6. Kopieer de XML-gegevens (zie hieronder) naar een bestand met de naam XMLData.xml in een bestand in de map van App_Data de toepassing.

7. Kopieer het default.aspx bestand (zie hieronder) naar de hoofdmap van de voorbeeldtoepassing. Gebruik een webbrowser om het default.aspx bestand te openen en klik vervolgens op de koppelingen op de pagina om de inhoud van de virtuele bestanden weer te geven.

Het eerste voorbeeld is een aangepaste VirtualPathProvider klasse. De DirectoryExists en FileExists methoden worden overschreven om aan te geven of een aangevraagde map aanwezig is in het virtuele bestandssysteem. De GetDirectory en GetFile methoden worden overschreven om aangepaste VirtualDirectory exemplaren VirtualFile te retourneren die informatie uit het virtuele bestandssysteem bevatten.

De klasse biedt ook een GetVirtualData methode die door de VirtualDirectory en VirtualFile klassen wordt gebruikt voor toegang tot het object met de gegevens van het DataSet virtuele bestandssysteem. In een productie-implementatie wordt deze methode doorgaans geïmplementeerd in een bedrijfsobject dat verantwoordelijk is voor interactie met het gegevensarchief.

using System;
using System.Data;
using System.Security.Permissions;
using System.Web;
using System.Web.Caching;
using System.Web.Hosting;

namespace Samples.AspNet.CS
{
  [AspNetHostingPermission(SecurityAction.Demand, Level = AspNetHostingPermissionLevel.Medium)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.High)]
  public class SamplePathProvider : VirtualPathProvider
  {
    private string dataFile;

    public SamplePathProvider()
      : base()
    {
    }

    protected override void Initialize()
    {
      // Set the datafile path relative to the application's path.
      dataFile = HostingEnvironment.ApplicationPhysicalPath + "App_Data\\XMLData.xml";
    }

    /// <summary>
    ///   Data set provider for the SampleVirtualDirectory and
    ///   SampleVirtualFile classes. In a production application
    ///   this method would be on a provider class that accesses
    ///   the virtual resource data source.
    /// </summary>
    /// <returns>
    ///   The System.Data.DataSet containing the virtual resources 
    ///   provided by the SamplePathProvider.
    /// </returns>
    public DataSet GetVirtualData()
    {
      // Get the data from the cache.
      DataSet ds = (DataSet)HostingEnvironment.Cache.Get("VPPData");
      if (ds == null)
      {
        // Data not in cache. Read XML file.
        ds = new DataSet();
        ds.ReadXml(dataFile);

        // Make DataSet dependent on XML file.
        CacheDependency cd = new CacheDependency(dataFile);

        // Put DataSet into cache for maximum of 20 minutes.
        HostingEnvironment.Cache.Add("VPPData", ds, cd,
          Cache.NoAbsoluteExpiration,
          new TimeSpan(0, 20, 0),
          CacheItemPriority.Default, null);

        // Set data timestamp.
        DateTime dataTimeStamp = DateTime.Now;
        // Cache it so we can get the timestamp in later calls.
        HostingEnvironment.Cache.Insert("dataTimeStamp", dataTimeStamp, null,
          Cache.NoAbsoluteExpiration,
          new TimeSpan(0, 20, 0),
          CacheItemPriority.Default, null);
      }
      return ds;
    }

    /// <summary>
    ///   Determines whether a specified virtual path is within
    ///   the virtual file system.
    /// </summary>
    /// <param name="virtualPath">An absolute virtual path.</param>
    /// <returns>
    ///   true if the virtual path is within the 
    ///   virtual file sytem; otherwise, false.
    /// </returns>
    private bool IsPathVirtual(string virtualPath)
    {
      String checkPath = VirtualPathUtility.ToAppRelative(virtualPath);
      return checkPath.StartsWith("~/vrdir", StringComparison.InvariantCultureIgnoreCase);
    }

    public override bool FileExists(string virtualPath)
    {
      if (IsPathVirtual(virtualPath))
      {
        SampleVirtualFile file = (SampleVirtualFile)GetFile(virtualPath);
        return file.Exists;
      }
      else
            {
                return Previous.FileExists(virtualPath);
            }
        }

    public override bool DirectoryExists(string virtualDir)
    {
      if (IsPathVirtual(virtualDir))
      {
        SampleVirtualDirectory dir = (SampleVirtualDirectory)GetDirectory(virtualDir);
        return dir.Exists;
      }
      else
            {
                return Previous.DirectoryExists(virtualDir);
            }
        }

    public override VirtualFile GetFile(string virtualPath)
    {
      if (IsPathVirtual(virtualPath))
        return new SampleVirtualFile(virtualPath, this);
      else
        return Previous.GetFile(virtualPath);
    }

    public override VirtualDirectory GetDirectory(string virtualDir)
    {
      if (IsPathVirtual(virtualDir))
        return new SampleVirtualDirectory(virtualDir, this);
      else
        return Previous.GetDirectory(virtualDir);
    }

    public override CacheDependency GetCacheDependency(
      string virtualPath, 
      System.Collections.IEnumerable virtualPathDependencies, 
      DateTime utcStart)
    {
      if (IsPathVirtual(virtualPath))
      {
        System.Collections.Specialized.StringCollection fullPathDependencies = null;

        // Get the full path to all dependencies.
        foreach (string virtualDependency in virtualPathDependencies)
        {
          if (fullPathDependencies == null)
            fullPathDependencies = new System.Collections.Specialized.StringCollection();

          fullPathDependencies.Add(virtualDependency);
        }
        if (fullPathDependencies == null)
          return null;

        // Copy the list of full-path dependencies into an array.
        string[] fullPathDependenciesArray = new string[fullPathDependencies.Count];
        fullPathDependencies.CopyTo(fullPathDependenciesArray, 0);
        // Copy the virtual path into an array.
        string[] virtualPathArray = new string[1];
        virtualPathArray[0] = virtualPath;

        return new CacheDependency(virtualPathArray, fullPathDependenciesArray, utcStart);
      }
      else
            {
                return Previous.GetCacheDependency(virtualPath, virtualPathDependencies, utcStart);
            }
        }
  }
}

Imports System.Data
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.Caching
Imports System.Web.Hosting


Namespace Samples.AspNet.VB
  <AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Medium), _
   AspNetHostingPermission(SecurityAction.InheritanceDemand, level:=AspNetHostingPermissionLevel.High)> _
  Public Class SamplePathProvider
    Inherits VirtualPathProvider

    Private dataFile As String

    Public Sub New()
      MyBase.New()
    End Sub

    Protected Overrides Sub Initialize()
      ' Set the datafile path relative to the application's path.
      dataFile = HostingEnvironment.ApplicationPhysicalPath & _
        "App_Data\XMLData.xml"
    End Sub

    '   Data set provider for the SampleVirtualFile and
    '   SampleVirtualDirectory classes. In a production application
    '   this method would be on a provider class that accesses
    '   the virtual resource data source.
    '   The System.Data.DataSet containing the virtual resources
    '   provided by the SamplePathProvider.
    Public Function GetVirtualData() As DataSet
      ' Get the data from the cache.
      Dim ds As DataSet
      ds = CType(HostingEnvironment.Cache.Get("VPPData"), DataSet)

      If ds Is Nothing Then
        ' Data set not in cache. Read XML file.
        ds = New DataSet
        ds.ReadXml(dataFile)

        ' Make DataSet dependent on XML file.
        Dim cd As CacheDependency
        cd = New CacheDependency(dataFile)

        ' Put DataSet into cache for maximum of 20 minutes.
        HostingEnvironment.Cache.Add("VPPData", ds, cd, _
         Cache.NoAbsoluteExpiration, _
         New TimeSpan(0, 20, 0), _
         CacheItemPriority.Default, Nothing)

        ' Set data timestamp.
        Dim dataTimeStamp As DateTime
        dataTimeStamp = DateTime.Now
        ' Cache it so we can get the timestamp in later calls.
        HostingEnvironment.Cache.Add("dataTimeStamp", dataTimeStamp, Nothing, _
          Cache.NoAbsoluteExpiration, _
          New TimeSpan(0, 20, 0), _
          CacheItemPriority.Default, Nothing)
      End If
      Return ds
    End Function

    Private Function IsPathVirtual(ByVal virtualPath As String) As Boolean
      Dim checkPath As String
      checkPath = VirtualPathUtility.ToAppRelative(virtualPath)
      Return checkPath.StartsWith("~/vrdir", StringComparison.InvariantCultureIgnoreCase)
    End Function

    Public Overrides Function FileExists(ByVal virtualPath As String) As Boolean
      If (IsPathVirtual(virtualPath)) Then
        Dim file As SampleVirtualFile
        file = CType(GetFile(virtualPath), SampleVirtualFile)
        Return file.Exists
      Else
        Return Previous.FileExists(virtualPath)
      End If
    End Function

    Public Overrides Function DirectoryExists(ByVal virtualDir As String) As Boolean
      If (IsPathVirtual(virtualDir)) Then
        Dim dir As SampleVirtualDirectory
        dir = CType(GetDirectory(virtualDir), SampleVirtualDirectory)
        Return dir.exists
      Else
        Return Previous.DirectoryExists(virtualDir)
      End If
    End Function

    Public Overrides Function GetFile(ByVal virtualPath As String) As VirtualFile
      If (IsPathVirtual(virtualPath)) Then
        Return New SampleVirtualFile(virtualPath, Me)
      Else
        Return Previous.GetFile(virtualPath)
      End If
    End Function

    Public Overrides Function GetDirectory(ByVal virtualDir As String) As VirtualDirectory
      If (IsPathVirtual(virtualDir)) Then
        Return New SampleVirtualDirectory(virtualDir, Me)
      Else
        Return Previous.GetDirectory(virtualDir)
      End If
    End Function

    Public Overrides Function GetCacheDependency(ByVal virtualPath As String, ByVal virtualPathDependencies As IEnumerable, ByVal utcStart As Date) As CacheDependency
      If (IsPathVirtual(virtualPath)) Then

        Dim fullPathDependencies As System.Collections.Specialized.StringCollection
        fullPathDependencies = Nothing

        ' Get the full path to all dependencies.
        For Each virtualDependency As String In virtualPathDependencies
          If fullPathDependencies Is Nothing Then
            fullPathDependencies = New System.Collections.Specialized.StringCollection
          End If

          fullPathDependencies.Add(virtualDependency)
        Next

        If fullPathDependencies Is Nothing Then
          Return Nothing
        End If

        Dim fullPathDependenciesArray As String()
        fullPathDependencies.CopyTo(fullPathDependenciesArray, 0)

        Return New CacheDependency(fullPathDependenciesArray, utcStart)
      Else
        Return Previous.GetCacheDependency(virtualPath, virtualPathDependencies, utcStart)
      End If
    End Function
  End Class
End Namespace

Het tweede voorbeeld is het XML-gegevensbestand dat wordt gebruikt om het DataSet object te vullen dat wordt geretourneerd door het aangepaste VirtualPathProvider object. Deze XML-gegevens worden gebruikt om het gebruik van , VirtualPathProviderVirtualDirectoryen VirtualFile objecten te demonstreren voor het ophalen van gegevens uit externe gegevens en zijn niet bedoeld om een gegevensarchief van productiekwaliteit te vertegenwoordigen.

<?xml version="1.0" encoding="utf-8" ?>
  <resource type="dir"
    path="/vrDir"
    parentPath=""
    content="">
    <resource type="file"
      path="/vrDir/Level1FileA.vrf"
      parentPath="/vrDir"
      content="This is the content of file Level1FileA.">
    </resource>
    <resource type="file"
      path="/vrDir/Level1FileB.vrf"
      parentPath="/vrDir"
      content="This is the content of file Level1FileB.">
    </resource>
    <resource type="dir"
      path="/vrDir/Level2DirA"
      parentPath="/vrDir"
      content="">
    <resource type="file"
      path="/vrDir/Level2DirA/Level2FileA.vrf"
      parentPath="/vrDir/Level2DirA"
      content="This is the content of file Level2FileA.">
    </resource>
    <resource type="file"
      path="/vrDir/Level2DirA/Level2FileB.vrf"
      parentPath="/vrDir/Level2DirA"
      content="This is the content of file Level2FileB.">
    </resource>
  </resource>
  <resource type="dir"
    path="/vrDir/Level2DirB"
    parentPath="/vrDir"
    content="">
    <resource type="file"
      path="/vrDir/Level2DirB/Level2FileA.vrf"
      parentPath="/vrDir/Level2DirB"
      content="This is the content of file Level2FileA.">
    </resource>
    <resource type="file"
      path="/vrDir/Level2DirB/Level2FileB.vrf"
      parentPath="/vrDir/Level2DirB"
      content="This is the content of file Level2FileB.">
    </resource>
  </resource>
</resource>

Het derde voorbeeld bevat een AppStart object dat een AppInitialize methode bevat. Deze methode wordt aangeroepen tijdens de initialisatie van een ASP.NET toepassing om een aangepaste initialisatie uit te voeren die vereist is. In dit geval wordt het aangepaste VirtualPathProvider-object geregistreerd met het ASP.NET buildsysteem.

using System.Web.Hosting;

namespace Samples.AspNet.CS
{
  /// <summary>
  ///   Contains the application initialization method
  ///   for the sample application.
  /// </summary>
  public static class AppStart
  {
    public static void AppInitialize()
    {
      SamplePathProvider sampleProvider = new SamplePathProvider();
      HostingEnvironment.RegisterVirtualPathProvider(sampleProvider);
    } 
  }
}

Imports System.Web.Hosting

Namespace Samples.AspNet.VB

  Public Class AppStart

    Public Shared Sub AppInitialize()
      Dim sampleProvider As SamplePathProvider = New SamplePathProvider()
      HostingEnvironment.RegisterVirtualPathProvider(sampleProvider)
    End Sub

  End Class
End Namespace

Het laatste voorbeeld is een ASP.NET pagina met koppelingen naar de virtuele bestanden in het virtuele bestandssysteem.

<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

</script>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
  <meta http-equiv="Content-Type" content="text/html" />
  <title>Virtual Path Provider Example</title>
</head>
<body>
  <form id="form1" runat="server">
    <asp:HyperLink ID="hyperLink1" runat="server" NavigateUrl="vrDir/Level1FileA.vrf" Text="Level 1, File A" /><br />
    <asp:HyperLink ID="hyperLink2" runat="server" NavigateUrl="vrDir/Level1FileB.vrf" Text="Level 1, File B" /><br />
    <asp:HyperLink ID="hyperLink3" runat="server" NavigateUrl="vrDir/Level2DirA/Level2FileA.vrf" Text="Level 2a, File A" /><br />
    <asp:HyperLink ID="hyperLink4" runat="server" NavigateUrl="vrDir/Level2DirA/Level2FileB.vrf" Text="Level 2a, File B" /><br />
    <asp:HyperLink ID="hyperLink5" runat="server" NavigateUrl="vrDir/Level2DirB/Level2FileA.vrf" Text="Level 2b, File A" /><br />
    <asp:HyperLink ID="hyperLink6" runat="server" NavigateUrl="vrDir/Level2DirB/Level2FileB.vrf" Text="Level 2b, File B" /><br />
  </form>
</body>
</html>

<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
  <meta http-equiv="Content-Type" content="text/html" />
  <title>Virtual Path Provider Example</title>
</head>
<body>
  <form id="form1" runat="server">
    <asp:HyperLink ID="hyperLink1" runat="server" NavigateUrl="vrDir/Level1FileA.vrf" Text="Level 1, File A" /><br />
    <asp:HyperLink ID="hyperLink2" runat="server" NavigateUrl="vrDir/Level1FileB.vrf" Text="Level 1, File B" /><br />
    <asp:HyperLink ID="hyperLink3" runat="server" NavigateUrl="vrDir/Level2DirA/Level2FileA.vrf" Text="Level 2a, File A" /><br />
    <asp:HyperLink ID="hyperLink4" runat="server" NavigateUrl="vrDir/Level2DirA/Level2FileB.vrf" Text="Level 2a, File B" /><br />
    <asp:HyperLink ID="hyperLink5" runat="server" NavigateUrl="vrDir/Level2DirB/Level2FileA.vrf" Text="Level 2b, File A" /><br />
    <asp:HyperLink ID="hyperLink6" runat="server" NavigateUrl="vrDir/Level2DirB/Level2FileB.vrf" Text="Level 2b, File B" /><br />
  </form>
</body>
</html>

Opmerkingen

De VirtualPathProvider klasse biedt een set methoden voor het implementeren van een virtueel bestandssysteem voor een webtoepassing. In een virtueel bestandssysteem worden de bestanden en mappen beheerd door een ander gegevensarchief dan het bestandssysteem van de server. U kunt bijvoorbeeld een virtueel bestandssysteem gebruiken om inhoud op te slaan in een SQL Server-database.

U kunt elk bestand opslaan dat op aanvraag wordt verwerkt in een virtueel bestandssysteem. Dit omvat:

• ASP.NET pagina's, basispagina's, gebruikersbesturingselementen en andere objecten.

• Standaardwebpagina's met extensies zoals .htm en .jpg.

• Elke aangepaste extensie die is toegewezen aan een BuildProvider exemplaar.

• Elk benoemd thema in de App_Theme map.

U kunt geen ASP.NET toepassingsmappen of bestanden opslaan die assembly's op toepassingsniveau genereren in een virtueel bestandssysteem. Dit omvat:

• Het bestand Global.asax.

• Web.config bestanden.

• Gegevensbestanden voor siteoverzichten die worden gebruikt door de XmlSiteMapProvider.

• Directory's die toepassingsassembly's bevatten of die toepassingsassembly's genereren: Bin, App_Code, App_GlobalResourceselke App_LocalResources.

• De map met toepassingsgegevens. App_Data

Een VirtualPathProvider registreren

Een aangepast VirtualPathProvider-exemplaar moet worden geregistreerd bij het ASP.NET compilatiesysteem met behulp van de methode HostingEnvironment.RegisterVirtualPathProvider voordat een paginaparsering of compilatie wordt uitgevoerd door de webtoepassing.

Normaal gesproken wordt een VirtualPathProvider exemplaar geregistreerd in een AppInitialize methode die is gedefinieerd in de App_Code map of tijdens de Application_Start gebeurtenis in het Global.asax bestand. Zie de sectie Voorbeeld voor een voorbeeld van het registreren van een VirtualPathProvider exemplaar in een AppInitialize methode.

U kunt een VirtualPathProvider exemplaar registreren tijdens andere gebeurtenissen, maar pagina's die zijn gecompileerd en in de cache opgeslagen voordat het VirtualPathProvider exemplaar wordt geregistreerd, worden niet ongeldig, zelfs als het nieuwe VirtualPathProvider exemplaar nu de bron voor de eerder gecompileerde pagina zou leveren.

Notities voor uitvoerders

Wanneer u overdrat van VirtualPathProvider, moet u de volgende leden overschrijven:

• FileExists(String)

• GetFile(String)

Als uw aangepaste VirtualPathProvider klasse mappen in het virtuele bestandssysteem ondersteunt, moet u de volgende leden overschrijven.

• DirectoryExists(String)

• GetDirectory(String)

  Note: If your virtual file system will contain themes for the Web site (by creating a virtual <code data-dev-comment-type="c">App_Themes</code> directory), your custom <xref data-throw-if-not-resolved="true" uid="System.Web.Hosting.VirtualPathProvider"></xref> class must support directories.
  

  Een aangepaste VirtualPathProvider klasse werkt met klassen die zijn afgeleid van de VirtualFile en VirtualDirectory klassen. U moet afgeleide klassen van deze typen implementeren om bestands- en mapgegevens van uw virtuele bestandssysteem op te geven. Voor een voorbeeld van een aangepaste VirtualFile implementatie raadpleegt u de sectie Voorbeeld van het onderwerp over het VirtualFile klasoverzicht. Voor een voorbeeld van een aangepaste VirtualDirectory implementatie raadpleegt u de sectie Voorbeeld van het onderwerp over het VirtualDirectory klasoverzicht.