从零开始打造 Laravel 扩展包:开发、测试到发布完整指南

2025-12-04 0 347

从零开始打造 Laravel 扩展包:开发、测试发布完整指南

手把手教你创建、测试、版本管理、发布和维护自己的 Laravel 扩展包。

引言

Laravel 生态之所以繁荣,离不开开源社区的贡献。你每天用的 Spatie、Laravel Debugbar、Livewire,本质上都是开发者分享出来的扩展包。

如果你写过一些能在多个项目里复用的功能——自定义验证规则、辅助函数、UI 组件之类的——那恭喜,你其实已经有了做扩展包的基础。

这篇文章会带你走完整个流程:从搭建项目结构,到编写测试、配置 CI/CD,最后发布到 Packagist。

原文链接 从零开始打造 Laravel 扩展包:开发、测试到发布完整指南

步骤 1:搭建扩展包结构

先从最基础的开始。

我们要做一个叫 mycompany/laravel-awesome 的扩展包,功能很简单:提供一个 @shout() 的 Blade 指令。

1. 创建扩展包文件夹

在 Laravel 项目里(或者单独建个目录),执行:

mkdir -p packages/mycompany/laravel-awesome
cd packages/mycompany/laravel-awesome

2. 初始化 Composer

composer init

3. 文件夹结构

最简单的扩展包结构长这样:

laravel-awesome/
├── composer.json.json
├── src/
│   ├── LaravelAwesomeServiceProvider.php
│   └── Helpers/
│       └── shout.php
└── tests/
    └── ExampleTest.php

步骤 2:编写辅助函数和服务提供者

1. 添加辅助函数:Helpers/shout.php

在扩展包里新建文件:

src/Helpers/shout.php

<?php

if (! function_exists(\'shout\')) {
    /**
     * 将给定字符串转换为大写。
     *
     * @param  string  $text
     * @return string
     */
    function shout(string $text): string
    {
        return strtoupper($text);
    }
}

2. 添加服务提供者

再创建一个服务提供者文件:

src/LaravelAwesomeServiceProvider.php

<?php

namespace MyCompanyLaravelAwesome;

use IlluminateSupportServiceProvider;
use IlluminateSupportFacadesBlade;

class LaravelAwesomeServiceProvider extends ServiceProvider
{
    public function boot()
    {
        // 注册 Blade 指令
        Blade::directive(\'shout\', function ($expression) {
            return \"<?php echo strtoupper($expression); ?>\";
        });

        // 加载辅助函数文件
        $this->loadHelpers();
    }

    public function register()
    {
        //
    }

    protected function loadHelpers(): void
    {
        foreach (glob(__DIR__ . \'/Helpers/*.php\') as $filename) {
            require_once $filename;
        }
    }
}

3. 配置自动加载

在 composer.json 里告诉 Laravel 去哪找这个类:

\"autoload\": {
    \"psr-4\": {
        \"MyCompany\\LaravelAwesome\\\": \"src/\"
    }
},
\"extra\": {
    \"laravel\": {
        \"providers\": [
            \"MyCompany\\LaravelAwesome\\LaravelAwesomeServiceProvider\"
        ]
    }
}

最后刷新一下自动加载:

composer dump-autoload

在 Laravel 项目里试试:

@shout(\'hello world\')

输出 → HELLO WORLD

完成!你的第一个 Laravel 扩展包就这么跑起来了。

步骤 3:加上测试

这里用 Pest,语法比 PHPUnit 简洁不少。

先装 Pest:

composer require pestphp/pest --dev

创建 tests/ExampleTest.php

<?php

it(\'将文本转换为大写\', function () {
    $result = strtoupper(\'laravel\');
    expect($result)->toBe(\'LARAVEL\');
});

运行测试:

vendor/bin/pest

把测试放在扩展包目录里,这样即使 Laravel 升级了,你也能及时发现兼容性问题。

步骤 4:本地测试

发布之前,先在另一个 Laravel 项目里测一下。

在主项目的 composer.json 里加上:

\"repositories\": [
    {
        \"type\": \"path\",
        \"url\": \"packages/mycompany/laravel-awesome\"
    }
],

然后安装:

composer require mycompany/laravel-awesome:*

这样就能快速迭代,不用每次都推到 GitHub。

步骤 5:配置 CI/CD

用 GitHub Actions 自动跑测试。新建 .github/workflows/tests.yml

name: Tests

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: shivammathur/setup-php@v2
        with:
          php-version: \'8.3\'
      - run: composer install --prefer-dist --no-progress
      - run: vendor/bin/pest

这样每次 push 代码,测试就会自动跑一遍。

步骤 6:版本管理

扩展包的版本管理很重要,要遵循语义化版本(SemVer)规范。

发布时这么操作:

git add .
git commit -m \"Initial release\"
git tag v1.0.0
git push origin main --tags

打上 tag 后,CI 会自动跑,Composer 也能根据 tag 管理版本。

步骤 7:发布到 Packagist

  1. 把代码推到 GitHub(公开仓库)
  2. 打开 packagist.org
  3. 点 Submit,贴上仓库地址
  4. Packagist 会自动从 tag 里拉取版本

现在别人就能装你的扩展包了:

composer require mycompany/laravel-awesome

步骤 8:后期维护

扩展包发布后,还要持续维护:

  • 支持多个 Laravel 版本(8.x 到 12.x),自动跑测试
  • 用 Dependabot 或 Renovate 自动更新依赖
  • README.md 里写清楚使用示例
  • 给仓库加上 topic:laravel、package、blade 等
  • 发新版本时遵循语义化版本:
    • MAJOR(大版本):不兼容的变更
    • MINOR(小版本):新功能
    • PATCH(补丁):修 bug

进阶技巧:Monorepo 管理多个扩展包

如果你有多个扩展包(比如一套 UI 组件),可以用 monorepo 的方式统一管理,配合 laravel/pintphpstan 这些工具共享配置。

这样做的好处是代码风格统一,依赖更新也方便。

额外福利:自动发布

再加个工作流 .github/workflows/release.yml

name: Auto Release

on:
  push:
    tags:
      - \'v*.*.*\'

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: ncipollo/release-action@v1
        with:
          generateReleaseNotes: true

这样每次打 tag,GitHub 就会自动生成 release 页面,Packagist 也会同步。

总结

到这里,你已经走完了从想法到发布的全流程:搭建结构 → 编写代码 → 测试 → CI/CD → Packagist 发布。

做扩展包不只是分享代码那么简单,它让你深入了解开源项目的运作机制,学会如何维护一个公开的项目,也能为 Laravel 生态做出贡献。

一旦掌握了这套流程,你会发现自己写的代码越来越模块化、越来越好复用,而且能帮助到更多开发者。

收藏 (0) 打赏

感谢您的支持,我会继续努力的!

打开微信/支付宝扫一扫,即可进行扫码打赏哦,分享从这里开始,精彩与您同在
点赞 (0)

申明:本文由第三方发布,内容仅代表作者观点,与本网站无关。对本文以及其中全部或者部分内容的真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。本网发布或转载文章出于传递更多信息之目的,并不意味着赞同其观点或证实其描述,也不代表本网对其真实性负责。

左子网 开发教程 从零开始打造 Laravel 扩展包:开发、测试到发布完整指南 https://www.zuozi.net/3555.html

常见问题
  • 1、自动:拍下后,点击(下载)链接即可下载;2、手动:拍下后,联系卖家发放即可或者联系官方找开发者发货。
查看详情
  • 1、源码默认交易周期:手动发货商品为1-3天,并且用户付款金额将会进入平台担保直到交易完成或者3-7天即可发放,如遇纠纷无限期延长收款金额直至纠纷解决或者退款!;
查看详情
  • 1、描述:源码描述(含标题)与实际源码不一致的(例:货不对板); 2、演示:有演示站时,与实际源码小于95%一致的(但描述中有”不保证完全一样、有变化的可能性”类似显著声明的除外); 3、发货:不发货可无理由退款; 4、安装:免费提供安装服务的源码但卖家不履行的; 5、收费:价格虚标,额外收取其他费用的(但描述中有显著声明或双方交易前有商定的除外); 6、其他:如质量方面的硬性常规问题BUG等。 注:经核实符合上述任一,均支持退款,但卖家予以积极解决问题则除外。
查看详情
  • 1、左子会对双方交易的过程及交易商品的快照进行永久存档,以确保交易的真实、有效、安全! 2、左子无法对如“永久包更新”、“永久技术支持”等类似交易之后的商家承诺做担保,请买家自行鉴别; 3、在源码同时有网站演示与图片演示,且站演与图演不一致时,默认按图演作为纠纷评判依据(特别声明或有商定除外); 4、在没有”无任何正当退款依据”的前提下,商品写有”一旦售出,概不支持退款”等类似的声明,视为无效声明; 5、在未拍下前,双方在QQ上所商定的交易内容,亦可成为纠纷评判依据(商定与描述冲突时,商定为准); 6、因聊天记录可作为纠纷评判依据,故双方联系时,只与对方在左子上所留的QQ、手机号沟通,以防对方不承认自我承诺。 7、虽然交易产生纠纷的几率很小,但一定要保留如聊天记录、手机短信等这样的重要信息,以防产生纠纷时便于左子介入快速处理。
查看详情

相关文章

猜你喜欢
发表评论
暂无评论
官方客服团队

为您解决烦忧 - 24小时在线 专业服务