Částečná zobrazení v ASP.NET Core

Steve Smith, Maher JENDOUBI, Rick Andersona Scottber

Částečné zobrazení je soubor Razor značek (.cshtml) bez direktivy, která vykresluje výstup HTML v rámci vykreslení výstupu jiného @page souboru s kódem.

Zobrazení nebo stažení ukázkového kódu (stažení)

Kdy použít částečná zobrazení

Částečná zobrazení jsou efektivním způsobem, jak:

• Rozdělit velké soubory s značkami na menší součásti.

  Ve velkém složitém souboru s kódem, který se skládá z několika logických částí, má práce s každou částí izolovanou do částečného zobrazení výhodu. Kód v souboru značek je spravovatelný, protože kód obsahuje pouze celkovou strukturu stránky a odkazy na částečná zobrazení.

• Omezte duplikaci společného obsahu značek napříč soubory značek.

  Pokud se napříč soubory značek používají stejné elementy značek, částečné zobrazení odebere duplikaci obsahu značek do jednoho souboru částečného zobrazení. Když se kód v částečném zobrazení změní, aktualizuje vykreslený výstup souborů značek, které používají částečné zobrazení.

Částečná zobrazení by se neměla používat k zachování běžných prvků rozložení. Běžné prvky rozložení by měly být zadány v _Layout.cshtml.

Nepoužívejte částečné zobrazení, ve kterém se k vykreslení kódu vyžaduje složitá logika vykreslování nebo provádění kódu. Místo částečného zobrazení použijte komponentu zobrazení.

Deklarace částečných zobrazení

Odkaz na částečné zobrazení

public IActionResult OnGetPartial() =>
    new PartialViewResult
    {
        ViewName = "_AuthorPartialRP",
        ViewData = ViewData,
    };

public IActionResult OnGetPartial() =>
    Partial("_AuthorPartialRP");

Použití částečného zobrazení v souboru s kódem

<partial name="_PartialName" />

<partial name="_PartialName.cshtml" />

<partial name="~/Pages/Folder/_PartialName.cshtml" />
<partial name="/Pages/Folder/_PartialName.cshtml" />

<partial name="~/Views/Folder/_PartialName.cshtml" />
<partial name="/Views/Folder/_PartialName.cshtml" />

<partial name="../Account/_PartialName.cshtml" />

Asynchronní pomocná metoda HTML

Při použití pomocníka HTML je osvědčeným postupem použít PartialAsync . PartialAsync vrátí typ IHtmlContent zabalený v Task<TResult> objektu . Na metodu se odkazuje předponou čekajícího volání @ znakem:

@await Html.PartialAsync("_PartialName")

Pokud je k dispozici přípona souboru, pomocník HTML odkazuje na částečné zobrazení, které musí být ve stejné složce jako soubor značek volající částečné zobrazení:

@await Html.PartialAsync("_PartialName.cshtml")

Následující příklad odkazuje na částečné zobrazení z kořenového adresáře aplikace. Cesty, které začínají lomítkem tildy ( ) nebo lomítkem ~/ ( / ), odkazují na kořen aplikace:

@await Html.PartialAsync("~/Pages/Folder/_PartialName.cshtml")
@await Html.PartialAsync("/Pages/Folder/_PartialName.cshtml")

@await Html.PartialAsync("~/Views/Folder/_PartialName.cshtml")
@await Html.PartialAsync("/Views/Folder/_PartialName.cshtml")

Následující příklad odkazuje na částečné zobrazení s relativní cestou:

@await Html.PartialAsync("../Account/_LoginPartial.cshtml")

Alternativně můžete částečné zobrazení vykreslit pomocí RenderPartialAsync . Tato metoda nevrací IHtmlContent . Streamuje vykreslený výstup přímo do odpovědi. Vzhledem k tomu, že metoda nevrací výsledek, musí být volána v rámci Razor bloku kódu:

@{
    await Html.RenderPartialAsync("_AuthorPartial");
}

Vzhledem RenderPartialAsync k tomu, že streamy vykreslují obsah, poskytuje v některých scénářích lepší výkon. V situacích s kritickým výkonem srovnávací testy stránky použijte oba přístupy a použijte přístup, který generuje rychlejší odezvu.

Synchronní pomocná metoda HTML

Partial a RenderPartial jsou synchronní ekvivalenty a PartialAsync v uvedeném RenderPartialAsync pořadí. Synchronní ekvivalenty se nedoporučuje, protože existují scénáře, ve kterých dochází k vzájemnému zablokování. Synchronní metody jsou cílem odebrání v budoucí verzi.

Částečné zjišťování zobrazení

Pokud se na částečné zobrazení odkazuje pomocí názvu bez přípony souboru, prohledá se následující umístění ve stanoveném pořadí:

Na částečné zjišťování zobrazení se vztahují následující konvence:

• Různá částečná zobrazení se stejným názvem souboru jsou povolena, pokud jsou částečná zobrazení v různých složkách.
• Při odkazování na částečné zobrazení podle názvu bez přípony souboru a částečné zobrazení je k dispozici ve složce volajícího i ve složce Shared, částečné zobrazení ve složce volajícího poskytuje částečné zobrazení. Pokud částečné zobrazení není k dispozici ve složce volajícího, je částečné zobrazení poskytnuto ze složky Shared. Částečná zobrazení ve složce Shared se nazývají sdílená částečná zobrazení nebo výchozí částečná zobrazení.
• Částečná zobrazení mohou být zřetězována, může částečné zobrazení volat jiné částečné zobrazení, pokud cyklický odkaz není — vytvořen voláními. Relativní cesty jsou vždy relativní vzhledem k aktuálnímu souboru, nikoli ke kořenovému adresáři nebo nadřazenému souboru.

Přístup k datům z částečných zobrazení

Když je vytvořena instance částečného zobrazení, obdrží kopii slovníku ViewData nadřazeného objektu. Aktualizace dat provedené v rámci částečného zobrazení se neuchová v nadřazeném zobrazení. ViewData Změny v částečném zobrazení se ztratí, když se částečné zobrazení vrátí.

Následující příklad ukazuje, jak předat instanci ViewDataDictionary do částečného zobrazení:

@await Html.PartialAsync("_PartialName", customViewData)

Model můžete předat do částečného zobrazení. Model může být vlastní objekt. Model můžete předat pomocí (vykreslí blok obsahu volajícímu) nebo PartialAsync RenderPartialAsync (streamuje obsah do výstupu):

@await Html.PartialAsync("_PartialName", model)

@model ReadRPModel

<h2>@Model.Article.Title</h2>
@* Pass the author's name to Pages\Shared\_AuthorPartialRP.cshtml *@
@await Html.PartialAsync("../Shared/_AuthorPartialRP", Model.Article.AuthorName)
@Model.Article.PublicationDate

@* Loop over the Sections and pass in a section and additional ViewData to 
   the strongly typed Pages\ArticlesRP\_ArticleSectionRP.cshtml partial view. *@
@{
    var index = 0;

    foreach (var section in Model.Article.Sections)
    {
        await Html.PartialAsync("_ArticleSectionRP", 
                                section,
                                new ViewDataDictionary(ViewData)
                                {
                                    { "index", index }
                                });

        index++;
    }
}

@model string
<div>
    <h3>@Model</h3>
    This partial view from /Pages/Shared/_AuthorPartialRP.cshtml.
</div>

@using PartialViewsSample.ViewModels
@model ArticleSection

<h3>@Model.Title Index: @ViewData["index"]</h3>
<div>
    @Model.Content
</div>

Následující kód v ukázkové aplikaci ukazuje zobrazení Views/Articles/Read.cshtml. Zobrazení obsahuje dvě částečná zobrazení. Druhé částečné zobrazení předá model a ViewData částečné zobrazení. Přetížení ViewDataDictionary konstruktoru slouží k předání nového slovníku při ViewData zachování existujícího ViewData slovníku.

@model PartialViewsSample.ViewModels.Article

<h2>@Model.Title</h2>
@* Pass the author's name to Views\Shared\_AuthorPartial.cshtml *@
@await Html.PartialAsync("_AuthorPartial", Model.AuthorName)
@Model.PublicationDate

@* Loop over the Sections and pass in a section and additional ViewData to 
   the strongly typed Views\Articles\_ArticleSection.cshtml partial view. *@
@{
    var index = 0;

    foreach (var section in Model.Sections)
    {
        await Html.PartialAsync("_ArticleSection", 
                                section,
                                new ViewDataDictionary(ViewData)
                                {
                                    { "index", index }
                                });

        index++;
    }
}

Views/Shared/_AuthorPartial.cshtml je první částečné zobrazení, na které odkazuje soubor značek Read.cshtml:

@model string
<div>
    <h3>@Model</h3>
    This partial view from /Views/Shared/_AuthorPartial.cshtml.
</div>

Views/Articles/_ArticleSection.cshtml je druhé částečné zobrazení, na které odkazuje soubor značek Read.cshtml:

@using PartialViewsSample.ViewModels
@model ArticleSection

<h3>@Model.Title Index: @ViewData["index"]</h3>
<div>
    @Model.Content
</div>

Za běhu se částečné části vykreslují do vykreslení výstupu nadřazeného souboru značek, který se sám vykreslí v rámci sdíleného souboru _Layout.cshtml. První částečné zobrazení vykreslí jméno a datum publikování autora článku:

Abraham Vychemtát

Toto částečné zobrazení ze < sdílené cesty k souboru částečného zobrazení > 19. 11. 1863 12:00:00

Druhé částečné zobrazení vykreslí oddíly článku:

Index sekce 1: 0

Čtyři skóre a před sedmi lety...

Index 2. části: 1

Teď jsme zapojeni do velké občanské válek a testujeme...

Index 3. části: 2

Ve větším smyslu ale nemůžeme vymetit ...

Další materiály