Composer+Git如何创建服务类库

发布时间：2023-03-16 14:54:02 作者：iii
来源：亿速云阅读：380

# Composer+Git如何创建服务类库

## 前言

在现代PHP开发中，Composer已成为依赖管理的标准工具，而Git是最流行的版本控制系统。将两者结合创建可复用的服务类库，能够显著提升代码复用率和团队协作效率。本文将详细介绍从零开始创建、发布到维护一个Composer类库的全过程。

## 一、环境准备

### 1.1 安装必要工具
```bash
# 安装Git
sudo apt-get install git

# 安装Composer
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php composer-setup.php
php -r "unlink('composer-setup.php');"
sudo mv composer.phar /usr/local/bin/composer

1.2 配置Git全局信息

git config --global user.name "Your Name"
git config --global user.email "your@email.com"

二、创建类库项目

2.1 初始化项目结构

mkdir my-service-library
cd my-service-library

2.2 初始化Composer配置

composer init

按提示填写包信息： - Package name: vendor/package-name - Description: 描述你的服务类库 - Author: Your Name your@email.com - Minimum Stability: stable - Package Type: library - License: MIT

2.3 创建基础目录结构

mkdir src
mkdir tests
touch README.md

三、开发服务类库

3.1 编写核心服务类

在src/目录下创建核心服务类：

<?php
// src/MyService.php
namespace Vendor\PackageName;

class MyService
{
    public function doSomething()
    {
        return "Service is working!";
    }
}

3.2 配置PSR-4自动加载

修改composer.json：

{
    "autoload": {
        "psr-4": {
            "Vendor\\PackageName\\": "src/"
        }
    }
}

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

composer dump-autoload

四、版本控制与Git管理

4.1 初始化Git仓库

git init

4.2 创建.gitignore文件

touch .gitignore

内容应包含：

/vendor/
composer.lock
.idea/

4.3 提交初始代码

git add .
git commit -m "Initial commit"

五、发布到代码托管平台

5.1 创建远程仓库

在GitHub/GitLab等平台创建新仓库，获取远程地址。

5.2 添加远程仓库

git remote add origin https://github.com/yourname/repository.git

5.3 推送代码

git push -u origin master

六、发布到Packagist

6.1 创建Packagist账号

访问https://packagist.org注册账号

6.2 提交包到Packagist

在Packagist点击”Submit”
输入你的Git仓库URL
点击”Check”然后”Submit”

6.3 配置自动更新

在Packagist包页面设置GitHub服务钩子，实现代码更新后自动同步。

七、版本管理与标签

7.1 语义化版本控制

遵循MAJOR.MINOR.PATCH原则： - MAJOR: 不兼容的API修改 - MINOR: 向后兼容的功能新增 - PATCH: 向后兼容的问题修正

7.2 创建版本标签

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

八、依赖管理与持续集成

8.1 添加开发依赖

composer require --dev phpunit/phpunit

8.2 配置CI/CD

创建.travis.yml示例：

language: php
php:
  - '7.4'
  - '8.0'

install:
  - composer install

script:
  - vendor/bin/phpunit

九、类库使用与文档

9.1 安装类库

用户可以通过Composer安装：

composer require vendor/package-name

9.2 编写使用文档

完善README.md：

# My Service Library

## 安装
```bash
composer require vendor/package-name
```

## 使用示例
```php
use Vendor\PackageName\MyService;

$service = new MyService();
echo $service->doSomething();
```

十、维护与更新策略

10.1 分支策略

master: 稳定版本
develop: 开发分支
feature/*: 功能分支

10.2 更新流程

从develop创建feature分支
开发完成后合并到develop
测试通过后合并到master
打标签发布新版本

十一、高级技巧

11.1 多版本支持

通过分支维护不同大版本： - 1.x - 2.x

11.2 类库拆分

当功能复杂时，可拆分为多个子包：

my-library/
  ├── core/
  ├── auth/
  └── payment/

十二、常见问题解决

12.1 依赖冲突

使用composer why命令分析依赖关系：

composer why vendor/conflicting-package

12.2 版本回退

git tag # 查看可用版本
git checkout v1.0.0

结语

通过Composer和Git的结合，我们可以高效地创建、发布和维护PHP服务类库。这不仅促进了代码复用，也为团队协作提供了标准化的工作流程。随着类库的不断迭代，建议持续关注PSR标准更新和社区最佳实践，保持类库的现代化和可维护性。

附录

参考资源

”`