CMS后端Web框架【免費(fèi)下載鏈接】OrchardCoreOrchard Core is an open-source modular and multi-tenant application framework built with ASP.NET Core, and a content management system (CMS) built on top of that framework.項(xiàng)目地址https://gitcode.com/gh_mirrors/or/OrchardCore點(diǎn)擊查看免費(fèi)下載顯示驅(qū)動程序Display Driver是 OrchardCore 內(nèi)容呈現(xiàn)體系中承上啟下的核心機(jī)制它負(fù)責(zé)把內(nèi)容部件Part、內(nèi)容字段Field或任意模型Model轉(zhuǎn)換成可供 Razor/Liquid 模板渲染的 Shape并為每個 Shape 指定默認(rèn)的擺放位置Location之后placement.json可以再對這些位置進(jìn)行覆蓋。本文以 OrchardCore 倉庫為基準(zhǔn)系統(tǒng)講解四類驅(qū)動基類、三個需要重寫的方法、Shape 構(gòu)建與位置鏈?zhǔn)脚渲?、表單回寫與驗(yàn)證以及驅(qū)動在Startup.cs中的注冊方式并結(jié)合倉庫源碼給出可直接復(fù)用的實(shí)戰(zhàn)代碼。一、什么是 Display Driver在 OrchardCore 的顯示管線中Shape 是渲染的最小單元模板通過 Shape 類型被解析。驅(qū)動Driver承擔(dān)模型 → Shape的橋接職責(zé)其工作方式如下系統(tǒng)在渲染內(nèi)容項(xiàng)時向所有已注冊的驅(qū)動廣播構(gòu)建顯示/編輯事件驅(qū)動判斷傳入的 Part、Field 或 Model 是否是自己關(guān)心的類型若匹配驅(qū)動返回一個或多個IDisplayResult即 Shape 結(jié)果并為其附加默認(rèn)位置位置的最終決定權(quán)交給placement.json——文檔明確說明placement.json可以在之后覆蓋驅(qū)動設(shè)定的默認(rèn)位置。IDisplayResult是一個延遲執(zhí)行的結(jié)果對象只有當(dāng) Shape 真正需要渲染時才會被創(chuàng)建詳見下文Factory系列方法這是 OrchardCore 避免無謂對象分配的關(guān)鍵設(shè)計。二、四個基類與各自的構(gòu)建上下文OrchardCore 針對不同的目標(biāo)類型提供了四個抽象基類每個基類都對應(yīng)特定的構(gòu)建上下文Build Context。上下文攜帶當(dāng)前渲染所需的元數(shù)據(jù)例如TypePartDefinition、PartFieldDefinition、Updater、HtmlFieldPrefix等?；愶@示/編輯上下文用途ContentPartDisplayDriverTPartBuildPartDisplayContext/BuildPartEditorContext內(nèi)容部件PartContentFieldDisplayDriverTFieldBuildFieldDisplayContext/BuildFieldEditorContext內(nèi)容字段FieldSectionDisplayDriverTModel, TSectionBuildDisplayContext/BuildEditorContext設(shè)置區(qū)塊站點(diǎn)設(shè)置、用戶設(shè)置等TSection是實(shí)體上的一個屬性DisplayDriverTModelBuildDisplayContext/BuildEditorContext任意其他模型2.1 Part 驅(qū)動與 Field 驅(qū)動的類型過濾從源碼看兩類驅(qū)動在進(jìn)入構(gòu)建前都會做類型守衛(wèi)。ContentFieldDisplayDriverTField在 ContentFieldDisplayDriver.cs 中通過partFieldDefinition.FieldDefinition.Name與typeof(TField).Name比較來決定是否接管該字段而ContentPartDisplayDriverTPart在 ContentPartDisplayDriverTPart.cs 中把ContentPart強(qiáng)轉(zhuǎn)為TPart轉(zhuǎn)型失敗即返回nullnull結(jié)果表示本驅(qū)動不處理該類型。2.2 Part/Field 驅(qū)動的 Shape 元數(shù)據(jù)增強(qiáng)Part 驅(qū)動重寫了Factory方法在創(chuàng)建 Shape 后自動設(shè)置Differentiator與AlternatesPart 的 Shape 不同標(biāo)識符為部件名例如HtmlBodyPart-Services、BagPart-LandingPage-ServicesField 的 Shape 不同標(biāo)識符為部件名-字段名或部件名-字段名-Shape類型例如HtmlBodyPart-Description-TextField在Displaying事件中通過ContentPartAlternatesFactory/ContentFieldAlternatesFactory注入緩存好的候選模板列表alternates這正是后續(xù)模板匹配機(jī)制的基礎(chǔ)。SectionDisplayDriverTModel, TSection的簽名要求TSection : new()、TModel : class, IEntity其默認(rèn)實(shí)現(xiàn)返回NullShapeResult()即null見 SectionDisplayDriver.cs。它適用于ISite、用戶等實(shí)體對象上的設(shè)置區(qū)塊——例如一個社交媒體設(shè)置區(qū)塊。三、需要重寫的方法無論選擇哪個基類核心都是三個方法方法觸發(fā)時機(jī)返回值Display(model, context)前端展示 / 后臺管理展示IDisplayResultEdit(model, context)渲染編輯器表單頁面IDisplayResultUpdateAsync(model, context)POST 提交——綁定與校驗(yàn)IDisplayResult通常直接返回Edit(...)以便回顯三個方法都有對應(yīng)的異步版本DisplayAsync、EditAsync?；愔型桨姹镜哪J(rèn)實(shí)現(xiàn)會自動包裝為Task.FromResult(...)因此你既可以只重寫同步版本也可以直接重寫異步版本UpdateAsync本身始終是異步的表單綁定與校驗(yàn)天然適合async/await。從 ContentPartDisplayDriverTPart.cs 可以看到基類的默認(rèn)實(shí)現(xiàn)DisplayAsync內(nèi)部調(diào)用DisplayEditAsync內(nèi)部調(diào)用EditUpdateAsync默認(rèn)返回null不處理回寫。同時驅(qū)動接口的BuildDisplayAsync/BuildEditorAsync/UpdateEditorAsync顯式實(shí)現(xiàn)負(fù)責(zé)強(qiáng)轉(zhuǎn)類型 → 設(shè)置Prefix→ 構(gòu)造細(xì)分上下文 → 調(diào)用虛方法 → 恢復(fù)狀態(tài)。四、構(gòu)建一個 ShapeInitialize 與結(jié)果輔助方法4.1 InitializeInitializeTViewModel(shapeType, factory)是文檔推薦的主要方式創(chuàng)建一個指定shapeType的 Shape并以強(qiáng)類型視圖模型TViewModel作為其數(shù)據(jù)載體然后通過鏈?zhǔn)?Location(...)分配位置。倉庫中TextFieldDisplayDriver的真實(shí)實(shí)現(xiàn)可作為標(biāo)準(zhǔn)范式見 TextFieldDisplayDriver.cspublic override IDisplayResult Display(TextField field, BuildFieldDisplayContext context) { return InitializeDisplayTextFieldViewModel(GetDisplayShapeType(context), model { model.Field field; model.Part context.ContentPart; model.PartFieldDefinition context.PartFieldDefinition; }) .Location(OrchardCoreConstants.DisplayType.Detail, Content) .Location(OrchardCoreConstants.DisplayType.Summary, Content); }OrchardCoreConstants.DisplayType定義在 OrchardCoreConstants.cs共四個取值Detail、Summary、DetailAdmin、SummaryAdmin。.Location(displayType, location)的重載允許按顯示類型分別指定位置例如 Detail 頁放 Content 區(qū)Summary 列表也放 Content 區(qū)而.Location(string)單參重載則設(shè)置所有顯示類型的默認(rèn)位置。4.2 其他結(jié)果輔助方法文檔列出的其余三種方式其實(shí)現(xiàn)均位于 DisplayDriverBase.csView(shapeType, model)——把現(xiàn)有模型直接包裝為ShapeViewModelTModel不執(zhí)行任何初始化回調(diào)適合模型本身就是視圖模型的場景Combine(...)——把多個IDisplayResult合并為一個CombinedResult讓一個驅(qū)動一次返回多個 Shape例如同時輸出主體和側(cè)邊欄兩個 ShapeDynamic(shapeType)——構(gòu)建無強(qiáng)類型視圖模型的松散 Shape可配合Actiondynamic初始化靈活但失去編譯期類型檢查。除此之外基類還提供Factory(...)系列延遲創(chuàng)建 Shape、支持傳入狀態(tài)對象避免閉包分配、Copy(shapeType, model)從已有對象復(fù)制屬性以及被標(biāo)記為[Obsolete]的Shape(shapeType, shape)。Factory是所有驅(qū)動創(chuàng)建 Shape 的最終落點(diǎn)ShapeResult會攜帶驅(qū)動當(dāng)前的Prefix。五、Shape 類型輔助方法在 Part/Field 驅(qū)動內(nèi)部不要手寫 Shape 類型字符串應(yīng)使用基類提供的輔助方法讓顯示模式display mode與編輯器editor后綴自動生效輔助方法返回值GetDisplayShapeType(context)當(dāng)前顯示類型對應(yīng)的顯示 Shape 類型GetEditorShapeType(context)當(dāng)前編輯器對應(yīng)的編輯 Shape 類型以 ContentFieldDisplayDriver.cs 的實(shí)現(xiàn)為例GetDisplayShapeType檢查PartFieldDefinition.DisplayMode()若非空則追加分隔符_Display__與模式名得到如TextField_Display__Header這樣的類型GetEditorShapeType檢查PartFieldDefinition.Editor()若非空則追加__與編輯器名得到如TextField_Edit__CustomEditor這樣的類型。同理Part 驅(qū)動的對應(yīng)實(shí)現(xiàn)見 ContentPartDisplayDriverTPart.cs。這樣內(nèi)容定義Content Definition中配置的顯示模式/編輯器就能自動映射為精確的 Shape 類型進(jìn)而命中精確的模板與 placement 規(guī)則。六、UpdateAsync讀取編輯器表單并校驗(yàn)POST 回寫是驅(qū)動中最容易出錯的部分。標(biāo)準(zhǔn)寫法TextFieldDisplayDriver的完整實(shí)現(xiàn)含必填、最小/最大長度校驗(yàn)見 TextFieldDisplayDriver.cspublic override async TaskIDisplayResult UpdateAsync(TextField field, UpdateFieldEditorContext context) { await context.Updater.TryUpdateModelAsync(field, Prefix, f f.Text); var settings context.PartFieldDefinition.GetSettingsTextFieldSettings(); if (settings.Required string.IsNullOrWhiteSpace(field.Text)) { context.Updater.ModelState.AddModelError(Prefix, nameof(field.Text), S[A value is required for {0}., context.PartFieldDefinition.DisplayName()]); } return Edit(field, context); }要點(diǎn)拆解綁定TryUpdateModelAsync(field, Prefix, f f.Text)從表單中按Prefix前綴讀取名為Text的字段并寫入field校驗(yàn)通過context.PartFieldDefinition.GetSettingsTextFieldSettings()讀取字段設(shè)置再結(jié)合ModelState.AddModelError記錄錯誤S[...]是本地化字符串來自IStringLocalizer回顯返回Edit(field, context)重新渲染編輯器校驗(yàn)失敗時錯誤信息會顯示在表單上驅(qū)動接口實(shí)現(xiàn)會在UpdateAsync返回非空結(jié)果后調(diào)用contentPart.Apply(partFieldDefinition.Name, field)把字段寫回內(nèi)容項(xiàng)見 ContentFieldDisplayDriver.csPart 驅(qū)動同理執(zhí)行part.ContentItem.Apply(typePartDefinition.Name, part)。Prefix 的作用Prefix是表單字段的命名空間前綴保證同一頁面上多個相同 Shape 實(shí)例的字段不會互相沖突。從源碼看字段驅(qū)動的Prefix由typePartDefinition.Name . partFieldDefinition.Name組成例如BlogPost.BodyPart 驅(qū)動的Prefix即部件名若外層存在HtmlFieldPrefix例如嵌套在 List 編輯器內(nèi)還會拼接為外層前綴.部件名或外層前綴.部件名.字段名見 ContentPartDisplayDriverTPart.cs。始終使用Prefix進(jìn)行綁定這是驅(qū)動正確工作的前提。七、Location字符串語法與 Fluent 構(gòu)建器驅(qū)動的.Location(...)支持兩種寫法二者完全等價// 字符串寫法 .Location(Parameters:5#Settings;1) // Fluent 寫法等價 .Location(l l.Zone(Parameters, 5).Tab(Settings, 1))PlacementLocationBuilder的實(shí)現(xiàn)位于 PlacementLocationBuilder.cs位置字符串遵循格式[/]Zone:position#tabgroup%card|column渲染層級為Zone → Tab → Card → Column。構(gòu)建器要求從.Zone()開始之后的層級可以自由跳過、任意順序鏈?zhǔn)秸{(diào)用。方法字符串等價說明.Zone(Content, 5)Content:5目標(biāo) Zone 與區(qū)內(nèi)位置.AsLayoutZone()/前綴標(biāo)記為布局區(qū)Layout Zone.Tab(Settings, 1)#Settings;1Tab 頁與頁內(nèi)位置.Card(Details, 2)%Details;2卡片與卡內(nèi)位置.Column(Left, 1, 9)\|Left_9;1列名稱、列內(nèi)位置、寬度 9 柵格.Group(search)search分組用于搜索等聚合場景完整嵌套示例文檔原文注釋中的結(jié)果由構(gòu)建器生成.Location(l l .Zone(Parameters, 5) .Tab(Settings, 1) .Card(Details, 2) .Column(Left, 3, 9)) // → Parameters:5#Settings;1%Details;2|Left_3;9位置position的比較規(guī)則在構(gòu)建器文檔注釋中有明確說明PlacementLocationBuilder.cs按數(shù)值比較2排在10之前支持點(diǎn)號子位置1.5位于1與2之間支持before/after特殊值分別把 Shape 放在區(qū)的最前/最后缺省位置按0處理。.Location(string displayType, string location)與.Location(string displayType, ActionPlacementLocationBuilder)重載用于按顯示類型分別配置實(shí)現(xiàn)見 ShapeResult.cs.Location(Summary, l l.Zone(Content, 1))注意ShapeResult內(nèi)部為前兩個顯示類型使用內(nèi)聯(lián)存儲、之后切換為字典存儲因此你可以在一個驅(qū)動里為多個顯示類型鏈?zhǔn)秸{(diào)用多個.Location(...)。八、驅(qū)動的注冊方式驅(qū)動必須注冊到 DI 容器才會被顯示管線發(fā)現(xiàn)。在模塊的Startup.cs的ConfigureServices中注冊// 內(nèi)容部件驅(qū)動以 MyPart 為例 services.AddContentPartDisplayDriverMyPart, MyPartDisplayDriver(); // 字段驅(qū)動以 TextField 為例 services.AddContentFieldDisplayDriverTextField, TextFieldDisplayDriver(); // 設(shè)置區(qū)塊 / 通用模型驅(qū)動 services.AddScopedIDisplayDriverISite, MySettingsDisplayDriver();更常見的做法是與部件/字段本身的注冊配對使用services.AddContentPartMyPart() .UseDisplayDriverMyPartDisplayDriver(); services.AddContentFieldTextField() .UseDisplayDriverTextFieldDisplayDriver();從 ContentPartServiceCollectionExtensions.cs 的實(shí)現(xiàn)看UseDisplayDriver等價于同時調(diào)用ForDisplayMode(...)與ForEditor(...)——即把驅(qū)動注冊到所有顯示模式與所有編輯器擴(kuò)展方法還提供ForDisplayMode(predicate)/ForEditor(predicate)精確控制驅(qū)動只服務(wù)于特定模式/編輯器謂詞接收模式名或編輯器名返回是否匹配以及RemoveDisplayDriver反注冊。倉庫中一個真實(shí)的應(yīng)用案例OrchardCore.ContentFields/Startup.cs 中BooleanField、TextField均通過AddContentFieldTField().UseDisplayDriverTFieldDisplayDriver()注冊同時還用ForDisplayMode(d !string.Equals(d, UserNames, ...))這類謂詞為UserPickerField的不同顯示模式注冊不同的驅(qū)動第 198-199 行。九、模板與 Alternates驅(qū)動選定的 Shape 類型決定了渲染模板MyPart.cshtml、MyPart.Summary.cshtml、MyPart_Edit.cshtml等。OrchardCore 按以下順序查找模板精確的 Shape 類型模板由 alternates候選模板名決定的更具體模板——GetDisplayShapeType/GetEditorShapeType產(chǎn)生的后綴顯示模式_Display__xxx、編輯器__xxx會自動加入候選列表主題或模塊通過placement.json的alternates節(jié)點(diǎn)或運(yùn)行時在 Shape 元數(shù)據(jù)shape.Metadata.Alternates中追加的額外候選。Alternates 的命名規(guī)則、內(nèi)容字段區(qū)分符differentiator等細(xì)節(jié)請參閱 Templates 模塊文檔。由于驅(qū)動返回的IDisplayResult是惰性的且ShapeResult在Displaying事件中才注入 alternates見 ContentFieldDisplayDriver.cs所以主題開發(fā)者可以在不修改模塊代碼的前提下通過placement.json覆蓋位置、通過 alternates 覆蓋模板實(shí)現(xiàn)完全的展示層定制。十、placement.json驅(qū)動默認(rèn)位置的最終裁決驅(qū)動內(nèi).Location(...)設(shè)置的是默認(rèn)位置。渲染時placement.json中的規(guī)則優(yōu)先級更高可對驅(qū)動結(jié)果進(jìn)行覆蓋。其典型結(jié)構(gòu)為按 Shape 類型分組、按 display type 細(xì)分位置{ TextField: [ { displayType: Detail, differentiator: BlogPost.Body, place: Content:5 } ] }differentiator與驅(qū)動自動生成的部件名-字段名或部件名-字段名-Shape類型對應(yīng)place字符串使用與驅(qū)動.Location(...)相同的位置語法Zone、Tab、Card、Column 等。這意味著驅(qū)動只需提供合理默認(rèn)值布局細(xì)節(jié)可以完全下沉到主題的placement.json中實(shí)現(xiàn)模塊管內(nèi)容、主題管布局的關(guān)注點(diǎn)分離。小結(jié)Display Driver 是 OrchardCore 內(nèi)容管線的樞紐四個基類覆蓋 Part/Field/設(shè)置區(qū)塊/通用模型四種目標(biāo)Display/Edit/UpdateAsync三個方法分別對應(yīng)展示、編輯渲染與表單回寫InitializeTViewModel配合GetDisplayShapeType/GetEditorShapeType構(gòu)建類型精確的 Shape字符串或 Fluent 的.Location(...)定義默認(rèn)位置最后通過Startup.cs中的AddContentPartDisplayDriver/AddContentFieldDisplayDriver/UseDisplayDriver完成注冊并可由placement.json與 alternates 在主題層進(jìn)行最終裁決。掌握這套流程即可為任意內(nèi)容類型編寫可擴(kuò)展、可主題化的展示邏輯。贊分享CMS后端Web框架【免費(fèi)下載鏈接】OrchardCoreOrchard Core is an open-source modular and multi-tenant application framework built with ASP.NET Core, and a content management system (CMS) built on top of that framework.項(xiàng)目地址https://gitcode.com/gh_mirrors/or/OrchardCore點(diǎn)擊查看免費(fèi)下載相關(guān)推薦Wox 插件清單 plugin.json 完整規(guī)范字段、SettingDefinitions、QueryRequirements 與 Features 權(quán)威指南Wox 插件清單 plugin.json 完整規(guī)范字段、SettingDefinitions、QueryRequirements 與 Features 權(quán)威指桌面應(yīng)用AI 應(yīng)用插件系統(tǒng)Webiny-js擴(kuò)展開發(fā)實(shí)戰(zhàn)構(gòu)建自定義內(nèi)容模型與字段類型Webiny js擴(kuò)展開發(fā)實(shí)戰(zhàn)構(gòu)建自定義內(nèi)容模型與字段類型 Webiny js作為開源無服務(wù)器企業(yè)CMS內(nèi)容管理系統(tǒng)Content ManagementCMS后端前端gh_mirrors/exam/examples權(quán)威教程模型部署容器化方案gh_mirrors/exam/examples權(quán)威教程模型部署容器化方案 你是否還在為深度學(xué)習(xí)模型部署時的環(huán)境配置頭痛本地開發(fā)環(huán)境與服務(wù)器不一致、依賴庫版示例工程創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考