집 > 기사 > 백엔드 개발 > 필기 PHP API 프레임워크(1) PSR 사양

필기 PHP API 프레임워크(1) PSR 사양

藏色散人앞으로: 2023-02-10 10:31:113464검색

이 기사에서는 주로 코딩 표준에 대해 설명합니다. 관심 있는 친구들은 아래를 살펴보는 것이 도움이 될 것입니다. 당신.

창작 의도

CURD 사용이 지치셨나요?
다양한 프레임워크가 좀 부담스럽나요?
프레임워크를 직접 디자인해 본 적이 있나요?
PHP 구문을 배웠지만 이를 연습하고 탄탄한 기초를 다질 프로젝트가 없습니다

자신만의 프레임워크를 빠르게 구축하고 업무나 공부에 도움과 영감을 줄 수 있기를 바랍니다.

무엇을 배울 수 있나요

PSR 사양
작곡기 사용
API 인터페이스 프레임워크를 빠르게 구축
다양한 데이터 유형의 Redis 애플리케이션
캐시 애플리케이션 분석

프레임워크를 개발하기 전, 프레임워크 개발에 따른 스펙을 소개하겠습니다.

대부분의 프로그래밍 언어에는 고유한 코딩 표준 세트가 있습니다. "세계 최고의 언어"인 PHP에는 확실히 고유한 코딩 표준이 있습니다. 이 사양은 PHP Standard Recommendation(줄여서 PSR)입니다.

물론 내 작업을 통해 많은 PHP 프로그래머, 특히 주니어 프로그래머가 PHP에 이러한 사양이 있다는 사실을 모르고 있다는 사실을 발견했습니다.

PSR이란 무엇인가요?

PSR을 소개하기 전에 이 사양을 공식화한 조직을 소개해야 합니다------PHP-FIG, 전체 이름은 PHP Framework Interoperability입니다.

조직 구성원은 사양을 공식화하고 이를 자체 프로젝트에 구현합니다. 공식 조직은 아니지만 CakePHP, Composer, Drupal, PEAR, Slim, Yii 프레임워크, Zend Framework 등과 같은 대부분의 PHP 커뮤니티 프로젝트를 대표하기도 합니다. 그리고 점점 더 많은 프로젝트가 이 표준에 합류하고 따르고 있습니다.

PSR 프로젝트의 목적은 프레임워크 작성자 또는 프레임워크 대표자 간의 논의를 통해 가장 낮은 수준의 제한이 있는 협업 표준을 개발하는 것입니다. 각 프레임워크는 엔지니어가 더 잘 협력할 수 있도록 통일된 코딩 표준을 따릅니다.

현재 공식 홈페이지에는 20개 항목이 등록되어 있으며, 초안 작성 및 폐기된 항목을 제외하면 다음과 같은 13개 항목이 있습니다.

필기 PHP API 프레임워크(1) PSR 사양

다음 사양을 살펴볼 수도 있습니다.

PSR-1 기본 코딩 표준

PHP 코드 파일은
PHP 코드 파일은 BOM 없이 UTF-8 인코딩으로 시작해야 합니다.
PHP 코드는 클래스, 함수, 상수 또는 부작용(예: 파일 출력 생성 및 .ini 구성 파일 수정 등)을 생성하는 기타 작업과 같은 선언만 정의해야 합니다. , 둘 다 하나만 선택할 수 있습니다
네임스페이스와 클래스는 PSR의 자동 로딩 사양 PSR-4를 준수해야 합니다
클래스 이름 지정은 StudyCaps 스타일의 대문자로 시작하는 CamelCase 명명 규칙을 따라야 합니다
모든 문자 클래스의 상수는 대문자로 시작해야 하며 단어 사이에는 밑줄이 있어야 합니다. 구분
메서드 이름은 camelCase 스타일 소문자 카멜 케이스 명명 규칙을 준수해야 합니다.

PSR-12 코드 스타일 사양

PSR-12 사양은 다음을 포함하여 매우 자세합니다. 선언, 네임스페이스, 클래스 및 상속, 제어 구조 등이 설명됩니다.

먼저 데모를 살펴보겠습니다.

<?php

declare(strict_types=1);

namespace Vendor\Package;

use Vendor\Package\{ClassA as A, ClassB, ClassC as C};
use Vendor\Package\SomeNamespace\ClassD as D;

use function Vendor\Package\{functionA, functionB, functionC};

use const Vendor\Package\{ConstantA, ConstantB, ConstantC};

class Foo extends Bar implements FooInterface
{
    public function sampleFunction(int $a, int $b = null): array
    {
        if ($a === $b) {
            bar();
        } elseif ($a > $b) {
            $foo->bar($arg1);
        } else {
            BazClass::bar($arg2, $arg3);
        }
    }

    final public static function bar()
    {
        // method body
    }
}

코드는 [PSR-1]의 코딩 사양을 따라야 합니다.
모든 PHP 파일은 Unix LF(줄 바꿈)를 줄 종결자로 사용해야 합니다. 끝은 빈 줄로 시작해야 합니다.
순수한 PHP 코드 파일은 마지막 ?> 닫는 태그를 생략해야 합니다.
줄당 문자 수는 80자 이내로 유지해야 합니다. 이론상 120자를 넘지 않아야 합니다. , 그러나 반드시는 안됩니다. 엄격한 제한이 있습니다. 공백이 아닌 줄 뒤에는 추가 공백이 없어야 합니다.
빈 줄을 사용하면 코드를 더 쉽게 읽을 수 있고 코드를 차단하는 데 도움이 됩니다.
한 줄에 하나 이상의 명령문이 있어서는 안 됩니다.
코드는 공백 4개로 들여쓰기되어야 하며 탭 키를 사용할 수 없습니다.
모든 PHP 키워드는 모두 소문자여야 합니다.
제어 구조의 기본 사양은 다음과 같습니다.

控制结构关键词后必须有一个空格。
左括号 ( 后一定不能有空格。
右括号 ) 前也一定不能有空格。
右括号 ) 与开始花括号 { 间一定有一个空格。
结构体主体一定要有一次缩进。
结束花括号 } 一定在结构体主体后单独成行。复制代码

PSR-4 자동 로딩

자동 로딩 관련 사양에 대해 파일 경로의 해당 클래스는 상호 운용 가능하며 PSR-0을 포함한 모든 자동 로딩 사양에 대한 보충 자료로 사용될 수 있습니다. 또한 이 PSR에는 자동으로 로드되는 클래스에 해당하는 파일 저장 경로 사양도 포함되어 있습니다.

```
 \(\)*\
```
- 반드시
  "vendor 네임스페이스"라는 최상위 네임스페이스를 가져야 합니다.
- 을 사용할 수 있습니다.
  하나 이상의 하위 네임스페이스가 있어야 합니다.
- 최종 클래스 이름이 있어야 합니다.
  전체 클래스 이름의 밑줄은 특별한 의미가 없습니다.
- 전체 클래스 이름 은 대문자와 소문자로 구성될 수 있습니다.
- 모든 클래스 이름은 대소문자를 구분해야 합니다.
전체 클래스 이름을 기준으로 해당 파일을 로드할 때...
- 전체 클래스 이름에서 첫 번째 네임스페이스 구분 기호, 앞에 있는 하나 이상의 연속된 네임스페이스 및 하위 네임스페이스를 다음과 같이 제거합니다. "네임스페이스 접두사"는 하나 이상의 "파일 기본 디렉터리"와 일치해야 합니다.
- 네임스페이스 접두사
  바로 뒤에 오는 하위 네임스페이스는 해당 "파일 기본 디렉터리"와 일치해야 합니다. 여기서 네임스페이스 구분 기호가 사용됩니다. 디렉토리 구분 기호로 사용됩니다.
- 끝에 있는 클래스 이름
  은 접미사가 인 해당 파일과 이름이 동일해야 합니다. .php
- 자동 로더의 구현은
  예외를 발생시켜서는 안 되며 어떠한 수준의 오류 메시지도 트리거해서는 안 되며 반환 값을 가져서는 안 됩니다 .

다음 표는 사양을 준수하는 전체 클래스 이름, 네임스페이스 접두사 및 파일 기본 디렉터리에 해당하는 파일 경로를 보여줍니다.

전체 클래스 이름AcmeLogWriter File_WriterAuraWebResponseStatusSymfonyCoreRequestZendAcl지금은 일반적으로 사용되는 세 가지 사양만 소개하겠습니다.

네임스페이스 접두사	파일 기본 디렉터리	파일 경로
AcmeLogWriter	./acme-log-writer/lib /	./acme- 로그 작가/lib/File_Writer.php
AuraWeb	/path/to/aura-web/src/	/path/to/aura-web/src/Response/Status.php
SymfonyCore	./vendor/Symfony/Core/	./vendor/Symfony/Core/Request.php
Zend	/usr/inc ludes/ 젠드/	/ usr /includes/Zend/Acl.php

더 많은 최신 사양 제안을 보려면 클릭하세요

이 섹션에서는 주로 PHP 코딩 사양 PSR을 소개합니다. 모든 사람이 개발 중에 이 사양을 따르도록 권장합니다. 특히 팀으로 개발할 때는 각자의 지식을 갖고 있지 않아야 합니다. 자체 코딩 스타일은 최대한 통일되어야 합니다. PHP-FIG 조직의 원래 의도가 밝혔듯이, 그들이 확립한 사양은 모든 사람의 코딩 자유를 제한하는 것이 아니라, 우리가 더 잘 협력할 수 있도록 공통점을 찾는 것입니다.

필기 PHP API 프레임워크(1) PSR 사양

창작 의도

무엇을 배울 수 있나요

다음 표는 사양을 준수하는 전체 클래스 이름, 네임스페이스 접두사 및 파일 기본 디렉터리에 해당하는 파일 경로를 보여줍니다.

관련 기사