怎么创建第一个composer package

# 怎么创建第一个Composer Package

## 前言

Composer是PHP生态中最流行的依赖管理工具，它允许开发者轻松地共享和复用代码。创建自己的Composer包是参与PHP开源社区的重要一步。本文将详细介绍如何从零开始创建并发布你的第一个Composer包。

## 准备工作

在开始之前，请确保你的开发环境满足以下要求：

1. 已安装PHP（建议7.4+版本）
2. 已安装Composer（最新版）
3. 拥有GitHub账号（或其他Git托管平台账号）
4. 注册Packagist账号（Composer官方仓库）

## 第一步：初始化项目

```bash
mkdir my-first-package
cd my-first-package
composer init

执行composer init命令后，会进入交互式配置向导：

• Package name: 遵循vendor/package-name格式（如yourname/string-helper）
• Description: 简短的包描述
• Author: 你的姓名和邮箱
• Minimum Stability: 通常选择dev或stable
• Package Type: 默认为library
• License: 选择开源协议（如MIT）

完成后会生成composer.json文件：

{
    "name": "yourname/string-helper",
    "description": "A simple string helper library",
    "type": "library",
    "license": "MIT",
    "authors": [
        {
            "name": "Your Name",
            "email": "your@email.com"
        }
    ],
    "require": {}
}

第二步：编写代码

创建src目录存放源代码：

mkdir src

示例：创建一个字符串处理类src/StringHelper.php：

<?php

namespace YourName\StringHelper;

class StringHelper
{
    public static function camelCase(string $str): string
    {
        return lcfirst(str_replace(' ', '', ucwords(str_replace(['-', '_'], ' ', $str))));
    }
    
    public static function snakeCase(string $str): string
    {
        return strtolower(preg_replace('/(?<!^)[A-Z]/', '_$0', $str));
    }
}

第三步：配置自动加载

修改composer.json添加PSR-4自动加载配置：

{
    "autoload": {
        "psr-4": {
            "YourName\\StringHelper\\": "src/"
        }
    }
}

执行命令生成自动加载文件：

composer dump-autoload

第四步：本地测试

创建test.php进行测试：

<?php

require __DIR__ . '/vendor/autoload.php';

use YourName\StringHelper\StringHelper;

echo StringHelper::camelCase('hello_world'); // 输出 helloWorld

第五步：版本控制

初始化Git仓库并提交代码：

git init
echo '/vendor/' > .gitignore
git add .
git commit -m "Initial commit"

第六步：发布到GitHub

1. 在GitHub创建新仓库
2. 添加远程仓库并推送代码：

git remote add origin git@github.com:yourname/string-helper.git
git push -u origin main

第七步：发布到Packagist

1. 登录Packagist
2. 点击”Submit”提交你的GitHub仓库URL
3. 启用GitHub服务的自动更新（推荐）

高级配置（可选）

添加单元测试

composer require phpunit/phpunit --dev
mkdir tests

示例测试文件tests/StringHelperTest.php：

use PHPUnit\Framework\TestCase;
use YourName\StringHelper\StringHelper;

class StringHelperTest extends TestCase
{
    public function testCamelCase()
    {
        $this->assertEquals('helloWorld', StringHelper::camelCase('hello_world'));
    }
}

添加持续集成

创建.github/workflows/ci.yml：

name: CI

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: shivammathur/setup-php@v2
        with:
          php-version: '8.0'
      - run: composer install
      - run: ./vendor/bin/phpunit

版本管理

使用语义化版本控制（SemVer）：

git tag -a v1.0.0 -m "First stable release"
git push --tags

总结

创建Composer包的主要步骤： 1. 初始化项目结构 2. 编写功能代码 3. 配置自动加载 4. 设置版本控制 5. 发布到代码仓库 6. 提交到Packagist

通过创建自己的Composer包，你不仅可以提高代码复用性，还能为PHP社区做出贡献。现在就开始创建你的第一个包吧！ “`