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

 Laravel1年前/  4022 /  11

现在已经有了很多,关于如何开发 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": "[email protected]"
        }
    ],
    "require": {}
}

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

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

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

3. 修改扩展包 composer 配置

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

{
    ...,
    "autoload": {
        "psr-4": {
            "Angkee\\Laradmin\\": "src/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "Angkee\\Laradmin\\Tests\\": "tests/"
        }
    },
    ...
}

4. 编写扩展包逻辑代码

接下来,我们来创建 AdminServiceProvider.phpAdmin.php 文件。

<?php

namespace Angkee\Admin;

use Illuminate\Support\ServiceProvider;

class AdminServiceProvider extends ServiceProvider
{
    public function boot()
    {
        //
    }

    public function register()
    {
        $this->app->singleton(‘admin‘, function () {
            return new Admin;
        });
    }
}
<?php

namespace Angkee\Admin;

class Admin
{
    public function printRunning()
    {
        echo ‘running‘;
    }
}

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

扩展包本地测试

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

‘providers‘ => [
    ...,
    Angkee\Admin\AdminServiceProvider::class,
],

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

{
    "require": {
        ...,
        "angkee/laradmin": "dev-master"
    },
    ...,
    "autoload": {
        ...,
        "psr-4": {
            ...,
            "Angkee\\Admin\\": "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 分钟,如果一切正常,会看到版本提示,安装成功!

参考文献

谦虚、自律、胸有成竹、不露城府

本帖由 Summer 于 1年前 加精

原文地址:https://www.cnblogs.com/guiyishanren/p/10984120.html

时间: 2024-10-25 07:11:30

如何开发、本地测试、发布 Laravel 扩展包?的相关文章

如何开发 Laravel 扩展包并发布到 Composer

如何开发 Laravel 扩展包并发布到 Composer 发布于 2019-01-22 cxp1539  1074 Vie 开发扩展包 我们来做一个根据第一个字符或者汉字生成头像的laravel扩展包.其实原理就是我们自己去写一个服务提供者,把服务提供者配置到app/providers数组中. 1.第一步现在自己项目中跟目录创建packages/cxp/avatar/src 2.修改 composer.json "psr-4": { "App\\": "

如何正确使用 Composer 安装 Laravel 扩展包

我们经常要往现有的项目中添加扩展包,有时候因为文档的错误引导,如下图来自 这个文档 的: composer update 这个命令在我们现在的逻辑中,可能会对项目造成巨大伤害. 因为 composer update 的逻辑是按照 composer.json 指定的扩展包版本规则,把所有扩展包更新到最新版本,注意,是 所有扩展包,举个例子,你在项目一开始的时候使用了 monolog,当时的配置信息是 "monolog/monolog": "1.*", 安装的是 mon

laravel扩展包服务提供者的注册的两种方式

一. 包自动发现 在 Laravel 应用的配置文件 config/app.php 中,providers 配置项定义了一个会被 Laravel 加载的服务提供者列表.当安装完新的扩展包后,在老版本中需要将扩展包的服务提供者添加到这个列表以便被 Laravel 使用.从 Laravel 5.5 开始,我们不必再手动添加服务提供者到该列表,而是将提供者定义到扩展包下 composer.json 文件的 extra 选项中,除了服务提供者之外,我们还可以以这种方式注册门面: "extra"

Laravel 扩展包开发

Packages是向Laravel中添加功能最重要的途径.composer.json中require的都是包.关于包的详细说明请查看官网 http://v4.golaravel.com/docs/4.2/packages . 下面一起创建一个简单的Package : 1. 环境配置 我们以Artisan的workbench命令来创建一个Package ,首先要配置 app/confg/workbench.php 1 <?php 2 3 return array( 4 5 'name' => '

laravel 扩展包

1 验证错误中文提示 composer require "overtrue/laravel-lang:~3.0"   在app.php中修改:'locale' => 'zh-CN' 原文地址:https://www.cnblogs.com/muwu/p/9032313.html

Laravel大型项目系列教程(七)之7 扩展包和Artisan开发

本节教程将讲解扩展包开发和Artisan扩展开发,并浏览不同分辨率下的自适应效果.本节结束后整个教程就结束了,文章最后有完整版程序代码的下载. 1.扩展包开发 在前面开发中,我们经常要用到通知,如修改用户信息时视图要写 @if (Session::has('message')) <div class="am-alert am-alert-{{ Session::get('message')['type'] }}" data-am-alert> <p>{{ Ses

10个Laravel4开发人员必用扩展包

Laravel是一个新的基于最新PHP版本语法,支持IoC等设计模式的快速开发框架.目前最新版本为4.2,推荐安装PHP版本5.5+. 本文列举10个基本软件包,都是开发人员使用Laravel框架来构建WEB应用过程中应该要用到的,无需自己重复构建,如认证.调试.网站优化. 代码生成器(Laravel Generators) 使用简单的命令行就可以自动根据代码模板生成Model/View/Controller代码以及模块(Module). IDE帮手(Laravel IDE Helper) 可以

开发发布npm module包

开发发布npm module包 问题 在项目开发过程中,每当进入一个新的业务项目,从零开始搭建一套前端项目结构是一件让人头疼的事情,就要重新复制一个上一个项目的前端框架和组件代码库.其中很多功能的模块组件都要重复拷贝,可以统一将这些组件类的模块统一打包上传至npm,以后每次都只需要install一下就可以了. 前期准备工作 安装nodejs github上新建一个repository用于托管组件代码 新建一个npm账户用于发布包 这里以工具组件库中的时间格式转换工具为例,主要用于对Date时间进

手把手安装Laravel框架(permissions扩展包)实现RBAC权限---以及一些安装时的ERROR

a.依赖管理工具,框架,环境 1.composer 2.laravel(我的是5.5) 3.PHP(我的7.2),MySql(我的5.7) b,安装 1.首先需要安装一个干净的 Laravel 项目,然后在项目根目录下通过 Composer 来安装扩展包依赖: composer create-project laravel/laravel permission --prefer-dist      2.进入安装完时生成的文件夹 cd permission 执行以下命令 composer requ