PSR 이해 - PHP 코딩 스타일 가이드

한동안 PHP로 개발을 했다면 PSR-12라는 용어를 접했을 것입니다. 이는 PHP 커뮤니티에서 가장 널리 받아들여지는 코딩 표준 중 하나이며 다양한 프로젝트에서 PHP 코드베이스의 일관성을 보장하는 것을 목표로 합니다. 단독으로 작업하든 팀의 일원으로 작업하든 PSR-12를 따르면 코드가 더 깔끔하고, 읽기 쉽고, 유지 관리하기 쉬워집니다. 이 블로그에서는 PSR-12가 무엇인지, 왜 중요한지, 프로젝트에 PSR-12를 적용하는 방법에 대해 자세히 설명하겠습니다.

목차

1. PSR-12란 무엇인가요?
2. PSR-12가 왜 중요한가요?
3. PSR-12의 주요 규칙
   • 파일 구조
   • 네임스페이스 및 사용 선언
   • 클래스 및 메소드
   • 제어 구조
   • 의견 및 문서
4. PSR-12를 PHP 프로젝트에 적용하는 방법
5. PSR-12를 따르는 데 도움이 되는 도구
6. 최종 생각

PSR-12란 무엇입니까?

PSR-12는 PHP-FIG(Framework Interoperability Group)에서 개발한 PHP용 코딩 스타일 가이드입니다. 이전 PSR-2 표준을 기반으로 구축되어 최신 PHP 관행을 반영하고 코드베이스 전체의 일관성을 향상시키는 업데이트된 규칙 세트를 제공합니다.

PSR-12를 깔끔하고 읽기 쉽고 유지 관리 가능한 PHP 코드 작성을 위한 청사진으로 생각해 보세요. PSR-12를 따르면 개발자는 자신의 코드가 표준화된 구조를 준수하는지 확인할 수 있으므로 다른 사람과 더 쉽게 협업하고 오픈 소스 프로젝트를 진행할 수 있습니다.

PSR-12가 왜 중요한가요?

PSR-12와 같은 코딩 표준은 단지 공백과 탭에 대한 문제를 해결하는 것이 아닙니다. 중요한 이유는 다음과 같습니다.

• 가독성: 표준 스타일을 따르는 코드는 특히 프로젝트를 처음 접하는 개발자의 경우 읽기가 더 쉽습니다.
• 협업: 모두가 동일한 규칙을 따르면 함께 ​​일하는 것이 더 원활하고 효율적이 됩니다.
• 유지관리성: 깨끗하고 일관된 코드는 시간이 지남에 따라 디버깅, 테스트 및 확장이 더 쉽습니다.
• 상호 운용성: 오픈 소스 프로젝트에서 또는 타사 라이브러리를 통합할 때 공통 표준을 따르면 다양한 코드베이스 간의 호환성이 보장됩니다.

PSR-12의 주요 규칙

PSR-12가 제시하는 몇 가지 주요 규칙을 살펴보겠습니다. 작은 지침도 많지만 가장 눈에 띄는 지침은 다음과 같습니다.

1. 파일 구조

• 열기 태그: PHP 파일은
• 인코딩: 파일은 BOM(바이트 순서 표시) 없이 UTF-8로 인코딩되어야 합니다.
• 줄 길이: 줄은 120자를 초과할 수 없지만 최대 80자를 선호합니다.
• 빈 줄: 여는 PHP 태그 뒤나 닫는 태그 앞에는 빈 줄이 없어야 합니다. 또한 return 문 앞과 메서드 정의 사이에는 빈 줄이 하나 있어야 합니다.

2. 네임스페이스 및 사용 선언

PSR-12에서는 명확성을 높이기 위해 네임스페이스와 사용 선언이 특정 순서를 따라야 합니다.

• 네임스페이스 선언: 네임스페이스 선언은 여는 PHP 태그 다음의 첫 번째 줄이어야 합니다. 네임스페이스 뒤에는 빈 줄이 하나 있어야 합니다.
• 사용 선언: 모든 사용 선언은 네임스페이스 선언 다음에 함께 그룹화되고 빈 줄로 구분되어야 합니다. 또한 마지막 사용문 뒤에는 빈 줄이 하나 있어야 합니다.

예:

<?php namespace App\Controllers;

use App\Models\User;
use App\Repositories\UserRepository;

class UserController {
    // Class implementation
}

3. 클래스와 메소드

PSR-12는 클래스, 속성 및 메서드 선언 방법에 대해 몇 가지 엄격한 규칙을 적용합니다.

• 클래스 선언: 클래스 키워드 뒤에는 공백과 클래스 이름이 와야 합니다. 여는 중괄호 {는 클래스 선언과 같은 줄에 배치되어야 하며, 닫는 중괄호 }는 한 줄에 있어야 합니다.
• 속성: 모든 속성에 대해 가시성(공개, 보호, 비공개)을 선언해야 합니다.
• 메서드: 클래스 선언과 유사하게 함수 키워드 뒤에는 공백이 오고 그 다음에는 메서드 이름이 와야 합니다. 모든 메소드에 대해 가시성을 선언해야 합니다.

class UserController {
    private $userRepository;

    public function __construct(UserRepository $userRepository) {
        $this->userRepository = $userRepository;
    }
}

4. 제어 구조

if, for, switch와 같은 제어 구조는 특정 규칙을 따라야 합니다.

• 구조: 제어 키워드와 여는 괄호 사이에 공백이 하나 있어야 합니다. 한 줄 문에도 중괄호 {}를 항상 사용해야 합니다.
• 들여쓰기: 제어 구조 내부의 모든 블록은 한 수준(일반적으로 공백 4개)만큼 들여쓰기되어야 합니다.

if ($user->isAdmin()) {
    echo "User is an admin";
} else {
    echo "User is not an admin";
}

5. 의견 및 문서

코멘트는 코드의 특정 부분이 존재하는 이유를 설명하는 데 매우 중요합니다. PSR-12는 적절하고 명확한 설명의 필요성을 강조합니다.

• 댓글 차단: 여러 줄의 댓글에는 /* */를 사용하고 댓글 앞에 빈 줄을 넣으세요.
• 한 줄 주석: 인라인 주석에는 //를 사용하고 주석이 의미가 있는지 확인하세요.

<?php namespace App\Controllers;

use App\Models\User;
use App\Repositories\UserRepository;

class UserController {
    // Class implementation
}

PHP 프로젝트에 PSR-12를 적용하는 방법

프로젝트에서 PSR-12를 따르려면 코드를 작성할 때 지침을 수동으로 준수할 수 있지만 규정 준수를 보장하는 가장 좋은 방법은 자동화된 도구를 사용하는 것입니다.

먼저 다음과 같은 일반적인 관행을 숙지하세요.

• 일관적인 들여쓰기 사용: 들여쓰기에는 공백 4개가 필요합니다.
• 줄 길이 제한: 줄을 120자 미만으로 유지하세요. 단, 가독성을 높이려면 80자를 선호합니다.
• 코드 구조 구성: 클래스 선언, 가시성 및 제어 구조에 대한 규칙을 따르세요.

PSR-12를 따르는 데 도움이 되는 도구

코드가 PSR-12를 따르는지 수동으로 확인하는 것은 시간이 많이 걸릴 수 있지만 이 프로세스를 자동화하는 데 도움이 되는 도구가 있습니다.

1. PHP_코드스니퍼

PHP 코드가 PSR-12를 따르도록 하는 가장 인기 있는 도구 중 하나는 PHP_CodeSniffer입니다. 코드를 분석하고 표준에서 벗어나는 부분을 지적합니다.

설치 및 사용 방법:

class UserController {
    private $userRepository;

    public function __construct(UserRepository $userRepository) {
        $this->userRepository = $userRepository;
    }
}

그런 다음 코드에 대해 실행하세요.

if ($user->isAdmin()) {
    echo "User is an admin";
} else {
    echo "User is not an admin";
}

2. PHP CS 픽서

또 다른 유용한 도구는 PHP CS Fixer입니다. 문제를 감지할 뿐만 아니라 자동으로 PSR-12를 준수하도록 코드를 수정할 수도 있습니다.

// Fetch user from the repository
$user = $userRepository->find($id);

/*
 * If user is not found, throw an exception.
 * This helps in handling invalid user IDs.
 */
if (!$user) {
    throw new NotFoundException();
}

다음을 사용하여 Fixer를 실행하세요.

composer require "squizlabs/php_codesniffer=*"

3. PHPStorm

PHPStorm을 사용하는 경우 PSR-12를 따르도록 구성할 수 있습니다. 설정으로 이동 -> 편집자 -> 코드 스타일 -> PHP 표준을 PSR-12로 설정합니다.

최종 생각

PHP 프로젝트에서 PSR-12를 따르는 것은 단순히 임의의 규칙을 준수하는 것 이상입니다. 혼자 작업하든 팀과 함께 작업하든 상관없이 코드를 더 깔끔하고, 읽기 쉽고, 유지 관리하기 쉽게 만드는 것입니다. PSR-12를 따르면 자신뿐만 아니라 전체 PHP 커뮤니티를 위한 코드를 작성하게 됩니다.

이 표준을 채택하는 것은 전문적이고 일관되며 유지 관리가 가능한 PHP 코드를 작성하기 위한 단계입니다. 언급된 도구를 사용하여 프로세스를 더 쉽게 만들고 프로젝트가 얼마나 깔끔하고 정리되는지 확인해 보세요!

즐거운 코딩하세요!

위 내용은 PSR 이해 - PHP 코딩 스타일 가이드의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!