如何开发、本地测试、发布 Laravel 扩展包？

nanchen2251 发布于2019-06-28 14:39 / 2803人阅读

摘要：现在已经有了很多，关于如何开发扩展包的文章。提交代码到首先，需要把扩展包的代码提交到上，记录下版本库的地址，注意是。填写完毕，提交后，记得测试一次，完成首次同步，成功会提示信息。

现在已经有了很多，关于如何开发 Laravel 扩展包的文章。但是大多文章写的太过片面，不够完整，而且我在实际进行开发扩展包的时候，还是遇到了很多的问题，我把自己的开发经验，以及遇到的问题记录下来，分享给大家。

扩展包开发 1. 创建新项目，初始化扩展包配置

首先创建一个新的 Laravel 项目：

composer create-project laravel/laravel laradmin -vvv

接下来在此项目中，创建目录 packages/{your_name}/{your_package_name}

mkdir -p packages/angkee/laradmin

进入扩展包目录，初始化 composer 配置

cd packages/angkee/laradmin   
composer init

执行之后，项目下生成一个 composer.json 文件：

{
    "name": "angkee/laradmin",
    "description": "Laradmin is a laravel package for can be generated fast backend management panel",
    "license": "MIT",
    "authors": [
        {
            "name": "angkee",
            "email": "angkee@qq.com"
        }
    ],
    "require": {}
}

2. 创建扩展包基本目录、文件

一般情况下，我们会创建以下文件和目录:

angkee/laradmin
├── src  #存放扩展包所有的逻辑代码
├── tests # 存放测试用例
├── README.md
├── composer.json
└── LICENSE

3. 修改扩展包 composer 配置

然后，修改此扩展包中的 composer.json 文件，设置一下 composer 的自动加载配置、以及扩展包的命名空间。

{
    ...,
    "autoload": {
        "psr-4": {
            "AngkeeLaradmin": "src/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "AngkeeLaradminTests": "tests/"
        }
    },
    ...
}

4. 编写扩展包逻辑代码

接下来，我们来创建 AdminServiceProvider.php、Admin.php 文件。

app->singleton("admin", function () {
            return new Admin;
        });
    }
}

此时，这个扩展包算是开发好了，接下来我们开始进行本地安装、测试。

扩展包本地测试

把 AdminServiceProvider 添加到项目的 config/app.php providers 数组中

"providers" => [
    ...,
    AngkeeAdminAdminServiceProvider::class,
],

再修改项目下的 composer.json 文件

{
    "require": {
        ...,
        "angkee/laradmin": "dev-master"
    },
    ...,
    "autoload": {
        ...,
        "psr-4": {
            ...,
            "AngkeeAdmin": "packages/laradmin/src/"
        }
    },
    ...
}

运行命令：

composer dump-autoload  
composer update

最后，修改一下 routes/web.php 文件：

Route::get("/", function () {
    app("admin")->printRunning();
});

此时，我们打开浏览器访问此项目，显示 running，恭喜你，成功了!

扩展包发布

扩展包开发、测试完成之后，这个时候就可以发布到 Packagist。

1. 提交代码到 GitHub

首先，需要把扩展包的代码提交到 GitHub 上，记录下 GitHub 版本库的地址，注意是 HTTPS。

2. 把扩展包发布到 Packagist

然后，访问 Packagist 官网，登录后，点击右上角Submit按钮，进入发布向导:

此时，将 GitHub 版本库的地址填写至 Repository URL 输入框中，然后点击 Submit 提交按钮，一切顺利，可以看到发布成功。

3. 设置代码同步

一旦在 Pakagist上发布了包，之后的版本更新和代码同步，有一个机制来保证，就是 GitHub 中的事件通知服务，用于代码递交时触发一个事件，将代码同步到其他环境中。

添加服务，服务列表中选择 Packagist，主要填写两项 Packagist 配置信息：

用户名：注意是 Packagist 上的用户名
Token：通讯令牌
Domain：可不用填写

其中 Token 需要到 Packagist 的个人设置里面去获取。

填写完毕，提交后，记得测试一次，完成首次同步，成功会提示信息。

Okay, the test payload is on its way.

回到Packagist，刷新，应该没有再出现 (Not Auto-Updated) 的提示，说明同步机制已经生效，之后每次 GitHub 变化，会自动通知并同步。

4. 设置版本信息

版本默认是 dev-master，Composer 包的版本号会从 Git 的 tag 中同步过来。

git tag 1.0.0  
git push --tag

扩展包刚发布，此时安装，可能会报找不到安装包的错误，需要稍等一下服务器同步，一般不过超过 3-5 分钟，如果一切正常，会看到版本提示，安装成功！

参考文献

Laravel 的扩展插件开发指南

人人为我，我为人人！向社区发布自己的 Composer 包

Composer & Laravel 包本地开发

云服务器私有云 laravel 性能测试敏捷开发如何测试 laravel5框架开发 python 扩展包

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/26317.html

PHP / Laravel API 开发推荐阅读清单

showImg(https://segmentfault.com/img/bV6aHV?w=1280&h=800); 社区优秀文章 Laravel 5.5+passport 放弃 dingo 开发 API 实战，让 API 开发更省心 - 自造车轮。 API 文档神器 Swagger 介绍及在 PHP 项目中使用 - API 文档撰写方案推荐 Laravel API 项目必须使用的 8 个...

shmily 2019-06-28 18:34 评论0 收藏0
刚接触一个 Laravel 项目，你可以从这些地方入手

摘要：在每一个的项目主页上，展示了扩展包的介绍版本号仓库地址如完整的文件，以及其他一些有用的信息。官方文档给出了总结服务提供者是所有应用程序引导中心。你可以浏览位于目录下的所有应用程序服务提供者。当你接手一个新项目的时候，可能会感到无从下手，如果不熟悉编程，则更是如此。那么，我们该从哪儿入手呢？项目代码的哪些部分我们需要着重了解？下面我们看看 Laravel 项目的几个通用的部分。项目文...

ranwu 2019-07-01 11:13 评论0 收藏0
如何将 Laravel 数据表里的数据导出成 Seeder 文件

摘要：本文经授权转自社区说明开发者使用部署一个新项目的时候通常会使用快速填充本地数据以方便开发调试扩展包提供了可将数据表里的数据直接转换为文件的功能本项目由团队成员整理发布首发地为社区使用场景通常情况下我们会希望本地开发环境数据与生产完全一致这样本文经授权转自 PHPHub 社区说明开发者使用 Laravel 部署一个新项目的时候, 通常会使用 seeder 快速填充本地数据以方便开发...

BigTomato 2019-06-27 12:11 评论0 收藏0
刚接触一个 Laravel 项目，你可以从这些地方入手

摘要：在每一个的项目主页上，展示了扩展包的介绍版本号仓库地址如完整的文件，以及其他一些有用的信息。官方文档给出了总结服务提供者是所有应用程序引导中心。你可以浏览位于目录下的所有应用程序服务提供者。 showImg(https://segmentfault.com/img/bV6vPF?w=1200&h=500); 当你接手一个新项目的时候，可能会感到无从下手，如果不熟悉编程，则更是如此。那么...

RyanQ 2019-06-28 18:36 评论0 收藏0
无头浏览器测试可视化：Laravel Dusk 控制台入门指南

摘要：通过添加此功能，该程序包将启用记录请求和响应信息所需的功能。是一条普通控制器路由，用于输出控制台的视图。收集浏览器行为这是整个扩展包最乏味的部分。 Laravel Dusk 控制台是一款 Laravel 扩展包，能够为你的 Dusk 测试套件提供漂亮的可视面板。通过它，你可以可视化运行 Dusk 测试时涉及的各个步骤，以及查看每个步骤的 DOM 快照。这对于调试浏览器测试、并搞清楚后台...

levius 2019-07-01 11:15 评论0 收藏0