国产探花免费观看_亚洲丰满少妇自慰呻吟_97日韩有码在线_资源在线日韩欧美_一区二区精品毛片,辰东完美世界有声小说,欢乐颂第一季,yy玄幻小说排行榜完本

首頁 > 語言 > PHP > 正文

PHP創建自己的Composer包方法

2024-05-05 00:03:08
字體:
來源:轉載
供稿:網友

倉庫(Repository)

倉庫是軟件開發中常見的概念,與源(sources)意義相近,主要指托管資源的場所。許多軟件都有倉庫的概念,例如yum、npm、maven、Git,以及本文的主角Composer。倉庫以中心化的方式托管資源,為軟件的正常工作提供保障。

Packagist 是Composer默認的中央倉庫,PHP社區的絕大部分Composer包都托管在該網站上。Packagist提供公開的、免費的托管服務,任何人均可注冊、自由發布包,無需審核。Packagist由Private Packagist提供托管和維護,兩者的主要區別為:Packagist的官網是https://packagist.org,托管...,托管的代碼無需開源,倉庫服務器可位于內網,提供更快、更高效的包代碼托管服務。

可以配置多個倉庫,Composer會自動找出最適合項目的依賴包。搜索包的流程如下:首先檢查當前項目是否配置額外倉庫,有則優先在額外倉庫中檢索;無結果向上到全局配置中的額外倉庫檢索;未配置或搜索無結果的情況下,回退到默認的Packagist中央倉庫檢索。除非禁用了默認的倉庫,Packagist中的包總會被檢索到。因為這個原因,Composer推薦PHP開發人員將包托管在Packagist網站上,方便他人檢索和引用。

配置倉庫

有兩種方法對Composer的倉庫進行配置:命令行和編輯配置文件。composer config是Composer配置的命令,可以用來配置項目或全局的倉庫信息,例如:

composer config [-g] repo.packagist composer https://packagist.phpcomposer.com

第二種方法是編輯配置文件。編輯項目的composer.json或~/.config/composer/config.json,增加repositories一項配置,例如:

"repositories": {  "packagist": {    "type": "composer",    "url": "https://packagist.phpcomposer.com"  }}

以上配置使用 Packagist中國全量鏡像 網站作為默認中央倉庫。在大陸地區部署PHP項目,建議使用該倉庫目錄,能加速依賴包的下載。

倉庫配置最重要的兩個參數是type和url。type指明倉庫的類型,url則指向具體網址。根據倉庫的位置,常用的type可選值有:

  1. composer,Composer包托管倉庫,例如 Packagist中國全量鏡像;
  2. vcs,版本控制管理系統,例如Github上的項目地址;
  3. pear,PEAR上的包;
  4. package,位于互聯網上包;
  5. artifact,代碼zip包合集;
  6. path,指向代碼具體位置。

互聯網上的倉庫,type的常見值是composer和vcs;本地的項目,常見值是artifact和path。具體用例,可參考Composer官方文檔。

掌握了倉庫的概念和其配置,接下來我們創建自己的包。

創建自己的Composer包

創建一個Composer包只需兩步:1. 填寫包描述信息;2. 寫代碼。本文創建一個hello-composer的包來演示創建過程。該包功能只有一個:輸出字符串“Hello, Composer!”。

Composer包的描述信息存放在composer.json文件中,可直接新建(或從其他項目拷貝)composer.json文件,手動填充必要的字段信息;也可以用composer init命令,交互式的輸入包信息,生成composer.json文件后再補全其他字段信息。我們采取直接編輯文件的方式,在composer.json中輸入如下內容:

{  "name": "tlanyan/hello-composer",  "description": "Hello, Composer!",  "type": "library",  "require": {    "php": ">=7.0"  },  "license": "MIT",  "authors": [    {      "name": "tlanyan",      "email": "tlanyan@hotmail.com"    }  ],  "minimum-stability": "stable",  "autoload": {    "psr-4": {      "tlanyan//": "src/"    }  }}

以上內容基本上是一個Composer包的必備字段。其他字段可參考Composer官網的composer.json說明。需注意標記為root-only的字段,root-only表示當前包為主項目時才生效。例如require-dev字段,在當前項目中開發,字段內的包會下載放到vendor文件夾內;如果該項目被其他項目引用,則該字段的值被忽略,引用的包不會被下載。

接下來編寫代碼。在src目錄下新建HelloComposer.php:

namespace tlanyan;class HelloComposer{  public static function greet()  {    echo "Hello, Composer!", PHP_EOL;  }}

代碼風格建議參考PSR-2規范,文件命名和路徑規范建議參考PSR-4規范。另外需注意文件的路徑需與composer.json中autoload的值相匹配。

通過簡單兩步,我們創建的自己的Composer包。接下來在其他項目中引用該包。

引用Composer包

新建一個test項目,引用上文創建的包并查看效果,步驟如下:

1.新建test文件夾,拷貝或者新建composer.json文件,配置如下:

  {    ....    "require": {      "tlanyan/hello-composer": "*"    },    "minimum-stability": "dev",    "repositories": {      "local": {        "type": "path",        "url": "/path/to/hello-composer"      }    },    ....  }

配置文件需要注意兩點: 1. 如果hello-composer的composer.json文件沒有version字段(或不是穩定版),minimum-stability值要是dev(默認是stable),否則無法安裝; 2. 需添加自定義倉庫,type值為path。

2.執行composer install -vvv安裝依賴包,安裝完成后vendor目錄下生成tlanyan/hello-composer目錄。

3.在test中新建Test.php文件,引用HelloComposer類:

  namespace test;    require "vendor/autoload.php";    use tlanyan/HelloComposer;    class Test  {    public static main()    {      HelloComposer::greet();    }  }    Test::main();

.執行Test.php:php Test.php,輸出"Hello, Composer!"。

通過配置Composer倉庫,我們成功引用了創建的hello-composer包。測試沒問題后,就可以發布到網上供其他人使用。下面簡要說是發布流程。

發布Composer包

將Composer包發布到互聯網的方式有幾種:

  1. 打包成zip,上傳到任意一個可公開訪問的網站;
  2. 通過版本控制軟件,上傳到代碼倉庫;
  3. 提交到PEAR社區;
  4. 提交到私有的Composer倉庫;
  5. 提交到Packagist。

前四種方式,需要用戶配置倉庫信息才能檢索到包(PEAR社區幾乎已死,可以忽略)。如果代碼開源,建議提交到Packagist,方便全世界的PHP開發者檢索和使用,為Composer生態做貢獻。

提交包到Packagist,要經歷以下過程:

  1. 在Github創建項目并提交代碼;
  2. 在Packagist輸入項目地址提交包;
  3. 在Github配置項目,觸發Packagist自動更新。

前兩步是必須的,第三步可選。本著為提交的包負責的態度,強烈建議完成第三步操作。

提交包的過程涉及到Github和Packagist兩個站點,Github和Packagist之間的關系為:Github托管實際的代碼和文件;Packagist托管包的作者、包名、版本號、下載量等元數據保。簡要說Packagist是索引,Github是內容提供方。

詳細步驟可參考官網指引或網上教程,網上相關內容太多,本文不再重復。

總結

本文介紹了Composer倉庫的概念,創建了一個完整的Composer包,并給出提交包到Packagist的指引。用戶掌握相關概念和運行機制后,可提交代碼為社區做貢獻,也可跳出Packagist自由的引用和安裝依賴包。



注:相關教程知識閱讀請移步到PHP教程頻道。
發表評論 共有條評論
用戶名: 密碼:
驗證碼: 匿名發表

圖片精選

主站蜘蛛池模板: 乌兰察布市| 吴旗县| 洛隆县| 集安市| 左权县| 江西省| 赤峰市| 松滋市| 大化| 宁都县| 白山市| 汾西县| 桦甸市| 金乡县| 临武县| 衡南县| 金堂县| 肥西县| 永寿县| 衡山县| 宁蒗| 保康县| 香港| 革吉县| 德州市| 绥阳县| 杭锦后旗| 临洮县| 米泉市| 丁青县| 长沙市| 阳春市| 汉寿县| 杭锦后旗| 高密市| 彭泽县| 峨眉山市| 龙陵县| 清远市| 白山市| 灵璧县|