Интеграция компонентов ASP.NET Core Razor с MVC или Razor Pages в размещенных Blazor WebAssembly решениях
Примечание.
Размещенные Blazor WebAssembly решения остаются поддерживаемыми, но шаблон проекта был удален и больше не поддерживается в .NET 8 или более поздней версии. Эта статья отображается в оглавлении до .NET 7 для справки, но обратите внимание, что .NET 7 — это выпуск срока поддержки standard, который больше не поддерживается.
Предупреждение
Эта версия ASP.NET Core больше не поддерживается. Дополнительные сведения см. в политике поддержки .NET и .NET Core.
В этой статье описываются Razor сценарии интеграции компонентов для размещенных Blazor WebAssembly приложений, включая предварительное отображение Razor компонентов на сервере.
Внимание
Изменения платформы в ASP.NET Core привели к различным наборам инструкций в этой статье. Прежде чем использовать инструкции этой статьи, убедитесь, что селектор версий документов в верхней части этой статьи соответствует версии ASP.NET Core, которую вы планируете использовать для приложения.
Предварительная отрисовка может улучшить оптимизацию для поисковых систем (SEO) за счет визуализации содержимого для первоначального ответа HTTP, который поисковые системы могут использовать для вычисления ранга страницы.
Конфигурация решения
Конфигурация предварительной отрисовки
Чтобы настроить предварительную отрисовку для размещенного приложения Blazor WebAssembly, сделайте следующее:
Разместите приложение Blazor WebAssembly в приложении ASP.NET Core. Вы можете добавить изолированное приложение Blazor WebAssembly в решение ASP.NET Core или использовать размещенное приложение Blazor WebAssembly, созданное из Blazor WebAssembly шаблона проекта, с помощью параметра размещения:
- Visual Studio: в диалоговом окне Дополнительные сведения установите флажок Размещено в ASP.NET Core при создании приложения Blazor WebAssembly. В примерах, используемых в этой статье, такое решение называется
BlazorHosted
. - Командная оболочка Visual Studio Code или .NET CLI:
dotnet new blazorwasm -ho
(используйте параметр-ho|--hosted
). Используйте параметр-o|--output {LOCATION}
, чтобы создать папку для решения и задать пространства имен проекта для решения. В примерах, используемых в этой статье, такое решение называетсяBlazorHosted
(dotnet new blazorwasm -ho -o BlazorHosted
).
Для примеров в этой статье используется имя размещенного решения (имя сборки)
BlazorHosted
. Пространством имен проекта клиента будетBlazorHosted.Client
, а пространством имен проекта сервера —BlazorHosted.Server
.- Visual Studio: в диалоговом окне Дополнительные сведения установите флажок Размещено в ASP.NET Core при создании приложения Blazor WebAssembly. В примерах, используемых в этой статье, такое решение называется
wwwroot/index.html
Удалите файл из Blazor WebAssemblyClient проекта.В проекте Client удалите следующие строки из файла
Program.cs
:- builder.RootComponents.Add<App>("#app"); - builder.RootComponents.Add<HeadOutlet>("head::after");
Добавьте файл
_Host.cshtml
в папкуPages
проекта Server. Файлы из проекта, созданного на основе шаблона Blazor Server, можно получить с помощью Visual Studio или .NET CLI. Для этого выполните в командной оболочке командуdotnet new blazorserver -o BlazorServer
(параметр-o BlazorServer
позволяет создать папку для проекта). Поместив файлы в папкуPages
проекта Server, внесите в файлы следующие изменения.Внесите указанные ниже изменения в файл
_Host.cshtml
.Обновите пространство имен
Pages
в верхней части файла, чтобы оно соответствовало пространству имен для страниц приложения Server. Заполнитель{APP NAMESPACE}
в следующем примере представляет пространство имен для страниц донорского приложения, из которого взят файл_Host.cshtml
:Удалить:
- @namespace {APP NAMESPACE}.Pages
Добавьте следующие пакеты:
@namespace BlazorHosted.Server.Pages
Добавьте директиву
@using
для проекта Client в начало файла:@using BlazorHosted.Client
Обновите ссылки таблицы стилей, чтобы они указывали на таблицы стилей проекта WebAssembly. В следующем примере для проекта клиента используется пространство имен
BlazorHosted.Client
: Заполнитель{APP NAMESPACE}
представляет пространство имен донорского приложения, из которого взят файл_Host.cshtml
. Обновите режим вспомогательной функции тегов компонента (тег<component>
) для компонентаHeadOutlet
, чтобы выполнить предварительную отрисовку компонента.Удалить:
- <link href="css/site.css" rel="stylesheet" /> - <link href="{APP NAMESPACE}.styles.css" rel="stylesheet" /> - <component type="typeof(HeadOutlet)" render-mode="ServerPrerendered" />
Добавьте следующие пакеты:
<link href="css/app.css" rel="stylesheet" /> <link href="BlazorHosted.Client.styles.css" rel="stylesheet" /> <component type="typeof(HeadOutlet)" render-mode="WebAssemblyPrerendered" />
Примечание.
Оставьте элемент
<link>
, который запрашивает таблицу стилей Bootstrap (css/bootstrap/bootstrap.min.css
).Обновите источник скрипта Blazor, чтобы использовать скрипт Blazor WebAssembly на стороне клиента:
Удалить:
- <script src="_framework/blazor.server.js"></script>
Добавьте следующие пакеты:
<script src="_framework/blazor.webassembly.js"></script>
Обновите режим
render-mode
вспомогательной функции тегов компонента, чтобы выполнить предварительную отрисовку корневого компонентаApp
с помощью WebAssemblyPrerendered:Удалить:
- <component type="typeof(App)" render-mode="ServerPrerendered" />
Добавьте следующие пакеты:
<component type="typeof(App)" render-mode="WebAssemblyPrerendered" />
Внимание
Предварительная отрисовка не поддерживается для конечных точек проверки подлинности (сегмент пути
/authentication/
). Дополнительные сведения см. в статье Сценарии обеспечения дополнительной безопасности для ASP.NET Core Blazor WebAssembly.
В файле
Program.cs
проекта Server измените резервную конечную точку, указав вместо файлаindex.html
страницу_Host.cshtml
.Удалить:
- app.MapFallbackToFile("index.html");
Добавьте следующие пакеты:
app.MapFallbackToPage("/_Host");
Если в проектах Client и Server используется одна или несколько общих служб во время предварительной отрисовки, следует учитывать регистрацию этих служб в методе, который может вызываться из обоих проектов. Дополнительные сведения см. в статье Внедрение зависимостей Blazor ASP.NET Core.
Запустите проект Server. Проект Server предварительно отрисовывает для клиентов размещенное приложение Blazor WebAssembly.
Настройка для внедрения Razor компонентов в страницы или представления
В следующих разделах и примерах внедрения Razor компонентов из ClientBlazor WebAssembly приложения на страницы или представления серверного приложения требуется дополнительная настройка.
Проект Server должен иметь следующие файлы и папки.
Razor Pages:
Pages/Shared/_Layout.cshtml
Pages/Shared/_Layout.cshtml.css
Pages/_ViewImports.cshtml
Pages/_ViewStart.cshtml
MVC:
Views/Shared/_Layout.cshtml
Views/Shared/_Layout.cshtml.css
Views/_ViewImports.cshtml
Views/_ViewStart.cshtml
Чтобы получить указанные выше файлы, создайте приложение на основе шаблонов проектов ASP.NET Core любым из следующих способов:
- В новых средствах Visual Studio для создания проектов.
- В оболочке командной строки с помощью команды
dotnet new webapp -o {PROJECT NAME}
(для страниц Razor) илиdotnet new mvc -o {PROJECT NAME}
(для MVC). Параметр-o|--output
с заполнителем{PROJECT NAME}
в качестве значения определяет имя приложения и создает для него папку.
Обновите пространства имен в импортированном файле _ViewImports.cshtml
, чтобы они совпадали с пространствами имен, используемыми в проекте Server, который получает файлы.
Pages/_ViewImports.cshtml
(для страниц Razor):
@using BlazorHosted.Server
@namespace BlazorHosted.Server.Pages
@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
Views/_ViewImports.cshtml
(для MVC):
@using BlazorHosted.Server
@using BlazorHosted.Server.Models
@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
Обновите импортированный файл макета (Pages/Shared/_Layout.cshtml
для Razor Pages или Views/Shared/_Layout.cshtml
для MVC).
Сначала удалите заголовок и таблицу стилей из донорского проекта (в следующем примере — RPDonor.styles.css
). Заполнитель {PROJECT NAME}
представляет имя приложения из донорского проекта.
- <title>@ViewData["Title"] - {PROJECT NAME}</title>
- <link rel="stylesheet" href="~/RPDonor.styles.css" asp-append-version="true" />
Включите стили проекта Client в файл макета. В следующем примере пространством имен проекта Client является BlazorHosted.Client
. В это же время можно также обновить элемент <title>
.
Поместите следующие строки в содержимое <head>
файла макета:
<title>@ViewData["Title"] - BlazorHosted</title>
<link href="css/app.css" rel="stylesheet" />
<link rel="stylesheet" href="BlazorHosted.Client.styles.css" asp-append-version="true" />
<component type="typeof(HeadOutlet)" render-mode="WebAssemblyPrerendered" />
Импортированный макет содержит две ссылки навигации Home
(страница Index
) и Privacy
. Чтобы ссылки Home
указывали на размещенное приложение Blazor WebAssembly, измените гиперссылки:
- <a class="navbar-brand" asp-area="" asp-page="/Index">{PROJECT NAME}</a>
+ <a class="navbar-brand" href="/">BlazorHosted</a>
- <a class="nav-link text-dark" asp-area="" asp-page="/Index">Home</a>
+ <a class="nav-link text-dark" href="/">Home</a>
В файле макета MVC:
- <a class="navbar-brand" asp-area="" asp-controller="Home"
- asp-action="Index">{PROJECT NAME}</a>
+ <a class="navbar-brand" href="/">BlazorHosted</a>
- <a class="nav-link text-dark" asp-area="" asp-controller="Home"
- asp-action="Index">Home</a>
+ <a class="nav-link text-dark" href="/">Home</a>
Обновите имя приложения элемента <footer>
. В следующем примере используется имя приложения BlazorHosted
:
- © {DATE} - {DONOR NAME} - <a asp-area="" asp-page="/Privacy">Privacy</a>
+ © {DATE} - BlazorHosted - <a asp-area="" asp-page="/Privacy">Privacy</a>
В предыдущем примере заполнитель {DATE}
представляет дату авторского права в приложении, созданном на основе шаблона проекта Razor Pages или MVC.
Чтобы сделать Privacy
ссылку свинцом privacy на страницу (Razor Страницы), добавьте privacy страницу в Server проект.
В файле Pages/Privacy.cshtml
в проекте Server:
@page
@model PrivacyModel
@{
ViewData["Title"] = "Privacy Policy";
}
<h1>@ViewData["Title"]</h1>
<p>Use this page to detail your site's privacy policy.</p>
Для представления на основе privacy MVC создайте privacy представление в Server проекте.
В файле View/Home/Privacy.cshtml
в проекте Server:
@{
ViewData["Title"] = "Privacy Policy";
}
<h1>@ViewData["Title"]</h1>
<p>Use this page to detail your site's privacy policy.</p>
В контроллере Home
приложения MVC реализуйте возврат представления.
Добавьте следующий код в Controllers/HomeController.cs
:
public IActionResult Privacy()
{
return View();
}
При импорте файлов из донорского приложения обязательно обновите все пространства имен в файлах, чтобы они совпадали с пространствами имен из проекта Server (например, BlazorHosted.Server
).
Импортируйте статические ресурсы в проект Server из папки wwwroot
донорского проекта:
- Папка
wwwroot/css
и содержимое - Папка
wwwroot/js
и содержимое - Папка
wwwroot/lib
и содержимое
Если донорский проект создан из шаблона проекта ASP.NET Core и вы не изменяете файлы, можно скопировать всю папку wwwroot
из донорского проекта в проект Server и удалить файл значка favicon.
Предупреждение
Избегайте размещения статического ресурса в обоих папках Client и Server wwwroot
папках. Если один и тот же файл присутствует в обеих папках, создается исключение, так как статические ресурсы используют один и тот же путь к корневой папке веб-страниц. Поэтому статический ресурс следует размещать только в одной из папок wwwroot
.
После внедрения описанной выше конфигурации внедрите компоненты Razor в страницы или представления проекта Server. Воспользуйтесь инструкциями, приведенными в следующих разделах этой статьи.
- Отрисовка компонентов на странице или представлении с помощью вспомогательного средства тега компонента
- Отрисовка компонентов на странице или представлении с помощью селектора CSS
Преобразование для просмотра компонентов на странице или в представлении с помощью вспомогательной функции тегов компонента
После настройки решения, в том числе дополнительной конфигурации, вспомогательная функция тега компонента поддерживает два режима рендеринга для отрисовки компонента из приложения Blazor WebAssembly на страницу или в представление:
В следующем примере Razor Pages компонент Counter
отрисовывается на странице. Чтобы сделать компонент интерактивным, сценарий Blazor WebAssembly добавляется в раздел отображения страницы. Чтобы избежать использования полного пространства имен для компонента Counter
с вспомогательной функцией тегов компонента ({ASSEMBLY NAME}.Pages.Counter
), добавьте директиву @using
для пространства имен Pages
проекта клиента. В следующем примере пространством имен проекта Client является BlazorHosted.Client
.
В проекте Server Pages/RazorPagesCounter1.cshtml
:
@page
@using BlazorHosted.Client.Pages
<component type="typeof(Counter)" render-mode="WebAssemblyPrerendered" />
@section Scripts {
<script src="_framework/blazor.webassembly.js"></script>
}
Запустите проект Server. Перейдите на страницу Razor по адресу /razorpagescounter1
. Предварительно отрисованный компонент Counter
внедряется на страницу.
Параметр RenderMode настраивает одно из следующих поведений компонента:
- компонент предварительно преобразуется в страницу;
- компонент отображается как статический HTML на странице или включает необходимые сведения для начальной загрузки приложения Blazor из агента пользователя.
Дополнительные сведения о вспомогательной функции тега компонента, в том числе о передаче параметров и конфигурации RenderMode, см. в статье Вспомогательная функция тега компонента в ASP.NET Core.
В зависимости от упорядочения страниц макета в приложении и статических ресурсов, используемых компонентами в приложении, возможно, придется выполнить дополнительные действия. Как правило, скрипты добавляются в раздел отрисовки Scripts
представления или страницы, а таблицы стилей добавляются в содержимое элемента <head>
макета.
Установка дочернего содержимого с помощью фрагмента отрисовки
Вспомогательная функция тега компонента не поддерживает получение делегата RenderFragment
для дочернего содержимого (например, param-ChildContent="..."
). Рекомендуется создать компонент Razor (.razor
), ссылающийся на компонент, который необходимо отрисовать с дочерним содержимым, подлежащим передаче, а затем вызвать компонент Razor из страницы или представления.
Убедитесь, что предварительно отрисовываемые компоненты верхнего уровня не обрезаются при публикации.
Если вспомогательная функция тега компонента напрямую ссылается на компонент из библиотеки, который подлежит усечению при публикации, компонент может быть обрезан во время публикации из-за отсутствия на него ссылок их кода приложения на стороне клиента. В результате компонент не будет предварительно отрисован, и в выходных данных останется пустое место. В этом случае укажите средству обрезки сохранить компонент библиотеки, добавив атрибут DynamicDependency
в любой класс в приложении на стороне клиента. Чтобы сохранить компонент с именем SomeLibraryComponentToBePreserved
, добавьте следующее в любой компонент:
@using System.Diagnostics.CodeAnalysis
@attribute [DynamicDependency(DynamicallyAccessedMemberTypes.All,
typeof(SomeLibraryComponentToBePreserved))]
Предыдущий подход обычно не требуется, так как приложение обычно предопределяет его компоненты (которые не обрезаются), что в свою очередь ссылается на компоненты из библиотек (вызывая их также не обрезать). Используйте DynamicDependency
явным образом только для предварительной отрисовки компонента библиотеки непосредственно в том случае, если библиотека подлежит обрезке.
Преобразование компонентов на странице или в представлении с помощью селектора CSS
Настроив решение, а также реализовав дополнительную конфигурацию, добавьте корневые компоненты в проект Client размещенного решения Blazor WebAssembly в файле Program.cs
. В следующем примере компонент Counter
объявляется как корневой компонент с помощью селектора CSS, который выбирает элемент с id
, соответствующим counter-component
. В следующем примере пространством имен проекта Client является BlazorHosted.Client
.
В файле Program.cs
проекта Client добавьте пространство имен для компонентов проекта Razor в начало файла:
using BlazorHosted.Client.Pages;
Настроив builder
в Program.cs
, добавьте компонент Counter
в качестве корневого компонента:
builder.RootComponents.Add<Counter>("#counter-component");
В следующем примере Razor Pages компонент Counter
отрисовывается на странице. Чтобы сделать компонент интерактивным, сценарий Blazor WebAssembly добавляется в раздел отображения страницы.
В проекте Server Pages/RazorPagesCounter2.cshtml
:
@page
<div id="counter-component">Loading...</div>
@section Scripts {
<script src="_framework/blazor.webassembly.js"></script>
}
Запустите проект Server. Перейдите на страницу Razor по адресу /razorpagescounter2
. Предварительно отрисованный компонент Counter
внедряется на страницу.
В зависимости от упорядочения страниц макета в приложении и статических ресурсов, используемых компонентами в приложении, возможно, придется выполнить дополнительные действия. Как правило, скрипты добавляются в раздел отрисовки Scripts
представления или страницы, а таблицы стилей добавляются в содержимое элемента <head>
макета.
Примечание.
В предыдущем примере исключение JSException возникает, если приложение Blazor WebAssembly предварительно отрисовывается и интегрируется в приложение Razor Pages или MVC одновременно с использованием селектора CSS. Переход к одному из компонентов Razor проекта Client или переход на страницу либо представление в Server с внедренным компонентом приводит к возникновению одного или нескольких исключений JSException.
Это нормальное поведение, поскольку предварительная отрисовка и интеграция приложения Blazor WebAssembly с маршрутизируемыми компонентами Razor несовместимы с использованием селекторов CSS.
Если вы уже работали с примерами из предыдущих разделов и теперь хотите только убедиться, что селектор CSS в вашем примере приложения работает нормально, закомментируйте спецификацию корневого компонента App
в файле Program.cs
проекта Client:
- builder.RootComponents.Add<App>("#app");
+ //builder.RootComponents.Add<App>("#app");
Перейдите к странице или представлению с внедренным компонентом Razor, где используется селектор CSS (например, /razorpagescounter2
из предыдущего примера). Загрузится страница или представление с внедренным компонентом, который должен нормально работать.
Сохранение предварительно отрисованного состояния
Без сохранения предварительно отрисованного состояния все состояния, которые использовались во время предварительной отрисовки, теряются и должны быть созданы заново при полной загрузке приложения. Если какое-либо состояние настроено асинхронно, пользовательский интерфейс может мерцать, так как предварительно отрисованный пользовательский интерфейс заменяется временными заполнителями и затем полностью отрисовывается снова.
Чтобы сохранить состояние для предварительно созданных компонентов, используйте вспомогательный компонент тега состояния сохраняемого компонента (справочный источник). Добавьте тег вспомогательного тега, <persist-component-state />
внутри закрывающего </body>
тега _Host
страницы в приложении, которое предопределено компонентами.
Примечание.
По ссылкам в документации на справочные материалы по .NET обычно загружается ветвь репозитория по умолчанию, которая представляет текущую разработку для следующего выпуска .NET. Чтобы выбрать тег для определенного выпуска, используйте раскрывающийся список Switch branches or tags (Переключение ветвей или тегов). Дополнительные сведения см. в статье Выбор тега версии исходного кода ASP.NET Core (dotnet/AspNetCore.Docs #26205).
В Pages/_Host.cshtml
приложениях, предварительно подготовленных Blazor webAssembly (WebAssemblyPrerendered
) в размещенном Blazor WebAssembly приложении:
<body>
...
<persist-component-state />
</body>
Решите, какое состояние следует сохранить с помощью службы PersistentComponentState. PersistentComponentState.RegisterOnPersisting
регистрирует обратный вызов для сохранения состояния компонента до приостановки приложения. Состояние извлекается при возобновлении работы приложения.
В следующем примере :
- Заполнитель
{TYPE}
представляет тип сохраняемых данных (например,WeatherForecast[]
). - Заполнитель
{TOKEN}
— это строка идентификатора состояния (например,fetchdata
).
@implements IDisposable
@inject PersistentComponentState ApplicationState
...
@code {
private {TYPE} data;
private PersistingComponentStateSubscription persistingSubscription;
protected override async Task OnInitializedAsync()
{
persistingSubscription =
ApplicationState.RegisterOnPersisting(PersistData);
if (!ApplicationState.TryTakeFromJson<{TYPE}>(
"{TOKEN}", out var restored))
{
data = await ...;
}
else
{
data = restored!;
}
}
private Task PersistData()
{
ApplicationState.PersistAsJson("{TOKEN}", data);
return Task.CompletedTask;
}
void IDisposable.Dispose()
{
persistingSubscription.Dispose();
}
}
Следующий пример представляет собой обновленную версию компонента FetchData
в размещенном приложении Blazor WebAssembly на основе шаблона проекта Blazor. Компонент WeatherForecastPreserveState
сохраняет состояние прогноза погоды во время предварительной отрисовки, а затем получает состояние для инициализации компонента. Вспомогательная функция тега "Сохранение состояния компонента" сохраняет состояние компонента после всех вызовов компонента.
Pages/WeatherForecastPreserveState.razor
:
@page "/weather-forecast-preserve-state"
@using BlazorSample.Shared
@implements IDisposable
@inject IWeatherForecastService WeatherForecastService
@inject PersistentComponentState ApplicationState
<PageTitle>Weather Forecast</PageTitle>
<h1>Weather forecast</h1>
<p>This component demonstrates fetching data from the server.</p>
@if (forecasts == null)
{
<p><em>Loading...</em></p>
}
else
{
<table class="table">
<thead>
<tr>
<th>Date</th>
<th>Temp. (C)</th>
<th>Temp. (F)</th>
<th>Summary</th>
</tr>
</thead>
<tbody>
@foreach (var forecast in forecasts)
{
<tr>
<td>@forecast.Date.ToShortDateString()</td>
<td>@forecast.TemperatureC</td>
<td>@forecast.TemperatureF</td>
<td>@forecast.Summary</td>
</tr>
}
</tbody>
</table>
}
@code {
private WeatherForecast[] forecasts = Array.Empty<WeatherForecast>();
private PersistingComponentStateSubscription persistingSubscription;
protected override async Task OnInitializedAsync()
{
persistingSubscription =
ApplicationState.RegisterOnPersisting(PersistForecasts);
if (!ApplicationState.TryTakeFromJson<WeatherForecast[]>(
"fetchdata", out var restored))
{
forecasts =
await WeatherForecastService.GetForecastAsync(DateOnly.FromDateTime(DateTime.Now));
}
else
{
forecasts = restored!;
}
}
private Task PersistForecasts()
{
ApplicationState.PersistAsJson("fetchdata", forecasts);
return Task.CompletedTask;
}
void IDisposable.Dispose()
{
persistingSubscription.Dispose();
}
}
При инициализации компонентов с тем же состоянием, которое использовалось во время предварительной отрисовки, все ресурсоемкие шаги инициализации выполняются только один раз. Отрисованный пользовательский интерфейс также соответствует предварительно отрисованному пользовательскому интерфейсу, поэтому в браузере нет никаких мерцаний.
Сохраняемое предварительно созданное состояние передается клиенту, где оно используется для восстановления состояния компонента. Для предварительной подготовки в размещенном Blazor WebAssembly приложении данные предоставляются в браузере и не должны содержать конфиденциальные конфиденциальные конфиденциальные данные.
Дополнительные ресурсы Blazor WebAssembly
- Управление состоянием: обработка предварительной отрисовки
- Поддержка предварительной отрисовки с отложенной загрузкой сборки
- Razor Темы жизненного цикла компонентов, относящиеся к предварительной подготовке
- Инициализация компонента (
OnInitialized{Async}
) - После отрисовки компонента (
OnAfterRender{Async}
) - Повторное подключение с отслеживанием состояния после предварительной отрисовки: хотя в содержимом раздела внимание в основном уделяется Blazor Server и подключению с отслеживанием состояния SignalR, сценарий для предварительной отрисовки в размещенных приложениях Blazor WebAssembly (WebAssemblyPrerendered) включает в себя аналогичные условия и подходы для предотвращения повторного выполнения кода разработчиком. Сведения о сохранении состояния во время выполнения кода инициализации во время предварительной отрисовки см . в разделе "Сохранение предопределенного состояния " этой статьи.
- Предварительная отрисовка с помощью взаимодействия с JavaScript
- Инициализация компонента (
- Субъекты проверки подлинности и авторизации, относящиеся к предварительной подготовке
- Размещение и развертывание: Blazor WebAssembly
- Обработка ошибок: предварительная отрисовка
- OnNavigateAsync выполняется дважды при предварительной подготовке: обработка асинхронных событий навигации с помощью
OnNavigateAsync
Предварительная отрисовка может улучшить оптимизацию для поисковых систем (SEO) за счет визуализации содержимого для первоначального ответа HTTP, который поисковые системы могут использовать для вычисления ранга страницы.
Конфигурация решения
Конфигурация предварительной отрисовки
Чтобы настроить предварительную отрисовку для размещенного приложения Blazor WebAssembly, сделайте следующее:
Разместите приложение Blazor WebAssembly в приложении ASP.NET Core. Вы можете добавить изолированное приложение Blazor WebAssembly в решение ASP.NET Core или использовать размещенное приложение Blazor WebAssembly, созданное из Blazor WebAssembly шаблона проекта, с помощью параметра размещения:
- Visual Studio: в диалоговом окне Дополнительные сведения установите флажок Размещено в ASP.NET Core при создании приложения Blazor WebAssembly. В примерах, используемых в этой статье, такое решение называется
BlazorHosted
. - Командная оболочка Visual Studio Code или .NET CLI:
dotnet new blazorwasm -ho
(используйте параметр-ho|--hosted
). Используйте параметр-o|--output {LOCATION}
, чтобы создать папку для решения и задать пространства имен проекта для решения. В примерах, используемых в этой статье, такое решение называетсяBlazorHosted
(dotnet new blazorwasm -ho -o BlazorHosted
).
В примерах, используемых в этой статье, пространством имен проекта клиента будет
BlazorHosted.Client
, а пространством имен проекта сервера —BlazorHosted.Server
.- Visual Studio: в диалоговом окне Дополнительные сведения установите флажок Размещено в ASP.NET Core при создании приложения Blazor WebAssembly. В примерах, используемых в этой статье, такое решение называется
wwwroot/index.html
Удалите файл из Blazor WebAssemblyClient проекта.В проекте Client удалите следующие строки из файла
Program.cs
:- builder.RootComponents.Add<App>("#app"); - builder.RootComponents.Add<HeadOutlet>("head::after");
Добавьте файлы
_Host.cshtml
и_Layout.cshtml
в папкуPages
проекта Server. Файлы из проекта, созданного на основе шаблона Blazor Server, можно получить с помощью Visual Studio или .NET CLI. Для этого выполните в командной оболочке командуdotnet new blazorserver -o BlazorServer
(параметр-o BlazorServer
позволяет создать папку для проекта). Поместив файлы в папкуPages
проекта Server, внесите в файлы следующие изменения.Внимание
Использование страницы макета (
_Layout.cshtml
) с вспомогательной функцией тега компонента для компонента HeadOutlet является обязательным условием для управления содержимым<head>
, например заголовком страницы (компонент PageTitle), и другими элементами head (компонент HeadContent). Дополнительные сведения см. в статье Управление содержимым head в приложениях ASP.NET Core Blazor.Внесите указанные ниже изменения в файл
_Layout.cshtml
.Обновите пространство имен
Pages
в верхней части файла, чтобы оно соответствовало пространству имен для страниц приложения Server. Заполнитель{APP NAMESPACE}
в следующем примере представляет пространство имен для страниц донорского приложения, из которого взят файл_Layout.cshtml
:Удалить:
- @namespace {APP NAMESPACE}.Pages
Добавьте следующие пакеты:
@namespace BlazorHosted.Server.Pages
Добавьте директиву
@using
для проекта Client в начало файла:@using BlazorHosted.Client
Обновите ссылки таблицы стилей, чтобы они указывали на таблицы стилей проекта WebAssembly. В следующем примере для проекта клиента используется пространство имен
BlazorHosted.Client
: Заполнитель{APP NAMESPACE}
представляет пространство имен донорского приложения, из которого взят файл_Layout.cshtml
. Обновите режим вспомогательной функции тегов компонента (тег<component>
) для компонентаHeadOutlet
, чтобы выполнить предварительную отрисовку компонента.Удалить:
- <link href="css/site.css" rel="stylesheet" /> - <link href="{APP NAMESPACE}.styles.css" rel="stylesheet" /> - <component type="typeof(HeadOutlet)" render-mode="ServerPrerendered" />
Добавьте следующие пакеты:
<link href="css/app.css" rel="stylesheet" /> <link href="BlazorHosted.Client.styles.css" rel="stylesheet" /> <component type="typeof(HeadOutlet)" render-mode="WebAssemblyPrerendered" />
Примечание.
Оставьте элемент
<link>
, который запрашивает таблицу стилей Bootstrap (css/bootstrap/bootstrap.min.css
).Обновите источник скрипта Blazor, чтобы использовать скрипт Blazor WebAssembly на стороне клиента:
Удалить:
- <script src="_framework/blazor.server.js"></script>
Добавьте следующие пакеты:
<script src="_framework/blazor.webassembly.js"></script>
В файле
_Host.cshtml
:Вместо пространства имен
Pages
укажите значение для проекта Client. Заполнитель{APP NAMESPACE}
представляет пространство имен для страниц донорского приложения, из которого взят файл_Host.cshtml
:Удалить:
- @namespace {APP NAMESPACE}.Pages
Добавьте следующие пакеты:
@namespace BlazorHosted.Client
Обновите режим
render-mode
вспомогательной функции тегов компонента, чтобы выполнить предварительную отрисовку корневого компонентаApp
с помощью WebAssemblyPrerendered:Удалить:
- <component type="typeof(App)" render-mode="ServerPrerendered" />
Добавьте следующие пакеты:
<component type="typeof(App)" render-mode="WebAssemblyPrerendered" />
Внимание
Предварительная отрисовка не поддерживается для конечных точек проверки подлинности (сегмент пути
/authentication/
). Дополнительные сведения см. в статье Сценарии обеспечения дополнительной безопасности для ASP.NET Core Blazor WebAssembly.
В разделе сопоставления конечных точек для проекта Server в файле
Program.cs
укажите вместо резервного файлаindex.html
страницу_Host.cshtml
:Удалить:
- app.MapFallbackToFile("index.html");
Добавьте следующие пакеты:
app.MapFallbackToPage("/_Host");
Если в проектах Client и Server используется одна или несколько общих служб во время предварительной отрисовки, следует учитывать регистрацию этих служб в методе, который может вызываться из обоих проектов. Дополнительные сведения см. в статье Внедрение зависимостей Blazor ASP.NET Core.
Запустите проект Server. Проект Server предварительно отрисовывает для клиентов размещенное приложение Blazor WebAssembly.
Настройка для внедрения Razor компонентов в страницы или представления
В следующих разделах и примерах внедрения Razor компонентов из ClientBlazor WebAssembly приложения на страницы или представления серверного приложения требуется дополнительная настройка.
Проект Server должен иметь следующие файлы и папки.
Razor Pages:
Pages/Shared/_Layout.cshtml
Pages/Shared/_Layout.cshtml.css
Pages/_ViewImports.cshtml
Pages/_ViewStart.cshtml
MVC:
Views/Shared/_Layout.cshtml
Views/Shared/_Layout.cshtml.css
Views/_ViewImports.cshtml
Views/_ViewStart.cshtml
Внимание
Использование страницы макета (_Layout.cshtml
) с вспомогательной функцией тега компонента для компонента HeadOutlet является обязательным условием для управления содержимым <head>
, например заголовком страницы (компонент PageTitle), и другими элементами head (компонент HeadContent). Дополнительные сведения см. в статье Управление содержимым head в приложениях ASP.NET Core Blazor.
Чтобы получить указанные выше файлы, создайте приложение на основе шаблонов проектов ASP.NET Core любым из следующих способов:
- В новых средствах Visual Studio для создания проектов.
- В оболочке командной строки с помощью команды
dotnet new webapp -o {PROJECT NAME}
(для страниц Razor) илиdotnet new mvc -o {PROJECT NAME}
(для MVC). Параметр-o|--output
с заполнителем{PROJECT NAME}
в качестве значения определяет имя приложения и создает для него папку.
Обновите пространства имен в импортированном файле _ViewImports.cshtml
, чтобы они совпадали с пространствами имен, используемыми в проекте Server, который получает файлы.
Pages/_ViewImports.cshtml
(для страниц Razor):
@using BlazorHosted.Server
@namespace BlazorHosted.Server.Pages
@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
Views/_ViewImports.cshtml
(для MVC):
@using BlazorHosted.Server
@using BlazorHosted.Server.Models
@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
Обновите импортированный файл макета (Pages/Shared/_Layout.cshtml
для Razor Pages или Views/Shared/_Layout.cshtml
для MVC).
Сначала удалите заголовок и таблицу стилей из донорского проекта (в следующем примере — RPDonor.styles.css
). Заполнитель {PROJECT NAME}
представляет имя приложения из донорского проекта.
- <title>@ViewData["Title"] - {PROJECT NAME}</title>
- <link rel="stylesheet" href="~/RPDonor.styles.css" asp-append-version="true" />
Включите стили проекта Client в файл макета. В следующем примере пространством имен проекта Client является BlazorHosted.Client
. В это же время можно также обновить элемент <title>
.
Поместите следующие строки в содержимое <head>
файла макета:
<title>@ViewData["Title"] - BlazorHosted</title>
<link href="css/app.css" rel="stylesheet" />
<link rel="stylesheet" href="BlazorHosted.Client.styles.css" asp-append-version="true" />
<component type="typeof(HeadOutlet)" render-mode="WebAssemblyPrerendered" />
Импортированный макет содержит две ссылки навигации Home
(страница Index
) и Privacy
. Чтобы ссылки Home
указывали на размещенное приложение Blazor WebAssembly, измените гиперссылки:
- <a class="navbar-brand" asp-area="" asp-page="/Index">{PROJECT NAME}</a>
+ <a class="navbar-brand" href="/">BlazorHosted</a>
- <a class="nav-link text-dark" asp-area="" asp-page="/Index">Home</a>
+ <a class="nav-link text-dark" href="/">Home</a>
В файле макета MVC:
- <a class="navbar-brand" asp-area="" asp-controller="Home"
- asp-action="Index">{PROJECT NAME}</a>
+ <a class="navbar-brand" href="/">BlazorHosted</a>
- <a class="nav-link text-dark" asp-area="" asp-controller="Home"
- asp-action="Index">Home</a>
+ <a class="nav-link text-dark" href="/">Home</a>
Обновите имя приложения элемента <footer>
. В следующем примере используется имя приложения BlazorHosted
:
- © {DATE} - {DONOR NAME} - <a asp-area="" asp-page="/Privacy">Privacy</a>
+ © {DATE} - BlazorHosted - <a asp-area="" asp-page="/Privacy">Privacy</a>
В предыдущем примере заполнитель {DATE}
представляет дату авторского права в приложении, созданном на основе шаблона проекта Razor Pages или MVC.
Чтобы сделать Privacy
ссылку свинцом privacy на страницу (Razor Страницы), добавьте privacy страницу в Server проект.
В файле Pages/Privacy.cshtml
в проекте Server:
@page
@model PrivacyModel
@{
ViewData["Title"] = "Privacy Policy";
}
<h1>@ViewData["Title"]</h1>
<p>Use this page to detail your site's privacy policy.</p>
Для представления на основе privacy MVC создайте privacy представление в Server проекте.
В файле View/Home/Privacy.cshtml
в проекте Server:
@{
ViewData["Title"] = "Privacy Policy";
}
<h1>@ViewData["Title"]</h1>
<p>Use this page to detail your site's privacy policy.</p>
В контроллере Home
приложения MVC реализуйте возврат представления.
Добавьте следующий код в Controllers/HomeController.cs
:
public IActionResult Privacy()
{
return View();
}
При импорте файлов из донорского приложения обязательно обновите все пространства имен в файлах, чтобы они совпадали с пространствами имен из проекта Server (например, BlazorHosted.Server
).
Импортируйте статические ресурсы в проект Server из папки wwwroot
донорского проекта:
- Папка
wwwroot/css
и содержимое - Папка
wwwroot/js
и содержимое - Папка
wwwroot/lib
и содержимое
Если донорский проект создан из шаблона проекта ASP.NET Core и вы не изменяете файлы, можно скопировать всю папку wwwroot
из донорского проекта в проект Server и удалить файл значка favicon.
Предупреждение
Избегайте размещения статического ресурса в обоих папках Client и Server wwwroot
папках. Если один и тот же файл присутствует в обеих папках, создается исключение, так как статический ресурс в каждой из папок использует один и тот же путь к корневой папке веб-страниц. Поэтому статический ресурс следует размещать только в одной из папок wwwroot
.
После внедрения описанной выше конфигурации внедрите компоненты Razor в страницы или представления проекта Server. Воспользуйтесь инструкциями, приведенными в следующих разделах этой статьи.
- Отрисовка компонентов на странице или представлении с помощью вспомогательного средства тега компонента
- Отрисовка компонентов на странице или представлении с помощью селектора CSS
Преобразование для просмотра компонентов на странице или в представлении с помощью вспомогательной функции тегов компонента
После настройки решения, в том числе дополнительной конфигурации, вспомогательная функция тега компонента поддерживает два режима рендеринга для отрисовки компонента из приложения Blazor WebAssembly на страницу или в представление:
В следующем примере Razor Pages компонент Counter
отрисовывается на странице. Чтобы сделать компонент интерактивным, сценарий Blazor WebAssembly добавляется в раздел отображения страницы. Чтобы избежать использования полного пространства имен для компонента Counter
с вспомогательной функцией тегов компонента ({ASSEMBLY NAME}.Pages.Counter
), добавьте директиву @using
для пространства имен Pages
проекта клиента. В следующем примере пространством имен проекта Client является BlazorHosted.Client
.
В проекте Server Pages/RazorPagesCounter1.cshtml
:
@page
@using BlazorHosted.Client.Pages
<component type="typeof(Counter)" render-mode="WebAssemblyPrerendered" />
@section Scripts {
<script src="_framework/blazor.webassembly.js"></script>
}
Запустите проект Server. Перейдите на страницу Razor по адресу /razorpagescounter1
. Предварительно отрисованный компонент Counter
внедряется на страницу.
Параметр RenderMode настраивает одно из следующих поведений компонента:
- компонент предварительно преобразуется в страницу;
- компонент отображается как статический HTML на странице или включает необходимые сведения для начальной загрузки приложения Blazor из агента пользователя.
Дополнительные сведения о вспомогательной функции тега компонента, в том числе о передаче параметров и конфигурации RenderMode, см. в статье Вспомогательная функция тега компонента в ASP.NET Core.
В зависимости от упорядочения страниц макета в приложении и статических ресурсов, используемых компонентами в приложении, возможно, придется выполнить дополнительные действия. Как правило, скрипты добавляются в раздел отрисовки Scripts
представления или страницы, а таблицы стилей добавляются в содержимое элемента <head>
макета.
Установка дочернего содержимого с помощью фрагмента отрисовки
Вспомогательная функция тега компонента не поддерживает получение делегата RenderFragment
для дочернего содержимого (например, param-ChildContent="..."
). Рекомендуется создать компонент Razor (.razor
), ссылающийся на компонент, который необходимо отрисовать с дочерним содержимым, подлежащим передаче, а затем вызвать компонент Razor из страницы или представления.
Убедитесь, что предварительно отрисовываемые компоненты верхнего уровня не обрезаются при публикации.
Если вспомогательная функция тега компонента напрямую ссылается на компонент из библиотеки, который подлежит усечению при публикации, компонент может быть обрезан во время публикации из-за отсутствия на него ссылок их кода приложения на стороне клиента. В результате компонент не будет предварительно отрисован, и в выходных данных останется пустое место. В этом случае укажите средству обрезки сохранить компонент библиотеки, добавив атрибут DynamicDependency
в любой класс в приложении на стороне клиента. Чтобы сохранить компонент с именем SomeLibraryComponentToBePreserved
, добавьте следующее в любой компонент:
@using System.Diagnostics.CodeAnalysis
@attribute [DynamicDependency(DynamicallyAccessedMemberTypes.All,
typeof(SomeLibraryComponentToBePreserved))]
Предыдущий подход обычно не требуется, так как приложение обычно предопределяет его компоненты (которые не обрезаются), что в свою очередь ссылается на компоненты из библиотек (вызывая их также не обрезать). Используйте DynamicDependency
явным образом только для предварительной отрисовки компонента библиотеки непосредственно в том случае, если библиотека подлежит обрезке.
Преобразование компонентов на странице или в представлении с помощью селектора CSS
Настроив решение, а также реализовав дополнительную конфигурацию, добавьте корневые компоненты в проект Client размещенного решения Blazor WebAssembly в файле Program.cs
. В следующем примере компонент Counter
объявляется как корневой компонент с помощью селектора CSS, который выбирает элемент с id
, соответствующим counter-component
. В следующем примере пространством имен проекта Client является BlazorHosted.Client
.
В файле Program.cs
проекта Client добавьте пространство имен для компонентов проекта Razor в начало файла:
using BlazorHosted.Client.Pages;
Настроив builder
в Program.cs
, добавьте компонент Counter
в качестве корневого компонента:
builder.RootComponents.Add<Counter>("#counter-component");
В следующем примере Razor Pages компонент Counter
отрисовывается на странице. Чтобы сделать компонент интерактивным, сценарий Blazor WebAssembly добавляется в раздел отображения страницы.
В проекте Server Pages/RazorPagesCounter2.cshtml
:
@page
<div id="counter-component">Loading...</div>
@section Scripts {
<script src="_framework/blazor.webassembly.js"></script>
}
Запустите проект Server. Перейдите на страницу Razor по адресу /razorpagescounter2
. Предварительно отрисованный компонент Counter
внедряется на страницу.
В зависимости от упорядочения страниц макета в приложении и статических ресурсов, используемых компонентами в приложении, возможно, придется выполнить дополнительные действия. Как правило, скрипты добавляются в раздел отрисовки Scripts
представления или страницы, а таблицы стилей добавляются в содержимое элемента <head>
макета.
Примечание.
В предыдущем примере исключение JSException возникает, если приложение Blazor WebAssembly предварительно отрисовывается и интегрируется в приложение Razor Pages или MVC одновременно с использованием селектора CSS. Переход к одному из компонентов Razor проекта Client или переход на страницу либо представление в Server с внедренным компонентом приводит к возникновению одного или нескольких исключений JSException.
Это нормальное поведение, поскольку предварительная отрисовка и интеграция приложения Blazor WebAssembly с маршрутизируемыми компонентами Razor несовместимы с использованием селекторов CSS.
Если вы уже работали с примерами из предыдущих разделов и теперь хотите только убедиться, что селектор CSS в вашем примере приложения работает нормально, закомментируйте спецификацию корневого компонента App
в файле Program.cs
проекта Client:
- builder.RootComponents.Add<App>("#app");
+ //builder.RootComponents.Add<App>("#app");
Перейдите к странице или представлению с внедренным компонентом Razor, где используется селектор CSS (например, /razorpagescounter2
из предыдущего примера). Загрузится страница или представление с внедренным компонентом, который должен нормально работать.
Сохранение предварительно отрисованного состояния
Без сохранения предварительно отрисованного состояния все состояния, которые использовались во время предварительной отрисовки, теряются и должны быть созданы заново при полной загрузке приложения. Если какое-либо состояние настроено асинхронно, пользовательский интерфейс может мерцать, так как предварительно отрисованный пользовательский интерфейс заменяется временными заполнителями и затем полностью отрисовывается снова.
Для решения этих проблем Blazor поддерживает состояние сохранения на предварительно отрисованной странице с помощью вспомогательной функции тега "Сохранение состояния компонента". Добавьте тег вспомогательной функции тега <persist-component-state />
в закрывающий тег </body>
.
Pages/_Layout.cshtml
:
<body>
...
<persist-component-state />
</body>
Решите, какое состояние следует сохранить с помощью службы PersistentComponentState. PersistentComponentState.RegisterOnPersisting
регистрирует обратный вызов для сохранения состояния компонента до приостановки приложения. Состояние извлекается при возобновлении работы приложения.
Следующий пример представляет собой обновленную версию компонента FetchData
в размещенном приложении Blazor WebAssembly на основе шаблона проекта Blazor. Компонент WeatherForecastPreserveState
сохраняет состояние прогноза погоды во время предварительной отрисовки, а затем получает состояние для инициализации компонента. Вспомогательная функция тега "Сохранение состояния компонента" сохраняет состояние компонента после всех вызовов компонента.
Pages/WeatherForecastPreserveState.razor
:
@page "/weather-forecast-preserve-state"
@implements IDisposable
@using BlazorSample.Shared
@inject IWeatherForecastService WeatherForecastService
@inject PersistentComponentState ApplicationState
<PageTitle>Weather Forecast</PageTitle>
<h1>Weather forecast</h1>
<p>This component demonstrates fetching data from the server.</p>
@if (forecasts == null)
{
<p><em>Loading...</em></p>
}
else
{
<table class="table">
<thead>
<tr>
<th>Date</th>
<th>Temp. (C)</th>
<th>Temp. (F)</th>
<th>Summary</th>
</tr>
</thead>
<tbody>
@foreach (var forecast in forecasts)
{
<tr>
<td>@forecast.Date.ToShortDateString()</td>
<td>@forecast.TemperatureC</td>
<td>@forecast.TemperatureF</td>
<td>@forecast.Summary</td>
</tr>
}
</tbody>
</table>
}
@code {
private WeatherForecast[] forecasts = Array.Empty<WeatherForecast>();
private PersistingComponentStateSubscription persistingSubscription;
protected override async Task OnInitializedAsync()
{
persistingSubscription =
ApplicationState.RegisterOnPersisting(PersistForecasts);
if (!ApplicationState.TryTakeFromJson<WeatherForecast[]>(
"fetchdata", out var restored))
{
forecasts =
await WeatherForecastService.GetForecastAsync(DateTime.Now);
}
else
{
forecasts = restored!;
}
}
private Task PersistForecasts()
{
ApplicationState.PersistAsJson("fetchdata", forecasts);
return Task.CompletedTask;
}
void IDisposable.Dispose()
{
persistingSubscription.Dispose();
}
}
При инициализации компонентов с тем же состоянием, которое использовалось во время предварительной отрисовки, все ресурсоемкие шаги инициализации выполняются только один раз. Отрисованный пользовательский интерфейс также соответствует предварительно отрисованному пользовательскому интерфейсу, поэтому в браузере нет никаких мерцаний.
Сохраняемое предварительно созданное состояние передается клиенту, где оно используется для восстановления состояния компонента. Для предварительной подготовки в размещенном Blazor WebAssembly приложении данные предоставляются в браузере и не должны содержать конфиденциальные конфиденциальные конфиденциальные данные.
Дополнительные ресурсы Blazor WebAssembly
- Управление состоянием: обработка предварительной отрисовки
- Поддержка предварительной отрисовки с отложенной загрузкой сборки
- Razor Темы жизненного цикла компонентов, относящиеся к предварительной подготовке
- Инициализация компонента (
OnInitialized{Async}
) - После отрисовки компонента (
OnAfterRender{Async}
) - Повторное подключение с отслеживанием состояния после предварительной отрисовки: хотя в содержимом раздела внимание в основном уделяется Blazor Server и подключению с отслеживанием состояния SignalR, сценарий для предварительной отрисовки в размещенных приложениях Blazor WebAssembly (WebAssemblyPrerendered) включает в себя аналогичные условия и подходы для предотвращения повторного выполнения кода разработчиком. Сведения о сохранении состояния во время выполнения кода инициализации во время предварительной отрисовки см . в разделе "Сохранение предопределенного состояния " этой статьи.
- Предварительная отрисовка с помощью взаимодействия с JavaScript
- Инициализация компонента (
- Субъекты проверки подлинности и авторизации, относящиеся к предварительной подготовке
- Размещение и развертывание: Blazor WebAssembly
Предварительная отрисовка может улучшить оптимизацию для поисковых систем (SEO) за счет визуализации содержимого для первоначального ответа HTTP, который поисковые системы могут использовать для вычисления ранга страницы.
Конфигурация решения
Конфигурация предварительной отрисовки
Чтобы настроить предварительную отрисовку для размещенного приложения Blazor WebAssembly, сделайте следующее:
Разместите приложение Blazor WebAssembly в приложении ASP.NET Core. Вы можете добавить изолированное приложение Blazor WebAssembly в решение ASP.NET Core или использовать размещенное приложение Blazor WebAssembly, созданное из Blazor WebAssembly шаблона проекта, с помощью параметра размещения:
- Visual Studio: в диалоговом окне Дополнительные сведения установите флажок Размещено в ASP.NET Core при создании приложения Blazor WebAssembly. В примерах, используемых в этой статье, такое решение называется
BlazorHosted
. - Командная оболочка Visual Studio Code или .NET CLI:
dotnet new blazorwasm -ho
(используйте параметр-ho|--hosted
). Используйте параметр-o|--output {LOCATION}
, чтобы создать папку для решения и задать пространства имен проекта для решения. В примерах, используемых в этой статье, такое решение называетсяBlazorHosted
(dotnet new blazorwasm -ho -o BlazorHosted
).
В примерах, используемых в этой статье, пространством имен проекта клиента будет
BlazorHosted.Client
, а пространством имен проекта сервера —BlazorHosted.Server
.- Visual Studio: в диалоговом окне Дополнительные сведения установите флажок Размещено в ASP.NET Core при создании приложения Blazor WebAssembly. В примерах, используемых в этой статье, такое решение называется
wwwroot/index.html
Удалите файл из Blazor WebAssemblyClient проекта.В проекте Client удалите следующую строку из файла
Program.cs
:- builder.RootComponents.Add<App>("#app");
Добавьте файл
Pages/_Host.cshtml
в папкуPages
проекта Server. Файл_Host.cshtml
можно получить из проекта, созданного на основе шаблона Blazor Server, выполнив в командной оболочке командуdotnet new blazorserver -o BlazorServer
(параметр-o BlazorServer
создает папку для проекта). Поместив файлPages/_Host.cshtml
в проект Server размещенного решения Blazor WebAssembly, внесите в файл следующие изменения:Задайте директиву
@using
для проекта Client (например,@using BlazorHosted.Client
).Обновите ссылки таблицы стилей, чтобы они указывали на таблицы стилей проекта WebAssembly. В следующем примере пространством имен проекта клиента является
BlazorHosted.Client
:- <link href="css/site.css" rel="stylesheet" /> - <link href="_content/BlazorServer/_framework/scoped.styles.css" rel="stylesheet" /> + <link href="css/app.css" rel="stylesheet" /> + <link href="BlazorHosted.Client.styles.css" rel="stylesheet" />
Примечание.
Оставьте элемент
<link>
, который запрашивает таблицу стилей Bootstrap (css/bootstrap/bootstrap.min.css
).Обновите режим
render-mode
вспомогательной функции тегов компонента, чтобы выполнить предварительную отрисовку корневого компонентаApp
с помощью WebAssemblyPrerendered:- <component type="typeof(App)" render-mode="ServerPrerendered" /> + <component type="typeof(App)" render-mode="WebAssemblyPrerendered" />
Обновите источник скрипта Blazor, чтобы использовать скрипт Blazor WebAssembly на стороне клиента:
- <script src="_framework/blazor.server.js"></script> + <script src="_framework/blazor.webassembly.js"></script>
В методе
Startup.Configure
проекта Server измените значение резервной точки, указав вместо файлаindex.html
страницу_Host.cshtml
.Startup.cs
:- endpoints.MapFallbackToFile("index.html"); + endpoints.MapFallbackToPage("/_Host");
Если в проектах Client и Server используется одна или несколько общих служб во время предварительной отрисовки, следует учитывать регистрацию этих служб в методе, который может вызываться из обоих проектов. Дополнительные сведения см. в статье Внедрение зависимостей Blazor ASP.NET Core.
Запустите проект Server. Проект Server предварительно отрисовывает для клиентов размещенное приложение Blazor WebAssembly.
Настройка для внедрения Razor компонентов в страницы или представления
В следующих разделах и примерах этой статьи для внедрения Razor компонентов клиентского Blazor WebAssembly приложения в страницы или представления серверного приложения требуется дополнительная настройка.
Используйте файл по умолчанию Razor Pages или файл макета MVC в проекте Server. Проект Server должен иметь следующие файлы и папки.
Razor Pages:
Pages/Shared/_Layout.cshtml
Pages/_ViewImports.cshtml
Pages/_ViewStart.cshtml
MVC:
Views/Shared/_Layout.cshtml
Views/_ViewImports.cshtml
Views/_ViewStart.cshtml
Получите предыдущие файлы из приложения, созданного из шаблона проекта Razor Pages или MVC. Дополнительные сведения см. в статье Учебник. Начало работы с Razor Pages в ASP.NET Core или Начало работы с ASP.NET Core MVC.
Обновите пространства имен в импортированном файле _ViewImports.cshtml
, чтобы они совпадали с пространствами имен, используемыми в проекте Server, который получает файлы.
Обновите импортированный файл макета (_Layout.cshtml
), чтобы включить в него стили проекта Client. В следующем примере пространством имен проекта Client является BlazorHosted.Client
. В это же время можно также обновить элемент <title>
.
Pages/Shared/_Layout.cshtml
(Razor Pages) или Views/Shared/_Layout.cshtml
(MVC):
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <title>@ViewData["Title"] - DonorProject</title>
+ <title>@ViewData["Title"] - BlazorHosted</title>
<link rel="stylesheet" href="~/lib/bootstrap/dist/css/bootstrap.min.css" />
<link rel="stylesheet" href="~/css/site.css" />
+ <link href="css/app.css" rel="stylesheet" />
+ <link href="BlazorHosted.Client.styles.css" rel="stylesheet" />
</head>
Импортированный макет содержит ссылки навигации Home
и Privacy
. Чтобы ссылка Home
указывала на размещенное приложение Blazor WebAssembly, измените гиперссылку:
- <a class="nav-link text-dark" asp-area="" asp-page="/Index">Home</a>
+ <a class="nav-link text-dark" href="/">Home</a>
В файле макета MVC:
- <a class="nav-link text-dark" asp-area="" asp-controller="Home"
- asp-action="Index">Home</a>
+ <a class="nav-link text-dark" href="/">Home</a>
Чтобы сделать Privacy
ссылку свинцом privacy на страницу, добавьте privacy страницу в Server проект.
В файле Pages/Privacy.cshtml
в проекте Server:
@page
@model BlazorHosted.Server.Pages.PrivacyModel
@{
}
<h1>Privacy Policy</h1>
Если предпочтительное представление на основе privacy MVC, создайте privacy представление в Server проекте.
View/Home/Privacy.cshtml
:
@{
ViewData["Title"] = "Privacy Policy";
}
<h1>@ViewData["Title"]</h1>
В контроллере Home
верните представление.
Controllers/HomeController.cs
:
public IActionResult Privacy()
{
return View();
}
Импортируйте статические ресурсы в проект Server из папки wwwroot
донорского проекта:
- Папка
wwwroot/css
и содержимое - Папка
wwwroot/js
и содержимое - Папка
wwwroot/lib
и содержимое
Если донорский проект создан из шаблона проекта ASP.NET Core и вы не изменяете файлы, можно скопировать всю папку wwwroot
из донорского проекта в проект Server и удалить файл значка favicon.
Предупреждение
Избегайте размещения статического ресурса в обоих папках Client и Server wwwroot
папках. Если один и тот же файл присутствует в обеих папках, создается исключение, так как статический ресурс в каждой из папок использует один и тот же путь к корневой папке веб-страниц. Поэтому статический ресурс следует размещать только в одной из папок wwwroot
.
Преобразование для просмотра компонентов на странице или в представлении с помощью вспомогательной функции тегов компонента
После настройки решения, в том числе дополнительной конфигурации, вспомогательная функция тега компонента поддерживает два режима рендеринга для отрисовки компонента из приложения Blazor WebAssembly на страницу или в представление:
В следующем примере Razor Pages компонент Counter
отрисовывается на странице. Чтобы сделать компонент интерактивным, сценарий Blazor WebAssembly добавляется в раздел отображения страницы. Чтобы избежать использования полного пространства имен для компонента Counter
с вспомогательной функцией тегов компонента ({ASSEMBLY NAME}.Pages.Counter
), добавьте директиву @using
для пространства имен Pages
проекта клиента. В следующем примере пространством имен проекта Client является BlazorHosted.Client
.
В проекте Server Pages/RazorPagesCounter1.cshtml
:
@page
@using BlazorHosted.Client.Pages
<component type="typeof(Counter)" render-mode="WebAssemblyPrerendered" />
@section Scripts {
<script src="_framework/blazor.webassembly.js"></script>
}
Запустите проект Server. Перейдите на страницу Razor по адресу /razorpagescounter1
. Предварительно отрисованный компонент Counter
внедряется на страницу.
Параметр RenderMode настраивает одно из следующих поведений компонента:
- компонент предварительно преобразуется в страницу;
- компонент отображается как статический HTML на странице или включает необходимые сведения для начальной загрузки приложения Blazor из агента пользователя.
Дополнительные сведения о вспомогательной функции тега компонента, в том числе о передаче параметров и конфигурации RenderMode, см. в статье Вспомогательная функция тега компонента в ASP.NET Core.
В зависимости от упорядочения страниц макета в приложении и статических ресурсов, используемых компонентами в приложении, возможно, придется выполнить дополнительные действия. Как правило, скрипты добавляются в раздел отрисовки Scripts
представления или страницы, а таблицы стилей добавляются в содержимое элемента <head>
макета.
Преобразование компонентов на странице или в представлении с помощью селектора CSS
Настроив решение, а также выполнив дополнительную конфигурацию, добавьте корневые компоненты в проект Client размещенного решения Blazor WebAssembly в Program.cs
. В следующем примере компонент Counter
объявляется как корневой компонент с помощью селектора CSS, который выбирает элемент с id
, соответствующим counter-component
. В следующем примере пространством имен проекта Client является BlazorHosted.Client
.
В файле Program.cs
проекта Client добавьте пространство имен для компонентов проекта Razor в начало файла:
using BlazorHosted.Client.Pages;
Настроив builder
в Program.cs
, добавьте компонент Counter
в качестве корневого компонента:
builder.RootComponents.Add<Counter>("#counter-component");
В следующем примере Razor Pages компонент Counter
отрисовывается на странице. Чтобы сделать компонент интерактивным, сценарий Blazor WebAssembly добавляется в раздел отображения страницы.
В проекте Server Pages/RazorPagesCounter2.cshtml
:
@page
<div id="counter-component">Loading...</div>
@section Scripts {
<script src="_framework/blazor.webassembly.js"></script>
}
Запустите проект Server. Перейдите на страницу Razor по адресу /razorpagescounter2
. Предварительно отрисованный компонент Counter
внедряется на страницу.
В зависимости от упорядочения страниц макета в приложении и статических ресурсов, используемых компонентами в приложении, возможно, придется выполнить дополнительные действия. Как правило, скрипты добавляются в раздел отрисовки Scripts
представления или страницы, а таблицы стилей добавляются в содержимое элемента <head>
макета.
Примечание.
В предыдущем примере исключение JSException возникает, если приложение Blazor WebAssembly предварительно отрисовывается и интегрируется в приложение Razor Pages или MVC одновременно с селектором CSS. При переходе к одному из компонентов Razor проекта Client появляется следующее исключение:
Microsoft.JSInterop.JSException: не удалось найти элемент, соответствующий селектору #counter-component.
Это нормальное поведение, поскольку предварительная отрисовка и интеграция приложения Blazor WebAssembly с маршрутизируемыми компонентами Razor несовместимы с использованием селекторов CSS.
Дополнительные ресурсы Blazor WebAssembly
- Управление состоянием: обработка предварительной отрисовки
- Поддержка предварительной отрисовки с отложенной загрузкой сборки
- Razor Темы жизненного цикла компонентов, относящиеся к предварительной подготовке
- Инициализация компонента (
OnInitialized{Async}
) - После отрисовки компонента (
OnAfterRender{Async}
) - Повторное подключение с отслеживанием состояния после предварительной отрисовки: хотя в содержимом раздела внимание в основном уделяется Blazor Server и подключению с отслеживанием состояния SignalR, сценарий для предварительной отрисовки в размещенных приложениях Blazor WebAssembly (WebAssemblyPrerendered) включает в себя аналогичные условия и подходы для предотвращения повторного выполнения кода разработчиком. Сведения о сохранении состояния во время выполнения кода инициализации во время предварительной отрисовки см . в разделе "Сохранение предопределенного состояния " этой статьи.
- Предварительная отрисовка с помощью взаимодействия с JavaScript
- Инициализация компонента (
- Субъекты проверки подлинности и авторизации, относящиеся к предварительной подготовке
- Размещение и развертывание: Blazor WebAssembly
Интеграция Razor компонентов в Razor приложения Pages или MVC в размещенном Blazor WebAssemblyрешении поддерживается в ASP.NET Core в .NET 5 или более поздней версии. Выберите вариант этой статьи для версии .NET 5 или более поздней.
ASP.NET Core