PHP Composer — จัดการแพ็กเกจ



Composer ทำ 2 อย่างหลัก: (1) ดาวน์โหลดไลบรารีที่โปรเจกต์ต้องใช้ (2) สร้าง autoloader ให้ทั้งโค้ดเราและโค้ดไลบรารี — ตัวที่สองสำคัญไม่แพ้ตัวแรก

ติดตั้ง Composer

macOS / Linux:

curl -sS https://getcomposer.org/installer | php
sudo mv composer.phar /usr/local/bin/composer

Windows: ดาวน์โหลด Composer-Setup.exe จาก getcomposer.org

เช็ค:

composer --version
Composer version 2.8.3 2024-11-17 15:22:29

เริ่มโปรเจกต์ใหม่

mkdir my-app && cd my-app
composer init

มันจะถามชื่อแพ็กเกจ (vendor/name เช่น pepder/my-app), คำอธิบาย, ผู้เขียน, ฯลฯ ตอบไปหรือกด Enter ผ่านได้ ผลลัพธ์คือไฟล์ composer.json:

{
    "name": "pepder/my-app",
    "require": {
        "php": ">=8.3"
    },
    "autoload": {
        "psr-4": {
            "App\\": "src/"
        }
    }
}

ติดตั้งไลบรารี

หาแพ็กเกจได้ที่ packagist.org ตัวอย่างติดตั้ง library สร้าง UUID:

composer require ramsey/uuid
./composer.json has been updated
Running composer update ramsey/uuid
...
  - Installing ramsey/uuid (4.7.6)
Generating autoload files

เกิดอะไรขึ้น:

  • เพิ่ม "ramsey/uuid": "^4.7" ใน composer.json ส่วน require
  • ดาวน์โหลดโค้ดลง vendor/ramsey/uuid/
  • อัปเดต composer.lock (บันทึกเวอร์ชันเป๊ะ ๆ ที่ติดตั้งจริง)
  • สร้าง/อัปเดต vendor/autoload.php

แพ็กเกจสำหรับ dev เท่านั้น (เครื่องมือทดสอบ, linter) ใช้ --dev:

composer require --dev phpunit/phpunit

ใช้งาน: require vendor/autoload.php

<?php
// index.php
declare(strict_types=1);

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

use Ramsey\Uuid\Uuid;

$id = Uuid::uuid4();
echo $id->toString(), "\n";      // 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d

vendor/autoload.php บรรทัดเดียว = โหลดได้ทั้งไลบรารีทุกตัว และโค้ดของเราใน src/ (ตาม PSR-4 ที่ตั้งไว้)

autoload โค้ดของเราเอง

ใน composer.json:

{
    "autoload": {
        "psr-4": {
            "App\\": "src/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "Tests\\": "tests/"
        }
    }
}

หลังแก้ autoload ต้องสั่ง:

composer dump-autoload

จากนั้นสร้าง src/Greeter.php:

<?php
namespace App;

class Greeter
{
    public function greet(string $name): string
    {
        return "สวัสดี $name";
    }
}

ใช้ได้ทันทีโดยไม่ต้อง require:

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

$g = new App\Greeter();
echo $g->greet('PHP'), "\n";

composer.json เทียบ composer.lock

composer.jsoncomposer.lock
เขียนโดยเรา (หรือ composer require)Composer อัตโนมัติ
เก็บอะไรช่วงเวอร์ชันที่ยอมรับ (^4.7)เวอร์ชันเป๊ะที่ติดตั้ง (4.7.6) + hash
commit ลง git ไหมใช่ใช่ (สำคัญมาก)
  • composer install — ติดตั้งตาม composer.lock เป๊ะ ๆ (ใช้บนเซิร์ฟเวอร์ / CI / เพื่อนร่วมทีม)
  • composer update — อัปเกรดตามช่วงใน composer.json แล้วเขียน .lock ใหม่ (ทำเมื่อตั้งใจอัปเดต)

commit composer.lock ทำให้ทุกเครื่องได้เวอร์ชันเดียวกันเป๊ะ — “works on my machine” น้อยลงมาก

semantic versioning constraint

เขียนหมายถึง
^4.7>=4.7.0 <5.0.0 — รับ minor/patch ใหม่ (นิยมสุด)
~4.7>=4.7.0 <4.8.0 — รับแค่ patch
4.7.*patch ใด ๆ ของ 4.7
>=4.7 <6ระบุช่วงเอง

composer scripts

รวมคำสั่งที่ทีมใช้บ่อยไว้ที่เดียว ใน composer.json:

{
    "scripts": {
        "test": "phpunit",
        "lint": "php-cs-fixer fix --dry-run --diff",
        "analyse": "phpstan analyse src --level=6",
        "check": [
            "@lint",
            "@analyse",
            "@test"
        ]
    }
}
composer test
composer check      # รันทั้ง lint + analyse + test

คำสั่งที่ใช้บ่อย

composer require vendor/pkg          # เพิ่มแพ็กเกจ
composer remove vendor/pkg           # ลบ
composer install                     # ติดตั้งตาม .lock
composer update                      # อัปเดตทั้งหมดตาม .json
composer update vendor/pkg           # อัปเดตเฉพาะตัวเดียว
composer dump-autoload -o            # สร้าง autoload ใหม่ (-o = optimized สำหรับ prod)
composer show                        # ดูแพ็กเกจที่ติดตั้ง
composer outdated                    # ดูตัวที่มีเวอร์ชันใหม่กว่า
composer why vendor/pkg              # ใครเป็นคนต้องการแพ็กเกจนี้

.gitignore

/vendor/

commit composer.json และ composer.lock แต่ ไม่ commit vendor/ — คนอื่น composer install เอาเอง

เรื่องที่คนมักพลาด

  • ไม่ commit composer.lock — เพื่อนร่วมทีม/เซิร์ฟเวอร์ได้เวอร์ชันไลบรารีคนละตัว บั๊กแปลก ๆ ตามมา
  • commit โฟลเดอร์ vendor/ — repo บวมเป็นสิบ MB โดยไม่จำเป็น
  • รัน composer update บน production — อัปทุกอย่างตามช่วง เสี่ยงพัง ใช้ composer install เสมอบนเซิร์ฟเวอร์
  • แก้ composer.json autoload แล้วไม่ dump-autoload — คลาสใหม่หาไม่เจอ
  • แก้ไฟล์ในโฟลเดอร์ vendor/ โดยตรง — หายเมื่อ composer install ครั้งถัดไป ถ้าต้องแก้ให้ fork หรือใช้ mechanism อื่น
  • require แพ็กเกจ dev-tool โดยไม่ใส่ --dev — มันจะถูกติดตั้งบน production ด้วย เปลืองและเพิ่มพื้นที่โจมตี

สรุป

  • composer init สร้าง composer.json, composer require vendor/pkg เพิ่มไลบรารี (--dev สำหรับเครื่องมือ)
  • require __DIR__.'/vendor/autoload.php' บรรทัดเดียวโหลดทั้งไลบรารีและโค้ดเราใน src/
  • ตั้ง "autoload": {"psr-4": {"App\\": "src/"}} แล้ว composer dump-autoload
  • commit composer.json + composer.lock, ignore vendor/
  • composer install (ตาม lock, สำหรับ deploy) ≠ composer update (อัปเกรด, ทำเมื่อตั้งใจ)
  • composer scripts รวมคำสั่ง test/lint/analyse

บทถัดไปว่าด้วย PHPUnit — เขียนเทสต์อัตโนมัติเพื่อให้มั่นใจว่าโค้ดยังทำงานถูกหลังแก้