资讯专栏INFORMATION COLUMN

Composer & Laravel 包本地开发

levius / 1369人阅读

摘要:本文参考超哥写的基于的模块化开发的详细实践版。包本地开发本地开发一个包做法基本与包开发一样,简单过一下吧。首先创建一个新的项目在项目中创建如下目录为我们要发布的包,对应为,对应为项目名。

本文参考超哥写的 基于 Composer 的 PHP 模块化开发 的详细实践版。

开发痛点

我相信很多人,对 composer 不了解,在开发包的时候会这样做:

创建项目(jcc/new-package) -> 写业务逻辑 -> push 到代码仓库 -> 创建调试项目 -> 安装包(composer require jcc/new-package -vvv) -> 调试 -> 修改项目 -> push 更新代码 -> 在调试项目中更新包代码 (composer update -vvv) -> ...

由此可见,不断重复的提交代码,更新代码,非常的麻烦,而且不能实时调试。

本文主要解决的问题:
本地开发包时,可本地测试,不需将代码提交到第三方代码仓库,再 composer require 安装到项目中测试:

创建项目(jcc/new-package) -> 写业务逻辑 -> 创建调试项目 -> 配置 composer.json -> 调试 -> 修改项目 -> 直接在调试项目调试 -> ...

由此可见,本地开发可减少 git 提交拉取代码的时间,降低了提交的每一个版本尽可能出现的低级错误。

本地包开发的工作原理:
Composer 将本地开发的包通过软连接的方式,从新项目( jcc/taxi )软连接到调试项目( jcc/test-taxi/vendor/jcc/texi )

主要用到了 repositories 的 path 类型,更新信息请移步 文档

Composer 包本地开发

首先我们看一下 Composer 安装包的结构,正常使用的情况下,拿一个安装好 laravel/laravel)为例子,打开 vendor 目录下的 laravel 会看到以下的结构:

vendor/laravel
├── framework
│   └── src
│       └── Illuminate
│           └── ...
└── tinker
    └── src
        └── Console

同时看一下 Laravel 项目下的 composer.json 文件的 require 或 require-dev 的依赖包:

{
      ...,
    "require": {
        "php": ">=7.0.0",
        "fideloper/proxy": "~3.3",
        "laravel/framework": "5.5.*",
        "laravel/tinker": "~1.0"
    },
      ...
}

由此可以知道目录结构是对应关系的。

创建目录并初始化

当然在初始化创建目录的时候,要注意项目名跟目录结构一致,例如我的新项目叫 jcc/taxi 那么我创建的目录结构应该这样子:

jcc
└── taxi

接着我们需要在 taxi 下进来进一步的开发,当然,在开发前需要先初始化 composer 配置,在 taxi 目录下运行:

composer init

按照指示填写信息即可:

在 texi 目录下会多出 composer.json 文件:

{
    "name": "jcc/taxi",
    "description": "This is a test.",
    "type": "library",
    "license": "MIT",
    "authors": [
        {
            "name": "jcc",
            "email": "changejian@gmail.com"
        }
    ],
    "minimum-stability": "dev",
    "require": {}
}
创建开发目录并设置必要信息

一般情况下,我们会创建 2 个目录,一个是 src 用于存放包所有的逻辑代码,一个是 tests 用于存放测试用例:

jcc/taxi
├── src
├── tests
├── README.md
├── composer.json
└── LICENSE

要注意的是,我们需要再 composer.json 设置一下 composer 自动加载配置,在 composer.json 加入:

{
      ...,
    "autoload": {
        "psr-4": {
            "JccTaxi": "src/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "JccTaxiTests": "tests/"
        }
    },
      ...
}

更多可以看一下 Composer 自动加载文档

创建测试包项目

首先,在 jcc 目录下创建一个新的项目,用于测试:

jcc
├── taxi
└── test-taxi

接着初始化 composer 配置,生成 composer.json 文件:

composer init

然后添加 Repositories 项目,有两种方式:

第一种:直接运行命令

composer config repositories.jcc path /Users/jiajianchan/Sites/jcc/taxi

第二种:直接在 composer.json 文件添加:

{
      ...,
    "repositories": {
        "jcc": {
            "type": "path",
            "url": "/Users/jiajianchan/Sites/jcc/taxi"
        }
    }
}

type 类型为 path,url 为项目的相对路径.

接下来就是添加依赖,同样有两种方式:
Shell:

composer require jcc/taxi:dev-master -vvv

composer.json 中添加:

{
    ...,
    "require": {
     "jcc/taxi": "dev-master"
    },
    ...
}

当然要注意版本号,必须在 jcc/taxi 项目中的 composer.json 中设置 minimum-stability 属性,不然在安装包的时候会报找不到版本号的错。

开发以及测试

首先在 jcc/taxi 项目下的 src 中创建 Client.php 文件:

a = $a;
        $this->b = $b;
    }

    public function addTogether()
    {
        return $this->a + $this->b;
    }
}

在 jcc/test-taxi 目录下安装一下 jcc/taxi 项目后,添加 test.php 文件:

// 引入 composer 自动加载文件
require __DIR__ . "/vendor/autoload.php"

$client = new JccTaxiClient(5, 1);

echo $client->addTogether() . "
";

最后,在 jcc/test-taxi 目录下运行 test.php 文件,即可得出相加的结果:

php test.php

如果你细心点,会发现,jcc/test-taxi 的 vendor 目录下的 jcc/taxi 依赖项目是一个 软连接。也就是说,你在 jcc/taxi 中的 Client.php 文件添加一个新方法,然后在 jcc/test-taxi 项目中调用即可,不需要重新 composer update 包哦。非常方便。

Laravel 包本地开发

本地开发一个 Laravel 包做法基本与 Composer 包开发一样,简单过一下吧。

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

composer create-project laravel/laravel laravel -vvv

在 Laravel 项目中创建如下目录:

laravel
├── app
├── ...
└── packages
    └── jcc
        └── taxi
            ├── LICENSE
            ├── README.md
            ├── composer.json
            ├── src
            │   ├── Taxi.php
            │   └── TaxiServiceProvider.php
            └── tests

jcc/taxi (vendor/name) 为我们要发布的 Laravel 包,jcc 对应为 github usernametaxi 对应为 项目名

首先初始化 composer 配置,这个跟正常包开发没区别,然后在 jcc/taxi 下的 src 目录创建 TaxiServiceProvider.php 文件:

app->singleton("taxi", function () {
            return new Taxi;
        });
    }
}

创建 Taxi.php 文件:


最后就是想包注册到 laravel 项目中,在 config/app.php 添加:

return [
    ...,
    "providers" => [
        ...,
        JccTaxiTaxiServiceProvider::Class,
    ],
];

修改 laravel 项目下的 composer.json 文件:

{
    ...,
    "autoload": {
        ...,
        "psr-4": {
            ...,
            "JccTaxi": "packages/jcc/taxi/src/"
        }
    },
    ...
}

并运行命令:

composer dump-autoload

最后在 web.php 中修改一下:

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

此时,我们访问 laravel 项目的主页时,会显示 running 这个单词,则恭喜你,成功了。

开发一个包说难不难,说易也不易,最重要的是你需要有源源不断的创造力!

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

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

相关文章

  • 简化你的关注与点赞 - Laravel Follow & Vote

    摘要:废话不多说,下面我简单介绍一下两个包的用法吧。还有的是这里使用了,如何去理解以及更好地使用最后,当然是要感谢超哥。经讨论更名为更名为更名为更名为 showImg(https://pigjian.com/storage/post_img/2017-04-12/follow-vote.png); 本文主要介绍两个包: Laravel - Follow : https://github.co...

    CodeSheep 评论0 收藏0
  • 如何开发本地测试、发布 Laravel 扩展

    摘要:现在已经有了很多,关于如何开发扩展包的文章。提交代码到首先,需要把扩展包的代码提交到上,记录下版本库的地址,注意是。填写完毕,提交后,记得测试一次,完成首次同步,成功会提示信息。 现在已经有了很多,关于如何开发 Laravel 扩展包的文章。但是大多文章写的太过片面,不够完整,而且我在实际进行开发扩展包的时候,还是遇到了很多的问题,我把自己的开发经验,以及遇到的问题记录下来,分享给大家...

    nanchen2251 评论0 收藏0
  • 基于ComposerLaravel扩展开发工作流

    使用场景 在引用第三方包的时候,对第三方包有改动需求,需要将代码放在自己的仓库;并且自己的其他项目也有需求引用自定义的第三方包;甚至自己会发布修改后的第三方包; 读完本文你讲获得: Git Submodule的基本使用 从本地加载第三方包 从自定义仓库地址获取扩展包 快速创建第三方包 本文是在我自己想要创建一个基础第三方包的时候记录下的操作步骤 1、利用git submoudle在已有项目中使...

    Faremax 评论0 收藏0
  • laravel-0.0.1】简单开始laravel5.1

    摘要:我是直接从开始学习的,所以之前版本并未考虑。我在上用的是和一个本地,并未做很多环境配置,只是简单开始。如果更有兴趣的,可以使用官方推荐使用的本地开发环境,不污染本地系统,放上安装教程地址网上有很棒很简单地环境搭建工具如 我是直接从laravel5.1开始学习的,所以之前版本并未考虑。 我在mac上用的是composer、phpstorm 和一个本地mysql,并未做很多环境配置,只是...

    chinafgj 评论0 收藏0
  • laravel开发扩展记录

    摘要:自动代码扩展开发时遵守的代码风格是项目开发规范。遵照此规范,在实际操作中,有许多重复,接下来推荐一款专为此规范量身定制的代码生成器。可以利用此扩展来快速构建项目原型。后续还会为大家带来一些最新的技术扩展。 whoops 错误提示扩展 whoops 是一个非常优秀的 PHP Debug 扩展,它能够使你在开发中快速定位出错的位置。laravel默认安装。showImg(https://s...

    fancyLuo 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<