PHP에서 PSR 표준 적용하기

목차
1. PSR 표준이란 무엇인가?
   - PSR의 개요
   - PSR 표준의 중요성
2. PSR-1 및 PSR-2: 코딩 표준
   - PSR-1: 기본 코딩 표준
   - PSR-2: 코드 스타일 가이드
3. PSR-4: 자동 로딩 표준
   - PSR-4의 개념
   - PSR-4를 사용한 클래스 자동 로딩
4. PSR-7: HTTP 메시지 인터페이스
   - PSR-7의 개요
   - PSR-7을 사용한 HTTP 메시지 처리
5. 코드 예제
6. 결론 및 추가 학습 자료

---

1. PSR 표준이란 무엇인가?

PSR의 개요

PSR(Php Standard Recommendations)은 PHP-FIG(PHP Framework Interoperability Group)에서 제안한 일련의 표준으로, PHP 코드의 일관성을 유지하고, 서로 다른 PHP 프레임워크와 라이브러리 간의 상호 운용성을 개선하기 위한 규칙을 제공합니다. PSR 표준을 준수하면 코드의 가독성과 유지보수성을 높이고, 다른 개발자와의 협업이 쉬워집니다.

PSR 표준의 중요성

- 일관성: PSR 표준을 따르면 모든 개발자가 동일한 코드 스타일과 구조를 유지할 수 있어, 코드의 일관성이 보장됩니다.
- 협업 용이성: 여러 개발자가 하나의 프로젝트에서 협업할 때, PSR 표준을 따름으로써 코드의 가독성과 유지보수성이 향상됩니다.
- 재사용성: PSR 표준을 따르면 다양한 프레임워크와 라이브러리에서 쉽게 통합하고 사용할 수 있습니다.

---

2. PSR-1 및 PSR-2: 코딩 표준

PSR-1: 기본 코딩 표준

PSR-1은 PHP 코드의 기본 코딩 표준을 정의하며, 코드의 가독성을 높이고, 코드 스타일을 일관되게 유지하기 위한 규칙을 제공합니다.

주요 내용:
- 파일 형식: PHP 파일은 UTF-8 인코딩을 사용해야 하며, PHP 태그 '<?php'로 시작해야 합니다.
- 네임스페이스 및 클래스 이름: 네임스페이스는 대문자로 시작하며, 각 단어는 대문자로 구분됩니다. 예: 'App\Namespace\ClassName'
- 클래스 상수: 클래스 상수는 모두 대문자로 작성되며, 단어 사이에는 밑줄('_')을 사용합니다. 예: 'CONST_NAME'
- 자동 로딩 규칙: PSR-4 자동 로딩 표준을 준수해야 합니다.

PSR-2: 코드 스타일 가이드

PSR-2는 PSR-1을 기반으로 한 코드 스타일 가이드로, 코드의 형식과 구조를 정의합니다. PSR-2는 코드의 일관성을 유지하고, 가독성을 높이기 위해 사용됩니다.

주요 내용:
- 탭 대신 스페이스 사용: 들여쓰기는 4개의 스페이스로 해야 하며, 탭은 사용하지 않습니다.
- 줄 바꿈: 코드의 줄 바꿈은 유닉스 스타일의 LF(Line Feed)를 사용합니다.
- 중괄호 위치: 클래스, 메서드, 함수의 중괄호는 새로운 줄에서 시작하며, 제어 구조(if, else, while 등)의 중괄호는 같은 줄에서 시작합니다.
- 한 줄에 하나의 명령문: 한 줄에 여러 명령문을 작성하지 않도록 합니다.

예제:

<?php

namespace App\Controller;

class UserController
{
    public function getUser($id)
    {
        if ($id > 0) {
            return $this->findUserById($id);
        }

        return null;
    }
}

?>

---

3. PSR-4: 자동 로딩 표준

PSR-4의 개념

PSR-4는 클래스 자동 로딩을 위한 표준으로, 클래스를 네임스페이스와 매핑하여 파일 시스템에서 올바른 위치에 클래스를 자동으로 로딩할 수 있도록 정의합니다. PSR-4는 클래스 파일의 구조와 네임스페이스를 일치시켜 자동 로딩을 쉽게 구현할 수 있게 합니다.

PSR-4를 사용한 클래스 자동 로딩

PSR-4를 준수하는 클래스를 자동 로딩하기 위해서는 Composer의 'composer.json' 파일에 자동 로딩 설정을 추가해야 합니다.

composer.json 설정:

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

이 설정은 'App' 네임스페이스가 'src/' 디렉토리에 매핑되도록 합니다. 이제 'src/Controller/UserController.php' 파일을 생성하면, 다음과 같이 네임스페이스를 사용할 수 있습니다.

UserController 클래스:

<?php

namespace App\Controller;

class UserController
{
    public function getUser($id)
    {
        // 메서드 구현
    }
}

?>

클래스 사용:

<?php

require 'vendor/autoload.php';

use App\Controller\UserController;

$controller = new UserController();
$controller->getUser(1);

?>

이렇게 하면 'App\Controller\UserController' 클래스가 'src/Controller/UserController.php' 파일에서 자동으로 로딩됩니다.

---

4. PSR-7: HTTP 메시지 인터페이스

PSR-7의 개요

PSR-7은 HTTP 메시지 인터페이스를 정의하는 표준으로, HTTP 요청(Request) 및 응답(Response)을 객체로 다룰 수 있게 합니다. PSR-7은 HTTP 메시지를 조작하고 처리하는 데 필요한 일관된 인터페이스를 제공하며, HTTP 관련 작업을 쉽게 관리할 수 있습니다.

PSR-7을 사용한 HTTP 메시지 처리

PSR-7을 사용하면 HTTP 요청 및 응답을 객체로 다루고, 이를 통해 다양한 HTTP 작업을 쉽게 수행할 수 있습니다. PSR-7을 준수하는 라이브러리로는 'Guzzle'이 있으며, 이를 사용하여 HTTP 요청을 쉽게 처리할 수 있습니다.

Guzzle 설치:

composer require guzzlehttp/guzzle

PSR-7 HTTP 요청 예제:

<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();
$response = $client->request('GET', 'https://jsonplaceholder.typicode.com/posts/1');

echo $response->getStatusCode(); // 200
echo $response->getBody();

?>

이 코드는 Guzzle을 사용하여 HTTP GET 요청을 보내고, 응답의 상태 코드와 본문을 출력합니다.

---

5. 코드 예제

다음은 PSR-1, PSR-2, PSR-4, PSR-7 표준을 적용한 종합적인 예제입니다.

1. PSR-4 자동 로딩 설정:

'composer.json':

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

2. PSR-1 및 PSR-2를 따른 클래스 작성:

'src/Controller/UserController.php':

<?php

namespace App\Controller;

class UserController
{
    public function getUser($id)
    {
        if ($id > 0) {
            return $this->findUserById($id);
        }

        return null;
    }

    private function findUserById($id)
    {
        // 데이터베이스에서 사용자 조회 로직
    }
}

?>

3. PSR-7을 사용한 HTTP 요청 처리:

<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();
$response = $client->request('GET', 'https://jsonplaceholder.typicode.com/posts/1');

if ($response->getStatusCode() === 200) {
    $body =

 $response->getBody();
    echo $body;
}

?>

코드 분석:
- 첫 번째 예제는 PSR-4를 따르는 자동 로딩 설정을 'composer.json' 파일에 정의합니다.
- 두 번째 예제는 PSR-1 및 PSR-2를 준수하는 클래스를 작성하여 코드의 일관성과 가독성을 유지합니다.
- 세 번째 예제는 PSR-7을 준수하는 Guzzle을 사용하여 HTTP 요청을 처리하고, 응답을 출력합니다.

---

6. 결론 및 추가 학습 자료

이번 글에서는 PHP에서 PSR 표준을 적용하는 방법에 대해 알아보았습니다. PSR-1과 PSR-2를 통해 코드의 일관성을 유지하고, PSR-4를 사용하여 자동 로딩을 구현하며, PSR-7을 사용하여 HTTP 메시지를 효율적으로 처리할 수 있습니다. 이러한 표준을 적용하면 코드의 가독성과 유지보수성이 향상되고, 다양한 PHP 프레임워크와 라이브러리 간의 상호 운용성이 높아집니다.

추가 학습 자료:
- [PHP-FIG 공식 웹사이트](https://www.php-fig.org/) PSR 표준과 관련된 자세한 문서와 가이드를 제공합니다.
- [PSR-1: 기본 코딩 표준](https://www.php-fig.org/psr/psr-1/) PSR-1에 대한 공식 문서입니다.
- [PSR-2: 코드 스타일 가이드](https://www.php-fig.org/psr/psr-2/) PSR-2에 대한 공식 문서입니다.
- [Guzzle 공식 문서](https://docs.guzzlephp.org/en/stable/) PSR-7을 지원하는 Guzzle의 설치 및 사용법을 설명합니다.

---

이제 PSR 표준을 준수하여 더 나은 PHP 코드를 작성할 수 있습니다. 실습을 통해 다양한 PSR 표준을 프로젝트에 적용하고, 개발 작업의 효율성을 극대화해보세요!