Project Icon

livewire-best-practices

Laravel Livewire框架开发动态UI的最佳实践

该项目收集了Laravel Livewire框架的最佳实践,包括安全性、性能和组件维护等关键领域。文档提供了实用建议,如根元素设置、大对象处理、嵌套限制和表单对象使用等。此外还涵盖了用户体验优化、惰性加载、计算属性应用和测试编写等主题,为开发者提供了全面的Livewire动态UI开发指南。

Livewire标志

Livewire最佳实践

与乌克兰站在一起

本仓库是一个精选列表,包含了如何使用Laravel Livewire框架来满足企业对Livewire组件的安全性、性能和维护性等方面的一般建议。

简短介绍

我是Michael Rubél,我从2019年Livewire框架刚推出且几乎不稳定时就开始使用它。当时,我对于如何快速开发动态UI而无需使用JavaScript感到印象深刻。但是像任何软件解决方案一样,它也有其缺陷,我不得不应对这些问题。本仓库的主要目标是收集在使用Livewire时需要考虑的最重要经验。

让我们开始吧...


🌳 始终设置根元素

Livewire要求每个组件都有一个根元素(div)。你应该始终在<div>你的代码在这里</div>内编写代码。省略这个结构将导致更新组件时出现许多问题。

示例


✨ 高性能Livewire的黄金法则

不要向Livewire组件传递大型对象!

尽可能避免将对象传递给组件的公共属性。使用原始类型:字符串、整数、数组等。这是因为Livewire在每次向服务器请求时都会序列化/反序列化你的组件负载,以在前端和后端之间共享状态。如果你需要处理对象,可以在方法或计算属性内创建它们,然后返回处理结果。

什么可以被视为大型对象?

  • 任何像Eloquent模型那样大的实例对Livewire来说已经足够大,可能会减慢组件生命周期,从而导致实时更新性能不佳。例如,如果你有一个表示用户资料(电子邮件和用户名)的组件,请将这些参数作为字符串传递给属性。

注意:如果你使用全页面组件,建议在全页面组件本身获取对象,然后将它们作为原始类型向下传递给嵌套组件。


🧵 保持组件嵌套层级为1

如果你有一个Livewire组件(0)包含另一个Livewire组件(1),那么你不应该再进一步嵌套(2+)。过多的嵌套可能会在处理DOM对比问题时造成麻烦。

此外,在使用嵌套时优先使用Blade组件,它们能够与父级Livewire组件通信,但不会增加Livewire带来的开销。

示例


📝 利用表单对象

Livewire v3引入了一个名为表单对象的新抽象层。始终使用它们,因为这会使你的组件在长期维护中更易于管理。

文档


🕵️ 不要向组件传递敏感数据

避免可能导致向Livewire组件传递敏感数据的情况,因为默认情况下可以轻易从客户端访问这些数据。从Livewire版本3开始,你可以使用#[Locked]属性来隐藏前端的属性。


☔ 优先使用事件监听器而不是轮询

与其不断轮询页面来刷新数据,不如使用事件监听器,只在从另一个组件发起特定任务后才执行组件更新。

示例


📦 使用计算属性访问数据库

你可以使用计算属性来避免不必要的数据库查询。计算属性在组件的生命周期内被缓存,不会在组件类或blade视图中多次运行。从Livewire v3开始,计算属性的结果还可以缓存在通用的应用级缓存中(例如Redis),参见

示例

🗺️ 使用路由模型绑定来获取模型

只需向 mount 方法传递 ID 或 UUID,然后将模型属性映射到组件属性。请记住:不要分配整个模型,而只分配其属性。为避免手动映射模型属性,你可以使用 fill 方法。

示例


💡 尽可能避免使用 live wire:model 修饰符

避免使用 live wire:model 修饰符。这可以大大减少不必要的服务器请求。 在 Livewire 版本 3 中,所有模型默认都是延迟的(旧版:defer 修饰符),这是一个好做法。

示例


👨‍💻 使用 Artisan 命令来创建、移动和重命名组件

Livewire 有内置的 Artisan 命令用于创建、移动、重命名组件等。 例如,与其手动重命名文件(这可能容易出错),你可以使用以下命令:

  • php artisan livewire:move Old/Path/To/Component New/Path/To/Component

💱 始终使用加载状态以提升用户体验

你可以使用加载状态来改善用户体验。如果你的处理过程运行时间超出预期,这将向用户指示背景中正在发生某些操作。为避免闪烁,你可以使用 delay 修饰符。

示例


📈 使用延迟加载

与其阻塞页面渲染直到数据准备就绪,你可以使用延迟加载技术创建一个占位符,使你的 UI 更加响应迅速。

示例


🔗 Entangle

使用 $wire.entangle 指令将你的数据与后端同步。这样,模型将在前端立即更新,并且数据将在网络请求到达服务器后在服务器端持久化。这极大地改善了在慢速设备上的用户体验。这种方法在其他前端社区中被称为"乐观响应"或"乐观 UI"。

示例


🌎 使用表单请求规则进行验证

Livewire 内部不支持表单请求,但你可以直接从表单请求中获取验证规则数组,而不是在组件中硬编码验证规则数组。 这样,你可以在不同的应用层中重用相同的验证规则,例如在 API 端点中。

示例


🧪 始终编写功能测试

即使是简单的测试也能在你修改组件时大有帮助。 Livewire 有一个简单yet强大的测试 API


🔨 你是否每天都在使用 Livewire?
如果你没有在列表中看到你的最佳实践,请提出建议。
如果你不确定这是否是一个好的实践,你可以开始一个讨论

贡献者

GitHub 贡献者图片

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号