Скомпилированные привязки

Обзор примера

Привязки данных .NET Multi-platform App UI (.NET MAUI) имеют две основные проблемы:

1. Не выполняется проверка выражений привязки во время компиляции. Вместо этого привязки разрешаются во время выполнения. Таким образом, недопустимые привязки проявляются только во время выполнения в виде нарушений в поведении приложения или сообщений об ошибке.
2. Затрачиваются избыточные ресурсы. Привязки разрешаются во время выполнения с использованием проверки объектов общего назначения (отражение), причем объем затрачиваемых на это ресурсов зависит от платформы.

Скомпилированные привязки повышают производительность привязки данных в приложениях .NET MAUI, разрешая выражения привязки во время компиляции, а не во время выполнения. Кроме того, такая проверка выражений привязки во время компиляции позволяет повысить эффективность устранения неполадок, поскольку недопустимые привязки выявляются как ошибки построения.

Скомпилированные привязки в XAML

Чтобы использовать скомпилированные привязки в XAML, задайте x:DataType атрибут для VisualElement типа объекта, к которому VisualElement привязываются его дочерние элементы. Атрибут x:DataType рекомендуется задавать на том же уровне иерархии представления, на котором задается BindingContext. Однако этот атрибут может быть переопределен в любом месте иерархии представлений.

Внимание

Скомпилированные привязки требуют использования компиляции XAML, которая включена по умолчанию в .NET MAUI. Если вы отключили компиляцию XAML, ее необходимо включить. Дополнительные сведения см. в разделе Компиляция XAML.

Чтобы использовать скомпилированные привязки в XAML, x:DataType атрибут должен иметь строковый литерал или тип с помощью x:Type расширения разметки. Во время компиляции XAML любые недопустимые выражения привязки будут выявляться как ошибки построения. Тем не менее компилятор XAML будет возвращать ошибку построения только для первого обнаруженного недопустимого выражения привязки. Любые допустимые выражения привязки, которые определены для объекта VisualElement или его дочерних объектов, будут скомпилированы независимо от того, задается ли BindingContext в XAML или в коде. При компиляции выражения привязки создается скомпилированный код, который получает значение из свойства источника и присваивает его свойству адресата, который указан в разметке. Кроме того, в зависимости от выражения привязки созданный код может наблюдать изменения в значении свойства источника и обновляет свойство адресата, а также может отправлять изменения из адресата обратно в источник.

Внимание

Скомпилированные привязки отключены для любых выражений привязки XAML, определяющих Source свойство. Это связано с тем, что свойство Source всегда задается с использованием расширения разметки x:Reference, которое не может быть разрешено во время компиляции.

Кроме того, скомпилированные привязки в XAML в настоящее время не поддерживаются в нескольких привязках.

По умолчанию .NET MAUI не создает предупреждения сборки для привязок XAML, которые не используют скомпилированные привязки. Однако вы можете выбрать скомпилированные предупреждения о привязках, создаваемые путем задания $(MauiStrictXamlCompilation) свойства true сборки в файле проекта приложения (*.csproj):

<MauiStrictXamlCompilation>true</MauiStrictXamlCompilation>

Дополнительные сведения о предупреждениях компилированных привязок XAML см . в предупреждениях скомпилированных привязок XAML.

Использование скомпилированных привязок в XAML

В следующем примере показано использование скомпилированных привязок между представлениями .NET MAUI и свойствами viewmodel:

<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:local="clr-namespace:DataBindingDemos"
             x:Class="DataBindingDemos.CompiledColorSelectorPage"
             x:DataType="local:HslColorViewModel"
             Title="Compiled Color Selector">
    <ContentPage.BindingContext>
        <local:HslColorViewModel Color="Sienna" />
    </ContentPage.BindingContext>
    ...
    <StackLayout>
        <BoxView Color="{Binding Color}"
                 ... />
        <StackLayout Margin="10, 0">
            <Label Text="{Binding Name}" />
            <Slider Value="{Binding Hue}" />
            <Label Text="{Binding Hue, StringFormat='Hue = {0:F2}'}" />
            <Slider Value="{Binding Saturation}" />
            <Label Text="{Binding Saturation, StringFormat='Saturation = {0:F2}'}" />
            <Slider Value="{Binding Luminosity}" />
            <Label Text="{Binding Luminosity, StringFormat='Luminosity = {0:F2}'}" />
        </StackLayout>
    </StackLayout>    
</ContentPage>

Создает ContentPage экземпляр HslColorViewModel свойства и инициализирует Color свойство в тегах элементов свойства для BindingContext свойства. Кроме того, атрибут ContentPage определяется x:DataType как тип viewmodel, указывающий, что любые выражения привязки в иерархии представлений ContentPage будут скомпилированы. Это можно проверить, изменив любое выражение привязки так, чтобы оно было привязано к несуществующему свойству модели представления, что приведет к ошибке сборки. Хотя в этом примере атрибуту x:DataType присваивается строковый литерал, для него также можно задать тип с расширением разметки x:Type. Дополнительные сведения о расширении разметки x:Type см. в разделе Расширение разметки x:Type.

Внимание

Обратите внимание, что атрибут x:DataType может быть переопределен в любом месте иерархии представления.

Элементы BoxView, Label и представления Slider наследуют контекст привязки из представления ContentPage. Эти представления являются целевыми объектами привязки, которые ссылаются на свойства источника в модели представления. Для свойств BoxView.Color и Label.Text привязки данных имеют режим OneWay: свойства в представлении задаются по свойствам в модели представления. Тем не менее свойство Slider.Value использует привязку TwoWay. Поэтому каждый объект Slider задается из модели представления, а модель представления задается из каждого объекта Slider.

При первом запуске BoxViewLabel примера элементы и Slider элементы задаются из модели представления на основе начального Color свойства, заданного при создании экземпляра модели представления. По мере управления BoxView Label ползунками элементы обновляются соответствующим образом:

Дополнительные сведения об этом селекторе цветов см. в разделе ViewModels и уведомления об изменении свойств.

Использование скомпилированных привязок в XAML в DataTemplate

Привязки в DataTemplate интерпретируются в контексте объекта, к которому применяется шаблон. Таким образом, при использовании скомпилированных привязок в DataTemplate объект DataTemplate должен объявлять тип своего объекта данных с использованием атрибута x:DataType. Сбой этого может привести к DataTemplate наследованию неправильного x:DataType из родительской области:

<ContentPage ...
             x:DataType="local:AnimalsPageViewModel">
    <!-- Binding to AnimalsPageViewModel.Animals -->
    <CollectionView ItemsSource="{Binding Animals}">
        <CollectionView.ItemTemplate>
            <DataTemplate>
                <!-- incorrect: compiler thinks you want to bind to AnimalsPageViewModel.Name -->  
                <Label Text="{Binding Name}" />
            </DataTemplate>
        </CollectionView.ItemTemplate>
    </CollectionView>
</ContentPage>

В следующем примере показано правильное задание параметра x:DataType DataTemplate:

<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:local="clr-namespace:DataBindingDemos"
             x:Class="DataBindingDemos.CompiledColorListPage"
             Title="Compiled Color List">
    <Grid>
        ...
        <ListView x:Name="colorListView"
                  ItemsSource="{x:Static local:NamedColor.All}"
                  ... >
            <ListView.ItemTemplate>
                <DataTemplate x:DataType="local:NamedColor">
                    <ViewCell>
                        <StackLayout Orientation="Horizontal">
                            <BoxView Color="{Binding Color}"
                                     ... />
                            <Label Text="{Binding FriendlyName}"
                                   ... />
                        </StackLayout>
                    </ViewCell>
                </DataTemplate>
            </ListView.ItemTemplate>
        </ListView>
        <!-- The BoxView doesn't use compiled bindings -->
        <BoxView Color="{Binding Source={x:Reference colorListView}, Path=SelectedItem.Color}"
                 ... />
    </Grid>
</ContentPage>

Свойство ListView.ItemsSource получает статическое свойство NamedColor.All. Класс NamedColor использует отражение .NET для перечисления всех статических открытых полей в Colors классе и хранения их имен в коллекции, доступной из статического All свойства. Таким образом, объект ListView заполняется экземплярами NamedColor. Для каждого элемента в ListView в качестве контекста привязки для элемента задается объект NamedColor. Элементы BoxView и Label в объекте ViewCell привязываются к свойствам NamedColor.

Определяет DataTemplate атрибут NamedColor типа, указывающий, что любые выражения привязки в DataTemplate иерархии представлений будут x:DataType скомпилированы. Это можно проверить, изменив любое выражение привязки так, чтобы оно было привязано к несуществующему свойству NamedColor, что приведет к ошибке построения. Хотя в этом примере атрибуту x:DataType присваивается строковый литерал, для него также можно задать тип с расширением разметки x:Type. Дополнительные сведения о расширении разметки x:Type см. в разделе Расширение разметки x:Type.

При первом запуске ListView примера заполняется NamedColor экземплярами. При выборе элемента в объекте ListView свойству BoxView.Color присваивается цвет элемента, выбранного в ListView:

При выборе других элементов в ListView обновляется цвет элемента BoxView.

Объединение скомпилированных привязок с классическими привязками в XAML

Выражения привязки компилируются только для иерархии представления, в которой определен атрибут x:DataType. И наоборот, любые представления в иерархии, в которой не определен атрибут x:DataType, будут использовать классические привязки. Таким образом, на одной странице могут объединяться скомпилированные и классические привязки. Например, в предыдущем разделе представления в DataTemplate используют скомпилированные привязки, а элемент BoxView, которому присваивается выбранный в ListView цвет, не использует их.

Таким образом, при тщательной проработке структуры атрибутов x:DataType на одной странице могут одновременно использоваться скомпилированные и классические привязки. Кроме того, атрибут x:DataType может в любом месте иерархии быть переопределен как null с использованием расширения разметки x:Null. Это указывает, что любые выражения привязки в иерархии этого представления будут использовать классические привязки. В следующем примере демонстрируется такой подход:

<StackLayout x:DataType="local:HslColorViewModel">
    <StackLayout.BindingContext>
        <local:HslColorViewModel Color="Sienna" />
    </StackLayout.BindingContext>
    <BoxView Color="{Binding Color}"
             VerticalOptions="FillAndExpand" />
    <StackLayout x:DataType="{x:Null}"
                 Margin="10, 0">
        <Label Text="{Binding Name}" />
        <Slider Value="{Binding Hue}" />
        <Label Text="{Binding Hue, StringFormat='Hue = {0:F2}'}" />
        <Slider Value="{Binding Saturation}" />
        <Label Text="{Binding Saturation, StringFormat='Saturation = {0:F2}'}" />
        <Slider Value="{Binding Luminosity}" />
        <Label Text="{Binding Luminosity, StringFormat='Luminosity = {0:F2}'}" />
    </StackLayout>
</StackLayout>   

Корневое представление StackLayout задает атрибут x:DataType как тип HslColorViewModel, указывая, что любое выражение привязки в иерархии корневого представления StackLayout будет компилироваться. Тем не менее внутреннее представление StackLayout переопределяет атрибут x:DataType как null с использованием расширения разметки x:Null. Таким образом, в выражениях привязки внутреннего представления StackLayout используются классические привязки. Скомпилированные привязки используются только элементом BoxView в иерархии корневого представления StackLayout.

Дополнительные сведения о расширении разметки x:Null см. в статье Расширение разметки x:Null.

Предупреждения о скомпилированных привязках XAML

В следующей таблице перечислены предупреждения компилятора для скомпилированных привязок и способы их устранения:

Код	Сообщение	Fix
XC0022	Привязка может быть скомпилирована для повышения производительности среды выполнения при x:DataType указании.	Добавьте x:DataType в XAML, чтобы указать тип текущего BindingContext. Рекомендуется добавить x:DataType все элементы, в которых изменяется контекст привязки.
XC0023	Привязка может быть скомпилирована для повышения производительности среды выполнения, если x:DataType она не является явной null.	Замените x:DataType="{x:Null}" правильным типом.

Чтобы убедиться, что эти предупреждения не игнорируются, рассмотрите возможность изменения конкретных предупреждений для создания ошибок со свойством $(WarningsAsErrors) сборки:

<WarningsAsErrors>$(WarningsAsErrors);XC0022;XC0023</WarningsAsErrors>

Чтобы игнорировать эти предупреждения, используйте $(NoWarn) свойство сборки с определенными кодами предупреждений:

<NoWarn>$(NoWarn);XC0022;XC0023</NoWarn>

Внимание

XC0022 и XC0023 предупреждения всегда будут подавляться, если $(MauiStrictXamlCompilation) для свойства сборки не задано значение true.

Если в файле проекта приложения задано $(TreatWarningsAsErrors) свойство true сборки, но вы хотите игнорировать определенные предупреждения компилятора XAML, используйте $(NoWarn) свойство сборки для молчания этих предупреждений или $(WarningsNotAsErrors) свойства сборки, чтобы уменьшить серьезность некоторых конкретных кодов.

Производительность

Скомпилированные привязки повышают производительность привязки данных с различными преимуществами производительности:

• Скомпилированные привязки, использующие уведомление об изменении свойства (то есть привязки в режиме OneWay, OneWayToSource или TwoWay), разрешаются примерно в 8 раз быстрее относительно классических привязок.
• Скомпилированные привязки, не использующие уведомление об изменении свойства (то есть привязки в режиме OneTime), разрешаются примерно в 20 раз быстрее относительно классических привязок.
• Задание BindingContext для скомпилированных привязок, использующих уведомление об изменении свойства (то есть для привязок в режиме OneWay, OneWayToSource или TwoWay), выполняется примерно в 5 раз быстрее, чем задание BindingContext для классических привязок.
• Задание BindingContext для скомпилированных привязок, не использующих уведомление об изменении свойства (то есть для привязок в режиме OneTime), выполняется примерно в 7 раз быстрее, чем задание BindingContext для классических привязок.

Выигрыш в производительности может быть еще более весомым на мобильных устройствах в зависимости от используемой платформы, версии операционной системы и типа устройства, на котором выполняется приложение.