BuildProvider Classe

Definição

Define um conjunto de propriedades e métodos para a geração de código-fonte dentro do ambiente de build do ASP.NET.Defines a set of properties and methods for generating source code within the ASP.NET build environment. Esta classe é abstrata.This class is abstract.

public ref class BuildProvider abstract
public abstract class BuildProvider
type BuildProvider = class
Public MustInherit Class BuildProvider
Herança
BuildProvider
Derivado

Exemplos

O exemplo de código a seguir ilustra uma implementação de provedor de compilação simples, herdando da classe base abstrata BuildProvider.The following code example illustrates a simple build provider implementation, inheriting from the abstract BuildProvider base class. O provedor de compilação substitui os membros CodeCompilerType, GetGeneratedTypee GenerateCode da classe base.The build provider overrides the CodeCompilerType, GetGeneratedType, and GenerateCode members of the base class. O exemplo não inclui a implementação da classe SampleClassGenerator.The example does not include the implementation of the SampleClassGenerator class. Para obter mais informações, consulte a visão geral da classe CodeCompileUnit.For more information, see the CodeCompileUnit class overview.

using System;
using System.Collections;
using System.IO;
using System.Text;
using System.Web;
using System.Web.Compilation;
using System.CodeDom.Compiler;
using System.CodeDom;
using System.Security;
using System.Security.Permissions;

// Define a simple build provider implementation.
[PermissionSet(SecurityAction.Demand, Unrestricted = true)]
public class SampleBuildProvider : BuildProvider
{
    // Define an internal member for the compiler type.
    protected CompilerType _compilerType = null;

    public SampleBuildProvider()
    {
        _compilerType = GetDefaultCompilerTypeForLanguage("C#");
    }

    // Return the internal CompilerType member 
    // defined in this implementation.
    public override CompilerType CodeCompilerType
    {
        get { return _compilerType; }
    }

    // Define the build provider implementation of the GenerateCode method.
    public override void GenerateCode(AssemblyBuilder assemBuilder)
    {
        // Generate a code compile unit, and add it to
        // the assembly builder.

        TextWriter tw = assemBuilder.CreateCodeFile(this);
        if (tw != null)
        {
            try
            {
                // Generate the code compile unit from the virtual path.
                CodeCompileUnit compileUnit = SampleClassGenerator.BuildCompileUnitFromPath(VirtualPath);

                // Generate the source for the code compile unit, 
                // and write it to a file specified by the assembly builder.
                CodeDomProvider provider = assemBuilder.CodeDomProvider;
                provider.GenerateCodeFromCompileUnit(compileUnit, tw, null);
            }
            finally
            {
                tw.Close();
            }
        }
    }

    public override System.Type GetGeneratedType(CompilerResults results)
    {
        string typeName = SampleClassGenerator.TypeName;

        return results.CompiledAssembly.GetType(typeName);
    }
}
Imports System.Collections
Imports System.IO
Imports System.Text
Imports System.Web
Imports System.Web.Compilation
Imports System.CodeDom.Compiler
Imports System.CodeDom
Imports System.Security
Imports System.Security.Permissions

<PermissionSet(SecurityAction.Demand, Unrestricted := true)> _
Public Class SampleBuildProvider
    Inherits BuildProvider

    Protected _compilerType As CompilerType = Nothing

    Public Sub New()
        _compilerType = GetDefaultCompilerType()
    End Sub

    ' Return the internal CompilerType member 
    ' defined in this implementation.
    Public Overrides ReadOnly Property CodeCompilerType() As CompilerType
        Get
            CodeCompilerType = _compilerType
        End Get
    End Property


    ' Define the build provider implementation of the GenerateCode method.
    Public Overrides Sub GenerateCode(ByVal assemBuilder As AssemblyBuilder)
        ' Generate a code compile unit, and add it to
        ' the assembly builder.

        Dim tw As TextWriter = assemBuilder.CreateCodeFile(Me)
        If Not tw Is Nothing Then
            Try
                ' Generate the code compile unit from the virtual path.
                Dim compileUnit As CodeCompileUnit = _
                        SampleClassGenerator.BuildCompileUnitFromPath(VirtualPath)

                ' Generate the source for the code compile unit, 
                ' and write it to a file specified by the assembly builder.
                Dim provider As CodeDomProvider = assemBuilder.CodeDomProvider
                provider.GenerateCodeFromCompileUnit(compileUnit, tw, Nothing)
            Finally
                tw.Close()
            End Try

        End If
    End Sub

    Public Overrides Function GetGeneratedType(ByVal results As CompilerResults) As System.Type
        Dim typeName As String = SampleClassGenerator.TypeName

        Return results.CompiledAssembly.GetType(typeName)
    End Function

End Class

Comentários

O ambiente de compilação ASP.NET usa BuildProvider objetos para gerar código-fonte para diferentes tipos de arquivo dentro de um aplicativo.The ASP.NET build environment uses BuildProvider objects to generate source code for different file types within an application. Classes derivadas de BuildProvider fornecem predominantemente o código-fonte para arquivos, páginas da Web, recursos e outros itens personalizados.Classes derived from BuildProvider predominantly provide source code for files, Web pages, resources, and other custom items.

Normalmente, você não cria uma instância da classe BuildProvider diretamente.Typically, you do not create an instance of the BuildProvider class directly. Em vez disso, você implementa uma classe que deriva de BuildProvidere configura a implementação de BuildProvider para uso dentro do ambiente de compilação ASP.NET.Instead, you implement a class that derives from BuildProvider, and configure the BuildProvider implementation for use within the ASP.NET build environment.

As instâncias da classe BuildProvider são usadas com AssemblyBuilder objetos para criar um ou mais arquivos em um assembly compilado.Instances of the BuildProvider class are used with AssemblyBuilder objects to build one or more files into a compiled assembly. Uma instância de BuildProvider gera o código-fonte no idioma apropriado para arquivos individuais, e o objeto AssemblyBuilder combina a origem contribuída por cada instância BuildProvider em um único assembly.A BuildProvider instance generates source code in the appropriate language for individual files, and the AssemblyBuilder object combines the source contributed by each BuildProvider instance into a single assembly.

O ambiente de compilação ASP.NET usa instâncias da classe BuildProvider para criar arquivos dentro de um aplicativo.The ASP.NET build environment uses instances of the BuildProvider class to build files within an application. A propriedade VirtualPath da classe BuildProvider indica o caminho do arquivo a ser compilado.The VirtualPath property of the BuildProvider class indicates the path of the file to be built. A extensão de arquivo de cada arquivo em um aplicativo é mapeada para um provedor de compilação correspondente.The file extension of each file within an application is mapped to a corresponding build provider. O ambiente de compilação ASP.NET Inicializa uma instância de BuildProvider para cada arquivo com base na extensão de arquivo e usa os métodos BuildProvider para gerar o código-fonte para o arquivo.The ASP.NET build environment initializes a BuildProvider instance for each file based on the file extension, and uses the BuildProvider methods to generate source code for the file. O ambiente de compilação ASP.NET passa um objeto AssemblyBuilder com base na linguagem de compilador preferida e no contexto do arquivo para os métodos BuildProvider ao criar um assembly a partir de um ou mais arquivos, para que a instância BuildProvider possa contribuir com o código-fonte de seu arquivo para o assembly geral.The ASP.NET build environment passes an AssemblyBuilder object based on the preferred compiler language and the context of the file to the BuildProvider methods when building an assembly from one or more files, so that the BuildProvider instance can contribute source code for its file to the overall assembly.

Para definir ações de compilação personalizadas para um tipo de arquivo em um aplicativo ASP.NET, você deve derivar uma classe de BuildProvider, implementar membros dentro da classe derivada para criar o tipo de arquivo e configurar o provedor de compilação para a extensão de arquivo correspondente no arquivo de configuração do aplicativo.To define custom build actions for a file type within an ASP.NET application, you must derive a class from BuildProvider, implement members within the derived class for building the file type, and configure the build provider for the corresponding file extension within the application configuration file.

O especifica a extensão de arquivo para arquivos com suporte e se o provedor de compilação dá suporte a arquivos de código, arquivos da Web, arquivos de recursos ou todos os arquivos.The specifies the file extension for supported files, and whether the build provider supports code files, Web files, resource files or all files. Use o atributo type para especificar o nome do tipo totalmente qualificado da implementação do provedor de compilação.Use the type attribute to specify the fully qualified type name of the build provider implementation. Use a classe BuildProviderAppliesToAttribute para especificar se o provedor de compilação se aplica a arquivos no diretório App_Code, a arquivos em um diretório de conteúdo da Web, a recursos globais ou locais ou a todos os arquivos.Use the BuildProviderAppliesToAttribute class to specify whether the build provider applies to files in the App_Code directory, to files in a Web content directory, to global or local resources, or to all files. Use o atributo extension para especificar a extensão de arquivo usada para identificar os arquivos aos quais a classe BuildProvider dá suporte.Use the extension attribute to specify the file extension used to identify files that the BuildProvider class supports. Use a classe BuildProviderCollection para examinar os provedores de compilação em um arquivo de configuração.Use the BuildProviderCollection class to examine build providers in a configuration file. Para obter mais informações sobre como configurar um provedor de compilação, consulte elemento buildproviders para compilação (esquema de configurações do ASP.net).For more information about configuring a build provider, see buildProviders Element for compilation (ASP.NET Settings Schema).

Para implementar um provedor de compilação que gera código-fonte para um tipo de arquivo personalizado, derive uma classe de BuildProvidere substitua o método GenerateCode para gerar o código-fonte para o tipo de arquivo com suporte.To implement a build provider that generates source code for a custom file type, derive a class from BuildProvider, and override the GenerateCode method to generate source code for the supported file type. A fonte gerada é adicionada ao objeto AssemblyBuilder na forma de um grafo do CodeDOM ou como conteúdo que representa um arquivo de código-fonte físico.The generated source is added to the AssemblyBuilder object in the form of a CodeDOM graph, or as content that represents a physical source code file. Se o provedor de compilação exigir uma linguagem de programação específica, substitua a propriedade CodeCompilerType para retornar um objeto CompilerType para a linguagem de programação com suporte.If the build provider requires a specific programming language, override the CodeCompilerType property to return a CompilerType object for the supported programming language. Se o provedor de compilação não exigir uma linguagem de programação específica, não substitua a propriedade CodeCompilerType; Use a implementação da classe base, que indica que o provedor de compilação pode usar qualquer linguagem de .NET Framework, como Visual Basic ou C# .If the build provider does not require a specific programming language, do not override the CodeCompilerType property; use the base class implementation, which indicates that the build provider can use any .NET Framework language, such as Visual Basic or C#.

Para implementar um provedor de compilação que gera código-fonte para conteúdo da Web, derive uma classe de BuildProvider e substitua o método GetGeneratedType para retornar o Type para a classe gerada pelo BuildProvider.To implement a build provider that generates source code for Web content, derive a class from BuildProvider and override the GetGeneratedType method to return the Type for the class generated by BuildProvider. Substitua o método GenerateCode para gerar o código-fonte para o tipo fornecido pelo arquivo com suporte.Override the GenerateCode method to generate source code for the type provided by the supported file.

Observação

Adicionar uma classe de BuildProvider personalizada ao arquivo Web. config funciona em um site ASP.NET, mas não funciona em um projeto de aplicativo Web ASP.NET.Adding a customized BuildProvider class to the Web.config file works in an ASP.NET Web site but does not work in an ASP.NET Web application project. Em um projeto de aplicativo Web, o código gerado pela classe BuildProvider não pode ser incluído no aplicativo.In a Web application project, the code that is generated by the BuildProvider class cannot be included in the application. Para obter mais informações, consulte visão geral da pré-compilação do projeto de aplicativo Web ASP.net.For more information, see ASP.NET Web Application Project Precompilation Overview.

Construtores

BuildProvider()

Inicia uma nova instância da classe BuildProvider.Initializes a new instance of the BuildProvider class.

Propriedades

CodeCompilerType

Representa o tipo de compilador usado por um provedor de build para gerar o código-fonte para um tipo de arquivo personalizado.Represents the compiler type used by a build provider to generate source code for a custom file type.

ReferencedAssemblies

Representa os assemblies a serem compilados com a origem gerada pelo provedor de build.Represents the assemblies to compile with the source generated by the build provider.

VirtualPath

Representa o arquivo a ser criado por esta implementação de provedor de build.Represents the file to be built by this build provider implementation.

VirtualPathDependencies

Representa uma coleção de caminhos virtuais que devem ser compilados antes de o provedor de build gerar o código.Represents a collection of virtual paths that must be built before the build provider generates code.

Métodos

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object.

(Herdado de Object)
GenerateCode(AssemblyBuilder)

Gera o código-fonte para o caminho virtual do provedor de build e adiciona o código-fonte a um construtor de assembly especificado.Generates source code for the virtual path of the build provider, and adds the source code to a specified assembly builder.

GetCodeCompileUnit(IDictionary)

Representa o contêiner para o gráfico de CodeDOM gerado.Represents the container for the generated CodeDOM graph.

GetCustomString(CompilerResults)

Gera uma cadeia de caracteres a ser persistida no assembly compilado.Generates a string to be persisted in the compiled assembly.

GetDefaultCompilerType()

Retorna as configurações do compilador para o idioma padrão no aplicativo.Returns the compiler settings for the default language in the application.

GetDefaultCompilerTypeForLanguage(String)

Retorna as configurações do compilador para o provedor de build com base no idioma especificado.Returns the compiler settings for the build provider based on the specified language.

GetGeneratedType(CompilerResults)

Retorna um tipo gerado pelo provedor de build do caminho virtual.Returns a type generated by the build provider from the virtual path.

GetHashCode()

Serve como a função de hash padrão.Serves as the default hash function.

(Herdado de Object)
GetResultFlags(CompilerResults)

Retorna um valor que indica as ações necessárias quando um caminho virtual é compilado.Returns a value indicating actions required when a virtual path is built.

GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
OpenReader()

Abre um leitor de texto para leitura do caminho virtual do objeto de provedor de build atual.Opens a text reader for reading from the virtual path of the current build provider object.

OpenReader(String)

Abre um leitor de texto para leitura de um caminho virtual especificado.Opens a text reader for reading from a specified virtual path.

OpenStream()

Abre um fluxo para leitura do caminho virtual do objeto de provedor de build atual.Opens a stream for reading the virtual path of the current build provider object.

OpenStream(String)

Abre um fluxo para leitura de um caminho virtual especificado.Opens a stream for reading from a specified virtual path.

ProcessCompileErrors(CompilerResults)

Quando substituído em uma classe derivada, permite que você examine as mensagens de erro do compilador para que possa modificá-las para fornecer mais informações.When overridden in a derived class, enables you to review compiler error messages so that you can modify them to provide more information.

RegisterBuildProvider(String, Type)

Registra um provedor de build.Registers a build provider.

ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)

Aplica-se a

Veja também