如何开发、本地测试、发布 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": "angkee@qq.com"
}
],
"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年前 加精

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

  1. 基于Composer的Laravel扩展包开发工作流 ,实现laravle项目的文件管理(记录成长)

    PHP Composer包开发 基于Composer的Laravel扩展包开发工作流 实现laravle项目的文件管理,添加文件/文件夹,删除文件,查看代码/文件(代码支持缩进,支持语法高亮) com ...

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

    如何开发 Laravel 扩展包并发布到 Composer  发布于 2019-01-22 cxp1539  1074 Vie   开发扩展包 我们来做一个根据第一个字符或者汉字生成头像的larave ...

  3. 【转】下载量最高的 100 个 Laravel 扩展包推荐

    说明 Laravel 另一个令人喜欢的地方,是拥有活跃的开发者社区,而活跃的开发者社区带来的,是繁华的扩展包生态. 本文对 Packagist 上打了 Laravel 标签 的扩展包进行整理,截止到现 ...

  4. 使用 Composer 安装Laravel扩展包的几种方法

    使用 Composer 安装Laravel扩展包的几种方法 以下的三种方法都是需要你在项目的根目录运行 第一种:composer install 如有 composer.lock 文件,直接安装,否则 ...

  5. 基于Composer的Laravel扩展包开发工作流

    使用场景 在引用第三方包的时候,对第三方包有改动需求,需要将代码放在自己的仓库:并且自己的其他项目也有需求引用自定义的第三方包:甚至自己会发布修改后的第三方包: 读完本文你讲获得: Git Submo ...

  6. laravel扩展包开发步骤总结

    1. 创建包 php artisan workbench vendor/package --resources     注:  vendor:开发商名   package:包名   2.修改下包里co ...

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

    我们经常要往现有的项目中添加扩展包,有时候因为文档的错误引导,如下图来自 这个文档 的: composer update 这个命令在我们现在的逻辑中,可能会对项目造成巨大伤害. 因为 composer ...

  8. laravel 安装 Laravel 扩展包

    问题说明 我们经常要往现有的项目中添加扩展包,有时候因为文档的错误引导,如下图来自这个文档 的: composer update 这个命令在我们现在的逻辑中,可能会对项目造成巨大伤害. 因为 comp ...

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

    一. 包自动发现 在 Laravel 应用的配置文件 config/app.php 中,providers 配置项定义了一个会被 Laravel 加载的服务提供者列表.当安装完新的扩展包后,在老版本中 ...

随机推荐

  1. 【前端】CentOS 7 系列教程之三: 搭建 git 服务器

    转载请注明出处:http://www.cnblogs.com/shamoyuu/p/linux_3.html 上一篇我们安装好了git,这一篇我们搭建git服务器 创建一个用户组 groupadd g ...

  2. Android 业务组件化开发实践

    组件化并不是新话题,其实很早很早以前我们开始为项目解耦的时候就讨论过的.但那时候我们说的是功能组件化.比如很多公司都常见的,网络请求模块.登录注册模块单独拿出来,交给一个团队开发,而在用的时候只需要接 ...

  3. lua ffi简介

    本文转自网络 由来 FFI库,是LuaJIT中最重要的一个扩展库.它允许从纯Lua代码调用外部C函数,使用C数据结构.有了它,就不用再像Lua标准math库一样,编写Lua扩展库.把开发者从开发Lua ...

  4. Ruby Proc 和 lambda的共同点和区别

    Proc 和 lambda 的目的是把block {....} 变成类似方法一样的对象,使其不需要重复编写同样的block. Proc 和 lambda 的共同点: 语法类似Proc.new{|n| ...

  5. Cocos2d-x 3.2 创建新应用

    1.cd 到 Cocos2d-x 3.2 的目录: 2.python setup.py: 3.source /Users/netty/.bash_profile ; 4.cocos new TestP ...

  6. java形式参数分别是基本类型和引用类型的调用

    什么是形式参数,基本类型,引用类型? 形式参数(形参)百度百科里的解释是:在定义函数名和函数体的时候使用的参数,目的是用来接收调用该函数时传入的参数. 通俗的说就是:形式参数是指在函数名后面的小括号里 ...

  7. linux中目录操作<1>

    一.目录的权限 (1)目录文件的访问权限分为三组,分别为所有者,用户,其他.每个权限组的权限位有3个,分别为读.写.执行. 注意:可以使用stat函数得到目录文件的状态信息.权限为在stat结构中st ...

  8. Node.js之网游服务器实践

    此文已由作者尧飘海授权网易云社区发布. 欢迎访问网易云社区,了解更多网易技术产品运营经验. 随着Node.js的不断发展与壮大,应用范围也越来越广泛,从传统的企业应用,到互联网使用,再到云计算的发展, ...

  9. bzoj 4504: K个串【大根堆+主席树】

    像超级钢琴一样把五元组放进大根堆,每次取一个出来拆开,(d,l,r,p,v)表示右端点为d,左端点区间为(l,r),最大区间和值为v左端点在p上 关于怎么快速求区间和,用可持久化线段树维护(主席树?) ...

  10. 查看软件安装的位置 Ubuntu

    Ubuntu和windows不一样,不是所有的软件都在一个文件夹,而是不同类型的分散在不同的文件夹下 所以查找起来也是不同的 如果知道是用 apt-get install 方法安装的,可以直接用 dp ...