在Laravel 9的Blade模板开发中,自定义组件可以极大提升代码片段的复用性,而组件内公共方法的调用是很多开发者容易踩坑的点,不同组件类型的调用逻辑存在差异,需要结合组件的实现形式选择正确的调用方式。
Laravel 9自定义组件的两种常见类型
Laravel 9的自定义组件主要分为无类组件和有类组件两种,两者的公共方法定义和调用逻辑完全不同,开发前需要先明确组件的类型。
无类组件
无类组件是直接通过Blade模板文件定义的组件,通常放在resources/views/components目录下,这类组件没有对应的PHP类,公共方法无法直接定义在组件内部,需要通过外部辅助函数或者服务提供者注入的方式实现。
有类组件
有类组件是通过php artisan make:component命令生成的组件,会同时生成对应的PHP类文件和Blade模板文件,公共方法可以直接定义在组件类中,调用逻辑更清晰,也是实际开发中使用更多的组件类型。
有类组件中定义公共方法
有类组件的公共方法需要定义在组件对应的PHP类中,所有需要被外部调用的方法都需要声明为public访问权限,否则在Blade模板中无法访问。
首先通过命令生成组件:
<?php // 执行命令生成测试组件 // php artisan make:component TestComponent
生成的组件类位于app/View/Components/TestComponent.php,我们可以在其中定义公共方法:
<?php
namespace AppViewComponents;
use IlluminateViewComponent;
class TestComponent extends Component
{
// 组件公共属性
public $title;
/**
* 组件构造函数
* @param string $title 组件标题
*/
public function __construct($title = '默认标题')
{
$this->title = $title;
}
/**
* 公共方法:格式化标题
* @return string 格式化后的标题
*/
public function formatTitle()
{
return '【' . $this->title . '】';
}
/**
* 公共方法:计算两个数字的和
* @param int $a 第一个数字
* @param int $b 第二个数字
* @return int 计算结果
*/
public function sum($a, $b)
{
return $a + $b;
}
/**
* 渲染组件的方法
* @return IlluminateContractsViewView
*/
public function render()
{
return view('components.test-component');
}
}
Blade模板中调用组件公共方法
在组件的Blade模板文件resources/views/components/test-component.blade.php中,可以直接通过$this关键字调用组件中定义的公共方法:
<div class="test-component">
<h3>组件标题:{{ $this->formatTitle() }}</h3>
<p>1加2的结果是:{{ $this->sum(1, 2) }}</p>
<p>组件原始标题:{{ $title }}</p>
</div>
在页面中调用该组件时,只需要按照常规组件调用方式即可:
<!-- 在任意Blade模板中调用组件 --> <x-test-component title="测试标题" />
无类组件中调用公共方法
无类组件没有对应的PHP类,无法直接定义公共方法,如果需要实现类似公共方法的功能,可以通过在Blade模板中定义局部函数,或者调用全局辅助函数的方式实现。
比如在resources/views/components/no-class-component.blade.php中定义局部函数:
<?php
// 定义局部函数作为公共方法使用
function formatDesc($desc) {
return '描述:' . $desc;
}
?>
<div class="no-class-component">
<p>{{ formatDesc($desc) }}</p>
</div>
调用该组件时传递对应的参数即可:
<x-no-class-component desc="这是一段测试描述" />
常见错误与解决方案
- 方法访问权限错误:如果组件类中的方法声明为
protected或者private,在Blade模板中调用会报错,需要将方法改为public权限。 - 无类组件使用$this调用方法:无类组件没有对应的PHP类,使用
$this调用方法会提示方法不存在,需要改用局部函数或者全局函数的方式实现。 - 方法参数传递错误:调用公共方法时传递的参数数量和类型不匹配,会触发参数错误异常,需要检查方法的参数定义和调用时的传参是否一致。
注意事项
组件中的公共方法尽量避免包含复杂的业务逻辑,复杂的业务处理建议放到服务层或者模型层,组件只负责数据的展示和简单的格式化操作,符合单一职责原则。
如果组件需要接收动态参数传递给公共方法,可以在组件类中定义对应的属性,在构造函数中接收参数并赋值,再在公共方法中使用该属性即可。