0

0

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

冰火之心

冰火之心

发布时间:2025-12-03 13:50:02

|

1014人浏览过

|

来源于php中文网

原创

答案:从创建结构、编写服务提供者到本地测试并发布,完整实现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
  • 内容示例:
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,添加对本地包的引用:

ToonMe
ToonMe

一款风靡Instagram的软件,一键生成卡通头像

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

然后安装你的包:

composer require yourname/sms-notification:dev-main

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

'providers' => [
    YourName\SmsNotification\SmsNotificationServiceProvider::class,
]

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

5. 支持自动发现(Auto-discovery)

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

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

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

6. 编写文档与发布到Packagist

完善README.md,说明安装、配置和使用方法。然后将代码推送到GitHub:

  • git init && git add . && git commit -m "Initial commit"
  • 创建GitHub仓库并推送

访问 Packagist,提交你的包URL,即可发布。之后其他人可通过composer require yourname/sms-notification安装使用。

基本上就这些。关键在于结构清晰、遵循PSR-4、合理使用服务提供者和配置发布机制。调试阶段建议始终在真实Laravel项目中测试,确保集成无误。发布后持续维护版本标签(如v1.0.0),便于用户升级。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2687

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1661

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1522

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

953

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1420

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1235

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1488

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

PS使用蒙版相关教程
PS使用蒙版相关教程

本专题整合了ps使用蒙版相关教程,阅读专题下面的文章了解更多详细内容。

23

2026.01.19

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.6万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号