编写自己的composer项目

composer的出现给php开发带来极大的便利, 配合phpunit的测试工具, 也可以更好的规范php开发. 尽管这些标准不是官方提供的, 但现在大部分的php框架几乎都按照这个规范去开发和管理项目. 这里先介绍一下怎么去编写自己的composer项目

一. 创建github项目

可以参考我的项目地址 https://github.com/yin32167/cpstpl

config 配置文件存放的位置
src 源代码
tests 测试文件位置

.gitignore git忽略文件
LICENSE.md 项目许可证
README.md 项目介绍
composer.json composer配置文件
phpunit.xml phpunit配置文件

1. 关于.gitignore配置

vendor
.composer.lock

执行composer install会生成composer.lock文件, 并将相关的依赖下载到vendor文件夹, 所以这两个文件是需要忽略的

2. 关于LICENSE.md内容

这个看大家项目的具体目的, 对于开源项目来讲, 用MIT协议比较常见

3. 关于README.md内容

主要是介绍项目基础信息及用法, 项目的github页面会将内容显示出来, 以markdown格式

二. 配置 composer

1. 安装composer: mac用户可以使用homebrew, windows用户可以直接下载安装包安装

https://pkg.phpcomposer.com/#how-to-install-composer

注意确保composer命令在环境变量中

2. 配置中国镜像: 由于国外镜像速度太慢, 影响开发效率

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

3. 编辑配置文件

# 添加内容
vi composer.json
############################################
{
    "name": "yin32167/cpstpl",
    "description":  "My template of composer project!",
    "keywords": ["yin32167"],
    "license": "MIT",
    "authors": [
        {
            "name": "Magina Yin",
            "email": "yin32167@aliyun.com",
            "homepage": "https://github.com/yin32167",
            "role": "Developer"
        }
    ],
    "require": {
        "php": ">=7.0.0"
    },
    "require-dev": {
        "phpunit/phpunit": "@stable"
    },
    "autoload": {
        "psr-4": {
            "Yin32167\\CpsTpl\\": "src/"
        }
    }
}
############################################

require: 由于composer是php的包管理工具, 所以需要依赖php环境, 这里我们建议使用php7以上版本, 毕竟各方面都有很大的提升
require-dev: 一般加载测试相关的包
autoload: 指定自动加载的文件夹, 现在一般采用psr-4标准

# 执行加载
composer install

会生成composer.lock及vendor文件夹. 如果修改了composer.json, 但之前已经生成了composer.lock, 此时需要执行composer update, 配置才能生效

三. 添加 phpunit

1. 安装

# Mac用户 
brew install phpunit

Windows 用户具体参见 http://www.phpunit.cn/manual/current/zh_cn/installation.html#installation.phar.windows
一定要确保phpunit在环境变量中

2. 编辑配置文件phpunit.xml

<?xml version="1.0" encoding="UTF-8"?>
<phpunit backupGlobals="false"
     backupStaticAttributes="false"
     bootstrap="vendor/autoload.php"
     colors="true"
     convertErrorsToExceptions="true"
     convertNoticesToExceptions="true"
     convertWarningsToExceptions="true"
     processIsolation="false"
     stopOnFailure="false">
    
    <testsuite>
        <directory suffix="Test.php">./tests</directory>
    </testsuite>

    <filter>
        <whitelist processUncoveredFilesFromWhitelist="true">
            <directory suffix=".php">./src</directory>
        </whitelist>
    </filter>  
</phpunit> 

bootstrap指定启动测试时, 先加载vendor/autoload.php
testsuite指定测试文件的目录
filter过滤依赖文件的位置

3. 执行测试样例

# 如果没有phpunit配置文件
phpunit --bootstrap src/CpsTplExample.php tests/CpsTplExampleTest.php

# 如果存在配置文件, 只需要在当前目录执行
phpunit tests/CpsTplExampleTest.php

四. 上传到 packagist

1. 先注册, 需要关联github

https://packagist.org

2. 创建composer模块名称, 尽量和github一致就好

   

3. 检测提交

如果你没按照它的规范, 会提示失败, 并给出原因, 只需按照修改即可.

附:

如果github中存在多个branch, 则在生成composer模块的时候会打包对应dev-分支名版本号, 如果不希望出现dev, 也就是看起来是正式版本, 需要在github打tag, 此时会以tag的名称作为版本号而不会加上dev