Blazor DynamicComponent 使用方法

10次阅读

DynamicComponent 是 Blazor 内置组件,用于按类型动态渲染 Razor 组件;需传入具体 Type 和匹配 Parameter 名的 Parameters 字典,支持参数校验与实例调用,但默认不保留状态。

Blazor DynamicComponent 使用方法

Blazor 的 DynamicComponent 是一个内置组件,用于按类型动态渲染任意 Razor 组件,无需硬编码条件判断或循环遍历。它适合做插件式 ui多态表单、可配置仪表板等场景。

基础用法:指定 Type 和 Parameters

最简使用方式是传入组件类型和参数字典:

  • Type 必须是具体组件的 typeof(MyComponent),不能是接口或抽象类;
  • ParametersIDictionary,键名需与目标组件的 [Parameter] 属性名完全一致(区分大小写);
  • 若目标组件有必需参数但未在字典中提供,运行时会报错;
  • 不支持直接用 @ref 获取实例,但可通过 Instance 属性间接访问(见下文)。

传参细节:参数怎么写才生效

参数不是“传进去就自动绑定”,关键在于匹配逻辑:

  • 字典中的 key 必须和目标组件的 [Parameter] 属性名一模一样,比如组件里写 [Parameter] public String Title { get; set; },那字典就得是 new Dictionary { ["Title"] = "欢迎页" }
  • 值类型引用类型RenderFragment 都可以传,但 RenderFragment 需要显式构造(如 @((RenderFragment)(builder => { builder.AddContent(0, "自定义内容"); })));
  • 参数会在 OnParametersSetOnParametersSetAsync 中被注入,你可以在这些方法里做校验或初始化逻辑。

获取并调用子组件实例

虽然不能用 @ref,但 DynamicComponent 提供了 Instance 属性:

  • 该属性在组件首次渲染完成后才有值(即 OnAfterRender 之后),需配合 StateHasChanged() 触发重绘
  • 建议用泛型接口约束子组件行为,例如定义 Interface IRefreshable { void Refresh(); },让所有可动态加载的组件实现它;
  • 然后这样调用:if (dynamicComp.Instance is IRefreshable refreshable) refreshable.Refresh();
  • 注意:切换 Type 后旧实例会被销毁,Instance 会变为新组件实例。

状态保持问题:切换后数据丢了怎么办

Blazor 的 DynamicComponent 默认不保留已卸载组件的状态(这点不同于 vue):

  • 每次切换 Type,旧组件彻底销毁,内存释放;
  • 如需保留状态,得自己管理:把关键数据提到父组件或服务中(如 @inject StateService),子组件通过参数或注入方式读写;
  • 也可用 Key 属性强制 Blazor 把不同组件视为独立实体(例如加 Key="@componentType.FullName"),但这只影响 dom 复用,不保存组件内部状态;
  • 没有内置缓存机制,别指望它自动记住输入框内容或滚动位置。

基本上就这些。用好 DynamicComponent 的关键是理解它的“一次性渲染 + 参数驱动”模型,而不是把它当普通组件来 ref 或生命周期强依赖。合理设计参数契约和状态边界,就能写出灵活又可控的动态 UI。

text=ZqhQzanResources