Laravel怎么创建自己的包(Package)_Laravel扩展包开发入门到发布-Laravel-PHP中文网

Laravel怎么创建自己的包(Package)_Laravel扩展包开发入门到发布

冰火之心

发布： 2025-12-03 13:50:02

原创

977人浏览过

答案：从创建结构、编写服务提供者到本地测试并发布，完整实现Laravel扩展包开发流程。1. 创建packages/yourname/sms-notification目录并composer init初始化，配置PSR-4命名空间；2. 在src/下创建SmsNotificationServiceProvider.php注册服务绑定与配置发布；3. 添加config/sms.php配置文件并在boot中mergeConfigFrom合并；4. 主项目composer.json添加path仓库引用，require安装后注册Provider或启用自动发现；5. composer.json中通过extra.laravel.providers支持自动发现；6. 编写README后推送GitHub并提交Packagist发布，完成可复用扩展包构建。

laravel怎么创建自己的包(package)_laravel扩展包开发入门到发布

在Laravel生态中，创建自己的扩展包（Package）是复用代码、提升开发效率的重要方式。无论是封装通用功能，还是准备开源分享，掌握Laravel包的开发流程非常实用。下面从零开始，带你完成一个Laravel扩展包的创建、本地测试到发布全过程。

1. 创建包的基本结构

一个Laravel包本质上是一个独立的Composer包，拥有自己的命名空间和目录结构。我们先在packages/yourname/your-package-name目录下初始化项目（可放在Laravel项目的根目录下）：

步骤：

新建目录：mkdir -p packages/yourname/sms-notification
进入目录：cd packages/yourname/sms-notification
初始化Composer：composer init

填写基本信息时，注意设置PSR-4自动加载的命名空间，例如：

"autoload": {
    "psr-4": {
        "YourName\SmsNotification\": "src/"
    }
}

登录后复制

然后运行composer install生成vendor/autoload.php。

2. 编写服务提供者（ServiceProvider）

Laravel通过服务提供者注册绑定、中间件、路由等。在src/目录下创建服务提供者：

创建文件：src/SmsNotificationServiceProvider.php
内容示例：

<?php

namespace YourNameSmsNotification;

use IlluminateSupportServiceProvider;

class SmsNotificationServiceProvider extends ServiceProvider
{
    public function register()
    {
        $this->app->bind('sms', function () {
            return new SmsManager();
        });
    }

    public function boot()
    {
        // 发布配置文件（可选）
        $this->publishes([
            __DIR__.'/../config/sms.php' => config_path('sms.php'),
        ]);
    }
}

登录后复制

再创建核心类SmsManager，放在src/SmsManager.php，实现具体逻辑。

3. 添加配置与资源文件

如果需要配置文件，可在config/sms.php创建默认配置：

return [
    'default' => env('SMS_DRIVER', 'aliyun'),
    'drivers' => [
        'aliyun' => [...],
        'tencent' => [...],
    ]
];

登录后复制

在boot()方法中调用$this->mergeConfigFrom()合并默认配置：

$this->mergeConfigFrom(
    __DIR__.'/../config/sms.php',
    'sms'
);

登录后复制

4. 在Laravel主项目中测试包

为方便本地调试，修改主项目的composer.json，添加对本地包的引用：

速创猫AI简历

一键生成高质量简历

291

查看详情

"repositories": [
    {
        "type": "path",
        "url": "packages/yourname/sms-notification"
    }
]

登录后复制

然后安装你的包：

composer require yourname/sms-notification:dev-main

登录后复制

接着在config/app.php中注册服务提供者（Laravel 5.5+ 可自动发现）：

'providers' => [
    YourNameSmsNotificationSmsNotificationServiceProvider::class,
]

登录后复制

运行php artisan vendor:publish测试配置文件是否能正常发布。

5. 支持自动发现（Auto-discovery）

避免用户手动注册ServiceProvider，可在包的composer.json中添加：

"extra": {
    "laravel": {
        "providers": [
            "YourName\SmsNotification\SmsNotificationServiceProvider"
        ],
        "aliases": {
            "Sms": "YourName\SmsNotification\Facades\Sms"
        }
    }
}

登录后复制

这样用户安装后无需额外配置即可使用。