โครงสร้างไฟล์ composer.json เบื้องต้น

หลังจากที่เราติดตั้ง Composer เรียบร้อยแล้ว สิ่งที่สำคัญต่อไปคือการทำความเข้าใจไฟล์ composer.json ซึ่งเป็นไฟล์ที่ใช้กำหนดรายละเอียดต่างๆ ของโปรเจกต์ PHP ของเรา รวมถึง Dependencies ที่โปรเจกต์เราต้องการ ไฟล์นี้เปรียบเสมือนหัวใจหลักของการจัดการ Dependencies ด้วย Composer เลยทีเดียว

ในบทนี้ เราจะมาเรียนรู้โครงสร้างพื้นฐานของไฟล์ composer.json และทำความเข้าใจองค์ประกอบสำคัญต่างๆ ที่เราจำเป็นต้องรู้กันครับ

`composer.json` คืออะไร?

composer.json คือไฟล์ JSON ที่เก็บข้อมูลเกี่ยวกับโปรเจกต์ PHP ของเรา ไม่ว่าจะเป็น ชื่อโปรเจกต์, คำอธิบาย, Dependencies ที่โปรเจกต์ใช้, และการตั้งค่า Autoloading ต่างๆ เมื่อเราสั่ง Composer ทำงาน Composer จะอ่านข้อมูลจากไฟล์นี้เพื่อจัดการ Dependencies และ Autoloading ให้เราโดยอัตโนมัติ

ตัวอย่างไฟล์ `composer.json`

ลองดูตัวอย่างไฟล์ composer.json ง่ายๆ กันก่อนครับ:

{
  "name": "my-vendor/my-project",
  "description": "A simple PHP project",
  "require": {
    "php": "^7.4"
  },
  "autoload": {
    "psr-4": {
      "MyProject\\": "src/"
    }
  }
}

เราจะมาอธิบายแต่ละส่วนประกอบกันครับ

องค์ประกอบหลักใน `composer.json`

ไฟล์ composer.json มีองค์ประกอบหลายส่วน แต่ในบทนี้เราจะเน้นเฉพาะส่วนที่สำคัญและใช้งานบ่อยที่สุดสำหรับผู้เริ่มต้นครับ ได้แก่ name, description, require, และ autoload

1. `name`

name คือชื่อของโปรเจกต์ของเรา ซึ่งควรอยู่ในรูปแบบ vendor/package โดยที่ vendor คือชื่อผู้พัฒนาหรือองค์กร และ package คือชื่อโปรเจกต์ ตัวอย่างเช่น acme/my-awesome-library หรือ my-company/my-web-app

การตั้งชื่อโปรเจกต์ตามรูปแบบนี้มีความสำคัญ เพราะ Composer ใช้ชื่อนี้ในการระบุโปรเจกต์ของเราบน Packagist (repository ของ Composer) และช่วยให้ผู้อื่นสามารถค้นหาและติดตั้งโปรเจกต์ของเราได้ง่ายขึ้น

ตัวอย่าง:

"name": "my-vendor/my-project"

2. `description`

description คือคำอธิบายสั้นๆ เกี่ยวกับโปรเจกต์ของเรา ควรเป็นข้อความที่อธิบายว่าโปรเจกต์นี้ทำอะไร มีจุดประสงค์อะไร เพื่อให้ผู้อื่นเข้าใจโปรเจกต์ของเราได้ง่ายขึ้น

ตัวอย่าง:

"description": "A simple PHP project"

3. `require`

require คือส่วนที่ใช้กำหนด Dependencies ที่โปรเจกต์ของเราต้องการ Dependencies คือ Library หรือ Package อื่นๆ ที่โปรเจกต์ของเราจำเป็นต้องใช้ในการทำงาน

ในส่วน require เราจะระบุชื่อ Package และ Version Constraints (ข้อจำกัดของเวอร์ชัน) ที่เราต้องการ ตัวอย่างเช่น:

"require": {
  "php": "^7.4",
  "monolog/monolog": "^2.0"
}

ในตัวอย่างนี้ เรากำหนดว่าโปรเจกต์ของเราต้องการ PHP เวอร์ชั่น 7.4 ขึ้นไป (^7.4) และ Monolog เวอร์ชั่น 2.0 ขึ้นไป (^2.0)

Version Constraints คืออะไร?

Version Constraints คือเงื่อนไขที่ใช้กำหนดช่วงของเวอร์ชันที่เราต้องการใช้ Composer รองรับ Version Constraints หลายรูปแบบ เช่น:

=: ระบุเวอร์ชันที่ต้องการอย่างเจาะจง เช่น =1.2.3
>: มากกว่า เช่น >1.2.3
>=: มากกว่าหรือเท่ากับ เช่น >=1.2.3
<: น้อยกว่า เช่น <1.2.3
<=: น้อยกว่าหรือเท่ากับ เช่น <=1.2.3
^: Compatible with specified version (แนะนำให้ใช้) เช่น ^1.2.3 จะอนุญาตเวอร์ชัน 1.2.3 ถึง < 2.0.0
~: Similar to ^, but more restrictive. เช่น ~1.2.3 จะอนุญาตเวอร์ชัน 1.2.3 ถึง < 1.3.0
*: Any version (ไม่แนะนำให้ใช้ใน Production)

การใช้ Version Constraints ที่เหมาะสมจะช่วยให้โปรเจกต์ของเราทำงานได้อย่างถูกต้องและหลีกเลี่ยงปัญหาความเข้ากันได้กับ Dependencies อื่นๆ

4. `autoload`

autoload คือส่วนที่ใช้กำหนดวิธีการ Autoloading Classes ในโปรเจกต์ของเรา Autoloading คือกลไกที่ช่วยให้เราสามารถโหลด Classes ได้โดยอัตโนมัติเมื่อมีการใช้งาน โดยไม่ต้อง include หรือ require ไฟล์ Class นั้นๆ เอง

Composer รองรับ Autoloading หลายมาตรฐาน เช่น PSR-0 และ PSR-4 แต่ในปัจจุบัน PSR-4 เป็นมาตรฐานที่นิยมใช้กันมากที่สุด

PSR-4 คืออะไร?

PSR-4 คือมาตรฐาน Autoloading ที่กำหนดว่า Namespace ของ Class จะต้องสอดคล้องกับโครงสร้าง Directory ของไฟล์ Class ตัวอย่างเช่น:

Namespace: MyProject\MyClass
File Path: src/MyClass.php

ในการกำหนด Autoloading ด้วย PSR-4 ใน composer.json เราจะใช้โครงสร้างดังนี้:

"autoload": {
  "psr-4": {
    "MyProject\\": "src/"
  }
}

ในตัวอย่างนี้ เรากำหนดว่า Namespace MyProject\ จะถูก Map ไปยัง Directory src/ นั่นหมายความว่า ถ้าเรามี Class ชื่อ MyProject\MyClass Composer จะค้นหาไฟล์ Class นั้นใน Directory src/MyClass.php

ทำไมต้องมี Backslash สองตัว (\\)?

ใน JSON, Backslash (\) เป็น Escape Character ดังนั้น ถ้าเราต้องการใช้ Backslash จริงๆ เราต้อง Escape มันด้วย Backslash อีกตัวหนึ่ง (\\) นั่นเอง

สรุป

ในบทนี้ เราได้เรียนรู้โครงสร้างพื้นฐานของไฟล์ composer.json และทำความเข้าใจองค์ประกอบสำคัญต่างๆ ได้แก่ name, description, require, และ autoload การเข้าใจองค์ประกอบเหล่านี้เป็นพื้นฐานสำคัญในการจัดการ Dependencies และ Autoloading ในโปรเจกต์ PHP ของเรา

ในบทถัดไป เราจะลงลึกในรายละเอียดเกี่ยวกับการกำหนด Dependencies ใน composer.json และเรียนรู้วิธีการใช้ Version Constraints อย่างมีประสิทธิภาพ

โครงสร้างไฟล์ composer.json เบื้องต้น