BuildProvider Класс

Определение

Определяет набор свойств и методов для создания исходного кода в среде построения ASP.NET.Defines a set of properties and methods for generating source code within the ASP.NET build environment. Это абстрактный класс.This class is abstract.

public ref class BuildProvider abstract
public abstract class BuildProvider
type BuildProvider = class
Public MustInherit Class BuildProvider
Наследование
BuildProvider
Производный

Примеры

В следующем примере кода показана простая реализация поставщика сборки, производная от абстрактного BuildProvider базового класса.The following code example illustrates a simple build provider implementation, inheriting from the abstract BuildProvider base class. Поставщик сборки переопределяет CodeCompilerTypeчлены, GetGeneratedTypeи GenerateCode базового класса.The build provider overrides the CodeCompilerType, GetGeneratedType, and GenerateCode members of the base class. Пример не включает реализацию SampleClassGenerator класса.The example does not include the implementation of the SampleClassGenerator class. Дополнительные сведения см. в 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

Комментарии

Среда сборки ASP.NET использует BuildProvider объекты для создания исходного кода для различных типов файлов в приложении.The ASP.NET build environment uses BuildProvider objects to generate source code for different file types within an application. Классы, производные от, в BuildProvider основном предоставляют исходный код для файлов, веб-страниц, ресурсов и других настраиваемых элементов.Classes derived from BuildProvider predominantly provide source code for files, Web pages, resources, and other custom items.

Как правило, экземпляр BuildProvider класса не создается напрямую.Typically, you do not create an instance of the BuildProvider class directly. Вместо этого реализуется класс, производный от BuildProvider, и BuildProvider настраивается реализация для использования в среде сборки ASP.NET.Instead, you implement a class that derives from BuildProvider, and configure the BuildProvider implementation for use within the ASP.NET build environment.

Экземпляры класса используются с AssemblyBuilder объектами для создания одного или нескольких файлов в скомпилированной сборке. BuildProviderInstances of the BuildProvider class are used with AssemblyBuilder objects to build one or more files into a compiled assembly. Экземпляр создает исходный код на соответствующем языке для отдельных файлов, AssemblyBuilder а объект объединяет источник, который участвует в каждом BuildProvider экземпляре, в одну сборку. BuildProviderA 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.

Среда сборки ASP.NET использует экземпляры BuildProvider класса для построения файлов в приложении.The ASP.NET build environment uses instances of the BuildProvider class to build files within an application. VirtualPath СвойствоBuildProvider класса указывает путь к файлу, который должен быть построен.The VirtualPath property of the BuildProvider class indicates the path of the file to be built. Расширение файла каждого файла в приложении сопоставляется с соответствующим поставщиком сборки.The file extension of each file within an application is mapped to a corresponding build provider. Среда сборки ASP.NET инициализирует BuildProvider экземпляр для каждого файла на основе расширения файла и BuildProvider использует методы для создания исходного кода для файла.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. Среда сборки ASP.NET передает AssemblyBuilder объект на основе предпочтительного языка компилятора и контекста файла BuildProvider в методы при сборке сборки из одного или нескольких BuildProvider файлов, чтобы экземпляр мог участвовать исходный код для файла в общую сборку.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.

Чтобы определить пользовательские действия сборки для типа файла в приложении ASP.NET, необходимо создать производный класс от BuildProviderкласса, реализовать члены в производном классе для создания типа файла и настроить поставщик сборки для соответствующего расширения файла. в файле конфигурации приложения.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.

Определяет расширение файла для поддерживаемых файлов, а также указывает, поддерживает ли поставщик сборки файлы кода, веб-файлы, файлы ресурсов или все файлы.The specifies the file extension for supported files, and whether the build provider supports code files, Web files, resource files or all files. type Используйте атрибут, чтобы указать полное имя типа для реализации поставщика сборки.Use the type attribute to specify the fully qualified type name of the build provider implementation. Используйте класс BuildProviderAppliesToAttribute , чтобы указать, применяется ли поставщик сборки к файлам в каталоге App_Code, к файлам в каталоге веб-содержимого, к глобальным или локальным ресурсам или ко всем файлам.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. Используйте атрибут, чтобы указать расширение файла BuildProvider , используемое для определения файлов, поддерживаемых классом. extensionUse the extension attribute to specify the file extension used to identify files that the BuildProvider class supports. BuildProviderCollection Используйте класс для проверки поставщиков сборки в файле конфигурации.Use the BuildProviderCollection class to examine build providers in a configuration file. Дополнительные сведения о настройке поставщика сборки см. в разделе элемент BuildProvider для компиляции (схема параметров ASP.NET).For more information about configuring a build provider, see buildProviders Element for compilation (ASP.NET Settings Schema).

Чтобы реализовать поставщик сборки, который создает исходный код для пользовательского типа файла, производные от класса BuildProviderи GenerateCode Переопределите метод, чтобы создать исходный код для поддерживаемого типа файла.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. Созданный источник добавляется AssemblyBuilder в объект в форме графа CodeDOM или в виде содержимого, представляющего физический файл исходного кода.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. Если поставщику сборки требуется определенный язык программирования, переопределите CodeCompilerType свойство, чтобы оно CompilerType возвращало объект для поддерживаемого языка программирования.If the build provider requires a specific programming language, override the CodeCompilerType property to return a CompilerType object for the supported programming language. Если поставщику сборки не требуется определенный язык программирования, не переопределяйте CodeCompilerType свойство; используйте реализацию базового класса, которая указывает, что поставщик сборки может использовать любой язык .NET Framework, например Visual Basic или. 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#.

Чтобы реализовать поставщик сборки, создающий исходный код для веб-содержимого, создайте класс, производный от BuildProvider класса, и GetGeneratedType Переопределите Type метод, чтобы он возвращал 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. Переопределите GenerateCode метод, чтобы создать исходный код для типа, предоставленного поддерживаемым файлом.Override the GenerateCode method to generate source code for the type provided by the supported file.

Примечание

Добавление настраиваемого BuildProvider класса в файл Web. config работает на веб-сайте ASP.NET, но не работает в проекте веб-приложения 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. В проекте веб-приложения код, созданный BuildProvider классом, не может быть включен в приложение.In a Web application project, the code that is generated by the BuildProvider class cannot be included in the application. Дополнительные сведения см. в разделе Обзор предварительной компиляции проекта веб-приложения ASP.NET.For more information, see ASP.NET Web Application Project Precompilation Overview.

Конструкторы

BuildProvider()

Инициализирует новый экземпляр класса BuildProvider.Initializes a new instance of the BuildProvider class.

Свойства

CodeCompilerType

Представляет тип компилятора, используемый поставщиком построения для создания исходного кода пользовательского типа файлов.Represents the compiler type used by a build provider to generate source code for a custom file type.

ReferencedAssemblies

Представляет сборки для компиляции с исходным кодом, созданным поставщиком построения.Represents the assemblies to compile with the source generated by the build provider.

VirtualPath

Представляет файл, который необходимо построить с помощью данной реализации поставщика построения.Represents the file to be built by this build provider implementation.

VirtualPathDependencies

Представляет коллекцию виртуальных путей, которые необходимо построить до того, как поставщик построения создаст код.Represents a collection of virtual paths that must be built before the build provider generates code.

Методы

Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GenerateCode(AssemblyBuilder)

Создает исходный код для виртуального пути к поставщику построения и добавляет исходный код в заданный построитель сборок.Generates source code for the virtual path of the build provider, and adds the source code to a specified assembly builder.

GetCodeCompileUnit(IDictionary)

Представляет контейнер для созданного графа CodeDOM.Represents the container for the generated CodeDOM graph.

GetCustomString(CompilerResults)

Создает строку, которую необходимо сохранить в скомпилированной сборке.Generates a string to be persisted in the compiled assembly.

GetDefaultCompilerType()

Возвращает параметры компилятора для языка приложения по умолчанию.Returns the compiler settings for the default language in the application.

GetDefaultCompilerTypeForLanguage(String)

Возвращает параметры компилятора для поставщика построения, исходя из заданного языка.Returns the compiler settings for the build provider based on the specified language.

GetGeneratedType(CompilerResults)

Возвращает тип, созданный поставщиком построения из виртуального пути.Returns a type generated by the build provider from the virtual path.

GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetResultFlags(CompilerResults)

Возвращает значение, определяющее действия, которые необходимо выполнить после построения виртуального пути.Returns a value indicating actions required when a virtual path is built.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
OpenReader()

Открывает средство чтения текста для считывания данных из виртуального пути к текущему объекту поставщика построения.Opens a text reader for reading from the virtual path of the current build provider object.

OpenReader(String)

Открывает средство чтения текста для считывания данных из заданного виртуального пути.Opens a text reader for reading from a specified virtual path.

OpenStream()

Открывает поток для считывания данных из виртуального пути к текущему объекту поставщика построения.Opens a stream for reading the virtual path of the current build provider object.

OpenStream(String)

Открывает поток для считывания данных из заданного виртуального пути.Opens a stream for reading from a specified virtual path.

ProcessCompileErrors(CompilerResults)

При переопределении в производном классе позволяет просматривать сообщения об ошибках компилятора, чтобы их можно было изменить для предоставления более подробной информации.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)

Регистрирует поставщик построения.Registers a build provider.

ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Применяется к

Дополнительно