Icons background left side Icons background left side in dark variant
PHP의 확장 가능한 마이크로 프레임워크 PHP의 확장 가능한 마이크로 프레임워크
Icons background right side Icons background right side in dark variant

Learn/flight_vs_laravel

Flight vs Laravel

Laravel이란?

Laravel은 모든 종소리와 장식을 갖춘 풀 기능 프레임워크로, 놀라운 개발자 중심 생태계를 가지고 있지만, 성능과 복잡성 측면에서 비용이 듭니다. Laravel의 목표는 개발자가 최고 수준의 생산성을 가지도록 하고, 일반적인 작업을 쉽게 만드는 것입니다. Laravel은 풀 기능의 엔터프라이즈 웹 애플리케이션을 구축하려는 개발자에게 훌륭한 선택입니다. 이는 성능과 복잡성 측면에서 일부 trade-off를 동반합니다. Laravel의 기초를 배우는 것은 쉽지만, 프레임워크에 숙달되는 데는 시간이 걸릴 수 있습니다.

또한 Laravel 모듈이 너무 많아서 개발자들은 문제를 해결하는 유일한 방법이 이러한 모듈을 통하는 것처럼 느껴지지만, 실제로는 다른 라이브러리를 사용하거나 직접 코드를 작성할 수 있습니다.

Flight와 비교한 장점

Flight와 비교한 단점

Learn/migrating_to_v3

v3로 마이그레이션

대부분의 경우 뒤로 호환성이 유지되었지만, v2에서 v3로 마이그레이션할 때 알아야 할 몇 가지 변경 사항이 있습니다. 설계 패턴과 너무 많이 충돌하는 변경 사항이 있어서 일부 조정이 필요했습니다.

출력 버퍼링 동작

v3.5.0

출력 버퍼링은 PHP 스크립트에서 생성된 출력을 클라이언트로 보내기 전에 PHP 내부 버퍼에 저장하는 프로세스입니다. 이를 통해 클라이언트로 보내기 전에 출력을 수정할 수 있습니다.

MVC 애플리케이션에서 컨트롤러는 "관리자" 역할을 하며 뷰가 무엇을 하는지 관리합니다. 컨트롤러 외부(또는 Flight의 경우 때때로 익명 함수)에서 출력이 생성되는 것은 MVC 패턴을 깨뜨립니다. 이 변경은 MVC 패턴에 더 잘 맞추고 프레임워크를 더 예측 가능하고 사용하기 쉽게 만들기 위한 것입니다.

v2에서는 출력 버퍼링이 자체 출력 버퍼를 일관되게 닫지 않는 방식으로 처리되어 단위 테스트와 스트리밍을 더 어렵게 만들었습니다. 대부분의 사용자에게 이 변경은 실제로 영향을 미치지 않을 수 있습니다. 그러나 콜러블과 컨트롤러 외부(예: 훅)에서 콘텐츠를 에코 출력하는 경우 문제가 발생할 가능성이 큽니다. 훅에서 콘텐츠를 에코 출력하거나 프레임워크가 실제로 실행되기 전에 에코 출력하는 것은 과거에는 작동했을 수 있지만 앞으로는 작동하지 않을 것입니다.

문제가 발생할 수 있는 곳

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

// just an example
define('START_TIME', microtime(true));

function hello() {
    echo 'Hello World';
}

Flight::map('hello', 'hello');
Flight::after('hello', function(){
    // this will actually be fine
    echo '<p>This Hello World phrase was brought to you by the letter "H"</p>';
});

Flight::before('start', function(){
    // things like this will cause an error
    echo '<html><head><title>My Page</title></head><body>';
});

Flight::route('/', function(){
    // this is actually just fine
    echo 'Hello World';

    // This should be just fine as well
    Flight::hello();
});

Flight::after('start', function(){
    // this will cause an error
    echo '<div>Your page loaded in '.(microtime(true) - START_TIME).' seconds</div></body></html>';
});

v2 렌더링 동작 켜기

기존 코드를 v3와 작동하도록 재작성하지 않고 그대로 유지할 수 있나요? 네, 가능합니다! flight.v2.output_buffering 구성 옵션을 true로 설정하여 v2 렌더링 동작을 켤 수 있습니다. 이는 기존 렌더링 동작을 계속 사용할 수 있게 해주지만, 앞으로는 이를 수정하는 것이 권장됩니다. 프레임워크의 v4에서는 이 기능이 제거될 것입니다.

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

Flight::set('flight.v2.output_buffering', true);

Flight::before('start', function(){
    // Now this will be just fine
    echo '<html><head><title>My Page</title></head><body>';
});

// more code

디스패처 변경 사항

v3.7.0

Dispatcher의 정적 메서드를 직접 호출한 경우, 예를 들어 Dispatcher::invokeMethod(), Dispatcher::execute() 등이라면 코드를 업데이트하여 이러한 메서드를 직접 호출하지 않도록 해야 합니다. Dispatcher는 의존성 주입 컨테이너를 더 쉽게 사용할 수 있도록 더 객체 지향적으로 변환되었습니다. Dispatcher와 유사하게 메서드를 호출해야 한다면 $result = $class->$method(...$params);나 call_user_func_array()를 수동으로 사용할 수 있습니다.

halt() stop() redirect() 및 error() 변경 사항

v3.10.0

3.10.0 이전의 기본 동작은 헤더와 응답 본문을 모두 지우는 것이었습니다. 이는 응답 본지만 지우도록 변경되었습니다. 헤더도 지워야 한다면 Flight::response()->clear()를 사용할 수 있습니다.

Learn/configuration

구성

개요

Flight는 프레임워크의 다양한 측면을 애플리케이션의 필요에 맞게 구성할 수 있는 간단한 방법을 제공합니다. 일부는 기본값으로 설정되어 있지만, 필요에 따라 이를 재정의할 수 있습니다. 또한 애플리케이션 전체에서 사용할 수 있는 자체 변수를 설정할 수도 있습니다.

이해

Flight의 특정 동작을 사용자 지정하려면 set 메서드를 통해 구성 값을 설정할 수 있습니다.

Flight::set('flight.log_errors', true);

app/config/config.php 파일에서 사용할 수 있는 모든 기본 구성 변수를 확인할 수 있습니다.

기본 사용법

Flight 구성 옵션

다음은 사용 가능한 모든 구성 설정 목록입니다:

로더 구성

로더에 대한 추가 구성 설정이 있습니다. 이는 클래스 이름에 _가 포함된 클래스를 자동 로드할 수 있게 합니다.

// 언더스코어를 사용한 클래스 로딩 활성화
// 기본값은 true
Loader::$v2ClassLoading = false;

변수

Flight는 애플리케이션의 어디서나 사용할 수 있도록 변수를 저장할 수 있게 합니다.

// 변수 저장
Flight::set('id', 123);

// 애플리케이션의 다른 곳에서
$id = Flight::get('id');

변수가 설정되었는지 확인하려면 다음을 할 수 있습니다:

if (Flight::has('id')) {
  // 무언가 수행
}

변수를 지우려면 다음을 할 수 있습니다:

// id 변수를 지움
Flight::clear('id');

// 모든 변수 지움
Flight::clear();

참고: 변수를 설정할 수 있다고 해서 반드시 설정해야 한다는 의미는 아닙니다. 이 기능을 절제해서 사용하세요. 이유는 여기에 저장된 모든 것이 전역 변수가 되기 때문입니다. 전역 변수는 애플리케이션의 어디서나 변경될 수 있어 버그를 추적하기 어렵게 만듭니다. 또한 단위 테스트와 같은 작업을 복잡하게 만들 수 있습니다.

오류 및 예외

모든 오류와 예외는 Flight에 의해 포착되어 error 메서드로 전달됩니다. flight.handle_errors가 true로 설정된 경우입니다.

기본 동작은 오류 정보와 함께 일반적인 HTTP 500 Internal Server Error 응답을 보내는 것입니다.

이 동작을 재정의하여 필요에 맞게 사용할 수 있습니다:

Flight::map('error', function (Throwable $error) {
  // 오류 처리
  echo $error->getTraceAsString();
});

기본적으로 오류는 웹 서버에 로깅되지 않습니다. 이를 활성화하려면 구성을 변경하세요:

Flight::set('flight.log_errors', true);

404 Not Found

URL을 찾을 수 없을 때 Flight는 notFound 메서드를 호출합니다. 기본 동작은 간단한 메시지와 함께 HTTP 404 Not Found 응답을 보내는 것입니다.

이 동작을 재정의하여 필요에 맞게 사용할 수 있습니다:

Flight::map('notFound', function () {
  // 찾을 수 없음 처리
});

관련 자료

문제 해결

변경 로그

Learn/ai

Flight와 함께하는 AI 및 개발자 경험

개요

Flight는 AI 기반 도구와 현대적인 개발자 워크플로우로 PHP 프로젝트를 쉽게 강화할 수 있게 해줍니다. LLM(대형 언어 모델) 제공자에 연결하는 내장 명령어와 프로젝트별 AI 코딩 지침을 생성하는 기능을 통해, Flight는 GitHub Copilot, Cursor, Windsurf와 같은 AI 어시스턴트에서 최대한의 이점을 얻도록 당신과 팀을 도와줍니다.

이해하기

AI 코딩 어시스턴트는 프로젝트의 맥락, 규칙, 목표를 이해할 때 가장 도움이 됩니다. Flight의 AI 도우미는 다음을 가능하게 합니다:

이 기능들은 Flight 코어 CLI와 공식 flightphp/skeleton 시작 프로젝트에 내장되어 있습니다.

기본 사용법

LLM 자격 증명 설정

ai:init 명령어는 프로젝트를 LLM 제공자에 연결하는 과정을 안내합니다.

php runway ai:init

다음으로 안내됩니다:

이로 인해 프로젝트 루트에 .runway-creds.json 파일이 생성되며 (.gitignore에 포함되도록 보장합니다).

예시:

Welcome to AI Init!
Which LLM API do you want to use? [1] openai, [2] grok, [3] claude: 1
Enter the base URL for the LLM API [https://api.openai.com]:
Enter your API key for openai: sk-...
Enter the model name you want to use (e.g. gpt-4, claude-3-opus, etc) [gpt-4o]:
Credentials saved to .runway-creds.json

프로젝트별 AI 지침 생성

ai:generate-instructions 명령어는 프로젝트에 맞춤형 AI 코딩 어시스턴트 지침을 생성하거나 업데이트하는 데 도움을 줍니다.

php runway ai:generate-instructions

프로젝트에 대한 몇 가지 질문(설명, 데이터베이스, 템플릿, 보안, 팀 규모 등)에 답변합니다. Flight는 LLM 제공자를 사용하여 지침을 생성한 후 다음에 작성합니다:

예시:

Please describe what your project is for? My awesome API
What database are you planning on using? MySQL
What HTML templating engine will you plan on using (if any)? latte
Is security an important element of this project? (y/n) y
...
AI instructions updated successfully.

이제 AI 도구는 프로젝트의 실제 요구사항에 기반한 더 스마트하고 관련성 있는 제안을 제공합니다.

고급 사용법

관련 자료

문제 해결

변경 로그

Learn/unit_testing_and_solid_principles

이 기사는 원래 2015년에 Airpair에서 출판되었습니다. 모든 크레딧은 Airpair와 원래 이 기사를 작성한 Brian Fenton에게 돌아갑니다. 웹사이트는 더 이상 이용할 수 없으며, 기사는 Wayback Machine 내에만 존재합니다. 이 기사는 PHP 커뮤니티의 학습 및 교육 목적으로 사이트에 추가되었습니다.

1 설정 및 구성

1.1 최신 상태 유지

가장 먼저 강조할 점은, 야생에서 사용되는 PHP 설치의 놀라울 정도로 적은 수가 최신 상태이거나 최신으로 유지된다는 것입니다. 이는 공유 호스팅 제한, 변경되지 않은 기본 설정, 또는 업그레이드 테스트를 위한 시간/예산 부족 때문일 수 있습니다. 그래서 가장 명확한 최선의 관행은 항상 PHP의 최신 버전(이 기사 작성 시 5.6.x)을 사용하는 것입니다. 게다가, PHP 자체와 사용 중인 확장이나 공급자 라이브러리의 정기적인 업그레이드를 계획하는 것도 중요합니다. 업그레이드는 새로운 언어 기능, 향상된 속도, 낮은 메모리 사용량, 그리고 보안 업데이트를 제공합니다. 업그레이드를 더 자주 수행할수록, 그 과정이 덜 고통스러워집니다.

1.2 합리적인 기본 설정

PHP는 php.ini.development 및 php.ini.production 파일을 통해 기본적으로 괜찮은 기본 설정을 제공하지만, 더 나아질 수 있습니다. 예를 들어, 날짜/시간대를 설정하지 않습니다. 이는 배포 관점에서 의미가 있지만, 설정되지 않으면 날짜/시간 관련 함수를 호출할 때마다 E_WARNING 오류가 발생합니다. 아래는 추천 설정입니다:

1.3 확장

사용하지 않을 확장(예: 데이터베이스 드라이버)은 비활성화하거나 활성화하지 않는 것이 좋습니다. 활성화된 확장을 확인하려면, phpinfo() 명령을 실행하거나 명령줄에서 실행하세요.

$ php -i

정보는 동일하지만, phpinfo()에는 HTML 형식이 추가됩니다. CLI 버전은 grep으로 특정 정보를 찾기 쉽습니다. 예:

$ php -i | grep error_log

이 방법의 주의점: 웹에 노출된 버전과 CLI 버전의 PHP 설정이 다를 수 있습니다.

2 Composer 사용

현대 PHP를 작성하는 최선의 관행 중 하나는 더 적게 작성하는 것입니다. 프로그래밍을 잘하기 위한 가장 좋은 방법은 실제로 해보는 것이지만, 라우팅, 기본 입력 유효성 검사 라이브러리, 단위 변환, 데이터베이스 추상화 레이어 등 이미 PHP 영역에서 해결된 많은 문제가 있습니다. Packagist에 가서 둘러보세요. 해결하려는 문제의 상당 부분이 이미 작성되고 테스트된 것을 발견할 수 있습니다.

모든 코드를 스스로 작성하는 유혹이 있을 수 있지만(학습 경험으로 자신의 프레임워크나 라이브러리를 작성하는 데 문제가 없음), Not Invented Here라는 감정을 억제하고 시간을 절약하세요. PIE 원칙을 따르세요 - Proudly Invented Elsewhere. 또한, 자신의 것을 작성하기로 선택했다면, 기존 제품과 크게 다르거나 더 나은 기능을 하지 않는 한 출시하지 마세요.

Composer는 PHP의 패키지 관리자로, Python의 pip, Ruby의 gem, Node의 npm과 유사합니다. JSON 파일을 정의하여 코드의 종속성을 나열하면, 필요한 코드 번들을 다운로드하고 설치하여 요구 사항을 해결합니다.

2.1 Composer 설치

이것이 로컬 프로젝트라고 가정하고, 현재 프로젝트 전용 Composer 인스턴스를 설치하세요. 프로젝트 디렉터리로 이동하여 실행하세요:

$ curl -sS https://getcomposer.org/installer | php

이 명령처럼 다운로드를 스크립트 해석기(sh, ruby, php 등)로 직접 전달하는 것은 보안 위험입니다. 설치 코드를 읽고 실행하기 전에 안심하세요.

편의를 위해 (composer install을 php composer.phar install보다 입력하기를 선호한다면), 전역으로 단일 Composer 복사본을 설치하려면 이 명령을 사용하세요:

$ mv composer.phar /usr/local/bin/composer
$ chmod +x composer

파일 권한에 따라 sudo를 사용해야 할 수 있습니다.

2.2 Composer 사용

Composer는 두 가지 주요 종속성 카테고리를 관리합니다: "require"와 "require-dev". "require"로 나열된 종속성은 모든 곳에 설치되지만, "require-dev" 종속성은 특별히 요청될 때만 설치됩니다. 보통 이것들은 활발한 개발 중에 사용되는 도구로, PHP_CodeSniffer와 같은 것입니다. 아래는 Guzzle, 인기 있는 HTTP 라이브러리를 설치하는 예입니다.

$ php composer.phar require guzzle/guzzle

개발 목적으로만 도구를 설치하려면, --dev 플래그를 추가하세요:

$ php composer.phar require --dev 'sebastian/phpcpd'

이것은 PHP Copy-Paste Detector를 개발 전용 종속성으로 설치합니다.

2.3 Install vs update

처음 composer install을 실행하면, composer.json 파일에 기반하여 필요한 라이브러리와 그 종속성을 설치합니다. 완료되면, composer는 composer.lock 파일을 생성합니다. 이 파일은 composer가 찾은 종속성과 그 정확한 버전, 해시를 포함합니다. 이후 composer install을 실행할 때, 이 잠금 파일을 확인하고 해당 정확한 버전을 설치합니다.

composer update은 다릅니다. composer.lock 파일(존재하는 경우)을 무시하고, _composer.json_의 제약 조건을 만족하는 가장 최신 버전의 각 종속성을 찾습니다. 완료되면 새 composer.lock 파일을 작성합니다.

2.4 Autoloading

composer install과 composer update은 autoloader를 생성하여, 방금 설치한 라이브러리를 사용하기 위한 필요한 파일의 위치를 PHP에 알려줍니다. 사용하려면, 이 줄을 추가하세요(보통 모든 요청에서 실행되는 부트스트랩 파일에):

require 'vendor/autoload.php';

3 좋은 디자인 원칙 따르기

3.1 SOLID

SOLID는 좋은 객체 지향 소프트웨어 디자인의 다섯 가지 핵심 원칙을 상기시키는 기억 장치입니다.

3.1.1 S - 단일 책임 원칙

이 원칙은 클래스가 하나의 책임만 가져야 하며, 다른 말로 하면 변경될 단 하나의 이유만 가져야 한다고 말합니다. 이는 작은 도구를 많이 사용하고 한 가지를 잘 수행하는 Unix 철학과 잘 맞습니다. 하나의 일만 하는 클래스는 테스트하고 디버그하기 훨씬 쉽고, 놀라움을 주지 않습니다. Validator 클래스의 메서드 호출이 DB 레코드를 업데이트하는 것을 원하지 않습니다. 아래는 ActiveRecord pattern에 기반한 애플리케이션에서 흔히 볼 수 있는 SRP 위반 예입니다.

class Person extends Model
{
    public $name;
    public $birthDate;
    protected $preferences;
    public function getPreferences() {}
    public function save() {}
}

이것은 기본적인 entity 모델입니다. 하지만 이 중 하나의 것이 여기에 속하지 않습니다. 엔티티 모델의 유일한 책임은 그것이 나타내는 엔티티와 관련된 행동일 뿐, 자신을 영속화하는 책임은 가져서는 안 됩니다.

class Person extends Model
{
    public $name;
    public $birthDate;
    protected $preferences;
    public function getPreferences() {}
}
class DataStore
{
    public function save(Model $model) {}
}

이것이 더 낫습니다. Person 모델은 하나의 일만 하고, 저장 행동은 영속성 객체로 이동되었습니다. 또한 Model만 타입 힌팅한 점에 주목하세요. L과 D 부분에서 다시 다룰 것입니다.

3.1.2 O - 개방 폐쇄 원칙

이 원칙을 요약하는 훌륭한 테스트가 있습니다: 구현할 기능, 아마도 최근에 작업한 또는 작업 중인 기능을 생각하세요. 기존 코드베이스에서 이 기능을 오직 새 클래스를 추가하는 것만으로, 기존 클래스를 변경하지 않고 구현할 수 있나요? 구성과 배선 코드는 약간 예외지만, 대부분의 시스템에서 이것은 놀라울 정도로 어렵습니다. 다형성 디스패치를 많이 의존해야 하며, 대부분의 코드베이스는 그렇게 설정되어 있지 않습니다. 관심이 있으시면, polymorphism and writing code without Ifs에 대한 좋은 Google 토크가 YouTube에 있습니다. 보너스로, 이 토크는 Miško Hevery, AngularJs의 제작자로 알려진 사람이 합니다.

3.1.3 L - Liskov 대체 원칙

이 원칙은 Barbara Liskov의 이름을 따서 명명되었으며, 아래와 같습니다:

"프로그램의 객체는 하위 타입의 인스턴스로 대체할 수 있어야 하며, 프로그램의 정확성을 변경하지 않아야 합니다."

이것은 잘 들리지만, 예를 통해 더 명확히 설명됩니다.

abstract class Shape
{
    public function getHeight();
    public function setHeight($height);
    public function getLength();
    public function setLength($length);
}

이것은 기본적인 네 변 모양을 나타냅니다. 특별한 것은 없습니다.

class Square extends Shape
{
    protected $size;
    public function getHeight() {
        return $this->size;
    }
    public function setHeight($height) {
        $this->size = $height;
    }
    public function getLength() {
        return $this->size;
    }
    public function setLength($length) {
        $this->size = $length;
    }
}

첫 번째 모양인 Square입니다. 간단한 모양입니다. 생성자가 차원을 설정한다고 가정할 수 있지만, 이 구현에서 길이와 높이가 항상 같다는 것을 볼 수 있습니다. Square는 그저 그렇습니다.

class Rectangle extends Shape
{
    protected $height;
    protected $length;
    public function getHeight() {
        return $this->height;
    }
    public function setHeight($height) {
        $this->height = $height;
    }
    public function getLength() {
        return $this->length;
    }
    public function setLength($length) {
        $this->length = $length;
    }
}

여기에는 다른 모양이 있습니다. 여전히 같은 메서드 서명이지만, 네 변 모양이지만, 서로 대체하려고 시작하면 어떨까요? 이제 Shape의 높이를 변경하면, 모양의 길이가 일치한다고 가정할 수 없게 됩니다. Square 모양을 제공할 때 사용자와 맺은 계약을 위반했습니다.

이것은 LSP 위반의 교과서적인 예이며, 타입 시스템을 최적으로 사용하기 위해 이 유형의 원칙이 필요합니다. duck typing조차도 기본 행동이 다르다는 것을 알려주지 않으며, 그것이 깨지는 것을 보지 않고는 알 수 없기 때문에, 처음부터 다르지 않도록 하는 것이 가장 좋습니다.

3.1.3 I - 인터페이스 분리 원칙

이 원칙은 하나의 큰 인터페이스보다 많은 작은, 세밀한 인터페이스를 선호합니다. 인터페이스는 "이 클래스 중 하나"가 아닌 행동에 기반해야 합니다. PHP에 포함된 인터페이스를 생각하세요. Traversable, Countable, Serializable 등입니다. 그것들은 객체가 가진 능력을 광고할 뿐, 상속된 것이 아닙니다. 그래서 인터페이스를 작게 유지하세요. 30개의 메서드가 있는 인터페이스를 원하지 않습니다. 3개가 더 좋은 목표입니다.

3.1.4 D - 의존성 역전 원칙

이것은 Dependency Injection에 대해 다른 곳에서 들어보셨을 수 있지만, 의존성 역전과 의존성 주입은 완전히 같은 것이 아닙니다. 의존성 역전은 시스템의 세부 사항이 아닌 추상화에 의존해야 한다고 말합니다. 일상적으로 이것이 무엇을 의미하나요?

코드 전체에 mysqli_query()를 직접 사용하지 말고, DataStore->query() 같은 것을 사용하세요.

이 원칙의 핵심은 추상화에 관한 것입니다. "데이터베이스 어댑터 사용"이라고 말하는 것처럼, mysqli_query 같은 직접 호출에 의존하지 마세요. mysqli_query를 절반의 클래스에서 직접 사용하면, 모든 것을 데이터베이스에 직접 연결합니다. MySQL에 대해 긍정적이거나 부정적인 것이 아니지만, 이 유형의 낮은 수준 세부 사항은 한 곳에 숨겨져야 하며, 그 기능은 일반적인 래퍼를 통해 노출되어야 합니다.

이것이 다소 진부한 예일 수 있지만, 제품을 프로덕션에 배포한 후 데이터베이스 엔진을 완전히 변경하는 경우는 매우 드물기 때문에 선택했습니다. 또한, 고정된 데이터베이스를 사용하더라도, 그 추상 래퍼 객체는 버그 수정, 행동 변경, 또는 원하는 기능을 구현할 수 있게 합니다. 또한, 낮은 수준 호출에서는 불가능한 단위 테스트를 가능하게 합니다.

4 객체 캘리세니즘

이 원칙에 대한 완전한 다이빙은 아니지만, 처음 두 가지는 쉽게 기억할 수 있고, 좋은 가치를 제공하며, 거의 모든 코드베이스에 즉시 적용할 수 있습니다.

4.1 메서드당 들여쓰기 레벨 하나만

이것은 메서드를 더 작은 청크로 분해하여, 더 명확하고 자문서화된 코드를 남기는 데 도움이 됩니다. 들여쓰기 레벨이 많을수록, 메서드가 더 많은 일을 하고, 작업 중에 추적해야 할 상태가 많아집니다.

바로 사람들은 이 점에 반대할 수 있지만, 이것은 가이드라인/휴리스틱일 뿐, 엄격한 규칙이 아닙니다. PHP_CodeSniffer 규칙을 이로 강제할 생각은 없습니다(비록 사람들이 했지만).

빠른 샘플을 실행해 보겠습니다:

public function transformToCsv($data)
{
    $csvLines = array();
    $csvLines[] = implode(',', array_keys($data[0]));
    foreach ($data as $row) {
        if (!$row) {
            continue;
        }
        $csvLines[] = implode(',', $row);
    }
    return $csvLines;
}

이 코드는 나쁘지 않지만(기술적으로 올바르고, 테스트 가능 등), 더 명확하게 만들 수 있습니다. 여기서 중첩 레벨을 줄이기 위해 어떻게 할까요?

먼저 foreach 루프의 내용을 간단히 해야 합니다(또는 완전히 제거).

if (!$row) {
    continue;
}

이 부분은 쉽습니다. 비어 있는 행을 무시하는 것뿐입니다. 루프에 도달하기 전에 내장 PHP 함수를 사용하여 이 과정을 단축할 수 있습니다.

$data = array_filter($data);
foreach ($data as $row) {
    $csvLines[] = implode(',', $row);
}

이제 단일 중첩 레벨이 있습니다. 하지만 이것을 보면, 배열의 각 항목에 함수를 적용하는 것뿐입니다. foreach 루프조차 필요하지 않습니다.

$data = array_filter($data);
$csvLines = array_map(function($row) {
    return implode(',', $row);
}, $data);

이제 중첩이 전혀 없고, 코드는 더 빠를 수 있습니다. 루핑을 네이티브 C 함수로 하기 때문입니다. 쉼표를 implode에 전달하기 위해 약간의 트릭을 사용해야 하지만, 이전 단계에서 멈추는 것이 더 이해하기 쉽다고 주장할 수 있습니다.

4.2 else 사용 피하기

이것은 두 가지 주요 아이디어를 다룹니다. 첫 번째는 메서드에서 여러 반환 문입니다. 메서드의 결과를 결정할 충분한 정보가 있으면, 그 결정 후 반환하세요. 두 번째는 Guard Clauses로 알려진 아이디어입니다. 이것은 기본적으로 메서드 상단 근처에서 검증 검사와 조기 반환을 결합합니다. 보여드리겠습니다.

public function addThreeInts($first, $second, $third) {
    if (is_int($first)) {
        if (is_int($second)) {
            if (is_int($third)) {
                $sum = $first + $second + $third;
            } else {
                return null;
            }
        } else {
            return null;
        }
    } else {
        return null;
    }
    return $sum;
}

이것은 간단합니다. 3개의 정수를 더하고 결과를 반환하거나, 매개변수가 정수가 아니면 null을 반환합니다. AND 연산자로 모든 검사를 한 줄에 결합할 수 있지만, 중첩 if/else 구조가 코드를 따라가기 더 어렵다는 것을 볼 수 있습니다. 이제 이 예를 보세요.

public function addThreeInts($first, $second, $third) {
    if (!is_int($first)) {
        return null;
    }
    if (!is_int($second)) {
        return null;
    }
    if (!is_int($third)) {
        return null;
    }
    return $first + $second + $third;
}

이 예는 훨씬 따라가기 쉽습니다. 여기서 guard clauses를 사용하여 매개변수에 대한 초기 주장을 검증하고, 통과하지 않으면 메서드를 즉시 종료합니다. 또한 합계를 추적하는 중간 변수를 더 이상 가지지 않습니다. 이미 행복한 경로에 있음을 확인했으므로, 할 일을 하세요. 모든 검사를 하나의 if로 할 수 있지만, 원칙은 명확합니다.

5 단위 테스트

단위 테스트는 코드의 행동을 확인하는 작은 테스트를 작성하는 관행입니다. 거의 항상 코드와 같은 언어(이 경우 PHP)로 작성되며, 언제든지 실행할 수 있을 만큼 빠릅니다. 코드 개선을 위한 매우 유용한 도구입니다. 코드가 예상대로 작동하는지 확인하는 명백한 이점 외에도, 단위 테스트는 디자인 피드백을 제공할 수 있습니다. 테스트하기 어려운 코드 조각은 종종 디자인 문제를 드러냅니다. 또한 회귀에 대한 안전망을 제공하여, 더 자주 리팩터링하고 코드를 더 깨끗한 디자인으로 진화시킬 수 있습니다.

5.1 도구

PHP에는 여러 단위 테스트 도구가 있지만, 단연코 가장 일반적인 것은 PHPUnit입니다. PHAR 파일을 직접 다운로드하거나, composer로 설치할 수 있습니다. 다른 모든 것에 composer를 사용하므로, 그 방법을 보여드리겠습니다. 또한, PHPUnit는 프로덕션에 배포되지 않을 가능성이 크므로, dev 종속성으로 설치하세요:

composer require --dev phpunit/phpunit

5.2 테스트는 사양

코드의 단위 테스트에서 가장 중요한 역할은 코드가 해야 할 일을 실행 가능한 사양으로 제공하는 것입니다. 테스트 코드가 잘못되었거나 코드에 버그가 있더라도, 시스템이 해야 할 일에 대한 지식은 귀중합니다.

5.3 먼저 테스트 작성

코드 전에 테스트를 작성한 경우와 코드 후에 작성한 경우를 본 적이 있다면, 그 차이가 뚜렷합니다. "후" 테스트는 클래스의 구현 세부 사항에 훨씬 더 관심이 있고, 좋은 라인 커버리지를 확보하는 데 초점을 맞춥니다. 반면, "전" 테스트는 원하는 외부 행동을 확인하는 데 더 관심이 있습니다. 이것이 단위 테스트에서 실제로 원하는 것입니다. 클래스 내부가 변경되면 구현 중심 테스트는 리팩터링을 더 어렵게 만듭니다.

5.4 좋은 단위 테스트의 특징

좋은 단위 테스트는 다음과 같은 특징을 공유합니다:

이 중 일부를 위반할 이유가 있지만, 일반적인 지침으로 유용합니다.

5.5 테스트가 고통스러울 때

단위 테스트는 나쁜 디자인의 고통을 앞당겨 느끼게 합니다 - Michael Feathers

단위 테스트를 작성할 때, 클래스를 실제로 사용해야 합니다. 테스트를 끝에 작성하거나, 더 나쁘게는 QA나 누구에게 코드 던지면, 클래스의 실제 행동에 대한 피드백을 얻지 못합니다. 테스트를 작성 중이고 클래스가 사용하기 어려우면, 작성 중에 알 수 있습니다. 이것은 거의 가장 저렴한 수정 시기입니다.

클래스가 테스트하기 어렵다면, 디자인 결함입니다. 다른 결함이 다르게 나타나지만, mocking을 많이 해야 한다면 클래스가 너무 많은 종속성을 가지거나 메서드가 너무 많은 일을 할 수 있습니다. 각 테스트에 많은 설정을 해야 한다면, 메서드가 너무 많은 일을 할 가능성이 큽니다. 행동을 실행하기 위해 복잡한 테스트 시나리오를 작성해야 한다면, 클래스의 메서드가 너무 많은 일을 할 수 있습니다. 사적인 메서드와 상태를 테스트하기 위해 파고들어야 한다면, 다른 클래스가 나오려고 할 수 있습니다. 단위 테스트는 "iceberg classes"를 드러내는 데 매우 좋습니다. 클래스의 80%가 보호되거나 사적인 코드에 숨겨져 있습니다. 이전에 가능한 한 많이 보호하는 것을 좋아했지만, 이제 각 클래스가 너무 많은 책임을 지고 있다는 것을 깨달았고, 진짜 해결책은 클래스를 더 작은 조각으로 나누는 것입니다.

Brian Fenton 작성 - Brian Fenton은 중서부와 Bay Area에서 8년 동안 PHP 개발자였으며, 현재 Thismoment에 있습니다. 그는 코드 장인 정신과 디자인 원칙에 초점을 맞춥니다. 블로그 www.brianfenton.us, Twitter @brianfenton. 아이를 키우는 데 바쁘지 않을 때는 음식, 맥주, 게임, 학습을 즐깁니다.

Learn/security

보안

개요

웹 애플리케이션에서 보안은 매우 중요한 문제입니다. 애플리케이션이 안전하고 사용자 데이터가 보호되도록 해야 합니다. Flight는 웹 애플리케이션을 보호하는 데 도움이 되는 여러 기능을 제공합니다.

이해

웹 애플리케이션을 구축할 때 인지해야 할 일반적인 보안 위협이 여러 가지 있습니다. 가장 일반적인 위협 중 일부는 다음과 같습니다:

Templates는 XSS를 방지하기 위해 기본적으로 출력을 이스케이프하므로 이를 기억할 필요가 없습니다. Sessions은 아래에 설명된 대로 사용자의 세션에 CSRF 토큰을 저장하여 CSRF를 방지하는 데 도움이 됩니다. PDO와 함께 준비된 문장을 사용하면 SQL 인젝션 공격을 방지할 수 있습니다(또는 PdoWrapper 클래스에서 편리한 메서드를 사용). CORS는 Flight::start()가 호출되기 전에 간단한 훅으로 처리할 수 있습니다.

이러한 모든 방법이 함께 작동하여 웹 애플리케이션을 안전하게 유지하는 데 도움이 됩니다. 보안 모범 사례를 배우고 이해하는 것이 항상 최우선이 되어야 합니다.

기본 사용법

헤더

HTTP 헤더는 웹 애플리케이션을 보호하는 가장 쉬운 방법 중 하나입니다. 클릭재킹, XSS 및 기타 공격을 방지하기 위해 헤더를 사용할 수 있습니다. 이러한 헤더를 애플리케이션에 추가하는 방법은 여러 가지가 있습니다.

헤더의 보안을 확인할 수 있는 훌륭한 웹사이트 두 곳은 securityheaders.com과 observatory.mozilla.org입니다. 아래 코드를 설정한 후, 이 두 웹사이트에서 헤더가 작동하는지 쉽게 확인할 수 있습니다.

수동 추가

Flight\Response 객체의 header 메서드를 사용하여 이러한 헤더를 수동으로 추가할 수 있습니다.

// 클릭재킹을 방지하기 위해 X-Frame-Options 헤더 설정
Flight::response()->header('X-Frame-Options', 'SAMEORIGIN');

// XSS를 방지하기 위해 Content-Security-Policy 헤더 설정
// 주의: 이 헤더는 매우 복잡할 수 있으므로, 애플리케이션에 맞는 인터넷 예제를 참조하세요
Flight::response()->header("Content-Security-Policy", "default-src 'self'");

// XSS를 방지하기 위해 X-XSS-Protection 헤더 설정
Flight::response()->header('X-XSS-Protection', '1; mode=block');

// MIME 스니핑을 방지하기 위해 X-Content-Type-Options 헤더 설정
Flight::response()->header('X-Content-Type-Options', 'nosniff');

// 참조자 정보 전송을 제어하기 위해 Referrer-Policy 헤더 설정
Flight::response()->header('Referrer-Policy', 'no-referrer-when-downgrade');

// HTTPS 강제 설정을 위해 Strict-Transport-Security 헤더 설정
Flight::response()->header('Strict-Transport-Security', 'max-age=31536000; includeSubDomains; preload');

// 사용 가능한 기능과 API를 제어하기 위해 Permissions-Policy 헤더 설정
Flight::response()->header('Permissions-Policy', 'geolocation=()');

이것들은 routes.php 또는 index.php 파일의 상단에 추가할 수 있습니다.

필터로 추가

다음과 같은 필터/훅에서 추가할 수도 있습니다: 

// 필터에서 헤더 추가
Flight::before('start', function() {
    Flight::response()->header('X-Frame-Options', 'SAMEORIGIN');
    Flight::response()->header("Content-Security-Policy", "default-src 'self'");
    Flight::response()->header('X-XSS-Protection', '1; mode=block');
    Flight::response()->header('X-Content-Type-Options', 'nosniff');
    Flight::response()->header('Referrer-Policy', 'no-referrer-when-downgrade');
    Flight::response()->header('Strict-Transport-Security', 'max-age=31536000; includeSubDomains; preload');
    Flight::response()->header('Permissions-Policy', 'geolocation=()');
});

미들웨어로 추가

이것들을 미들웨어 클래스에 추가할 수도 있습니다. 이는 어떤 경로에 적용할지 가장 큰 유연성을 제공합니다. 일반적으로 이러한 헤더는 모든 HTML 및 API 응답에 적용되어야 합니다.

// app/middlewares/SecurityHeadersMiddleware.php

namespace app\middlewares;

use flight\Engine;

class SecurityHeadersMiddleware
{
    protected Engine $app;

    public function __construct(Engine $app)
    {
        $this->app = $app;
    }

    public function before(array $params): void
    {
        $response = $this->app->response();
        $response->header('X-Frame-Options', 'SAMEORIGIN');
        $response->header("Content-Security-Policy", "default-src 'self'");
        $response->header('X-XSS-Protection', '1; mode=block');
        $response->header('X-Content-Type-Options', 'nosniff');
        $response->header('Referrer-Policy', 'no-referrer-when-downgrade');
        $response->header('Strict-Transport-Security', 'max-age=31536000; includeSubDomains; preload');
        $response->header('Permissions-Policy', 'geolocation=()');
    }
}

// index.php 또는 경로가 있는 곳
// 참고: 이 빈 문자열 그룹은 모든 경로에 대한 전역 미들웨어로 작동합니다.
// 물론 특정 경로에만 추가할 수도 있습니다.
Flight::group('', function(Router $router) {
    $router->get('/users', [ 'UserController', 'getUsers' ]);
    // 더 많은 경로
}, [ SecurityHeadersMiddleware::class ]);

Cross Site Request Forgery (CSRF)

Cross Site Request Forgery (CSRF)는 악성 웹사이트가 사용자의 브라우저를 통해 웹사이트에 요청을 보내는 공격 유형입니다. 이것은 사용자의 지식 없이 웹사이트에서 작업을 수행하는 데 사용될 수 있습니다. Flight는 내장된 CSRF 보호 메커니즘을 제공하지 않지만, 미들웨어를 사용하여 쉽게 구현할 수 있습니다.

설정

먼저 CSRF 토큰을 생성하고 사용자의 세션에 저장해야 합니다. 그런 다음 이 토큰을 폼에 사용하고 폼이 제출될 때 확인할 수 있습니다. 세션을 관리하기 위해 flightphp/session 플러그인을 사용하겠습니다.

// CSRF 토큰 생성 및 사용자 세션에 저장
// (Flight에 세션 객체를 생성하고 연결했다고 가정)
// 더 많은 정보는 세션 문서를 참조하세요
Flight::register('session', flight\Session::class);

// 세션당 하나의 토큰만 생성하면 됩니다 (같은 사용자의 여러 탭 및 요청에서 작동)
if(Flight::session()->get('csrf_token') === null) {
    Flight::session()->set('csrf_token', bin2hex(random_bytes(32)) );
}
기본 PHP Flight 템플릿 사용
<!-- 폼에서 CSRF 토큰 사용 -->
<form method="post">
    <input type="hidden" name="csrf_token" value="<?= Flight::session()->get('csrf_token') ?>">
    <!-- 다른 폼 필드 -->
</form>
Latte 사용

Latte 템플릿에서 CSRF 토큰을 출력하는 사용자 정의 함수를 설정할 수도 있습니다.


Flight::map('render', function(string $template, array $data, ?string $block): void {
    $latte = new Latte\Engine;

    // 다른 구성...

    // CSRF 토큰을 출력하는 사용자 정의 함수 설정
    $latte->addFunction('csrf', function() {
        $csrfToken = Flight::session()->get('csrf_token');
        return new \Latte\Runtime\Html('<input type="hidden" name="csrf_token" value="' . $csrfToken . '">');
    });

    $latte->render($finalPath, $data, $block);
});

이제 Latte 템플릿에서 csrf() 함수를 사용하여 CSRF 토큰을 출력할 수 있습니다.

<form method="post">
    {csrf()}
    <!-- 다른 폼 필드 -->
</form>

CSRF 토큰 확인

여러 방법으로 CSRF 토큰을 확인할 수 있습니다.

미들웨어
// app/middlewares/CsrfMiddleware.php

namespace app\middleware;

use flight\Engine;

class CsrfMiddleware
{
    protected Engine $app;

    public function __construct(Engine $app)
    {
        $this->app = $app;
    }

    public function before(array $params): void
    {
        if($this->app->request()->method == 'POST') {
            $token = $this->app->request()->data->csrf_token;
            if($token !== $this->app->session()->get('csrf_token')) {
                $this->app->halt(403, 'Invalid CSRF token');
            }
        }
    }
}

// index.php 또는 경로가 있는 곳
use app\middlewares\CsrfMiddleware;

Flight::group('', function(Router $router) {
    $router->get('/users', [ 'UserController', 'getUsers' ]);
    // 더 많은 경로
}, [ CsrfMiddleware::class ]);
이벤트 필터
// 이 미들웨어는 요청이 POST인지 확인하고, 그렇다면 CSRF 토큰이 유효한지 확인합니다
Flight::before('start', function() {
    if(Flight::request()->method == 'POST') {

        // 폼 값에서 CSRF 토큰 캡처
        $token = Flight::request()->data->csrf_token;
        if($token !== Flight::session()->get('csrf_token')) {
            Flight::halt(403, 'Invalid CSRF token');
            // 또는 JSON 응답의 경우
            Flight::jsonHalt(['error' => 'Invalid CSRF token'], 403);
        }
    }
});

Cross Site Scripting (XSS)

Cross Site Scripting (XSS)는 악성 폼 입력이 웹사이트에 코드를 주입할 수 있는 공격 유형입니다. 이러한 기회는 대부분 최종 사용자가 채우는 폼 값에서 발생합니다. 사용자 출력은 절대 신뢰하지 마세요! 그들이 세계 최고의 해커라고 항상 가정하세요. 그들은 페이지에 악성 JavaScript 또는 HTML을 주입할 수 있습니다. 이 코드는 사용자 정보를 훔치거나 웹사이트에서 작업을 수행하는 데 사용될 수 있습니다. Flight의 뷰 클래스나 Latte와 같은 다른 템플릿 엔진을 사용하면 출력을 이스케이프하여 XSS 공격을 쉽게 방지할 수 있습니다.

// 사용자가 영리하게 이름으로 이것을 사용하려고 한다고 가정
$name = '<script>alert("XSS")</script>';

// 이 출력은 이스케이프됩니다
Flight::view()->set('name', $name);
// 출력: &lt;script&gt;alert(&quot;XSS&quot;)&lt;/script&gt;

// 뷰 클래스로 등록된 Latte와 같은 것을 사용하면 이것도 자동으로 이스케이프됩니다.
Flight::view()->render('template', ['name' => $name]);

SQL Injection

SQL Injection은 악성 사용자가 데이터베이스에 SQL 코드를 주입할 수 있는 공격 유형입니다. 이것은 데이터베이스에서 정보를 훔치거나 데이터베이스에서 작업을 수행하는 데 사용될 수 있습니다. 다시 사용자 입력은 절대 신뢰하지 마세요! 그들이 피를 갈구한다고 항상 가정하세요. PDO 객체에서 준비된 문장을 사용하면 SQL 인젝션을 방지할 수 있습니다.

// Flight::db()가 PDO 객체로 등록되어 있다고 가정
$statement = Flight::db()->prepare('SELECT * FROM users WHERE username = :username');
$statement->execute([':username' => $username]);
$users = $statement->fetchAll();

// PdoWrapper 클래스를 사용하면 한 줄로 쉽게 할 수 있습니다
$users = Flight::db()->fetchAll('SELECT * FROM users WHERE username = :username', [ 'username' => $username ]);

// ? 플레이스홀더로 PDO 객체와 동일한 작업을 할 수 있습니다
$statement = Flight::db()->fetchAll('SELECT * FROM users WHERE username = ?', [ $username ]);

비보안 예제

아래는 SQL 준비된 문장을 사용하여 다음과 같은 무해한 예로부터 보호하는 이유입니다:

// 최종 사용자가 웹 폼을 채웁니다.
// 폼 값으로 해커가 이런 것을 입력합니다:
$username = "' OR 1=1; -- ";

$sql = "SELECT * FROM users WHERE username = '$username' LIMIT 5";
$users = Flight::db()->fetchAll($sql);
// 쿼리가 빌드된 후 이렇게 보입니다
// SELECT * FROM users WHERE username = '' OR 1=1; -- LIMIT 5

// 이상해 보이지만 유효한 쿼리이며 작동합니다. 실제로,
// 모든 사용자를 반환하는 매우 일반적인 SQL 인젝션 공격입니다.

var_dump($users); // 데이터베이스의 모든 사용자를 덤프합니다, 단일 사용자 이름만이 아닙니다

CORS

Cross-Origin Resource Sharing (CORS)는 웹 페이지에서 리소스(예: 폰트, JavaScript 등)가 원본 도메인 외부의 다른 도메인에서 요청될 수 있도록 하는 메커니즘입니다. Flight에는 내장된 기능이 없지만, Flight::start() 메서드가 호출되기 전에 실행되는 훅으로 쉽게 처리할 수 있습니다.

// app/utils/CorsUtil.php

namespace app\utils;

class CorsUtil
{
    public function set(array $params): void
    {
        $request = Flight::request();
        $response = Flight::response();
        if ($request->getVar('HTTP_ORIGIN') !== '') {
            $this->allowOrigins();
            $response->header('Access-Control-Allow-Credentials', 'true');
            $response->header('Access-Control-Max-Age', '86400');
        }

        if ($request->method === 'OPTIONS') {
            if ($request->getVar('HTTP_ACCESS_CONTROL_REQUEST_METHOD') !== '') {
                $response->header(
                    'Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD'
                );
            }
            if ($request->getVar('HTTP_ACCESS_CONTROL_REQUEST_HEADERS') !== '') {
                $response->header(
                    "Access-Control-Allow-Headers",
                    $request->getVar('HTTP_ACCESS_CONTROL_REQUEST_HEADERS')
                );
            }

            $response->status(200);
            $response->send();
            exit;
        }
    }

    private function allowOrigins(): void
    {
        // 허용된 호스트를 여기에 사용자 지정하세요.
        $allowed = [
            'capacitor://localhost',
            'ionic://localhost',
            'http://localhost',
            'http://localhost:4200',
            'http://localhost:8080',
            'http://localhost:8100',
        ];

        $request = Flight::request();

        if (in_array($request->getVar('HTTP_ORIGIN'), $allowed, true) === true) {
            $response = Flight::response();
            $response->header("Access-Control-Allow-Origin", $request->getVar('HTTP_ORIGIN'));
        }
    }
}

// index.php 또는 경로가 있는 곳
$CorsUtil = new CorsUtil();

// start가 실행되기 전에 실행되어야 합니다.
Flight::before('start', [ $CorsUtil, 'setupCors' ]);

오류 처리

프로덕션에서 민감한 오류 세부 정보를 숨겨 공격자에게 정보를 유출하지 마세요. 프로덕션에서 display_errors를 0으로 설정하고 오류를 표시하는 대신 로그를 기록하세요.

// bootstrap.php 또는 index.php에서

// app/config/config.php에 이것을 추가하세요
$environment = ENVIRONMENT;
if ($environment === 'production') {
    ini_set('display_errors', 0); // 오류 표시 비활성화
    ini_set('log_errors', 1);     // 오류 로그 기록
    ini_set('error_log', '/path/to/error.log');
}

// 경로 또는 컨트롤러에서
// 제어된 오류 응답을 위해 Flight::halt() 사용
Flight::halt(403, 'Access denied');

입력 정제

사용자 입력을 절대 신뢰하지 마세요. 악성 데이터가 스며드는 것을 방지하기 위해 처리 전에 filter_var를 사용하여 정제하세요.


// $_POST 요청에 $_POST['input']과 $_POST['email']이 있다고 가정

// 문자열 입력 정제
$clean_input = filter_var(Flight::request()->data->input, FILTER_SANITIZE_STRING);
// 이메일 정제
$clean_email = filter_var(Flight::request()->data->email, FILTER_SANITIZE_EMAIL);

비밀번호 해싱

비밀번호를 안전하게 저장하고 PHP의 내장 함수인 password_hash와 password_verify를 사용하여 안전하게 확인하세요. 비밀번호는 평문으로 저장해서는 안 되며, 가역적인 방법으로 암호화해서도 안 됩니다. 해싱은 데이터베이스가 손상되더라도 실제 비밀번호가 보호되도록 합니다.

$password = Flight::request()->data->password;
// 저장 시(예: 등록 중) 비밀번호 해싱
$hashed_password = password_hash($password, PASSWORD_DEFAULT);

// 비밀번호 확인(예: 로그인 중)
if (password_verify($password, $stored_hash)) {
    // 비밀번호 일치
}

속도 제한

캐시를 사용하여 요청 속도를 제한하여 무차별 대입 공격이나 서비스 거부 공격으로부터 보호하세요.

// flightphp/cache가 설치되고 등록되어 있다고 가정
// 필터에서 flightphp/cache 사용
Flight::before('start', function() {
    $cache = Flight::cache();
    $ip = Flight::request()->ip;
    $key = "rate_limit_{$ip}";
    $attempts = (int) $cache->retrieve($key);

    if ($attempts >= 10) {
        Flight::halt(429, 'Too many requests');
    }

    $cache->set($key, $attempts + 1, 60); // 60초 후 재설정
});

관련 항목

문제 해결

변경 로그

Learn/routing

라우팅

개요

Flight PHP의 라우팅은 URL 패턴을 콜백 함수나 클래스 메서드에 매핑하여 빠르고 간단한 요청 처리를 가능하게 합니다. 이는 최소한의 오버헤드, 초보자 친화적인 사용, 그리고 외부 의존성 없이 확장성을 위해 설계되었습니다.

이해

라우팅은 Flight에서 HTTP 요청을 애플리케이션 로직에 연결하는 핵심 메커니즘입니다. 라우트를 정의함으로써 서로 다른 URL이 함수, 클래스 메서드 또는 컨트롤러 액션을 통해 특정 코드를 트리거하는 방식을 지정할 수 있습니다. Flight의 라우팅 시스템은 유연하며, 기본 패턴, 명명된 매개변수, 정규 표현식, 그리고 의존성 주입 및 리소스 라우팅과 같은 고급 기능을 지원합니다. 이 접근 방식은 코드를 체계적으로 유지하고 유지보수를 용이하게 하며, 초보자에게는 빠르고 간단하며 고급 사용자에게는 확장 가능합니다.

참고: 라우팅에 대해 더 알고 싶으신가요? 더 자세한 설명을 위해 "왜 프레임워크인가?" 페이지를 확인하세요.

기본 사용법

간단한 라우트 정의

Flight의 기본 라우팅은 URL 패턴을 콜백 함수나 클래스와 메서드의 배열로 매칭하여 수행됩니다.

Flight::route('/', function(){
    echo 'hello world!';
});

라우트는 정의된 순서대로 매칭됩니다. 요청과 일치하는 첫 번째 라우트가 호출됩니다.

콜백으로 함수 사용

콜백은 호출 가능한 모든 객체일 수 있습니다. 따라서 일반 함수를 사용할 수 있습니다:

function hello() {
    echo 'hello world!';
}

Flight::route('/', 'hello');

컨트롤러로 클래스와 메서드 사용

클래스의 메서드(정적 또는 비정적)를 사용할 수도 있습니다:

class GreetingController {
    public function hello() {
        echo 'hello world!';
    }
}

Flight::route('/', [ 'GreetingController','hello' ]);
// 또는
Flight::route('/', [ GreetingController::class, 'hello' ]); // 선호하는 방법
// 또는
Flight::route('/', [ 'GreetingController::hello' ]);
// 또는 
Flight::route('/', [ 'GreetingController->hello' ]);

먼저 객체를 생성한 후 메서드를 호출하는 방식도 있습니다:

use flight\Engine;

// GreetingController.php
class GreetingController
{
    protected Engine $app
    public function __construct(Engine $app) {
        $this->app = $app;
        $this->name = 'John Doe';
    }

    public function hello() {
        echo "Hello, {$this->name}!";
    }
}

// index.php
$app = Flight::app();
$greeting = new GreetingController($app);

Flight::route('/', [ $greeting, 'hello' ]);

참고: 프레임워크 내에서 컨트롤러가 호출될 때 기본적으로 flight\Engine 클래스가 항상 주입됩니다. 의존성 주입 컨테이너를 통해 지정하지 않는 한 예외입니다.

메서드별 라우팅

기본적으로 라우트 패턴은 모든 요청 메서드에 대해 매칭됩니다. URL 앞에 식별자를 배치하여 특정 메서드에 응답할 수 있습니다.

Flight::route('GET /', function () {
  echo 'I received a GET request.';
});

Flight::route('POST /', function () {
  echo 'I received a POST request.';
});

// Flight::get()은 라우트를 생성하는 메서드가 아니므로 라우트에 사용할 수 없습니다.
//    변수 가져오기 메서드입니다.
Flight::post('/', function() { /* code */ });
Flight::patch('/', function() { /* code */ });
Flight::put('/', function() { /* code */ });
Flight::delete('/', function() { /* code */ });

| 구분자를 사용하여 여러 메서드를 단일 콜백에 매핑할 수도 있습니다:

Flight::route('GET|POST /', function () {
  echo 'I received either a GET or a POST request.';
});

HEAD 및 OPTIONS 요청에 대한 특별 처리

Flight는 HEAD 및 OPTIONS HTTP 요청에 대한 내장 처리를 제공합니다:

HEAD 요청

Flight::route('GET /info', function() {
    echo 'This is some info!';
});
// /info에 대한 HEAD 요청은 동일한 헤더를 반환하지만 본문은 없습니다.

OPTIONS 요청

OPTIONS 요청은 정의된 모든 라우트에 대해 Flight가 자동으로 처리합니다.

// 다음과 같이 정의된 라우트의 경우:
Flight::route('GET|POST /users', function() { /* ... */ });

// /users에 대한 OPTIONS 요청은 다음과 같이 응답합니다:
//
// Status: 204 No Content
// Allow: GET, POST, HEAD, OPTIONS

라우터 객체 사용

또한 라우터 객체를 가져와서 사용할 수 있으며, 이는 몇 가지 도우미 메서드를 제공합니다:

$router = Flight::router();

// Flight::route()와 동일하게 모든 메서드를 매핑
$router->map('/', function() {
    echo 'hello world!';
});

// GET 요청
$router->get('/users', function() {
    echo 'users';
});
$router->post('/users',             function() { /* code */});
$router->put('/users/update/@id',   function() { /* code */});
$router->delete('/users/@id',       function() { /* code */});
$router->patch('/users/@id',        function() { /* code */});

정규 표현식 (Regex)

라우트에서 정규 표현식을 사용할 수 있습니다:

Flight::route('/user/[0-9]+', function () {
  // 이는 /user/1234와 매칭됩니다.
});

이 방법은 사용 가능하지만, 더 읽기 쉽고 유지보수가 용이하므로 명명된 매개변수 또는 정규 표현식을 사용한 명명된 매개변수를 사용하는 것이 권장됩니다.

명명된 매개변수

라우트에 명명된 매개변수를 지정하면 콜백 함수로 전달됩니다. 이는 라우트의 가독성을 위한 것이며, 아래 중요한 주의사항 섹션을 참조하세요.

Flight::route('/@name/@id', function (string $name, string $id) {
  echo "hello, $name ($id)!";
});

: 구분자를 사용하여 명명된 매개변수에 정규 표현식을 포함할 수도 있습니다:

Flight::route('/@name/@id:[0-9]{3}', function (string $name, string $id) {
  // 이는 /bob/123과 매칭됩니다.
  // 하지만 /bob/12345와는 매칭되지 않습니다.
});

참고: 위치 매개변수와 함께 regex 그룹 () 매칭은 지원되지 않습니다. 예: :'\(

중요한 주의사항

위 예시에서 @name이 변수 $name에 직접 연결된 것처럼 보이지만, 그렇지 않습니다. 콜백 함수의 매개변수 순서가 전달되는 것을 결정합니다. 콜백 함수의 매개변수 순서를 변경하면 변수도 변경됩니다. 다음은 예시입니다:

Flight::route('/@name/@id', function (string $id, string $name) {
  echo "hello, $name ($id)!";
});

다음 URL로 이동하면 /bob/123의 출력은 hello, 123 (bob)!가 됩니다. 라우트와 콜백 함수를 설정할 때 주의하세요!

선택적 매개변수

세그먼트를 괄호로 감싸서 매칭에 선택적인 명명된 매개변수를 지정할 수 있습니다.

Flight::route(
  '/blog(/@year(/@month(/@day)))',
  function(?string $year, ?string $month, ?string $day) {
    // 이는 다음 URL과 매칭됩니다:
    // /blog/2012/12/10
    // /blog/2012/12
    // /blog/2012
    // /blog
  }
);

매칭되지 않은 선택적 매개변수는 NULL로 전달됩니다.

와일드카드 라우팅

매칭은 개별 URL 세그먼트에만 수행됩니다. 여러 세그먼트를 매칭하려면 * 와일드카드를 사용하세요.

Flight::route('/blog/*', function () {
  // 이는 /blog/2000/02/01과 매칭됩니다.
});

모든 요청을 단일 콜백으로 라우팅하려면 다음을 수행하세요:

Flight::route('*', function () {
  // 무언가를 수행
});

404 Not Found 핸들러

기본적으로 URL을 찾을 수 없으면 Flight는 매우 간단하고 평범한 HTTP 404 Not Found 응답을 보냅니다. 더 사용자 지정된 404 응답을 원한다면 map으로 자신의 notFound 메서드를 매핑할 수 있습니다:

Flight::map('notFound', function() {
    $url = Flight::request()->url;

    // 사용자 지정 템플릿과 함께 Flight::render()를 사용할 수도 있습니다.
    $output = <<<HTML
        <h1>My Custom 404 Not Found</h1>
        <h3>The page you have requested {$url} could not be found.</h3>
        HTML;

    $this->response()
        ->clearBody()
        ->status(404)
        ->write($output)
        ->send();
});

Method Not Found 핸들러

기본적으로 URL은 발견되지만 메서드가 허용되지 않으면 Flight는 매우 간단하고 평범한 HTTP 405 Method Not Allowed 응답을 보냅니다 (예: Method Not Allowed. Allowed Methods are: GET, POST). 또한 해당 URL에 대한 허용된 메서드가 포함된 Allow 헤더를 포함합니다.

더 사용자 지정된 405 응답을 원한다면 map으로 자신의 methodNotFound 메서드를 매핑할 수 있습니다:

use flight\net\Route;

Flight::map('methodNotFound', function(Route $route) {
    $url = Flight::request()->url;
    $methods = implode(', ', $route->methods);

    // 사용자 지정 템플릿과 함께 Flight::render()를 사용할 수도 있습니다.
    $output = <<<HTML
        <h1>My Custom 405 Method Not Allowed</h1>
        <h3>The method you have requested for {$url} is not allowed.</h3>
        <p>Allowed Methods are: {$methods}</p>
        HTML;

    $this->response()
        ->clearBody()
        ->status(405)
        ->setHeader('Allow', $methods)
        ->write($output)
        ->send();
});

고급 사용법

라우트에서의 의존성 주입

컨테이너(PSR-11, PHP-DI, Dice 등)를 통해 의존성 주입을 사용하려면, 직접 객체를 생성하고 컨테이너를 사용하여 객체를 생성하거나 문자열을 사용하여 클래스와 메서드를 정의하는 라우트 유형만 사용 가능합니다. 더 자세한 정보는 의존성 주입 페이지를 참조하세요.

간단한 예시입니다:

use flight\database\PdoWrapper;

// Greeting.php
class Greeting
{
    protected PdoWrapper $pdoWrapper;
    public function __construct(PdoWrapper $pdoWrapper) {
        $this->pdoWrapper = $pdoWrapper;
    }

    public function hello(int $id) {
        // $this->pdoWrapper로 무언가를 수행
        $name = $this->pdoWrapper->fetchField("SELECT name FROM users WHERE id = ?", [ $id ]);
        echo "Hello, world! My name is {$name}!";
    }
}

// index.php

// 필요한 매개변수로 컨테이너 설정
// PSR-11에 대한 더 많은 정보는 의존성 주입 페이지를 참조하세요.
$dice = new \Dice\Dice();

// '$dice = '로 변수를 재할당하는 것을 잊지 마세요!!!!!
$dice = $dice->addRule('flight\database\PdoWrapper', [
    'shared' => true,
    'constructParams' => [ 
        'mysql:host=localhost;dbname=test', 
        'root',
        'password'
    ]
]);

// 컨테이너 핸들러 등록
Flight::registerContainerHandler(function($class, $params) use ($dice) {
    return $dice->create($class, $params);
});

// 일반적으로 라우트
Flight::route('/hello/@id', [ 'Greeting', 'hello' ]);
// 또는
Flight::route('/hello/@id', 'Greeting->hello');
// 또는
Flight::route('/hello/@id', 'Greeting::hello');

Flight::start();

다음 라우트로 실행 전달

사용 중단됨 콜백 함수에서 true를 반환하여 다음 매칭 라우트로 실행을 전달할 수 있습니다.

Flight::route('/user/@name', function (string $name) {
  // 조건 확인
  if ($name !== "Bob") {
    // 다음 라우트로 계속
    return true;
  }
});

Flight::route('/user/*', function () {
  // 이 라우트가 호출됩니다.
});

이제 이런 복잡한 사용 사례를 처리하기 위해 미들웨어를 사용하는 것이 권장됩니다.

라우트 별칭

라우트에 별칭을 할당하면 나중에 코드에서 동적으로 해당 별칭을 호출하여 링크(HTML 템플릿의 링크나 리다이렉트 URL 생성 등)를 생성할 수 있습니다.

Flight::route('/users/@id', function($id) { echo 'user:'.$id; }, false, 'user_view');
// 또는 
Flight::route('/users/@id', function($id) { echo 'user:'.$id; })->setAlias('user_view');

// 코드의 나중 부분에서
class UserController {
    public function update() {

        // 사용자 저장 코드...
        $id = $user['id']; // 예: 5

        $redirectUrl = Flight::getUrl('user_view', [ 'id' => $id ]); // '/users/5' 반환
        Flight::redirect($redirectUrl);
    }
}

URL이 변경되는 경우에 특히 유용합니다. 위 예시에서 users가 /admin/users/@id로 이동했다고 가정해 보세요. 라우트에 별칭이 있으면 코드에서 모든 이전 URL을 찾고 변경할 필요가 없으며, 별칭은 이제 위 예시처럼 /admin/users/5를 반환합니다.

그룹 내에서도 라우트 별칭이 작동합니다:

Flight::group('/users', function() {
    Flight::route('/@id', function($id) { echo 'user:'.$id; }, false, 'user_view');
    // 또는
    Flight::route('/@id', function($id) { echo 'user:'.$id; })->setAlias('user_view');
});

라우트 정보 검사

매칭된 라우트 정보를 검사하려면 2가지 방법이 있습니다:

  1. Flight::router() 객체의 executedRoute 속성을 사용할 수 있습니다.
  2. 라우트 메서드의 세 번째 매개변수로 true를 전달하여 라우트 객체를 콜백으로 전달받을 수 있습니다. 라우트 객체는 항상 콜백 함수의 마지막 매개변수로 전달됩니다.

executedRoute

Flight::route('/', function() {
  $route = Flight::router()->executedRoute;
  // $route로 무언가를 수행
  // 매칭된 HTTP 메서드 배열
  $route->methods;

  // 명명된 매개변수 배열
  $route->params;

  // 매칭 정규 표현식
  $route->regex;

  // URL 패턴에서 사용된 '*'의 내용 포함
  $route->splat;

  // URL 경로 표시... 정말 필요하다면
  $route->pattern;

  // 이 라우트에 할당된 미들웨어 표시
  $route->middleware;

  // 이 라우트에 할당된 별칭 표시
  $route->alias;
});

참고: executedRoute 속성은 라우트가 실행된 후에만 설정됩니다. 라우트 실행 전에 접근하려 하면 NULL입니다. 미들웨어에서도 executedRoute를 사용할 수 있습니다!

라우트 정의에 true 전달

Flight::route('/', function(\flight\net\Route $route) {
  // 매칭된 HTTP 메서드 배열
  $route->methods;

  // 명명된 매개변수 배열
  $route->params;

  // 매칭 정규 표현식
  $route->regex;

  // URL 패턴에서 사용된 '*'의 내용 포함
  $route->splat;

  // URL 경로 표시... 정말 필요하다면
  $route->pattern;

  // 이 라우트에 할당된 미들웨어 표시
  $route->middleware;

  // 이 라우트에 할당된 별칭 표시
  $route->alias;
}, true);// <-- 이 true 매개변수가 이를 가능하게 합니다.

라우트 그룹화 및 미들웨어

관련 라우트를 함께 그룹화해야 할 때가 있습니다(예: /api/v1). group 메서드를 사용하여 이를 수행할 수 있습니다:

Flight::group('/api/v1', function () {
  Flight::route('/users', function () {
    // /api/v1/users와 매칭
  });

  Flight::route('/posts', function () {
    // /api/v1/posts와 매칭
  });
});

그룹의 그룹을 중첩할 수도 있습니다:

Flight::group('/api', function () {
  Flight::group('/v1', function () {
    // Flight::get()은 변수를 가져오며 라우트를 설정하지 않습니다! 아래 객체 컨텍스트 참조
    Flight::route('GET /users', function () {
      // GET /api/v1/users와 매칭
    });

    Flight::post('/posts', function () {
      // POST /api/v1/posts와 매칭
    });

    Flight::put('/posts/1', function () {
      // PUT /api/v1/posts와 매칭
    });
  });
  Flight::group('/v2', function () {

    // Flight::get()은 변수를 가져오며 라우트를 설정하지 않습니다! 아래 객체 컨텍스트 참조
    Flight::route('GET /users', function () {
      // GET /api/v2/users와 매칭
    });
  });
});

객체 컨텍스트와 함께 그룹화

다음 방식으로 Engine 객체와 함께 라우트 그룹화를 사용할 수 있습니다:

$app = Flight::app();

$app->group('/api/v1', function (Router $router) {

  // $router 변수를 사용
  $router->get('/users', function () {
    // GET /api/v1/users와 매칭
  });

  $router->post('/posts', function () {
    // POST /api/v1/posts와 매칭
  });
});

참고: $router 객체를 사용한 라우트 및 그룹 정의의 선호 방법입니다.

미들웨어와 함께 그룹화

라우트 그룹에 미들웨어를 할당할 수도 있습니다:

Flight::group('/api/v1', function () {
  Flight::route('/users', function () {
    // /api/v1/users와 매칭
  });
}, [ MyAuthMiddleware::class ]); // 인스턴스를 사용하려면 [ new MyAuthMiddleware() ]

그룹 미들웨어 페이지에서 더 자세한 내용을 확인하세요.

리소스 라우팅

resource 메서드를 사용하여 리소스에 대한 일련의 라우트를 생성할 수 있습니다. 이는 RESTful 규칙을 따르는 리소스에 대한 라우트 세트를 생성합니다.

리소스를 생성하려면 다음을 수행하세요:

Flight::resource('/users', UsersController::class);

배경에서 발생하는 일은 다음 라우트를 생성하는 것입니다:

[
      'index' => 'GET /users',
      'create' => 'GET /users/create',
      'store' => 'POST /users',
      'show' => 'GET /users/@id',
      'edit' => 'GET /users/@id/edit',
      'update' => 'PUT /users/@id',
      'destroy' => 'DELETE /users/@id'
]

컨트롤러는 다음 메서드를 사용합니다:

class UsersController
{
    public function index(): void
    {
    }

    public function show(string $id): void
    {
    }

    public function create(): void
    {
    }

    public function store(): void
    {
    }

    public function edit(string $id): void
    {
    }

    public function update(string $id): void
    {
    }

    public function destroy(string $id): void
    {
    }
}

참고: 새로 추가된 라우트를 보려면 php runway routes를 실행하여 runway를 사용하세요.

리소스 라우트 사용자 지정

리소스 라우트를 구성할 몇 가지 옵션이 있습니다.

별칭 베이스

aliasBase를 구성할 수 있습니다. 기본적으로 별칭은 지정된 URL의 마지막 부분입니다. 예를 들어 /users/는 aliasBase가 users가 됩니다. 이러한 라우트가 생성될 때 별칭은 users.index, users.create 등이 됩니다. 별칭을 변경하려면 aliasBase를 원하는 값으로 설정하세요.

Flight::resource('/users', UsersController::class, [ 'aliasBase' => 'user' ]);
Only 및 Except

only 및 except 옵션을 사용하여 생성할 라우트를 지정할 수도 있습니다.

// 이 메서드만 화이트리스트하고 나머지는 블랙리스트
Flight::resource('/users', UsersController::class, [ 'only' => [ 'index', 'show' ] ]);
// 이 메서드만 블랙리스트하고 나머지는 화이트리스트
Flight::resource('/users', UsersController::class, [ 'except' => [ 'create', 'store', 'edit', 'update', 'destroy' ] ]);

이것들은 라우트를 생성할 라우트를 지정할 수 있는 화이트리스트 및 블랙리스트 옵션입니다.

미들웨어

resource 메서드가 생성한 각 라우트에 실행될 미들웨어를 지정할 수도 있습니다.

Flight::resource('/users', UsersController::class, [ 'middleware' => [ MyAuthMiddleware::class ] ]);

스트리밍 응답

이제 stream() 또는 streamWithHeaders()를 사용하여 클라이언트로 응답을 스트리밍할 수 있습니다. 이는 대용량 파일, 장기 실행 프로세스 또는 대용량 응답 생성에 유용합니다. 라우트 스트리밍은 일반 라우트와 약간 다르게 처리됩니다.

참고: 스트리밍 응답은 flight.v2.output_buffering이 false로 설정된 경우에만 사용 가능합니다.

수동 헤더와 함께 스트림

라우트의 stream() 메서드를 사용하여 클라이언트로 응답을 스트리밍할 수 있습니다. 이렇게 하면 클라이언트로 아무것도 출력하기 전에 모든 헤더를 수동으로 설정해야 합니다. 이는 header() PHP 함수 또는 Flight::response()->setRealHeader() 메서드로 수행됩니다.

Flight::route('/@filename', function($filename) {

    $response = Flight::response();

    // 명백히 경로를 정제하고 그 밖의 것을 수행합니다.
    $fileNameSafe = basename($filename);

    // 라우트 실행 후 여기서 추가 헤더를 설정해야 한다면
    // 아무것도 에코되기 전에 정의해야 합니다.
    // 모두 header() 함수의 원시 호출이거나 
    // Flight::response()->setRealHeader() 호출이어야 합니다.
    header('Content-Disposition: attachment; filename="'.$fileNameSafe.'"');
    // 또는
    $response->setRealHeader('Content-Disposition: attachment; filename="'.$fileNameSafe.'"');

    $filePath = '/some/path/to/files/'.$fileNameSafe;

    if (!is_readable($filePath)) {
        Flight::halt(404, 'File not found');
    }

    // 원한다면 콘텐츠 길이를 수동으로 설정
    header('Content-Length: '.filesize($filePath));
    // 또는
    $response->setRealHeader('Content-Length: '.filesize($filePath));

    // 파일을 읽으면서 클라이언트로 스트리밍
    readfile($filePath);

// 여기가 마법의 줄입니다.
})->stream();

헤더와 함께 스트림

스트리밍을 시작하기 전에 헤더를 설정하기 위해 streamWithHeaders() 메서드를 사용할 수도 있습니다.

Flight::route('/stream-users', function() {

    // 여기에 원하는 추가 헤더를 추가할 수 있습니다.
    // header() 또는 Flight::response()->setRealHeader()를 사용해야 합니다.

    // 데이터를 어떻게 가져오든, 예시로...
    $users_stmt = Flight::db()->query("SELECT id, first_name, last_name FROM users");

    echo '{';
    $user_count = count($users);
    while($user = $users_stmt->fetch(PDO::FETCH_ASSOC)) {
        echo json_encode($user);
        if(--$user_count > 0) {
            echo ',';
        }

        // 데이터를 클라이언트로 보내기 위해 필요
        ob_flush();
    }
    echo '}';

// 스트리밍을 시작하기 전에 헤더를 설정하는 방법입니다.
})->streamWithHeaders([
    'Content-Type' => 'application/json',
    'Content-Disposition' => 'attachment; filename="users.json"',
    // 선택적 상태 코드, 기본 200
    'status' => 200
]);

관련 항목

문제 해결

404 Not Found 또는 예상치 못한 라우트 동작

404 Not Found 오류를 보고 계시지만(인생을 걸고 타이포가 아니라고 맹세하더라도) 이는 라우트 엔드포인트에서 값을 반환하는 대신 에코하는 문제일 수 있습니다. 이는 의도적 이유로 일부 개발자에게 숨어들 수 있습니다.

Flight::route('/hello', function(){
    // 이는 404 Not Found 오류를 일으킬 수 있습니다.
    return 'Hello World';
});

// 아마 원하는 것은
Flight::route('/hello', function(){
    echo 'Hello World';
});

이유는 라우터에 내장된 특별 메커니즘 때문으로, 반환 출력을 "다음 라우트로 이동" 신호로 처리합니다. 동작은 라우팅 섹션에 문서화되어 있습니다.

변경 로그

Learn/learn

Flight에 대해 알아보세요

Flight는 PHP를 위한 빠르고 간단하며 확장 가능한 프레임워크입니다. 매우 다재다능하며 모든 종류의 웹 애플리케이션을 구축하는 데 사용할 수 있습니다. 단순성을 염두에 두고 구축되었으며 이해하고 사용하기 쉬운 방식으로 작성되었습니다.

참고: Flight::를 정적 변수로 사용하는 예제와 $app-> Engine 객체를 사용하는 예제를 볼 수 있습니다. 둘 다 서로 호환되며 작동합니다. 컨트롤러/미들웨어에서 $app과 $this->app은 Flight 팀에서 권장하는 접근 방식입니다.

핵심 구성 요소

라우팅

웹 애플리케이션의 라우트를 관리하는 방법을 알아보세요. 여기에는 라우트 그룹화, 라우트 매개변수 및 미들웨어가 포함됩니다.

미들웨어

애플리케이션에서 요청과 응답을 필터링하기 위해 미들웨어를 사용하는 방법을 알아보세요.

자동 로딩

애플리케이션에서 사용자 정의 클래스를 자동 로드하는 방법을 알아보세요.

요청

애플리케이션에서 요청과 응답을 처리하는 방법을 알아보세요.

응답

사용자에게 응답을 보내는 방법을 알아보세요.

HTML 템플릿

내장된 뷰 엔진을 사용하여 HTML 템플릿을 렌더링하는 방법을 알아보세요.

보안

일반적인 보안 위협으로부터 애플리케이션을 보호하는 방법을 알아보세요.

구성

애플리케이션을 위해 프레임워크를 구성하는 방법을 알아보세요.

이벤트 관리자

이벤트 시스템을 사용하여 애플리케이션에 사용자 정의 이벤트를 추가하는 방법을 알아보세요.

Flight 확장

사용자 정의 메서드와 클래스를 추가하여 프레임워크를 확장하는 방법을 알아보세요.

메서드 훅 및 필터링

메서드와 내부 프레임워크 메서드에 이벤트 훅을 추가하는 방법을 알아보세요.

의존성 주입 컨테이너 (DIC)

의존성 주입 컨테이너(DIC)를 사용하여 애플리케이션의 의존성을 관리하는 방법을 알아보세요.

유틸리티 클래스

컬렉션

컬렉션은 데이터를 저장하고 배열 또는 객체로 쉽게 접근할 수 있도록 사용됩니다.

JSON 래퍼

JSON 인코딩과 디코딩을 일관되게 만들기 위한 몇 가지 간단한 함수가 있습니다.

PDO 래퍼

PDO는 때때로 불필요한 골칫거리를 초래할 수 있습니다. 이 간단한 래퍼 클래스는 데이터베이스와 상호 작용을 훨씬 쉽게 만들어줍니다.

업로드된 파일 핸들러

업로드된 파일을 관리하고 영구 위치로 이동하는 데 도움이 되는 간단한 클래스입니다.

중요한 개념

왜 프레임워크인가?

프레임워크를 사용하는 이유에 대한 짧은 기사입니다. 프레임워크를 사용하기 전에 그 이점을 이해하는 것이 좋습니다.

또한 @lubiana에 의해 훌륭한 튜토리얼이 만들어졌습니다. Flight에 대해 구체적으로 자세히 다루지는 않지만, 이 가이드는 프레임워크를 둘러싼 주요 개념과 사용 이유에 대한 이해를 돕습니다. 튜토리얼은 여기에서 찾을 수 있습니다.

Flight와 다른 프레임워크 비교

Laravel, Slim, Fat-Free 또는 Symfony와 같은 다른 프레임워크에서 Flight로 이전하는 경우, 이 페이지가 두 프레임워크 간의 차이점을 이해하는 데 도움이 됩니다.

기타 주제

단위 테스트

Flight 코드를 견고하게 단위 테스트하는 방법을 배우기 위해 이 가이드를 따르세요.

AI & 개발자 경험

Flight가 AI 도구와 현대 개발 워크플로와 함께 작동하여 더 빠르고 스마트하게 코딩하는 방법을 알아보세요.

v2 -> v3 이전

하위 호환성이 대부분 유지되었지만, v2에서 v3로 이전할 때 알아야 할 몇 가지 변경 사항이 있습니다.

Learn/unit_testing

단위 테스트

개요

Flight의 단위 테스트는 애플리케이션이 예상대로 작동하는지 확인하고, 버그를 조기에 포착하며, 코드베이스를 유지보수하기 쉽게 만드는 데 도움이 됩니다. Flight는 가장 인기 있는 PHP 테스트 프레임워크인 PHPUnit와 원활하게 작동하도록 설계되었습니다.

이해

단위 테스트는 애플리케이션의 작은 부분(컨트롤러나 서비스 등)의 동작을 격리된 상태에서 확인합니다. Flight에서 이는 루트, 컨트롤러, 로직이 다양한 입력에 어떻게 응답하는지를 테스트하는 것을 의미합니다—전역 상태나 실제 외부 서비스에 의존하지 않고요.

주요 원칙:

기본 사용법

PHPUnit 설정

  1. Composer로 PHPUnit 설치: 
    composer require --dev phpunit/phpunit
  2. 프로젝트 루트에 tests 디렉토리 생성.
  3. composer.json에 테스트 스크립트 추가: 
    "scripts": {
   "test": "phpunit --configuration phpunit.xml"
}
  4. phpunit.xml 파일 생성: 
    <?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="vendor/autoload.php">
   <testsuites>
       <testsuite name="Flight Tests">
           <directory>tests</directory>
       </testsuite>
   </testsuites>
</phpunit>

이제 composer test로 테스트를 실행할 수 있습니다.

간단한 루트 핸들러 테스트

이메일을 검증하는 루트가 있다고 가정해 보세요:

// index.php
$app->route('POST /register', [ UserController::class, 'register' ]);

// UserController.php
class UserController {
    protected $app;
    public function __construct(flight\Engine $app) {
        $this->app = $app;
    }
    public function register() {
        $email = $this->app->request()->data->email;
        if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
            return $this->app->json(['status' => 'error', 'message' => 'Invalid email']);
        }
        return $this->app->json(['status' => 'success', 'message' => 'Valid email']);
    }
}

이 컨트롤러에 대한 간단한 테스트:

use PHPUnit\Framework\TestCase;
use flight\Engine;

class UserControllerTest extends TestCase {
    public function testValidEmailReturnsSuccess() {
        $app = new Engine();
        $app->request()->data->email = 'test@example.com';
        $controller = new UserController($app);
        $controller->register();
        $response = $app->response()->getBody();
        $output = json_decode($response, true);
        $this->assertEquals('success', $output['status']);
        $this->assertEquals('Valid email', $output['message']);
    }

    public function testInvalidEmailReturnsError() {
        $app = new Engine();
        $app->request()->data->email = 'invalid-email';
        $controller = new UserController($app);
        $controller->register();
        $response = $app->response()->getBody();
        $output = json_decode($response, true);
        $this->assertEquals('error', $output['status']);
        $this->assertEquals('Invalid email', $output['message']);
    }
}

팁:

테스트 가능한 컨트롤러를 위한 의존성 주입 사용

컨트롤러에 데이터베이스나 메일러 같은 의존성을 주입하여 테스트에서 쉽게 모킹할 수 있게 만드세요:

use flight\database\PdoWrapper;

class UserController {
    protected $app;
    protected $db;
    protected $mailer;
    public function __construct($app, $db, $mailer) {
        $this->app = $app;
        $this->db = $db;
        $this->mailer = $mailer;
    }
    public function register() {
        $email = $this->app->request()->data->email;
        if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
            return $this->app->json(['status' => 'error', 'message' => 'Invalid email']);
        }
        $this->db->runQuery('INSERT INTO users (email) VALUES (?)', [$email]);
        $this->mailer->sendWelcome($email);
        return $this->app->json(['status' => 'success', 'message' => 'User registered']);
    }
}

모킹을 사용한 테스트:

use PHPUnit\Framework\TestCase;

class UserControllerDICTest extends TestCase {
    public function testValidEmailSavesAndSendsEmail() {
        $mockDb = $this->createMock(flight\database\PdoWrapper::class);
        $mockDb->method('runQuery')->willReturn(true);
        $mockMailer = new class {
            public $sentEmail = null;
            public function sendWelcome($email) { $this->sentEmail = $email; return true; }
        };
        $app = new flight\Engine();
        $app->request()->data->email = 'test@example.com';
        $controller = new UserController($app, $mockDb, $mockMailer);
        $controller->register();
        $response = $app->response()->getBody();
        $result = json_decode($response, true);
        $this->assertEquals('success', $result['status']);
        $this->assertEquals('User registered', $result['message']);
        $this->assertEquals('test@example.com', $mockMailer->sentEmail);
    }
}

고급 사용법

관련 자료

문제 해결

변경 로그

Learn/flight_vs_symfony

플라이트 대 시미포니

시미포니란 무엇인가요?

Symfony은 웹 프로젝트용 PHP 프레임워크 및 재사용 가능한 PHP 구성 요소 세트입니다.

최고의 PHP 응용프로그램이 구축되는 표준 기반입니다. 50 개의 독립형 구성 요소 중에서 필요한 애플리케이션에 사용할 수 있습니다.

PHP 웹 애플리케이션의 생성 및 유지 관리 속도를 높이세요. 반복되는 코딩 작업을 줄이고 코드를 제어하는 강력함을 누려보세요.

플라이트와 비교한 장점

플라이트와 비교한 단점

Learn/flight_vs_another_framework

다른 프레임워크와 Flight 비교

다른 프레임워크(Laravel, Slim, Fat-Free, 또는 Symfony와 같은)에서 Flight로 이관하는 경우, 이 페이지에서 두 프레임워크 간의 차이를 이해하는 데 도움이 될 것입니다.

Laravel

Laravel은 모든 기능을 갖추고 있으며 탁월한 개발자 중심 생태계를 갖춘 완전한 기능을 제공하는 프레임워크이지만, 성능과 복잡성 면에서 비용이 발생합니다.

Laravel과 Flight 비교 보기.

Slim

Slim은 Flight와 유사한 미니멀한 프레임워크입니다. 가벼우며 사용하기 쉽도록 설계되었지만, Flight보다 약간 더 복잡할 수 있습니다.

Slim과 Flight 비교 보기.

Fat-Free

Fat-Free은 훨씬 작은 패키지에 전체 스택 프레임워크가 포함되어 있습니다. 모든 도구가 갖춰져 있지만, 어떤 프로젝트는 불필요한 복잡성을 초래할 수 있는 데이터 아키텍처를 가지고 있습니다.

Fat-Free와 Flight 비교 보기.

Symfony

Symfony는 모듈식 엔터프라이즈 레벨 프레임워크로서 유연하고 확장 가능하게 설계되었습니다. 작은 프로젝트나 신입 개발자에게는 Symfony가 약간 압도적일 수 있습니다.

Symfony와 Flight 비교 보기.

Learn/pdo_wrapper

PdoWrapper PDO 도우미 클래스

개요

Flight의 PdoWrapper 클래스는 PDO를 사용하여 데이터베이스 작업을 수행하는 데 친근한 도우미입니다. 일반적인 데이터베이스 작업을 간소화하고, 결과를 가져오는 데 유용한 메서드를 추가하며, 결과를 쉽게 접근할 수 있도록 Collections로 반환합니다. 또한 고급 사용 사례를 위해 쿼리 로깅과 애플리케이션 성능 모니터링(APM)을 지원합니다.

이해하기

PHP에서 데이터베이스를 사용하는 것은 PDO를 직접 사용할 때 특히 장황할 수 있습니다. PdoWrapper는 PDO를 확장하여 쿼리, 가져오기, 결과 처리 작업을 훨씬 쉽게 만드는 메서드를 추가합니다. 준비된 문장과 가져오기 모드를 다루는 대신, 일반적인 작업에 대한 간단한 메서드를 사용하며, 모든 행이 Collection으로 반환되므로 배열 또는 객체 표기법을 사용할 수 있습니다.

Flight에서 PdoWrapper를 공유 서비스로 등록한 후, 앱의 어디서나 Flight::db()를 통해 사용할 수 있습니다.

기본 사용법

PDO 도우미 등록

먼저 Flight에 PdoWrapper 클래스를 등록합니다:

Flight::register('db', \flight\database\PdoWrapper::class, [
    'mysql:host=localhost;dbname=cool_db_name', 'user', 'pass', [
        PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES \'utf8mb4\'',
        PDO::ATTR_EMULATE_PREPARES => false,
        PDO::ATTR_STRINGIFY_FETCHES => false,
        PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC
    ]
]);

이제 어디서나 Flight::db()를 사용하여 데이터베이스 연결을 가져올 수 있습니다.

쿼리 실행

runQuery()

function runQuery(string $sql, array $params = []): PDOStatement

INSERT, UPDATE 또는 결과를 수동으로 가져오고 싶을 때 사용합니다:

$db = Flight::db();
$statement = $db->runQuery("SELECT * FROM users WHERE status = ?", ['active']);
while ($row = $statement->fetch()) {
    // $row는 배열입니다
}

쓰기 작업에도 사용할 수 있습니다:

$db->runQuery("INSERT INTO users (name) VALUES (?)", ['Alice']);
$db->runQuery("UPDATE users SET name = ? WHERE id = ?", ['Bob', 1]);

fetchField()

function fetchField(string $sql, array $params = []): mixed

데이터베이스에서 단일 값을 가져옵니다:

$count = Flight::db()->fetchField("SELECT COUNT(*) FROM users WHERE status = ?", ['active']);

fetchRow()

function fetchRow(string $sql, array $params = []): Collection

단일 행을 Collection(배열/객체 접근)으로 가져옵니다:

$user = Flight::db()->fetchRow("SELECT * FROM users WHERE id = ?", [123]);
echo $user['name'];
// 또는
echo $user->name;

fetchAll()

function fetchAll(string $sql, array $params = []): array<Collection>

모든 행을 Collection 배열로 가져옵니다:

$users = Flight::db()->fetchAll("SELECT * FROM users WHERE status = ?", ['active']);
foreach ($users as $user) {
    echo $user['name'];
    // 또는
    echo $user->name;
}

IN() 플레이스홀더 사용

IN() 절에서 단일 ?를 사용하고 배열 또는 쉼표로 구분된 문자열을 전달할 수 있습니다:

$ids = [1, 2, 3];
$users = Flight::db()->fetchAll("SELECT * FROM users WHERE id IN (?)", [$ids]);
// 또는
$users = Flight::db()->fetchAll("SELECT * FROM users WHERE id IN (?)", ['1,2,3']);

고급 사용법

쿼리 로깅 & APM

쿼리 성능을 추적하려면 등록 시 APM 추적을 활성화합니다:

Flight::register('db', \flight\database\PdoWrapper::class, [
    'mysql:host=localhost;dbname=cool_db_name', 'user', 'pass', [/* 옵션 */], true // 마지막 매개변수가 APM을 활성화합니다
]);

쿼리를 실행한 후 수동으로 로깅할 수 있지만, 활성화된 경우 APM이 자동으로 로깅합니다:

Flight::db()->logQueries();

이것은 연결 및 쿼리 메트릭과 함께 이벤트(flight.db.queries)를 발생시키며, Flight의 이벤트 시스템을 사용하여 이를 수신할 수 있습니다.

전체 예제

Flight::route('/users', function () {
    // 모든 사용자 가져오기
    $users = Flight::db()->fetchAll('SELECT * FROM users');

    // 모든 사용자 스트리밍
    $statement = Flight::db()->runQuery('SELECT * FROM users');
    while ($user = $statement->fetch()) {
        echo $user['name'];
    }

    // 단일 사용자 가져오기
    $user = Flight::db()->fetchRow('SELECT * FROM users WHERE id = ?', [123]);

    // 단일 값 가져오기
    $count = Flight::db()->fetchField('SELECT COUNT(*) FROM users');

    // 특수 IN() 구문
    $users = Flight::db()->fetchAll('SELECT * FROM users WHERE id IN (?)', [[1,2,3,4,5]]);
    $users = Flight::db()->fetchAll('SELECT * FROM users WHERE id IN (?)', ['1,2,3,4,5']);

    // 새 사용자 삽입
    Flight::db()->runQuery("INSERT INTO users (name, email) VALUES (?, ?)", ['Bob', 'bob@example.com']);
    $insert_id = Flight::db()->lastInsertId();

    // 사용자 업데이트
    Flight::db()->runQuery("UPDATE users SET name = ? WHERE id = ?", ['Bob', 123]);

    // 사용자 삭제
    Flight::db()->runQuery("DELETE FROM users WHERE id = ?", [123]);

    // 영향을 받은 행 수 가져오기
    $statement = Flight::db()->runQuery("UPDATE users SET name = ? WHERE name = ?", ['Bob', 'Sally']);
    $affected_rows = $statement->rowCount();
});

관련 항목

문제 해결

변경 로그

Learn/dependency_injection_container

의존성 주입 컨테이너

개요

의존성 주입 컨테이너(DIC)는 애플리케이션의 의존성을 관리할 수 있게 해주는 강력한 확장 기능입니다.

이해하기

의존성 주입(DI)은 현대 PHP 프레임워크의 핵심 개념으로, 객체의 인스턴스화와 구성을 관리하는 데 사용됩니다. DIC 라이브러리의 예로는 flightphp/container, Dice, Pimple, PHP-DI, league/container 등이 있습니다.

DIC는 클래스 생성과 관리를 중앙화된 위치에서 허용하는 멋진 방법입니다. 이는 동일한 객체를 여러 클래스(예: 컨트롤러나 미들웨어)에 전달해야 할 때 유용합니다.

기본 사용법

기존 방식은 다음과 같을 수 있습니다:


require 'vendor/autoload.php';

// 데이터베이스에서 사용자 관리 클래스
class UserController {

    protected PDO $pdo;

    public function __construct(PDO $pdo) {
        $this->pdo = $pdo;
    }

    public function view(int $id) {
        $stmt = $this->pdo->prepare('SELECT * FROM users WHERE id = :id');
        $stmt->execute(['id' => $id]);

        print_r($stmt->fetch());
    }
}

// routes.php 파일에서

$db = new PDO('mysql:host=localhost;dbname=test', 'user', 'pass');

$UserController = new UserController($db);
Flight::route('/user/@id', [ $UserController, 'view' ]);
// 다른 UserController 라우트...

Flight::start();

위 코드에서 새로운 PDO 객체를 생성하고 UserController 클래스에 전달하는 것을 볼 수 있습니다. 작은 애플리케이션에서는 괜찮지만, 애플리케이션이 성장함에 따라 동일한 PDO 객체를 여러 곳에서 생성하거나 전달해야 한다는 것을 알게 될 것입니다. 여기서 DIC가 유용합니다.

Dice를 사용한 DIC 예제는 다음과 같습니다:


require 'vendor/autoload.php';

// 위와 동일한 클래스. 변경 없음
class UserController {

    protected PDO $pdo;

    public function __construct(PDO $pdo) {
        $this->pdo = $pdo;
    }

    public function view(int $id) {
        $stmt = $this->pdo->prepare('SELECT * FROM users WHERE id = :id');
        $stmt->execute(['id' => $id]);

        print_r($stmt->fetch());
    }
}

// 새로운 컨테이너 생성
$container = new \Dice\Dice;

// 컨테이너가 PDO 객체를 생성하는 방법을 알려주는 규칙 추가
// 아래처럼 자신에게 재할당하는 것을 잊지 마세요!
$container = $container->addRule('PDO', [
    // shared는 동일한 객체가 매번 반환된다는 의미
    'shared' => true,
    'constructParams' => ['mysql:host=localhost;dbname=test', 'user', 'pass' ]
]);

// Flight가 이를 사용하도록 컨테이너 핸들러 등록
Flight::registerContainerHandler(function($class, $params) use ($container) {
    return $container->create($class, $params);
});

// 이제 컨테이너를 사용하여 UserController 생성
Flight::route('/user/@id', [ UserController::class, 'view' ]);

Flight::start();

이 예제에 많은 추가 코드가 들어간 것 같다고 생각할 수 있습니다. 마법은 PDO 객체가 필요한 다른 컨트롤러가 있을 때 발생합니다.


// 모든 컨트롤러가 PDO 객체를 필요로 하는 생성자를 가진다면
// 아래 라우트들은 자동으로 주입됩니다!!!
Flight::route('/company/@id', [ CompanyController::class, 'view' ]);
Flight::route('/organization/@id', [ OrganizationController::class, 'view' ]);
Flight::route('/category/@id', [ CategoryController::class, 'view' ]);
Flight::route('/settings', [ SettingsController::class, 'view' ]);

DIC를 사용하는 추가 이점은 단위 테스트가 훨씬 쉬워진다는 것입니다. 모의 객체를 생성하여 클래스에 전달할 수 있습니다. 이는 애플리케이션 테스트를 작성할 때 큰 이점입니다!

중앙화된 DIC 핸들러 생성

앱을 확장하여 services 파일에서 중앙화된 DIC 핸들러를 생성할 수 있습니다. 예제는 다음과 같습니다:

// services.php

// 새로운 컨테이너 생성
$container = new \Dice\Dice;
// 아래처럼 자신에게 재할당하는 것을 잊지 마세요!
$container = $container->addRule('PDO', [
    // shared는 동일한 객체가 매번 반환된다는 의미
    'shared' => true,
    'constructParams' => ['mysql:host=localhost;dbname=test', 'user', 'pass' ]
]);

// 이제 모든 객체를 생성하는 매핑 가능한 메서드 생성
Flight::map('make', function($class, $params = []) use ($container) {
    return $container->create($class, $params);
});

// 컨트롤러/미들웨어에 Flight가 이를 사용하도록 컨테이너 핸들러 등록
Flight::registerContainerHandler(function($class, $params) {
    Flight::make($class, $params);
});

// 생성자에서 PDO 객체를 받는 샘플 클래스라고 가정
class EmailCron {
    protected PDO $pdo;

    public function __construct(PDO $pdo) {
        $this->pdo = $pdo;
    }

    public function send() {
        // 이메일 보내는 코드
    }
}

// 마지막으로 의존성 주입을 사용하여 객체 생성
$emailCron = Flight::make(EmailCron::class);
$emailCron->send();

flightphp/container

Flight에는 의존성 주입을 처리하기 위해 사용할 수 있는 간단한 PSR-11 준수 컨테이너를 제공하는 플러그인이 있습니다. 사용 예제는 다음과 같습니다:


// 예: index.php
require 'vendor/autoload.php';

use flight\Container;

$container = new Container;

$container->set(PDO::class, fn(): PDO => new PDO('sqlite::memory:'));

Flight::registerContainerHandler([$container, 'get']);

class TestController {
  private PDO $pdo;

  function __construct(PDO $pdo) {
    $this->pdo = $pdo;
  }

  function index() {
    var_dump($this->pdo);
    // 올바르게 출력됩니다!
  }
}

Flight::route('GET /', [TestController::class, 'index']);

Flight::start();

flightphp/container의 고급 사용법

의존성을 재귀적으로 해결할 수도 있습니다. 예제는 다음과 같습니다:

<?php

require 'vendor/autoload.php';

use flight\Container;

class User {}

interface UserRepository {
  function find(int $id): ?User;
}

class PdoUserRepository implements UserRepository {
  private PDO $pdo;

  function __construct(PDO $pdo) {
    $this->pdo = $pdo;
  }

  function find(int $id): ?User {
    // 구현 ...
    return null;
  }
}

$container = new Container;

$container->set(PDO::class, static fn(): PDO => new PDO('sqlite::memory:'));
$container->set(UserRepository::class, PdoUserRepository::class);

$userRepository = $container->get(UserRepository::class);
var_dump($userRepository);

/*
object(PdoUserRepository)#4 (1) {
  ["pdo":"PdoUserRepository":private]=>
  object(PDO)#3 (0) {
  }
}
 */

DICE

자신의 DIC 핸들러를 생성할 수도 있습니다. PSR-11이 아닌(Dice) 사용자 지정 컨테이너를 사용하고 싶을 때 유용합니다. 이를 수행하는 방법은 기본 사용법 섹션을 참조하세요.

또한 Flight를 사용할 때 생활을 더 쉽게 만들어주는 몇 가지 유용한 기본값이 있습니다.

Engine 인스턴스

컨트롤러/미들웨어에서 Engine 인스턴스를 사용하는 경우, 다음과 같이 구성할 수 있습니다:


// 부트스트랩 파일 어딘가에서
$engine = Flight::app();

$container = new \Dice\Dice;
$container = $container->addRule('*', [
    'substitutions' => [
        // 여기서 인스턴스를 전달합니다
        Engine::class => $engine
    ]
]);

$engine->registerContainerHandler(function($class, $params) use ($container) {
    return $container->create($class, $params);
});

// 이제 컨트롤러/미들웨어에서 Engine 인스턴스 사용 가능

class MyController {
    public function __construct(Engine $app) {
        $this->app = $app;
    }

    public function index() {
        $this->app->render('index');
    }
}

다른 클래스 추가

컨테이너에 추가하고 싶은 다른 클래스가 있다면, Dice에서는 컨테이너가 자동으로 해결해주므로 쉽습니다. 예제는 다음과 같습니다:


$container = new \Dice\Dice;
// 클래스에 의존성을 주입할 필요가 없다면
// 아무것도 정의할 필요가 없습니다!
Flight::registerContainerHandler(function($class, $params) use ($container) {
    return $container->create($class, $params);
});

class MyCustomClass {
    public function parseThing() {
        return 'thing';
    }
}

class UserController {

    protected MyCustomClass $MyCustomClass;

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

    public function index() {
        echo $this->MyCustomClass->parseThing();
    }
}

Flight::route('/user', 'UserController->index');

PSR-11

Flight는 PSR-11 준수 컨테이너를 사용할 수도 있습니다. 이는 PSR-11 인터페이스를 구현하는 모든 컨테이너를 사용할 수 있다는 의미입니다. League의 PSR-11 컨테이너를 사용한 예제는 다음과 같습니다:


require 'vendor/autoload.php';

// 위와 동일한 UserController 클래스

$container = new \League\Container\Container();
$container->add(UserController::class)->addArgument(PdoWrapper::class);
$container->add(PdoWrapper::class)
    ->addArgument('mysql:host=localhost;dbname=test')
    ->addArgument('user')
    ->addArgument('pass');
Flight::registerContainerHandler($container);

Flight::route('/user', [ 'UserController', 'view' ]);

Flight::start();

이전 Dice 예제보다 약간 장황할 수 있지만, 동일한 이점으로 작업을 수행합니다!

관련 자료

문제 해결

변경 로그

Learn/middleware

미들웨어

개요

Flight는 라우트와 그룹 라우트 미들웨어를 지원합니다. 미들웨어는 라우트 콜백 전에 (또는 후에) 코드가 실행되는 애플리케이션의 일부입니다. 이는 코드에 API 인증 검사를 추가하거나 사용자가 라우트에 접근할 권한이 있는지 확인하는 훌륭한 방법입니다.

이해

미들웨어는 앱을 크게 단순화할 수 있습니다. 복잡한 추상 클래스 상속이나 메서드 오버라이드 대신, 미들웨어를 사용하면 사용자 지정 앱 로직을 라우트에 할당하여 라우트를 제어할 수 있습니다. 미들웨어를 샌드위치처럼 생각할 수 있습니다. 바깥쪽에 빵이 있고, 양상추, 토마토, 고기, 치즈 같은 레이어가 있습니다. 각 요청이 샌드위치를 한 입 베어 물 때 바깥 레이어를 먼저 먹고 핵심으로 들어가는 것처럼 상상해 보세요.

미들웨어가 작동하는 시각적 예시입니다. 그 다음에 이 기능이 어떻게 작동하는지 실용적인 예를 보여드리겠습니다.

사용자 요청 URL /api ----> 
    Middleware->before() 실행 ----->
        /api에 연결된 Callable/메서드 실행 및 응답 생성 ------>
    Middleware->after() 실행 ----->
사용자가 서버로부터 응답 받음

그리고 실용적인 예시입니다:

사용자가 URL /dashboard로 이동
    LoggedInMiddleware->before() 실행
        before()가 유효한 로그인 세션 확인
            예: 아무것도 하지 않고 실행 계속
            아니오: 사용자를 /login으로 리다이렉트
                /api에 연결된 Callable/메서드 실행 및 응답 생성
    LoggedInMiddleware->after()가 정의되지 않아 실행 계속
사용자가 서버로부터 대시보드 HTML 받음

실행 순서

미들웨어 함수는 라우트에 추가된 순서대로 실행됩니다. 실행은 Slim Framework가 이를 처리하는 방식과 유사합니다.

before() 메서드는 추가된 순서대로 실행되고, after() 메서드는 역순으로 실행됩니다.

예: Middleware1->before(), Middleware2->before(), Middleware2->after(), Middleware1->after().

기본 사용법

미들웨어를 익명 함수나 클래스(권장) 같은 모든 호출 가능한 메서드로 사용할 수 있습니다.

익명 함수

간단한 예시입니다:

Flight::route('/path', function() { echo ' Here I am!'; })->addMiddleware(function() {
    echo 'Middleware first!';
});

Flight::start();

// 이는 "Middleware first! Here I am!"을 출력합니다.

주의: 익명 함수를 사용할 때 해석되는 유일한 메서드는 before() 메서드입니다. 익명 클래스와 함께 after() 동작을 정의할 수 없습니다.

클래스 사용

미들웨어는 클래스(권장)로 등록할 수 있습니다. "after" 기능을 사용하려면 반드시 클래스를 사용해야 합니다.

class MyMiddleware {
    public function before($params) {
        echo 'Middleware first!';
    }

    public function after($params) {
        echo 'Middleware last!';
    }
}

$MyMiddleware = new MyMiddleware();
Flight::route('/path', function() { echo ' Here I am! '; })->addMiddleware($MyMiddleware); 
// 또는 ->addMiddleware([ $MyMiddleware, $MyMiddleware2 ]);

Flight::start();

// 이는 "Middleware first! Here I am! Middleware last!"를 표시합니다.

미들웨어 클래스 이름만 정의하고 클래스를 인스턴스화할 수도 있습니다.

Flight::route('/path', function() { echo ' Here I am! '; })->addMiddleware(MyMiddleware::class);

주의: 미들웨어 이름만 전달하면 의존성 주입 컨테이너에 의해 자동으로 실행되며, 미들웨어는 필요한 매개변수로 실행됩니다. 의존성 주입 컨테이너가 등록되지 않은 경우, 기본적으로 __construct(Engine $app)에 flight\Engine 인스턴스를 전달합니다.

매개변수가 있는 라우트 사용

라우트에서 매개변수가 필요하면, 미들웨어 함수에 단일 배열로 전달됩니다. (function($params) { ... } 또는 public function before($params) { ... }). 이렇게 하는 이유는 매개변수를 그룹으로 구조화할 수 있고, 일부 그룹에서 매개변수가 다른 순서로 나타날 수 있어 잘못된 매개변수를 참조하여 미들웨어 함수가 깨질 수 있기 때문입니다. 이 방법으로 위치 대신 이름으로 접근할 수 있습니다.

use flight\Engine;

class RouteSecurityMiddleware {

    protected Engine $app;

    public function __construct(Engine $app) {
        $this->app = $app;
    }

    public function before(array $params) {
        $clientId = $params['clientId'];

        // jobId가 전달될 수도 있고 안 될 수도 있음
        $jobId = $params['jobId'] ?? 0;

        // job ID가 없으면 조회할 필요가 없을 수 있음.
        if($jobId === 0) {
            return;
        }

        // 데이터베이스에서 일종의 조회 수행
        $isValid = !!$this->app->db()->fetchField("SELECT 1 FROM client_jobs WHERE client_id = ? AND job_id = ?", [ $clientId, $jobId ]);

        if($isValid !== true) {
            $this->app->halt(400, 'You are blocked, muahahaha!');
        }
    }
}

// routes.php
$router->group('/client/@clientId/job/@jobId', function(Router $router) {

    // 아래 그룹은 여전히 부모 미들웨어를 받음
    // 하지만 매개변수는 미들웨어에서 단일 배열로 전달됨
    $router->group('/job/@jobId', function(Router $router) {
        $router->get('', [ JobController::class, 'view' ]);
        $router->put('', [ JobController::class, 'update' ]);
        $router->delete('', [ JobController::class, 'delete' ]);
        // 더 많은 라우트...
    });
}, [ RouteSecurityMiddleware::class ]);

미들웨어를 사용한 라우트 그룹화

라우트 그룹을 추가하면 그 그룹의 모든 라우트가 동일한 미들웨어를 갖게 됩니다. 헤더의 API 키를 확인하는 Auth 미들웨어로 여러 라우트를 그룹화해야 할 때 유용합니다.


// 그룹 메서드 끝에 추가
Flight::group('/api', function() {

    // 이 "빈" 라우트는 실제로 /api와 일치
    Flight::route('', function() { echo 'api'; }, false, 'api');
    // 이는 /api/users와 일치
    Flight::route('/users', function() { echo 'users'; }, false, 'users');
    // 이는 /api/users/1234와 일치
    Flight::route('/users/@id', function($id) { echo 'user:'.$id; }, false, 'user_view');
}, [ new ApiAuthMiddleware() ]);

모든 라우트에 글로벌 미들웨어를 적용하려면 "빈" 그룹을 추가할 수 있습니다:


// 그룹 메서드 끝에 추가
Flight::group('', function() {

    // 이는 여전히 /users
    Flight::route('/users', function() { echo 'users'; }, false, 'users');
    // 그리고 이는 여전히 /users/1234
    Flight::route('/users/@id', function($id) { echo 'user:'.$id; }, false, 'user_view');
}, [ ApiAuthMiddleware::class ]); // 또는 [ new ApiAuthMiddleware() ], 동일

일반적인 사용 사례

API 키 검증

/api 라우트를 보호하고 API 키가 올바른지 확인하려면 미들웨어로 쉽게 처리할 수 있습니다.

use flight\Engine;

class ApiMiddleware {

    protected Engine $app;

    public function __construct(Engine $app) {
        $this->app = $app;
    }

    public function before(array $params) {
        $authorizationHeader = $this->app->request()->getHeader('Authorization');
        $apiKey = str_replace('Bearer ', '', $authorizationHeader);

        // 데이터베이스에서 api 키 조회
        $apiKeyHash = hash('sha256', $apiKey);
        $hasValidApiKey = !!$this->db()->fetchField("SELECT 1 FROM api_keys WHERE hash = ? AND valid_date >= NOW()", [ $apiKeyHash ]);

        if($hasValidApiKey !== true) {
            $this->app->jsonHalt(['error' => 'Invalid API Key']);
        }
    }
}

// routes.php
$router->group('/api', function(Router $router) {
    $router->get('/users', [ ApiController::class, 'getUsers' ]);
    $router->get('/companies', [ ApiController::class, 'getCompanies' ]);
    // 더 많은 라우트...
}, [ ApiMiddleware::class ]);

이제 모든 API 라우트가 설정한 API 키 검증 미들웨어로 보호됩니다! 라우터 그룹에 더 많은 라우트를 추가하면 즉시 동일한 보호를 받습니다!

로그인 검증

로그인한 사용자만 접근할 수 있는 일부 라우트를 보호하려면? 미들웨어로 쉽게 달성할 수 있습니다!

use flight\Engine;

class LoggedInMiddleware {

    protected Engine $app;

    public function __construct(Engine $app) {
        $this->app = $app;
    }

    public function before(array $params) {
        $session = $this->app->session();
        if($session->get('logged_in') !== true) {
            $this->app->redirect('/login');
            exit;
        }
    }
}

// routes.php
$router->group('/admin', function(Router $router) {
    $router->get('/dashboard', [ DashboardController::class, 'index' ]);
    $router->get('/clients', [ ClientController::class, 'index' ]);
    // 더 많은 라우트...
}, [ LoggedInMiddleware::class ]);

라우트 매개변수 검증

URL에서 값을 변경하여 접근하지 말아야 할 데이터에 접근하는 것을 사용자에게서 보호하려면? 미들웨어로 해결할 수 있습니다!

use flight\Engine;

class RouteSecurityMiddleware {

    protected Engine $app;

    public function __construct(Engine $app) {
        $this->app = $app;
    }

    public function before(array $params) {
        $clientId = $params['clientId'];
        $jobId = $params['jobId'];

        // 데이터베이스에서 일종의 조회 수행
        $isValid = !!$this->app->db()->fetchField("SELECT 1 FROM client_jobs WHERE client_id = ? AND job_id = ?", [ $clientId, $jobId ]);

        if($isValid !== true) {
            $this->app->halt(400, 'You are blocked, muahahaha!');
        }
    }
}

// routes.php
$router->group('/client/@clientId/job/@jobId', function(Router $router) {
    $router->get('', [ JobController::class, 'view' ]);
    $router->put('', [ JobController::class, 'update' ]);
    $router->delete('', [ JobController::class, 'delete' ]);
    // 더 많은 라우트...
}, [ RouteSecurityMiddleware::class ]);

미들웨어 실행 처리

인증 미들웨어가 있고 사용자가 인증되지 않으면 로그인 페이지로 리다이렉트하려고 가정해 보세요. 몇 가지 옵션이 있습니다:

  1. 미들웨어 함수에서 false를 반환하면 Flight가 자동으로 403 Forbidden 오류를 반환하지만, 사용자 지정이 없습니다.
  2. Flight::redirect()를 사용하여 사용자를 로그인 페이지로 리다이렉트할 수 있습니다.
  3. 미들웨어 내에서 사용자 지정 오류를 생성하고 라우트 실행을 중단할 수 있습니다.

간단하고 직관적

간단한 return false; 예시입니다:

class MyMiddleware {
    public function before($params) {
        $hasUserKey = Flight::session()->exists('user');
        if ($hasUserKey === false) {
            return false;
        }

        // true이므로 모든 것이 계속 진행됨
    }
}

리다이렉트 예시

사용자를 로그인 페이지로 리다이렉트하는 예시입니다:

class MyMiddleware {
    public function before($params) {
        $hasUserKey = Flight::session()->exists('user');
        if ($hasUserKey === false) {
            Flight::redirect('/login');
            exit;
        }
    }
}

사용자 지정 오류 예시

API를 구축 중이므로 JSON 오류를 발생시켜야 한다고 가정해 보세요. 이렇게 할 수 있습니다:

class MyMiddleware {
    public function before($params) {
        $authorization = Flight::request()->getHeader('Authorization');
        if(empty($authorization)) {
            Flight::jsonHalt(['error' => 'You must be logged in to access this page.'], 403);
            // 또는
            Flight::json(['error' => 'You must be logged in to access this page.'], 403);
            exit;
            // 또는
            Flight::halt(403, json_encode(['error' => 'You must be logged in to access this page.']);
        }
    }
}

관련 항목

문제 해결

변경 로그

Learn/filtering

필터링

개요

Flight는 매핑된 메서드가 호출되기 전과 후에 필터링할 수 있도록 합니다.

이해하기

기억해야 할 미리 정의된 훅은 없습니다. 프레임워크의 기본 메서드와 매핑한 사용자 지정 메서드 모두를 필터링할 수 있습니다.

필터 함수는 다음과 같습니다:

/**
 * @param array $params 필터링되는 메서드에 전달된 매개변수.
 * @param string $output (v2 출력 버퍼링 전용) 필터링되는 메서드의 출력.
 * @return bool 체인을 계속하려면 true/void를 반환하거나 반환하지 말고, 체인을 중단하려면 false를 반환합니다.
 */
function (array &$params, string &$output): bool {
  // 필터 코드
}

전달된 변수를 사용하여 입력 매개변수와/또는 출력을 조작할 수 있습니다.

메서드 전에 필터를 실행하려면 다음과 같이 합니다:

Flight::before('start', function (array &$params, string &$output): bool {
  // 무언가 수행
});

메서드 후에 필터를 실행하려면 다음과 같이 합니다:

Flight::after('start', function (array &$params, string &$output): bool {
  // 무언가 수행
});

원하는 만큼의 필터를 어떤 메서드에도 추가할 수 있습니다. 필터는 선언된 순서대로 호출됩니다.

필터링 프로세스의 예는 다음과 같습니다:

// 사용자 지정 메서드 매핑
Flight::map('hello', function (string $name) {
  return "Hello, $name!";
});

// before 필터 추가
Flight::before('hello', function (array &$params, string &$output): bool {
  // 매개변수 조작
  $params[0] = 'Fred';
  return true;
});

// after 필터 추가
Flight::after('hello', function (array &$params, string &$output): bool {
  // 출력 조작
  $output .= " Have a nice day!";
  return true;
});

// 사용자 지정 메서드 호출
echo Flight::hello('Bob');

이것은 다음과 같이 표시되어야 합니다:

Hello Fred! Have a nice day!

여러 필터를 정의한 경우, 필터 함수 중 하나에서 false를 반환하여 체인을 중단할 수 있습니다:

Flight::before('start', function (array &$params, string &$output): bool {
  echo 'one';
  return true;
});

Flight::before('start', function (array &$params, string &$output): bool {
  echo 'two';

  // 이것은 체인을 종료합니다
  return false;
});

// 이것은 호출되지 않습니다
Flight::before('start', function (array &$params, string &$output): bool {
  echo 'three';
  return true;
});

참고: map 및 register와 같은 핵심 메서드는 직접 호출되며 동적으로 호출되지 않기 때문에 필터링할 수 없습니다. 자세한 내용은 Extending Flight를 참조하세요.

관련 항목

문제 해결

변경 로그

Learn/requests

요청

개요

Flight는 HTTP 요청을 단일 객체로 캡슐화하며, 이를 다음과 같이 접근할 수 있습니다:

$request = Flight::request();

이해

HTTP 요청은 HTTP 수명 주기를 이해하는 데 핵심적인 측면 중 하나입니다. 사용자가 웹 브라우저나 HTTP 클라이언트에서 작업을 수행하면, 헤더, 본문, URL 등을 프로젝트로 보냅니다. 이러한 헤더(브라우저 언어, 처리할 수 있는 압축 유형, 사용자 에이전트 등)를 캡처하고, Flight 애플리케이션으로 전송된 본문과 URL을 캡처할 수 있습니다. 이러한 요청은 앱이 다음에 무엇을 할지 이해하는 데 필수적입니다.

기본 사용법

PHP에는 $_GET, $_POST, $_REQUEST, $_SERVER, $_FILES, $_COOKIE와 같은 여러 슈퍼 글로벌이 있습니다. Flight는 이를 편리한 Collections로 추상화합니다. query, data, cookies, files 속성을 배열 또는 객체로 접근할 수 있습니다.

참고: 프로젝트에서 이러한 슈퍼 글로벌을 사용하는 것은 강력히 권장되지 않으며, request() 객체를 통해 참조해야 합니다.

참고: $_ENV에 대한 추상화는 제공되지 않습니다.

$_GET

query 속성을 통해 $_GET 배열에 접근할 수 있습니다:

// GET /search?keyword=something
Flight::route('/search', function(){
    $keyword = Flight::request()->query['keyword'];
    // 또는
    $keyword = Flight::request()->query->keyword;
    echo "You are searching for: $keyword";
    // $keyword로 데이터베이스 쿼리 또는 다른 작업 수행
});

$_POST

data 속성을 통해 $_POST 배열에 접근할 수 있습니다:

Flight::route('POST /submit', function(){
    $name = Flight::request()->data['name'];
    $email = Flight::request()->data['email'];
    // 또는
    $name = Flight::request()->data->name;
    $email = Flight::request()->data->email;
    echo "You submitted: $name, $email";
    // $name과 $email로 데이터베이스 저장 또는 다른 작업 수행
});

$_COOKIE

cookies 속성을 통해 $_COOKIE 배열에 접근할 수 있습니다:

Flight::route('GET /login', function(){
    $savedLogin = Flight::request()->cookies['myLoginCookie'];
    // 또는
    $savedLogin = Flight::request()->cookies->myLoginCookie;
    // 실제로 저장되었는지 확인하고, 저장되었다면 자동 로그인
    if($savedLogin) {
        Flight::redirect('/dashboard');
        return;
    }
});

새 쿠키 값 설정에 대한 도움은 overclokk/cookie를 참조하세요.

$_SERVER

getVar() 메서드를 통해 $_SERVER 배열에 접근하는 단축 방법이 있습니다:

$host = Flight::request()->getVar('HTTP_HOST');

$_FILES

files 속성을 통해 업로드된 파일에 접근할 수 있습니다:

// $_FILES 속성에 대한 직접 접근. 권장 접근법은 아래 참조
$uploadedFile = Flight::request()->files['myFile']; 
// 또는
$uploadedFile = Flight::request()->files->myFile;

더 많은 정보는 Uploaded File Handler를 참조하세요.

파일 업로드 처리

v3.12.0

프레임워크의 도우미 메서드를 사용하여 파일 업로드를 처리할 수 있습니다. 기본적으로 요청에서 파일 데이터를 가져와 새 위치로 이동하는 것입니다.

Flight::route('POST /upload', function(){
    // <input type="file" name="myFile">와 같은 입력 필드가 있는 경우
    $uploadedFileData = Flight::request()->getUploadedFiles();
    $uploadedFile = $uploadedFileData['myFile'];
    $uploadedFile->moveTo('/path/to/uploads/' . $uploadedFile->getClientFilename());
});

여러 파일이 업로드된 경우, 이를 반복할 수 있습니다:

Flight::route('POST /upload', function(){
    // <input type="file" name="myFiles[]">와 같은 입력 필드가 있는 경우
    $uploadedFiles = Flight::request()->getUploadedFiles()['myFiles'];
    foreach ($uploadedFiles as $uploadedFile) {
        $uploadedFile->moveTo('/path/to/uploads/' . $uploadedFile->getClientFilename());
    }
});

보안 참고: 파일 업로드를 다룰 때는 항상 사용자 입력을 검증하고 정제하세요. 업로드할 허용 확장 유형을 검증하는 것뿐만 아니라, 파일의 "매직 바이트"를 검증하여 사용자가 주장하는 파일 유형인지 확인해야 합니다. 이에 대한 기사 및 라이브러리가 도움이 됩니다.

요청 본문

POST/PUT 요청을 다룰 때와 같은 원시 HTTP 요청 본문을 가져오려면 다음을 할 수 있습니다:

Flight::route('POST /users/xml', function(){
    $xmlBody = Flight::request()->getBody();
    // 전송된 XML로 작업 수행.
});

JSON 본문

콘텐츠 유형이 application/json이고 예시 데이터가 {"id": 123}인 요청을 받으면, data 속성에서 사용할 수 있습니다:

$id = Flight::request()->data->id;

요청 헤더

getHeader() 또는 getHeaders() 메서드를 사용하여 요청 헤더에 접근할 수 있습니다:

// Authorization 헤더가 필요한 경우
$host = Flight::request()->getHeader('Authorization');
// 또는
$host = Flight::request()->header('Authorization');

// 모든 헤더를 가져와야 하는 경우
$headers = Flight::request()->getHeaders();
// 또는
$headers = Flight::request()->headers();

요청 메서드

method 속성 또는 getMethod() 메서드를 사용하여 요청 메서드에 접근할 수 있습니다:

$method = Flight::request()->method; // 실제로는 getMethod()로 채워짐
$method = Flight::request()->getMethod();

참고: getMethod() 메서드는 먼저 $_SERVER['REQUEST_METHOD']에서 메서드를 가져온 다음, $_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']가 존재하면 이를 덮어쓰거나 $_REQUEST['_method']가 존재하면 이를 사용합니다.

요청 객체 속성

요청 객체는 다음 속성을 제공합니다:

도우미 메서드

URL의 일부를 조합하거나 특정 헤더를 다루기 위한 몇 가지 도우미 메서드가 있습니다.

전체 URL

getFullUrl() 메서드를 사용하여 전체 요청 URL에 접근할 수 있습니다:

$url = Flight::request()->getFullUrl();
// https://example.com/some/path?foo=bar

기본 URL

getBaseUrl() 메서드를 사용하여 기본 URL에 접근할 수 있습니다:

// http://example.com/path/to/something/cool?query=yes+thanks
$url = Flight::request()->getBaseUrl();
// https://example.com
// 주의: 후행 슬래시 없음.

쿼리 파싱

parseQuery() 메서드에 URL을 전달하여 쿼리 문자열을 연관 배열로 파싱할 수 있습니다:

$query = Flight::request()->parseQuery('https://example.com/some/path?foo=bar');
// ['foo' => 'bar']

콘텐츠 Accept 유형 협상

v3.17.2

클라이언트가 보낸 Accept 헤더를 기반으로 응답할 최적의 콘텐츠 유형을 결정하기 위해 negotiateContentType() 메서드를 사용할 수 있습니다.

// 예시 Accept 헤더: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8
// 아래는 지원하는 유형을 정의합니다.
$availableTypes = ['application/json', 'application/xml'];
$typeToServe = Flight::request()->negotiateContentType($availableTypes);
if ($typeToServe === 'application/json') {
    // JSON 응답 제공
} elseif ($typeToServe === 'application/xml') {
    // XML 응답 제공
} else {
    // 다른 기본값 사용 또는 오류 발생
}

참고: Accept 헤더에 사용 가능한 유형 중 하나가 없으면 메서드는 null을 반환합니다. Accept 헤더가 정의되지 않은 경우, 메서드는 $availableTypes 배열의 첫 번째 유형을 반환합니다.

관련 자료

문제 해결

변경 로그

Learn/why_frameworks

프레임워크를 사용하는 이유?

일부 프로그래머는 프레임워크를 사용하는 것에 열렬히 반대합니다. 프레임워크가 부풀려지고 느리며 배우기 어렵다고 주장합니다. 그들은 프레임워크가 불필요하며 그들 없이 더 나은 코드를 작성할 수 있다고 말합니다. 프레임워크를 사용하는 단점에 대해 몇 가지 타당한 이유가 있습니다. 그러나 프레임워크를 사용하는 장점도 많이 있습니다.

프레임워크를 사용하는 이유

프레임워크를 사용해야 하는 몇 가지 이유는 다음과 같습니다:

Flight은 일종의 마이크로 프레임워크입니다. 이는 작고 가벼워서 많은 기능을 제공하지 않습니다. Laravel이나 Symfony와 같은 큰 프레임워크만큼의 기능을 제공하지는 않습니다. 그러나 웹 애플리케이션을 구축하는 데 필요한 많은 기능을 제공합니다. 또한 학습과 사용이 쉽습니다. 이는 빠르고 쉽게 웹 애플리케이션을 구축하는 좋은 선택입니다. 프레임워크가 처음이라면, Flight는 시작하기에 좋은 초보자 프레임워크입니다. 프레임워크를 사용하는 장점에 대해 배우며 복잡성이 너무 많지 않도록 도와줍니다. Flight 경험 후에는 Laravel이나 Symfony와 같이 더 복잡한 프레임워크로 전환하기가 쉬워질 것입니다만, 여전히 Flight로도 강력하고 견고한 애플리케이션을 만들 수 있습니다.

라우팅이란 무엇인가?

라우팅은 Flight 프레임워크의 핵심이지만 정확히 무엇일까요? 라우팅은 URL을 가져와 코드에서 특정 함수와 일치시키는 과정입니다. 요청된 URL에 따라 웹사이트가 다른 작업을 수행할 수 있습니다. 예를 들어, '/user/1234'를 방문하면 사용자 프로필을 보여줄 수 있지만 '/users'를 방문하면 모든 사용자 목록을 표시할지도 모릅니다. 모두 라우팅을 통해 이루어집니다.

이것은 다음과 같이 작동할 수 있습니다:

그리고 왜 중요한가요?

적절한 중앙 집중형 라우터를 가지고 있다면 실제로 여러분의 삶이 크게 쉬워질 수 있습니다! 처음에는 약간 복잡해 보일 수도 있습니다. 다음은 몇 가지 이유입니다:

아마도 'index.php'에 여러분의 웹사이트를 만드는 스크립트별 방법에 익숙하실 것입니다. 'index.php'라는 파일이 있고 URL을 확인하고 URL에 따라 특정 함수를 실행하는 많은 'if' 문이 있는 것일 것입니다. 이것은 라우팅 방식 중 하나일 수 있지만 조직화되지 않았으며 빠르게 복잡해질 수 있습니다. Flight의 라우팅 시스템은 라우팅을 처리하는 더 정리되고 강력한 방법입니다.

이렇게 하시겠습니까?


// /user/view_profile.php?id=1234
if ($_GET['id']) {
    $id = $_GET['id'];
    viewUserProfile($id);
}

// /user/edit_profile.php?id=1234
if ($_GET['id']) {
    $id = $_GET['id'];
    editUserProfile($id);
}

// etc...

아니면 이렇게 하시겠습니까?


// index.php
Flight::route('/user/@id', [ 'UserController', 'viewUserProfile' ]);
Flight::route('/user/@id/edit', [ 'UserController', 'editUserProfile' ]);

// 아마도 여러분의 app/controllers/UserController.php에서
class UserController {
    public function viewUserProfile($id) {
        // 무언가 수행
    }

    public function editUserProfile($id) {
        // 무언가 수행
    }
}

중앙 집중식 라우팅 시스템을 사용하는 이점을 보시기 바랍니다. 나중에 오랜 기간동안 관리하고 이해하기 쉽습니다!

요청과 응답

Flight는 요청과 응답을 처리하는 간단하고 쉬운 방법을 제공합니다. 이것이 웹 프레임워크의 핵심입니다. 사용자 브라우저에서 요청을 받아들이고, 처리한 다음 사용자에게 응답을 보냅니다. 사용자 프로필 표시, 사용자 로그인 허용 또는 사용자가 새 블로그 글을 게시할 수 있도록 하는 웹 애플리케이션을 구축할 수 있습니다.

요청

요청은 사용자 브라우저가 여러분의 웹사이트를 방문할 때 서버로 보내는 것입니다. 이 요청에는 사용자가 할 작업에 대한 정보가 포함되어 있습니다. 예를 들어, 사용자가 방문하려는 URL, 사용자가 서버로 보내려는 데이터 및 서버에서 사용자가 받기 원하는 데이터에 대한 정보가 포함될 수 있습니다. 이 요청은 읽기 전용임을 알려드립니다. 요청을 변경할 수는 없지만 읽을 수는 있습니다. Flight은 요청에 관한 정보에 액세스할 수 있는 간단한 방법을 제공합니다. Flight::request() 메서드를 사용하여 요청에 관한 정보에 액세스할 수 있습니다. 이 메서드는 요청에 관한 정보를 포함한 Request 객체를 반환합니다. 이 객체를 사용하여 요청에 관한 정보에 액세스할 수 있으며, URL, 메서드 또는 사용자가 서버에게 보낸 데이터와 같은 정보를 액세스할 수 있습니다.

응답

응답은 사용자 브라우저가 여러분의 웹사이트를 방문할 때 여러분의 서버가 사용자 브라우저로 보내는 것입니다. 이 응답에는 서버가 하려는 작업에 대한 정보가 포함되어 있습니다. 예를 들어, 사용자에게 보내기 원하는 데이터, 사용자로부터 받기 원하는 데이터 또는 서버가 사용자의 컴퓨터에 저장하길 원하는 데이터에 대한 정보가 포함될 수 있습니다. Flight는 사용자 브라우저로 응답을 보내는 간단한 방법을 제공합니다. Flight::response() 메서드를 사용하여 응답을 전송할 수 있습니다. 이 메서드는 Response 객체를 매개변수로 받아 사용자 브라우저로 응답을 전송합니다. 이 객체를 사용하여 사용자 브라우저로 응답을 보낼 수 있으며, HTML, JSON 또는 파일과 같은 응답을 보낼 수 있습니다. Flight는 응답의 일부를 자동으로 생성하여 작업을 쉽게 만들어줍니다. 그러나 최종적으로 사용자에게 반환할 것을 완전히 제어할 수 있습니다.

Learn/responses

응답

개요

Flight는 응답 헤더의 일부를 생성하는 데 도움을 주지만, 사용자에게 보낼 내용에 대한 대부분의 제어를 유지합니다. 대부분의 경우 response() 객체에 직접 접근하지만, Flight는 일부 응답 헤더를 설정하는 데 도움을 주는 헬퍼 메서드를 제공합니다.

이해하기

사용자가 요청 요청을 애플리케이션에 보낸 후, 적절한 응답을 생성해야 합니다. 그들은 선호하는 언어, 특정 유형의 압축을 처리할 수 있는지, 사용자 에이전트 등과 같은 정보를 보냈으며, 모든 것을 처리한 후 적절한 응답을 보내는 시간입니다. 이는 헤더 설정, HTML 또는 JSON 본문 출력, 또는 페이지로 리디렉션하는 등의 작업일 수 있습니다.

기본 사용법

응답 본문 보내기

Flight는 출력을 버퍼링하기 위해 ob_start()를 사용합니다. 이는 echo 또는 print를 사용하여 사용자에게 응답을 보낼 수 있으며, Flight가 이를 캡처하여 적절한 헤더와 함께 사용자에게 보낸다는 의미입니다.

// 이는 "Hello, World!"를 사용자의 브라우저로 보냅니다
Flight::route('/', function() {
    echo "Hello, World!";
});

// HTTP/1.1 200 OK
// Content-Type: text/html
//
// Hello, World!

대안으로, write() 메서드를 호출하여 본문에 추가할 수도 있습니다.

// 이는 "Hello, World!"를 사용자의 브라우저로 보냅니다
Flight::route('/', function() {
    // 때때로 필요할 때 작업을 수행하지만 장황합니다
    Flight::response()->write("Hello, World!");

    // 이 시점에서 설정한 본문을 검색하려면
    // 이렇게 할 수 있습니다
    $body = Flight::response()->getBody();
});

JSON

Flight는 JSON 및 JSONP 응답을 보내는 지원을 제공합니다. JSON 응답을 보내기 위해 JSON 인코딩할 데이터를 전달합니다:

Flight::route('/@companyId/users', function(int $companyId) {
    // 예를 들어 데이터베이스에서 사용자를 가져오는 등의 작업
    $users = Flight::db()->fetchAll("SELECT id, first_name, last_name FROM users WHERE company_id = ?", [ $companyId ]);

    Flight::json($users);
});
// [{"id":1,"first_name":"Bob","last_name":"Jones"}, /* more users */ ]

참고: 기본적으로 Flight는 응답과 함께 Content-Type: application/json 헤더를 보냅니다. JSON을 인코딩할 때 JSON_THROW_ON_ERROR 및 JSON_UNESCAPED_SLASHES 플래그도 사용합니다.

상태 코드와 함께 JSON

두 번째 인수로 상태 코드를 전달할 수도 있습니다:

Flight::json(['id' => 123], 201);

예쁘게 출력하는 JSON

마지막 위치에 인수를 전달하여 예쁘게 출력할 수도 있습니다:

Flight::json(['id' => 123], 200, true, 'utf-8', JSON_PRETTY_PRINT);

JSON 인수 순서 변경

Flight::json()은 매우 오래된 메서드이지만, Flight의 목표는 프로젝트의 이전 호환성을 유지하는 것입니다. 인수의 순서를 다시 설정하여 더 간단한 구문을 사용하려면, 다른 Flight 메서드처럼 JSON 메서드를 재매핑할 수 있습니다:

Flight::map('json', function($data, $code = 200, $options = 0) {

    // 이제 json() 메서드를 사용할 때 `true, 'utf-8'`를 할 필요가 없습니다!
    Flight::_json($data, $code, true, 'utf-8', $options);
}

// 이제 이렇게 사용할 수 있습니다
Flight::json(['id' => 123], 200, JSON_PRETTY_PRINT);

JSON과 실행 중지

v3.10.0

JSON 응답을 보내고 실행을 중지하려면 jsonHalt() 메서드를 사용할 수 있습니다. 이는 권한 부여를 확인하는 등의 경우에 유용하며, 사용자가 권한이 없으면 JSON 응답을 즉시 보내고 기존 본문 내용을 지우고 실행을 중지할 수 있습니다.

Flight::route('/users', function() {
    $authorized = someAuthorizationCheck();
    // 사용자가 권한이 있는지 확인
    if($authorized === false) {
        Flight::jsonHalt(['error' => 'Unauthorized'], 401);
        // 여기서는 exit;가 필요 없습니다.
    }

    // 나머지 라우트로 계속 진행
});

v3.10.0 이전에는 다음과 같이 해야 했습니다:

Flight::route('/users', function() {
    $authorized = someAuthorizationCheck();
    // 사용자가 권한이 있는지 확인
    if($authorized === false) {
        Flight::halt(401, json_encode(['error' => 'Unauthorized']));
    }

    // 나머지 라우트로 계속 진행
});

응답 본문 지우기

응답 본문을 지우려면 clearBody 메서드를 사용할 수 있습니다:

Flight::route('/', function() {
    if($someCondition) {
        Flight::response()->write("Hello, World!");
    } else {
        Flight::response()->clearBody();
    }
});

위 사용 사례는 흔하지 않지만, 미들웨어에서 사용된다면 더 흔할 수 있습니다.

응답 본문에 콜백 실행

addResponseBodyCallback 메서드를 사용하여 응답 본문에 콜백을 실행할 수 있습니다:

Flight::route('/users', function() {
    $db = Flight::db();
    $users = $db->fetchAll("SELECT * FROM users");
    Flight::render('users_table', ['users' => $users]);
});

// 이는 모든 라우트의 응답을 gzip으로 압축합니다
Flight::response()->addResponseBodyCallback(function($body) {
    return gzencode($body, 9);
});

여러 콜백을 추가할 수 있으며, 추가된 순서대로 실행됩니다. 이는 callable을 허용하므로 클래스 배열 [ $class, 'method' ], 클로저 $strReplace = function($body) { str_replace('hi', 'there', $body); };, 또는 HTML 코드를 압축하는 함수 이름 'minify' 등을 허용합니다.

참고: flight.v2.output_buffering 구성 옵션을 사용 중이라면 라우트 콜백이 작동하지 않습니다.

특정 라우트 콜백

이것을 특정 라우트에만 적용하려면 라우트 자체에 콜백을 추가할 수 있습니다:

Flight::route('/users', function() {
    $db = Flight::db();
    $users = $db->fetchAll("SELECT * FROM users");
    Flight::render('users_table', ['users' => $users]);

    // 이는 이 라우트의 응답만 gzip으로 압축합니다
    Flight::response()->addResponseBodyCallback(function($body) {
        return gzencode($body, 9);
    });
});

미들웨어 옵션

미들웨어를 사용하여 모든 라우트에 콜백을 적용할 수도 있습니다:

// MinifyMiddleware.php
class MinifyMiddleware {
    public function before() {
        // response() 객체에 여기서 콜백을 적용합니다.
        Flight::response()->addResponseBodyCallback(function($body) {
            return $this->minify($body);
        });
    }

    protected function minify(string $body): string {
        // 본문을 압축하는 등의 작업
        return $body;
    }
}

// index.php
Flight::group('/users', function() {
    Flight::route('', function() { /* ... */ });
    Flight::route('/@id', function($id) { /* ... */ });
}, [ new MinifyMiddleware() ]);

상태 코드

status 메서드를 사용하여 응답의 상태 코드를 설정할 수 있습니다:

Flight::route('/@id', function($id) {
    if($id == 123) {
        Flight::response()->status(200);
        echo "Hello, World!";
    } else {
        Flight::response()->status(403);
        echo "Forbidden";
    }
});

현재 상태 코드를 가져오려면 인수 없이 status 메서드를 사용할 수 있습니다:

Flight::response()->status(); // 200

응답 헤더 설정

header 메서드를 사용하여 응답의 콘텐츠 유형 등의 헤더를 설정할 수 있습니다:

// 이는 "Hello, World!"를 사용자의 브라우저에 일반 텍스트로 보냅니다
Flight::route('/', function() {
    Flight::response()->header('Content-Type', 'text/plain');
    // 또는
    Flight::response()->setHeader('Content-Type', 'text/plain');
    echo "Hello, World!";
});

리디렉션

redirect() 메서드를 사용하여 현재 요청을 리디렉션할 수 있으며, 새로운 URL을 전달합니다:

Flight::route('/login', function() {
    $username = Flight::request()->data->username;
    $password = Flight::request()->data->password;
    $passwordConfirm = Flight::request()->data->password_confirm;

    if($password !== $passwordConfirm) {
        Flight::redirect('/new/location');
        return; // 아래 기능이 실행되지 않도록 필요합니다
    }

    // 새 사용자 추가...
    Flight::db()->runQuery("INSERT INTO users ....");
    Flight::redirect('/admin/dashboard');
});

참고: 기본적으로 Flight는 HTTP 303 ("See Other") 상태 코드를 보냅니다. 선택적으로 사용자 지정 코드를 설정할 수 있습니다:

Flight::redirect('/new/location', 301); // 영구

라우트 실행 중지

halt 메서드를 호출하여 프레임워크를 중지하고 즉시 종료할 수 있습니다:

Flight::halt();

선택적으로 HTTP 상태 코드와 메시지를 지정할 수도 있습니다:

Flight::halt(200, 'Be right back...');

halt를 호출하면 그 시점까지의 응답 내용을 버리고 모든 실행을 중지합니다. 프레임워크를 중지하고 현재 응답을 출력하려면 stop 메서드를 사용합니다:

Flight::stop($httpStatusCode = null);

참고: Flight::stop()은 응답을 출력하지만 스크립트 실행을 계속하므로 원하는 결과가 아닐 수 있습니다. 추가 실행을 방지하기 위해 Flight::stop() 호출 후 exit 또는 return을 사용할 수 있지만, 일반적으로 Flight::halt()를 사용하는 것이 권장됩니다.

이는 헤더 키와 값을 응답 객체에 저장합니다. 요청 수명 주기 끝에서 헤더를 빌드하고 응답을 보냅니다.

고급 사용법

즉시 헤더 보내기

헤더에 사용자 지정 작업을 수행해야 하며 작업 중인 코드 라인에서 헤더를 보내야 하는 경우가 있을 수 있습니다. 스트리밍 라우트를 설정 중이라면 이것이 필요합니다. 이는 response()->setRealHeader()를 통해 달성할 수 있습니다.

Flight::route('/', function() {
    Flight::response()->setRealHeader('Content-Type: text/plain');
    echo 'Streaming response...';
    sleep(5);
    echo 'Done!';
})->stream();

JSONP

JSONP 요청의 경우, 콜백 함수를 정의하는 데 사용하는 쿼리 매개변수 이름을 선택적으로 전달할 수 있습니다:

Flight::jsonp(['id' => 123], 'q');

따라서 ?q=my_func를 사용한 GET 요청을 하면 다음과 같은 출력을 받을 수 있습니다:

my_func({"id":123});

쿼리 매개변수 이름을 전달하지 않으면 기본적으로 jsonp가 됩니다.

참고: 2025년 이후에도 JSONP 요청을 사용 중이라면 채팅에 참여하여 이유를 알려주세요! 좋은 전투/공포 이야기를 듣는 것을 좋아합니다!

응답 데이터 지우기

clear() 메서드를 사용하여 응답 본문과 헤더를 지울 수 있습니다. 이는 응답에 할당된 모든 헤더를 지우고, 응답 본문을 지우며, 상태 코드를 200으로 설정합니다.

Flight::response()->clear();

응답 본문만 지우기

응답 본문만 지우려면 clearBody() 메서드를 사용할 수 있습니다:

// 이는 response() 객체에 설정된 헤더를 유지합니다.
Flight::response()->clearBody();

HTTP 캐싱

Flight는 HTTP 수준 캐싱에 대한 내장 지원을 제공합니다. 캐싱 조건이 충족되면 Flight는 HTTP 304 Not Modified 응답을 반환합니다. 클라이언트가 동일한 리소스를 다음에 요청할 때 로컬 캐시된 버전을 사용하도록 안내됩니다.

라우트 수준 캐싱

전체 응답을 캐싱하려면 cache() 메서드를 사용하고 캐싱 시간을 전달할 수 있습니다.

// 이는 응답을 5분 동안 캐싱합니다
Flight::route('/news', function () {
  Flight::response()->cache(time() + 300);
  echo 'This content will be cached.';
});

// 또는 strtotime() 메서드에 전달할 문자열을 사용할 수 있습니다
Flight::route('/news', function () {
  Flight::response()->cache('+5 minutes');
  echo 'This content will be cached.';
});

Last-Modified

lastModified 메서드를 사용하고 UNIX 타임스탬프를 전달하여 페이지가 마지막으로 수정된 날짜와 시간을 설정할 수 있습니다. 클라이언트는 마지막 수정 값이 변경될 때까지 캐시를 계속 사용합니다.

Flight::route('/news', function () {
  Flight::lastModified(1234567890);
  echo 'This content will be cached.';
});

ETag

ETag 캐싱은 Last-Modified와 유사하지만, 리소스에 원하는 ID를 지정할 수 있습니다:

Flight::route('/news', function () {
  Flight::etag('my-unique-id');
  echo 'This content will be cached.';
});

lastModified 또는 etag을 호출하면 캐시 값을 설정하고 확인합니다. 요청 간 캐시 값이 동일하면 Flight는 즉시 HTTP 304 응답을 보내고 처리를 중지합니다.

파일 다운로드

v3.12.0

사용자에게 파일을 스트리밍하는 헬퍼 메서드가 있습니다. download 메서드를 사용하고 경로를 전달할 수 있습니다.

Flight::route('/download', function () {
  Flight::download('/path/to/file.txt');
  // v3.17.1부터 다운로드에 사용자 지정 파일 이름을 지정할 수 있습니다
  Flight::download('/path/to/file.txt', 'custom_name.txt');
});

관련 자료

문제 해결

변경 로그

Learn/events

이벤트 관리자

v3.15.0 기준

개요

이벤트는 애플리케이션에서 사용자 지정 동작을 등록하고 트리거할 수 있게 합니다. Flight::onEvent()와 Flight::triggerEvent()의 추가로, 앱의 라이프사이클의 주요 순간에 후크하거나 알림 및 이메일과 같은 사용자 지정 이벤트를 정의하여 코드를 더 모듈화하고 확장 가능하게 만들 수 있습니다. 이러한 메서드는 Flight의 mappable methods 일부로, 필요에 맞게 동작을 재정의할 수 있습니다.

이해하기

이벤트는 애플리케이션의 서로 다른 부분을 분리하여 서로에게 너무 의존하지 않게 합니다. 이 분리—종종 디커플링이라고 불림—는 코드를 업데이트, 확장 또는 디버그하기 쉽게 만듭니다. 모든 것을 하나의 큰 덩어리로 작성하는 대신, 논리를 특정 작업(이벤트)에 응답하는 더 작고 독립적인 조각으로 분할할 수 있습니다.

블로그 앱을 구축한다고 상상해 보세요:

이벤트 없이, 모든 것을 하나의 함수에 넣게 됩니다. 이벤트와 함께라면 분할할 수 있습니다: 한 부분은 댓글을 저장하고, 다른 부분은 'comment.posted'와 같은 이벤트를 트리거하며, 별도의 리스너가 이메일과 로깅을 처리합니다. 이는 코드를 더 깨끗하게 유지하고, 코어 논리를 건드리지 않고 기능(예: 알림)을 추가하거나 제거할 수 있게 합니다.

일반적인 사용 사례

대부분의 경우, 이벤트는 선택적이지만 시스템의 절대적인 코어 부분이 아닌 것에 적합합니다. 예를 들어 다음은 좋지만, 어떤 이유로 실패하더라도 애플리케이션이 여전히 작동해야 합니다:

그러나 비밀번호를 잊었을 때 기능을 생각해 보세요. 이는 코어 기능의 일부여야 하며 이벤트가 아닙니다. 왜냐하면 그 이메일이 발송되지 않으면 사용자가 비밀번호를 재설정하지 못하고 애플리케이션을 사용할 수 없기 때문입니다.

기본 사용법

Flight의 이벤트 시스템은 두 가지 주요 메서드 Flight::onEvent()(이벤트 리스너 등록)와 Flight::triggerEvent()(이벤트 발화)를 중심으로 구축됩니다. 다음과 같이 사용할 수 있습니다:

이벤트 리스너 등록

이벤트에 대한 리스닝을 위해 Flight::onEvent()를 사용합니다. 이 메서드는 이벤트 발생 시 무엇이 일어나야 하는지 정의할 수 있게 합니다.

Flight::onEvent(string $event, callable $callback): void

Flight에 이벤트 발생 시 무엇을 할지 알려 "구독"합니다. 콜백은 이벤트 트리거에서 전달된 인수를 받을 수 있습니다.

Flight의 이벤트 시스템은 동기적입니다. 즉, 각 이벤트 리스너가 순차적으로 하나씩 실행됩니다. 이벤트를 트리거하면, 해당 이벤트에 등록된 모든 리스너가 완료될 때까지 코드가 계속되지 않습니다. 이는 비동기 이벤트 시스템(리스너가 병렬로 또는 나중에 실행될 수 있음)과 다르기 때문에 이해하는 것이 중요합니다.

간단한 예제

Flight::onEvent('user.login', function ($username) {
    echo "Welcome back, $username!";

    // you can send an email if the login is from a new location
});

여기서 'user.login' 이벤트가 트리거되면, 사용자 이름을 이용해 인사하고 필요 시 이메일을 보내는 로직을 포함할 수 있습니다.

참고: 콜백은 함수, 익명 함수 또는 클래스 메서드가 될 수 있습니다.

이벤트 트리거

이벤트가 발생하도록 하려면 Flight::triggerEvent()를 사용합니다. 이는 해당 이벤트에 등록된 모든 리스너를 실행하고 제공된 데이터를 전달합니다.

Flight::triggerEvent(string $event, ...$args): void

간단한 예제

$username = 'alice';
Flight::triggerEvent('user.login', $username);

이는 'user.login' 이벤트를 트리거하고 'alice'를 이전에 정의한 리스너에 보내 출력: Welcome back, alice!.

이벤트 중지

리스너가 false를 반환하면 해당 이벤트의 추가 리스너가 실행되지 않습니다. 이는 특정 조건에 따라 이벤트 체인을 중지할 수 있게 합니다. 리스너의 순서가 중요하다는 점을 기억하세요. 첫 번째로 false를 반환하는 리스너가 나머지를 중지합니다.

예제:

Flight::onEvent('user.login', function ($username) {
    if (isBanned($username)) {
        logoutUser($username);
        return false; // Stops subsequent listeners
    }
});
Flight::onEvent('user.login', function ($username) {
    sendWelcomeEmail($username); // this is never sent
});

이벤트 메서드 재정의

Flight::onEvent()와 Flight::triggerEvent()는 확장 가능하므로, 동작 방식을 재정의할 수 있습니다. 이는 로깅 추가나 이벤트 디스패치 방식 변경과 같은 이벤트 시스템을 사용자 지정하려는 고급 사용자에게 유용합니다.

예제: onEvent 사용자 지정

Flight::map('onEvent', function (string $event, callable $callback) {
    // Log every event registration
    error_log("New event listener added for: $event");
    // Call the default behavior (assuming an internal event system)
    Flight::_onEvent($event, $callback);
});

이제 이벤트를 등록할 때마다 로그를 기록한 후 진행합니다.

왜 재정의하나?

이벤트를 어디에 배치할까

프로젝트에서 이벤트 개념에 익숙하지 않다면, 앱에서 이 모든 이벤트를 어디에 등록하나?라고 궁금할 수 있습니다. Flight의 단순함 덕분에 엄격한 규칙은 없으며, 프로젝트에 맞게 어디든 배치할 수 있습니다. 그러나 앱이 성장함에 따라 코드를 유지하기 위해 체계적으로 유지하는 것이 도움이 됩니다. Flight의 가벼운 특성에 맞춘 실용적인 옵션과 모범 사례는 다음과 같습니다:

옵션 1: 메인 index.php에

작은 앱이나 빠른 프로토타입의 경우, index.php 파일에 이벤트 등록과 라우트를 함께 배치할 수 있습니다. 모든 것을 한 곳에 유지하여 단순함을 우선할 때 적합합니다.

require 'vendor/autoload.php';

// Register events
Flight::onEvent('user.login', function ($username) {
    error_log("$username logged in at " . date('Y-m-d H:i:s'));
});

// Define routes
Flight::route('/login', function () {
    $username = 'bob';
    Flight::triggerEvent('user.login', $username);
    echo "Logged in!";
});

Flight::start();

옵션 2: 별도의 events.php 파일

조금 더 큰 앱의 경우, 이벤트 등록을 app/config/events.php와 같은 전용 파일로 이동하는 것을 고려하세요. index.php에서 라우트 전에 이 파일을 포함합니다. 이는 Flight 프로젝트에서 app/config/routes.php에 라우트를 조직하는 방식을 모방합니다.

// app/config/events.php
Flight::onEvent('user.login', function ($username) {
    error_log("$username logged in at " . date('Y-m-d H:i:s'));
});

Flight::onEvent('user.registered', function ($email, $name) {
    echo "Email sent to $email: Welcome, $name!";
});
// index.php
require 'vendor/autoload.php';
require 'app/config/events.php';

Flight::route('/login', function () {
    $username = 'bob';
    Flight::triggerEvent('user.login', $username);
    echo "Logged in!";
});

Flight::start();

옵션 3: 트리거되는 곳 근처에

또 다른 접근은 컨트롤러나 라우트 정의 내부와 같이 트리거되는 곳 근처에 이벤트를 등록하는 것입니다. 이는 이벤트가 앱의 한 부분에 특정할 때 잘 작동합니다.

Flight::route('/signup', function () {
    // Register event here
    Flight::onEvent('user.registered', function ($email) {
        echo "Welcome email sent to $email!";
    });

    $email = 'jane@example.com';
    Flight::triggerEvent('user.registered', $email);
    echo "Signed up!";
});

Flight를 위한 모범 사례

팁: 목적별 그룹화

events.php에서 관련 이벤트(예: 모든 사용자 관련 이벤트)를 함께 그룹화하고 명확성을 위해 주석 사용:

// app/config/events.php
// User Events
Flight::onEvent('user.login', function ($username) {
    error_log("$username logged in");
});
Flight::onEvent('user.registered', function ($email) {
    echo "Welcome to $email!";
});

// Page Events
Flight::onEvent('page.updated', function ($pageId) {
    Flight::cache()->delete("page_$pageId");
});

이 구조는 잘 확장되며 초보자 친화적입니다.

실제 세계 예제

이벤트가 어떻게 작동하고 왜 유용한지 보여주기 위해 실제 시나리오를 살펴보겠습니다.

예제 1: 사용자 로그인 로깅

// Step 1: Register a listener
Flight::onEvent('user.login', function ($username) {
    $time = date('Y-m-d H:i:s');
    error_log("$username logged in at $time");
});

// Step 2: Trigger it in your app
Flight::route('/login', function () {
    $username = 'bob'; // Pretend this comes from a form
    Flight::triggerEvent('user.login', $username);
    echo "Hi, $username!";
});

왜 유용한가: 로그인 코드는 로깅에 대해 알 필요가 없음—그냥 이벤트를 트리거. 나중에 더 많은 리스너(예: 환영 이메일 보내기)를 라우트를 변경하지 않고 추가할 수 있음.

예제 2: 새 사용자 알림

// Listener for new registrations
Flight::onEvent('user.registered', function ($email, $name) {
    // Simulate sending an email
    echo "Email sent to $email: Welcome, $name!";
});

// Trigger it when someone signs up
Flight::route('/signup', function () {
    $email = 'jane@example.com';
    $name = 'Jane';
    Flight::triggerEvent('user.registered', $email, $name);
    echo "Thanks for signing up!";
});

왜 유용한가: 가입 논리는 사용자 생성에 집중하고, 이벤트는 알림 처리. 나중에 더 많은 리스너(예: 가입 로그) 추가 가능.

예제 3: 캐시 지우기

// Listener to clear a cache
Flight::onEvent('page.updated', function ($pageId) {
    // if using the flightphp/cache plugin
    Flight::cache()->delete("page_$pageId");
    echo "Cache cleared for page $pageId.";
});

// Trigger when a page is edited
Flight::route('/edit-page/(@id)', function ($pageId) {
    // Pretend we updated the page
    Flight::triggerEvent('page.updated', $pageId);
    echo "Page $pageId updated.";
});

왜 유용한가: 편집 코드는 캐싱에 신경 쓰지 않음—업데이트 신호만. 앱의 다른 부분이 필요에 따라 반응할 수 있음.

모범 사례

Flight PHP의 이벤트 시스템은 Flight::onEvent()와 Flight::triggerEvent()로 단순하면서도 강력한 유연한 애플리케이션 구축 방식을 제공합니다. 앱의 다른 부분이 이벤트 통해 서로 소통하게 함으로써 코드를 조직화, 재사용 가능하고 확장하기 쉽게 유지할 수 있습니다. 작업 로깅, 알림 보내기 또는 업데이트 관리 시, 이벤트는 논리를 엉키지 않게 도와줍니다. 게다가 이러한 메서드를 재정의할 수 있어 시스템을 필요에 맞게 조정할 자유가 있습니다. 단일 이벤트로 작게 시작해 앱 구조가 어떻게 변하는지 지켜보세요!

내장 이벤트

Flight PHP에는 프레임워크 라이프사이클에 후크할 수 있는 몇 가지 내장 이벤트가 있습니다. 이러한 이벤트는 요청/응답 사이클의 특정 지점에서 트리거되어 특정 작업 발생 시 사용자 지정 논리를 실행할 수 있게 합니다.

내장 이벤트 목록

관련 자료

문제 해결

변경 로그

Learn/templates

HTML 뷰와 템플릿

개요

Flight는 기본적으로 간단한 HTML 템플릿 기능이 제공됩니다. 템플릿은 애플리케이션 로직을 프레젠테이션 계층에서 분리하는 매우 효과적인 방법입니다.

이해하기

애플리케이션을 구축할 때, 최종 사용자에게 전달할 HTML을 만들게 될 것입니다. PHP 자체는 템플릿 언어이지만, 데이터베이스 호출, API 호출 등의 비즈니스 로직을 HTML 파일에 쉽게 포함시켜 테스트와 분리를 매우 어렵게 만들 수 있습니다. 데이터를 템플릿에 전달하고 템플릿이 자체적으로 렌더링하도록 하면 코드를 분리하고 단위 테스트하기가 훨씬 쉬워집니다. 템플릿을 사용하면 나중에 감사하게 될 것입니다!

기본 사용법

Flight는 기본 뷰 엔진을 자신의 뷰 클래스를 등록함으로써 간단히 교체할 수 있습니다. Smarty, Latte, Blade 등의 사용 예시는 아래를 스크롤하여 확인하세요!

Latte

권장

뷰에 Latte 템플릿 엔진을 사용하는 방법은 다음과 같습니다.

설치

composer require latte/latte

기본 구성

주요 아이디어는 기본 PHP 렌더러 대신 Latte를 사용하도록 render 메서드를 덮어쓰는 것입니다.

// 기본 PHP 렌더러 대신 latte를 사용하도록 render 메서드 덮어쓰기
Flight::map('render', function(string $template, array $data, ?string $block): void {
    $latte = new Latte\Engine;

    // latte가 캐시를 저장하는 위치
    $latte->setTempDirectory(__DIR__ . '/../cache/');

    $finalPath = Flight::get('flight.views.path') . $template;

    $latte->render($finalPath, $data, $block);
});

Flight에서 Latte 사용하기

이제 Latte로 렌더링할 수 있으므로 다음과 같이 할 수 있습니다:

<!-- app/views/home.latte -->
<html>
  <head>
    <title>{$title ? $title . ' - '}My App</title>
    <link rel="stylesheet" href="style.css">
  </head>
  <body>
    <h1>Hello, {$name}!</h1>
  </body>
</html>
// routes.php
Flight::route('/@name', function ($name) {
    Flight::render('home.latte', [
        'title' => 'Home Page',
        'name' => $name
    ]);
});

브라우저에서 /Bob을 방문하면 출력은 다음과 같습니다:

<html>
  <head>
    <title>Home Page - My App</title>
    <link rel="stylesheet" href="style.css">
  </head>
  <body>
    <h1>Hello, Bob!</h1>
  </body>
</html>

추가 읽기

Latte를 레이아웃과 함께 사용하는 더 복잡한 예시는 이 문서의 멋진 플러그인 섹션에 나와 있습니다.

번역 및 언어 기능 포함 Latte의 전체 기능을 더 알아보려면 공식 문서를 읽어보세요.

내장 뷰 엔진

더 이상 사용되지 않음

참고: 여전히 기본 기능이며 기술적으로 작동합니다.

뷰 템플릿을 표시하려면 render 메서드를 템플릿 파일 이름과 선택적 템플릿 데이터로 호출하세요:

Flight::render('hello.php', ['name' => 'Bob']);

전달된 템플릿 데이터는 자동으로 템플릿에 주입되며 로컬 변수처럼 참조할 수 있습니다. 템플릿 파일은 단순한 PHP 파일입니다. hello.php 템플릿 파일의 내용이 다음과 같다면:

Hello, <?= $name ?>!

출력은 다음과 같습니다:

Hello, Bob!

set 메서드를 사용하여 뷰 변수를 수동으로 설정할 수도 있습니다:

Flight::view()->set('name', 'Bob');

이제 name 변수는 모든 뷰에서 사용할 수 있습니다. 따라서 간단히 다음과 같이 할 수 있습니다:

Flight::render('hello');

render 메서드에서 템플릿 이름을 지정할 때 .php 확장자를 생략할 수 있습니다.

기본적으로 Flight는 템플릿 파일을 views 디렉토리에서 찾습니다. 템플릿에 대한 대체 경로를 설정하려면 다음 구성을 설정하세요:

Flight::set('flight.views.path', '/path/to/views');

레이아웃

웹사이트는 교환 가능한 콘텐츠와 함께 단일 레이아웃 템플릿 파일을 가지는 것이 일반적입니다. 레이아웃에 사용할 콘텐츠를 렌더링하려면 render 메서드에 선택적 매개변수를 전달할 수 있습니다.

Flight::render('header', ['heading' => 'Hello'], 'headerContent');
Flight::render('body', ['body' => 'World'], 'bodyContent');

뷰에는 headerContent와 bodyContent라는 저장된 변수가 있습니다. 레이아웃을 렌더링하려면 다음과 같이 하세요:

Flight::render('layout', ['title' => 'Home Page']);

템플릿 파일이 다음과 같다면:

header.php:

<h1><?= $heading ?></h1>

body.php:

<div><?= $body ?></div>

layout.php:

<html>
  <head>
    <title><?= $title ?></title>
  </head>
  <body>
    <?= $headerContent ?>
    <?= $bodyContent ?>
  </body>
</html>

출력은 다음과 같습니다:

<html>
  <head>
    <title>Home Page</title>
  </head>
  <body>
    <h1>Hello</h1>
    <div>World</div>
  </body>
</html>

Smarty

뷰에 Smarty 템플릿 엔진을 사용하는 방법은 다음과 같습니다:

// Smarty 라이브러리 로드
require './Smarty/libs/Smarty.class.php';

// Smarty를 뷰 클래스로 등록
// 로드 시 Smarty를 구성하는 콜백 함수도 전달
Flight::register('view', Smarty::class, [], function (Smarty $smarty) {
  $smarty->setTemplateDir('./templates/');
  $smarty->setCompileDir('./templates_c/');
  $smarty->setConfigDir('./config/');
  $smarty->setCacheDir('./cache/');
});

// 템플릿 데이터 할당
Flight::view()->assign('name', 'Bob');

// 템플릿 표시
Flight::view()->display('hello.tpl');

완전성을 위해 Flight의 기본 render 메서드도 덮어써야 합니다:

Flight::map('render', function(string $template, array $data): void {
  Flight::view()->assign($data);
  Flight::view()->display($template);
});

Blade

뷰에 Blade 템플릿 엔진을 사용하는 방법은 다음과 같습니다:

먼저 Composer를 통해 BladeOne 라이브러리를 설치해야 합니다:

composer require eftec/bladeone

그런 다음 Flight에서 BladeOne을 뷰 클래스로 구성할 수 있습니다:

<?php
// BladeOne 라이브러리 로드
use eftec\bladeone\BladeOne;

// BladeOne을 뷰 클래스로 등록
// 로드 시 BladeOne을 구성하는 콜백 함수도 전달
Flight::register('view', BladeOne::class, [], function (BladeOne $blade) {
  $views = __DIR__ . '/../views';
  $cache = __DIR__ . '/../cache';

  $blade->setPath($views);
  $blade->setCompiledPath($cache);
});

// 템플릿 데이터 할당
Flight::view()->share('name', 'Bob');

// 템플릿 표시
echo Flight::view()->run('hello', []);

완전성을 위해 Flight의 기본 render 메서드도 덮어써야 합니다:

<?php
Flight::map('render', function(string $template, array $data): void {
  echo Flight::view()->run($template, $data);
});

이 예에서 hello.blade.php 템플릿 파일은 다음과 같을 수 있습니다:

<?php
Hello, {{ $name }}!

출력은 다음과 같습니다:

Hello, Bob!

관련 항목

문제 해결

변경 로그

Learn/collections

Collections

Overview

Flight의 Collection 클래스는 데이터 세트를 관리하기 위한 유용한 유틸리티입니다. 배열과 객체 표기법을 모두 사용하여 데이터에 접근하고 조작할 수 있어 코드가 더 깔끔하고 유연해집니다.

Understanding

Collection은 기본적으로 배열 주위의 래퍼이지만, 추가 기능이 있습니다. 배열처럼 사용할 수 있으며, 반복할 수 있고, 항목 수를 세고, 객체 속성처럼 항목에 접근할 수 있습니다. 이는 앱에서 구조화된 데이터를 전달하거나 코드를 더 읽기 쉽게 만들 때 특히 유용합니다.

Collections는 여러 PHP 인터페이스를 구현합니다:

Basic Usage

Creating a Collection

배열을 생성자에 전달하여 컬렉션을 생성할 수 있습니다:

use flight\util\Collection;

$data = [
  'name' => 'Flight',
  'version' => 3,
  'features' => ['routing', 'views', 'extending']
];

$collection = new Collection($data);

Accessing Items

배열 또는 객체 표기법을 사용하여 항목에 접근할 수 있습니다:

// Array notation
echo $collection['name']; // Output: FlightPHP

// Object notation
echo $collection->version; // Output: 3

존재하지 않는 키에 접근하려고 하면 오류 대신 null을 반환합니다.

Setting Items

두 표기법을 사용하여 항목을 설정할 수도 있습니다:

// Array notation
$collection['author'] = 'Mike Cao';

// Object notation
$collection->license = 'MIT';

Checking and Removing Items

항목이 존재하는지 확인:

if (isset($collection['name'])) {
  // Do something
}

if (isset($collection->version)) {
  // Do something
}

항목 제거:

unset($collection['author']);
unset($collection->license);

Iterating Over a Collection

Collections는 반복 가능하므로 foreach 루프에서 사용할 수 있습니다:

foreach ($collection as $key => $value) {
  echo "$key: $value\n";
}

Counting Items

컬렉션의 항목 수를 세는 방법:

echo count($collection); // Output: 4

Getting All Keys or Data

모든 키 가져오기:

$keys = $collection->keys(); // ['name', 'version', 'features', 'license']

배열로 모든 데이터 가져오기:

$data = $collection->getData();

Clearing the Collection

모든 항목 제거:

$collection->clear();

JSON Serialization

Collections를 JSON으로 쉽게 변환할 수 있습니다:

echo json_encode($collection);
// Output: {"name":"FlightPHP","version":3,"features":["routing","views","extending"],"license":"MIT"}

Advanced Usage

필요에 따라 내부 데이터 배열을 완전히 교체할 수 있습니다:

$collection->setData(['foo' => 'bar']);

Collections는 컴포넌트 간에 구조화된 데이터를 전달하거나 배열 데이터에 더 객체 지향적인 인터페이스를 제공할 때 특히 유용합니다.

See Also

Troubleshooting

Changelog

Learn/flight_vs_fat_free

Flight vs Fat-Free

Fat-Free란 무엇인가?

Fat-Free (애정 어린 별칭으로 F3로 알려짐)는 동적이고 강력한 웹 애플리케이션을 빠르게 구축하는 데 도움을 주기 위해 설계된 강력하면서도 사용하기 쉬운 PHP 마이크로 프레임워크입니다!

Flight는 기능과 간단함 측면에서 Fat-Free와 많은 면에서 비교되며, 아마도 가장 가까운 사촌일 것입니다. Fat-Free에는 Flight에 없는 많은 기능이 있지만, Flight에도 있는 많은 기능이 있습니다. Fat-Free는 나이를 드러내기 시작했으며, 예전만큼 인기가 없습니다.

업데이트가 점점 덜 빈번해지고 있으며, 커뮤니티도 예전만큼 활발하지 않습니다. 코드는 충분히 간단하지만, 때때로 구문 규율의 부족으로 인해 읽고 이해하기 어려울 수 있습니다. PHP 8.3에서 작동하지만, 코드 자체는 여전히 PHP 5.3에 살고 있는 것처럼 보입니다.

Flight와 비교한 장점

Flight와 비교한 단점

Learn/extending

확장

개요

Flight는 확장 가능한 프레임워크로 설계되었습니다. 이 프레임워크는 기본 메서드와 구성 요소 세트를 제공하지만, 사용자의 자체 메서드를 매핑하거나, 자체 클래스 등록, 또는 기존 클래스와 메서드 재정의가 가능합니다.

이해

Flight의 기능을 확장하는 방법은 2가지가 있습니다:

  1. 메서드 매핑 - 애플리케이션의 어디서나 호출할 수 있는 간단한 사용자 정의 메서드를 생성하는 데 사용됩니다. 이는 코드의 어디서나 호출할 수 있는 유틸리티 함수에 일반적으로 사용됩니다.
  2. 클래스 등록 - Flight에 자체 클래스를 등록하는 데 사용됩니다. 이는 종속성이나 구성이 필요한 클래스에 일반적으로 사용됩니다.

기존 프레임워크 메서드를 재정의하여 프로젝트 요구사항에 더 잘 맞도록 기본 동작을 변경할 수도 있습니다.

DIC(Dependency Injection Container)를 찾고 계신다면, Dependency Injection Container 페이지로 이동하세요.

기본 사용법

프레임워크 메서드 재정의

Flight는 코드를 수정하지 않고도 자체 요구사항에 맞게 기본 기능을 재정의할 수 있도록 허용합니다. 재정의할 수 있는 모든 메서드는 아래에서 확인할 수 있습니다.

예를 들어, Flight가 URL을 라우트에 매칭할 수 없을 때 notFound 메서드를 호출하여 일반적인 HTTP 404 응답을 보냅니다. 이 동작을 map 메서드를 사용하여 재정의할 수 있습니다:

Flight::map('notFound', function() {
  // 사용자 정의 404 페이지 표시
  include 'errors/404.html';
});

Flight는 또한 프레임워크의 핵심 구성 요소를 교체할 수 있도록 허용합니다. 예를 들어 기본 Router 클래스를 자체 사용자 정의 클래스로 교체할 수 있습니다:

// 사용자 정의 Router 클래스 생성
class MyRouter extends \flight\net\Router {
    // 여기서 메서드 재정의
    // 예를 들어 GET 요청에 대한 단축으로
    // pass route 기능을 제거
    public function get($pattern, $callback, $alias = '') {
        return parent::get($pattern, $callback, false, $alias);
    }
}

// 사용자 정의 클래스 등록
Flight::register('router', MyRouter::class);

// Flight가 Router 인스턴스를 로드할 때 사용자 클래스 로드
$myRouter = Flight::router();
$myRouter->get('/hello', function() {
  echo "Hello World!";
}, 'hello_alias');

그러나 map 및 register와 같은 프레임워크 메서드는 재정의할 수 없습니다. 이를 시도하면 오류가 발생합니다 (다시 아래에서 메서드 목록 확인).

매핑 가능한 프레임워크 메서드

아래는 프레임워크의 전체 메서드 세트입니다. 이는 일반 정적 메서드인 핵심 메서드와, 필터링되거나 재정의될 수 있는 매핑된 메서드인 확장 메서드로 구성됩니다.

핵심 메서드

이 메서드들은 프레임워크의 핵심이며 재정의할 수 없습니다.

Flight::map(string $name, callable $callback, bool $pass_route = false) // 사용자 정의 프레임워크 메서드 생성.
Flight::register(string $name, string $class, array $params = [], ?callable $callback = null) // 프레임워크 메서드에 클래스 등록.
Flight::unregister(string $name) // 프레임워크 메서드에 등록된 클래스 등록 해제.
Flight::before(string $name, callable $callback) // 프레임워크 메서드 전에 필터 추가.
Flight::after(string $name, callable $callback) // 프레임워크 메서드 후에 필터 추가.
Flight::path(string $path) // 클래스 자동 로딩을 위한 경로 추가.
Flight::get(string $key) // Flight::set()으로 설정된 변수 가져오기.
Flight::set(string $key, mixed $value) // Flight 엔진 내 변수 설정.
Flight::has(string $key) // 변수가 설정되었는지 확인.
Flight::clear(array|string $key = []) // 변수 지우기.
Flight::init() // 프레임워크를 기본 설정으로 초기화.
Flight::app() // 애플리케이션 객체 인스턴스 가져오기
Flight::request() // 요청 객체 인스턴스 가져오기
Flight::response() // 응답 객체 인스턴스 가져오기
Flight::router() // 라우터 객체 인스턴스 가져오기
Flight::view() // 뷰 객체 인스턴스 가져오기

확장 메서드

Flight::start() // 프레임워크 시작.
Flight::stop() // 프레임워크 중지 및 응답 전송.
Flight::halt(int $code = 200, string $message = '') // 선택적 상태 코드와 메시지로 프레임워크 중지.
Flight::route(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') // URL 패턴을 콜백에 매핑.
Flight::post(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') // POST 요청 URL 패턴을 콜백에 매핑.
Flight::put(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') // PUT 요청 URL 패턴을 콜백에 매핑.
Flight::patch(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') // PATCH 요청 URL 패턴을 콜백에 매핑.
Flight::delete(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') // DELETE 요청 URL 패턴을 콜백에 매핑.
Flight::group(string $pattern, callable $callback) // URL 그룹화 생성, 패턴은 문자열이어야 함.
Flight::getUrl(string $name, array $params = []) // 라우트 별칭에 기반한 URL 생성.
Flight::redirect(string $url, int $code) // 다른 URL로 리디렉션.
Flight::download(string $filePath) // 파일 다운로드.
Flight::render(string $file, array $data, ?string $key = null) // 템플릿 파일 렌더링.
Flight::error(Throwable $error) // HTTP 500 응답 전송.
Flight::notFound() // HTTP 404 응답 전송.
Flight::etag(string $id, string $type = 'string') // ETag HTTP 캐싱 수행.
Flight::lastModified(int $time) // 마지막 수정 HTTP 캐싱 수행.
Flight::json(mixed $data, int $code = 200, bool $encode = true, string $charset = 'utf8', int $option) // JSON 응답 전송.
Flight::jsonp(mixed $data, string $param = 'jsonp', int $code = 200, bool $encode = true, string $charset = 'utf8', int $option) // JSONP 응답 전송.
Flight::jsonHalt(mixed $data, int $code = 200, bool $encode = true, string $charset = 'utf8', int $option) // JSON 응답 전송 및 프레임워크 중지.
Flight::onEvent(string $event, callable $callback) // 이벤트 리스너 등록.
Flight::triggerEvent(string $event, ...$args) // 이벤트 트리거.

map 및 register로 추가된 사용자 정의 메서드는 필터링될 수도 있습니다. 이러한 메서드를 필터링하는 방법에 대한 예시는 Filtering Methods 가이드를 참조하세요.

확장 가능한 프레임워크 클래스

기존 클래스를 확장하고 자체 클래스를 등록하여 기능을 재정의할 수 있는 여러 클래스가 있습니다. 이러한 클래스들은 다음과 같습니다:

Flight::app() // 애플리케이션 클래스 - flight\Engine 클래스 확장
Flight::request() // 요청 클래스 - flight\net\Request 클래스 확장
Flight::response() // 응답 클래스 - flight\net\Response 클래스 확장
Flight::router() // 라우터 클래스 - flight\net\Router 클래스 확장
Flight::view() // 뷰 클래스 - flight\template\View 클래스 확장
Flight::eventDispatcher() // 이벤트 디스패처 클래스 - flight\core\Dispatcher 클래스 확장

사용자 정의 메서드 매핑

간단한 사용자 정의 메서드를 매핑하려면 map 함수를 사용합니다:

// 메서드 매핑
Flight::map('hello', function (string $name) {
  echo "hello $name!";
});

// 사용자 정의 메서드 호출
Flight::hello('Bob');

간단한 사용자 정의 메서드를 만드는 것은 가능하지만, PHP에서 표준 함수를 생성하는 것이 IDE의 자동 완성 기능이 있고 읽기 쉽기 때문에 권장됩니다. 위 코드의 등가물은 다음과 같습니다:

function hello(string $name) {
  echo "hello $name!";
}

hello('Bob');

이것은 메서드에 변수를 전달하여 예상 값이 필요한 경우 더 많이 사용됩니다. 아래와 같이 register() 메서드를 사용하는 것은 구성 전달 후 사전 구성된 클래스를 호출하는 데 더 적합합니다.

사용자 정의 클래스 등록

자체 클래스를 등록하고 구성하려면 register 함수를 사용합니다. map()에 비해 이점은 이 함수를 호출할 때 동일한 클래스를 재사용할 수 있다는 것입니다 (예: Flight::db()로 동일한 인스턴스 공유에 유용).

// 클래스 등록
Flight::register('user', User::class);

// 클래스 인스턴스 가져오기
$user = Flight::user();

register 메서드는 클래스 생성자에 매개변수를 전달할 수도 있습니다. 따라서 사용자 정의 클래스를 로드할 때 미리 초기화된 상태로 제공됩니다. 생성자 매개변수는 추가 배열을 전달하여 정의할 수 있습니다. 데이터베이스 연결을 로드하는 예시입니다:

// 생성자 매개변수와 함께 클래스 등록
Flight::register('db', PDO::class, ['mysql:host=localhost;dbname=test', 'user', 'pass']);

// 클래스 인스턴스 가져오기
// 정의된 매개변수로 객체 생성
//
// new PDO('mysql:host=localhost;dbname=test','user','pass');
//
$db = Flight::db();

// 코드의 나중에 필요하다면 동일한 메서드를 다시 호출
class SomeController {
  public function __construct() {
    $this->db = Flight::db();
  }
}

추가 콜백 매개변수를 전달하면 클래스 생성 직후 즉시 실행됩니다. 이는 새 객체에 대한 설정 절차를 수행할 수 있도록 합니다. 콜백 함수는 새 객체의 인스턴스를 하나의 매개변수로 받습니다.

// 콜백은 생성된 객체를 전달받음
Flight::register(
  'db',
  PDO::class,
  ['mysql:host=localhost;dbname=test', 'user', 'pass'],
  function (PDO $db) {
    $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
  }
);

기본적으로 클래스를 로드할 때마다 공유 인스턴스를 받습니다. 클래스의 새 인스턴스를 얻으려면 매개변수로 false를 전달하면 됩니다:

// 클래스의 공유 인스턴스
$shared = Flight::db();

// 클래스의 새 인스턴스
$new = Flight::db(false);

참고: 매핑된 메서드가 등록된 클래스보다 우선순위가 높습니다. 동일한 이름으로 둘 다 선언하면 매핑된 메서드만 호출됩니다.

예시

Flight를 핵심에 내장되지 않은 기능으로 확장하는 방법에 대한 예시입니다.

로깅

Flight에는 내장 로깅 시스템이 없지만, 로깅 라이브러리를 Flight와 함께 사용하는 것은 매우 쉽습니다. Monolog 라이브러리를 사용한 예시입니다:

// services.php

// Flight에 로거 등록
Flight::register('log', Monolog\Logger::class, [ 'name' ], function(Monolog\Logger $log) {
    $log->pushHandler(new Monolog\Handler\StreamHandler('path/to/your.log', Monolog\Logger::WARNING));
});

이제 등록되었으므로 애플리케이션에서 사용할 수 있습니다:

// 컨트롤러나 라우트에서
Flight::log()->warning('This is a warning message');

이것은 지정한 로그 파일에 메시지를 로깅합니다. 오류 발생 시 로그를 남기고 싶다면 error 메서드를 사용할 수 있습니다:

// 컨트롤러나 라우트에서
Flight::map('error', function(Throwable $ex) {
    Flight::log()->error($ex->getMessage());
    // 사용자 정의 오류 페이지 표시
    include 'errors/500.html';
});

또한 before 및 after 메서드를 사용하여 기본 APM(Application Performance Monitoring) 시스템을 생성할 수 있습니다:

// services.php 파일에서

Flight::before('start', function() {
    Flight::set('start_time', microtime(true));
});

Flight::after('start', function() {
    $end = microtime(true);
    $start = Flight::get('start_time');
    Flight::log()->info('Request '.Flight::request()->url.' took ' . round($end - $start, 4) . ' seconds');

    // 요청 또는 응답 헤더를 로그에 추가할 수도 있음
    // (많은 요청이 있으면 데이터가 많아지니 주의)
    Flight::log()->info('Request Headers: ' . json_encode(Flight::request()->headers));
    Flight::log()->info('Response Headers: ' . json_encode(Flight::response()->headers));
});

캐싱

Flight에는 내장 캐싱 시스템이 없지만, 캐싱 라이브러리를 Flight와 함께 사용하는 것은 매우 쉽습니다. PHP File Cache 라이브러리를 사용한 예시입니다:

// services.php

// Flight에 캐시 등록
Flight::register('cache', \flight\Cache::class, [ __DIR__ . '/../cache/' ], function(\flight\Cache $cache) {
    $cache->setDevMode(ENVIRONMENT === 'development');
});

이제 등록되었으므로 애플리케이션에서 사용할 수 있습니다:

// 컨트롤러나 라우트에서
$data = Flight::cache()->get('my_cache_key');
if (empty($data)) {
    // 데이터 처리 수행
    $data = [ 'some' => 'data' ];
    Flight::cache()->set('my_cache_key', $data, 3600); // 1시간 캐시
}

간단한 DIC 객체 인스턴스화

애플리케이션에서 DIC(Dependency Injection Container)를 사용 중이라면, Flight를 사용하여 객체를 인스턴스화할 수 있습니다. Dice 라이브러리를 사용한 예시입니다:

// services.php

// 새 컨테이너 생성
$container = new \Dice\Dice;
// 아래와 같이 자신에게 재할당하는 것을 잊지 마세요!
$container = $container->addRule('PDO', [
    // shared는 동일 객체가 매번 반환됨을 의미
    'shared' => true,
    'constructParams' => ['mysql:host=localhost;dbname=test', 'user', 'pass' ]
]);

// 이제 모든 객체를 생성하는 매핑 가능한 메서드 생성 가능. 
Flight::map('make', function($class, $params = []) use ($container) {
    return $container->create($class, $params);
});

// 컨트롤러/미들웨어에 사용하도록 컨테이너 핸들러 등록
Flight::registerContainerHandler(function($class, $params) {
    Flight::make($class, $params);
});

// 생성자에서 PDO 객체를 받는 샘플 클래스라고 가정
class EmailCron {
    protected PDO $pdo;

    public function __construct(PDO $pdo) {
        $this->pdo = $pdo;
    }

    public function send() {
        // 이메일 전송 코드
    }
}

// 마지막으로 의존성 주입을 사용하여 객체 생성
$emailCron = Flight::make(EmailCron::class);
$emailCron->send();

멋지지 않나요?

관련 자료

문제 해결

변경 로그

Learn/json

JSON Wrapper

개요

Flight의 Json 클래스는 애플리케이션에서 JSON 데이터를 인코딩하고 디코딩하는 간단하고 일관된 방법을 제공합니다. PHP의 기본 JSON 함수를 더 나은 오류 처리와 유용한 기본값으로 감싸서 JSON 작업을 더 쉽고 안전하게 만듭니다.

이해하기

현대 PHP 앱에서 JSON 작업은 API 구축이나 AJAX 요청 처리 시 매우 일반적입니다. Json 클래스는 모든 JSON 인코딩과 디코딩을 중앙화하여 PHP의 내장 함수에서 발생하는 이상한 에지 케이스나 난해한 오류를 걱정할 필요가 없습니다.

주요 기능:

기본 사용법

데이터를 JSON으로 인코딩하기

PHP 데이터를 JSON 문자열로 변환하려면 Json::encode()를 사용하세요:

use flight\util\Json;

$data = [
  'framework' => 'Flight',
  'version' => 3,
  'features' => ['routing', 'views', 'extending']
];

$json = Json::encode($data);
echo $json;
// 출력: {"framework":"Flight","version":3,"features":["routing","views","extending"]}

인코딩이 실패하면 유용한 오류 메시지가 포함된 예외를 받게 됩니다.

예쁜 출력

JSON을 사람이 읽기 쉽게 하려면 prettyPrint()를 사용하세요:

echo Json::prettyPrint($data);
/*
{
  "framework": "Flight",
  "version": 3,
  "features": [
    "routing",
    "views",
    "extending"
  ]
}
*/

JSON 문자열 디코딩

JSON 문자열을 PHP 데이터로 다시 변환하려면 Json::decode()를 사용하세요:

$json = '{"framework":"Flight","version":3}';
$data = Json::decode($json);
echo $data->framework; // 출력: Flight

객체 대신 연관 배열을 원하면 두 번째 인수로 true를 전달하세요:

$data = Json::decode($json, true);
echo $data['framework']; // 출력: Flight

디코딩이 실패하면 명확한 오류 메시지가 포함된 예외를 받게 됩니다.

JSON 유효성 검사

문자열이 유효한 JSON인지 확인하세요:

if (Json::isValid($json)) {
  // 유효합니다!
} else {
  // 유효하지 않은 JSON
}

마지막 오류 가져오기

네이티브 PHP 함수에서 발생한 마지막 JSON 오류 메시지를 확인하려면:

$error = Json::getLastError();
if ($error !== '') {
  echo "마지막 JSON 오류: $error";
}

고급 사용법

더 많은 제어가 필요하다면 인코딩 및 디코딩 옵션을 사용자 지정할 수 있습니다 ( PHP의 json_encode 옵션 참조):

// HEX_TAG 옵션으로 인코딩
$json = Json::encode($data, JSON_HEX_TAG);

// 사용자 지정 깊이로 디코딩
$data = Json::decode($json, false, 1024);

관련 항목

문제 해결

변경 로그

Learn/flight_vs_slim

Flight vs Slim

Slim이란?

Slim은 PHP 마이크로 프레임워크로, 간단하면서도 강력한 웹 애플리케이션과 API를 빠르게 작성하는 데 도움을 줍니다.

Flight의 v3 기능 중 일부는 실제로 Slim에서 영감을 얻었습니다. 라우트 그룹화와 미들웨어를 특정 순서로 실행하는 기능은 Slim에서 영감을 받은 두 가지 기능입니다. Slim v3는 단순성을 목표로 출시되었지만, v4에 대해서는 혼합된 평가가 있었습니다.

Flight와 비교한 장점

Flight와 비교한 단점

Learn/autoloading

자동 로딩

개요

자동 로딩은 PHP에서 클래스들을 로드하기 위해 디렉토리 또는 디렉토리들을 지정하는 개념입니다. 이는 require나 include를 사용하여 클래스들을 로드하는 것보다 훨씬 더 유익합니다. 또한 Composer 패키지를 사용하는 데 필수적입니다.

이해

기본적으로 모든 Flight 클래스는 Composer 덕분에 자동으로 자동 로딩됩니다. 그러나 자신의 클래스들을 자동 로딩하려면 Flight::path() 메서드를 사용하여 클래스들을 로드할 디렉토리를 지정할 수 있습니다.

자동 로더를 사용하면 코드를 상당히 단순화할 수 있습니다. 파일 상단에 사용되는 모든 클래스들을 캡처하기 위해 수많은 include나 require 문으로 시작하는 대신, 클래스들을 동적으로 호출하면 자동으로 포함됩니다.

기본 사용법

다음과 같은 디렉토리 트리를 가지고 있다고 가정해 보겠습니다:

# 예시 경로
/home/user/project/my-flight-project/
├── app
│   ├── cache
│   ├── config
│   ├── controllers - 이 프로젝트의 컨트롤러들을 포함
│   ├── translations
│   ├── UTILS - 이 애플리케이션 전용 클래스들을 포함 (나중에 예시를 위해 의도적으로 대문자)
│   └── views
└── public
    └── css
    └── js
    └── index.php

이것이 이 문서 사이트의 파일 구조와 동일하다는 것을 눈치챘을 수 있습니다.

각 디렉토리를 다음과 같이 로드할 수 있도록 지정할 수 있습니다:


/**
 * public/index.php
 */

// 자동 로더에 경로 추가
Flight::path(__DIR__.'/../app/controllers/');
Flight::path(__DIR__.'/../app/utils/');

/**
 * app/controllers/MyController.php
 */

// 네임스페이싱 불필요

// 모든 자동 로딩된 클래스들은 Pascal Case(각 단어 대문자, 공백 없음)로 하는 것을 권장
class MyController {

    public function index() {
        // 무언가 수행
    }
}

네임스페이스

네임스페이스를 사용한다면 이를 구현하는 것이 매우 쉬워집니다. Flight::path() 메서드를 사용하여 애플리케이션의 루트 디렉토리(문서 루트나 public/ 폴더가 아님)를 지정해야 합니다.


/**
 * public/index.php
 */

// 자동 로더에 경로 추가
Flight::path(__DIR__.'/../');

이제 컨트롤러가 어떻게 보일지 예시를 보세요. 아래 예시를 보지만 중요한 정보에 대한 주석에 주의하세요.

/**
 * app/controllers/MyController.php
 */

// 네임스페이스 필수
// 네임스페이스는 디렉토리 구조와 동일
// 네임스페이스는 디렉토리 구조와 동일한 대소문자를 따라야 함
// 네임스페이스와 디렉토리는 밑줄을 가질 수 없음 (Loader::setV2ClassLoading(false)가 설정되지 않은 한)
namespace app\controllers;

// 모든 자동 로딩된 클래스들은 Pascal Case(각 단어 대문자, 공백 없음)로 하는 것을 권장
// 3.7.2부터 Loader::setV2ClassLoading(false)를 실행하여 클래스 이름에 Pascal_Snake_Case를 사용할 수 있음
class MyController {

    public function index() {
        // 무언가 수행
    }
}

utils 디렉토리의 클래스를 자동 로딩하려면 기본적으로 동일한 작업을 합니다:


/**
 * app/UTILS/ArrayHelperUtil.php
 */

// 네임스페이스는 디렉토리 구조와 대소문자를 일치시켜야 함 (위 파일 트리의 UTILS 디렉토리가 대문자임을 주의
//     위 파일 트리와 같이)
namespace app\UTILS;

class ArrayHelperUtil {

    public function changeArrayCase(array $array) {
        // 무언가 수행
    }
}

클래스 이름의 밑줄

3.7.2부터 Loader::setV2ClassLoading(false);를 실행하여 클래스 이름에 Pascal_Snake_Case를 사용할 수 있습니다. 이는 클래스 이름에 밑줄을 허용합니다. 권장되지 않지만 필요로 하는 사람들을 위해 제공됩니다.

use flight\core\Loader;

/**
 * public/index.php
 */

// 자동 로더에 경로 추가
Flight::path(__DIR__.'/../app/controllers/');
Flight::path(__DIR__.'/../app/utils/');
Loader::setV2ClassLoading(false);

/**
 * app/controllers/My_Controller.php
 */

// 네임스페이싱 불필요

class My_Controller {

    public function index() {
        // 무언가 수행
    }
}

관련 항목

문제 해결

클래스 발견되지 않음 (자동 로딩 작동 안 함)

이 문제가 발생하지 않는 몇 가지 이유가 있을 수 있습니다. 아래에 몇 가지 예시가 있지만 자동 로딩 섹션도 확인하세요.

잘못된 파일 이름

가장 흔한 것은 클래스 이름이 파일 이름과 일치하지 않는 것입니다.

MyClass라는 이름의 클래스가 있다면 파일은 MyClass.php로 명명되어야 합니다. MyClass라는 클래스 이름과 myclass.php라는 파일 이름이라면 자동 로더가 이를 찾을 수 없습니다.

잘못된 네임스페이스

네임스페이스를 사용한다면 네임스페이스가 디렉토리 구조와 일치해야 합니다.

// ...코드...

// MyController가 app/controllers 디렉토리에 있고 네임스페이스된 경우
// 이는 작동하지 않습니다.
Flight::route('/hello', 'MyController->hello');

// 다음 옵션 중 하나를 선택해야 합니다
Flight::route('/hello', 'app\controllers\MyController->hello');
// 또는 상단에 use 문이 있는 경우

use app\controllers\MyController;

Flight::route('/hello', [ MyController::class, 'hello' ]);
// 다음과 같이 작성할 수도 있음
Flight::route('/hello', MyController::class.'->hello');
// 또는...
Flight::route('/hello', [ 'app\controllers\MyController', 'hello' ]);

path() 정의되지 않음

스켈레톤 앱에서 이는 config.php 파일 내부에 정의되어 있지만, 클래스들이 발견되도록 하려면 path() 메서드가 정의되어 있는지 확인해야 합니다 (아마도 디렉토리의 루트로).

// 자동 로더에 경로 추가
Flight::path(__DIR__.'/../');

변경 로그

Learn/uploaded_file

업로드된 파일 핸들러

개요

Flight의 UploadedFile 클래스는 애플리케이션에서 파일 업로드를 쉽게 그리고 안전하게 처리할 수 있게 합니다. 이는 PHP의 파일 업로드 프로세스 세부 사항을 래핑하여 파일 정보를 액세스하고 업로드된 파일을 이동하는 간단한 객체 지향 방식을 제공합니다.

이해

사용자가 폼을 통해 파일을 업로드하면 PHP는 파일에 대한 정보를 $_FILES 슈퍼글로벌에 저장합니다. Flight에서는 $_FILES와 직접 상호작용하는 경우가 거의 없습니다. 대신 Flight의 Request 객체( Flight::request()를 통해 액세스 가능)에 getUploadedFiles() 메서드가 있으며, 이는 UploadedFile 객체 배열을 반환하여 파일 처리를 훨씬 더 편리하고 견고하게 만듭니다.

UploadedFile 클래스는 다음을 수행하는 메서드를 제공합니다:

이 클래스는 파일 업로드의 일반적인 함정을 피하는 데 도움을 주며, 오류 처리나 파일을 안전하게 이동하는 등의 작업을 포함합니다.

기본 사용법

요청에서 업로드된 파일 액세스

업로드된 파일에 액세스하는 권장 방법은 요청 객체를 통하는 것입니다:

Flight::route('POST /upload', function() {
    // <input type="file" name="myFile">라는 폼 필드에 대한 경우
    $uploadedFiles = Flight::request()->getUploadedFiles();
    $file = $uploadedFiles['myFile'];

    // 이제 UploadedFile 메서드를 사용할 수 있습니다
    if ($file->getError() === UPLOAD_ERR_OK) {
        $file->moveTo('/path/to/uploads/' . $file->getClientFilename());
        echo "File uploaded successfully!";
    } else {
        echo "Upload failed: " . $file->getError();
    }
});

여러 파일 업로드 처리

폼이 여러 업로드를 위해 name="myFiles[]"를 사용하는 경우 UploadedFile 객체 배열을 받게 됩니다:

Flight::route('POST /upload', function() {
    // <input type="file" name="myFiles[]">라는 폼 필드에 대한 경우
    $uploadedFiles = Flight::request()->getUploadedFiles();
    foreach ($uploadedFiles['myFiles'] as $file) {
        if ($file->getError() === UPLOAD_ERR_OK) {
            $file->moveTo('/path/to/uploads/' . $file->getClientFilename());
            echo "Uploaded: " . $file->getClientFilename() . "<br>";
        } else {
            echo "Failed to upload: " . $file->getClientFilename() . "<br>";
        }
    }
});

UploadedFile 인스턴스 수동 생성

보통 UploadedFile을 수동으로 생성하지 않지만, 필요하다면 할 수 있습니다:

use flight\net\UploadedFile;

$file = new UploadedFile(
  $_FILES['myfile']['name'],
  $_FILES['myfile']['type'],
  $_FILES['myfile']['size'],
  $_FILES['myfile']['tmp_name'],
  $_FILES['myfile']['error']
);

파일 정보 액세스

업로드된 파일에 대한 세부 정보를 쉽게 가져올 수 있습니다:

echo $file->getClientFilename();   // 사용자의 컴퓨터에서 원본 파일 이름
echo $file->getClientMediaType();  // MIME 유형 (예: image/png)
echo $file->getSize();             // 바이트 단위 파일 크기
echo $file->getTempName();         // 서버의 임시 파일 경로
echo $file->getError();            // 업로드 오류 코드 (0은 오류 없음)

업로드된 파일 이동

파일을 검증한 후 영구 위치로 이동하세요:

try {
  $file->moveTo('/path/to/uploads/' . $file->getClientFilename());
  echo "File uploaded successfully!";
} catch (Exception $e) {
  echo "Upload failed: " . $e->getMessage();
}

moveTo() 메서드는 문제가 발생하면 예외를 발생시킵니다 (예: 업로드 오류나 권한 문제).

업로드 오류 처리

업로드 중 문제가 발생하면 읽기 쉬운 오류 메시지를 가져올 수 있습니다:

if ($file->getError() !== UPLOAD_ERR_OK) {
  // 오류 코드를 사용하거나 moveTo()에서 예외를 잡을 수 있습니다
  echo "There was an error uploading the file.";
}

관련 항목

문제 해결

변경 로그

Guides/unit_testing

Flight PHP에서의 단위 테스트와 PHPUnit

이 가이드는 PHPUnit를 사용한 Flight PHP에서의 단위 테스트를 소개하며, 단위 테스트가 왜 중요한지 이해하고 실질적으로 적용하고 싶은 초보자를 대상으로 합니다. 우리는 동작 테스트에 중점을 두겠습니다—이메일 보내기나 레코드 저장과 같이 애플리케이션이 예상대로 작동하는지 확인하는 것—대신 사소한 계산에 초점을 맞춥니다. 간단한 route handler부터 시작하여 더 복잡한 controller로 진행하며, dependency injection (DI)과 타사 서비스 모킹을 포함합니다.

왜 단위 테스트를 할까?

단위 테스트는 코드가 예상대로 동작하는지 확인하며, 프로덕션에 도달하기 전에 버그를 포착합니다. Flight에서 가벼운 라우팅과 유연성은 복잡한 상호작용으로 이어질 수 있어 특히 가치 있습니다. 솔로 개발자나 팀에게 단위 테스트는 안전망 역할을 하며, 예상 동작을 문서화하고 나중에 코드를 다시 볼 때 회귀를 방지합니다. 또한 설계를 개선합니다: 테스트하기 어려운 코드는 종종 과도하게 복잡하거나 긴밀하게 결합된 클래스를 나타냅니다.

단순한 예제(예: x * y = z 테스트)와 달리, 우리는 입력 유효성 검사, 데이터 저장, 이메일과 같은 실제 동작에 중점을 둡니다. 우리의 목표는 테스트를 접근하기 쉽고 의미 있게 만드는 것입니다.

일반 지침 원칙

  1. 구현이 아닌 동작 테스트: 내부 세부 사항이 아닌 결과(예: “이메일 발송” 또는 “레코드 저장”)에 중점을 두세요. 이는 리팩토링에 대한 테스트의 견고성을 만듭니다.
  2. Flight:: 사용 중지: Flight의 정적 메서드는 매우 편리하지만 테스트를 어렵게 만듭니다. $app = Flight::app();에서 가져온 $app 변수를 사용하는 데 익숙해지세요. $app는 Flight::와 동일한 메서드를 모두 가지고 있습니다. 컨트롤러 등에서 여전히 $app->route() 또는 $this->app->json()을 사용할 수 있습니다. 또한 $router = $app->router();로 실제 Flight 라우터를 사용하고 $router->get(), $router->post(), $router->group() 등을 사용할 수 있습니다. Routing 참조.
  3. 테스트를 빠르게 유지: 빠른 테스트는 빈번한 실행을 장려합니다. 단위 테스트에서 데이터베이스 호출과 같은 느린 작업을 피하세요. 테스트가 느리면 통합 테스트를 작성 중이라는 신호입니다. 통합 테스트는 실제 데이터베이스, 실제 HTTP 호출, 실제 이메일 발송 등을 포함합니다. 그들은 위치가 있지만 느리고 불안정할 수 있으며, 때때로 알려지지 않은 이유로 실패합니다.
  4. 설명적인 이름 사용: 테스트 이름은 테스트 중인 동작을 명확히 설명해야 합니다. 이는 가독성과 유지보수성을 향상시킵니다.
  5. 전역 변수를 피하세요: $app->set()과 $app->get() 사용을 최소화하세요. 이는 전역 상태처럼 작동하여 모든 테스트에서 모킹이 필요합니다. DI 또는 DI 컨테이너를 선호하세요( Dependency Injection Container 참조). 심지어 $app->map() 메서드 사용도 기술적으로 "전역"이며 DI를 선호하여 피해야 합니다. flightphp/session과 같은 세션 라이브러리를 사용하세요. 이렇게 하면 테스트에서 세션 객체를 모킹할 수 있습니다. 코드에서 $_SESSION을 직접 호출하지 마세요. 이는 전역 변수를 코드에 주입하여 테스트를 어렵게 만듭니다.
  6. Dependency Injection 사용: 컨트롤러에 의존성(예: PDO, 메일러)을 주입하여 로직을 격리하고 모킹을 단순화하세요. 의존성이 너무 많은 클래스가 있으면 SOLID principles을 따르는 단일 책임이 있는 더 작은 클래스로 리팩토링을 고려하세요.
  7. 타사 서비스 모킹: 데이터베이스, HTTP 클라이언트(cURL), 이메일 서비스를 모킹하여 외부 호출을 피하세요. 핵심 로직은 실행되도록 하되 1~2계층 깊이 테스트하세요. 예를 들어, 앱이 텍스트 메시지를 보낸다면 테스트 실행 시마다 실제로 텍스트 메시지를 보내지 마세요. 비용이 쌓이고 느려집니다. 대신 텍스트 메시지 서비스를 모킹하고 코드가 올바른 매개변수로 텍스트 메시지 서비스를 호출했는지 확인하세요.
  8. 완벽이 아닌 높은 커버리지 목표: 100% 라인 커버리지는 좋지만, 코드의 모든 것이 제대로 테스트되었다는 의미는 아닙니다( PHPUnit에서의 branch/path coverage를 연구하세요). 중요한 동작(예: 사용자 등록, API 응답 및 실패 응답 포착)을 우선하세요.
  9. 라우트에 컨트롤러 사용: 라우트 정의에서 클로저가 아닌 컨트롤러를 사용하세요. 기본적으로 flight\Engine $app이 컨트롤러의 생성자를 통해 주입됩니다. 테스트에서 $app = new Flight\Engine();를 사용하여 테스트 내에서 Flight를 인스턴스화하고 컨트롤러에 주입한 후 메서드를 직접 호출하세요(예: $controller->register()). Extending Flight 및 Routing 참조.
  10. 모킹 스타일 선택하고 일관되게 유지: PHPUnit는 여러 모킹 스타일(예: prophecy, 내장 모킹)을 지원하며, 익명 클래스를 사용할 수도 있습니다. 이는 코드 완성, 메서드 정의 변경 시 깨짐 등의 이점이 있습니다. 테스트 전반에서 일관되게 하세요. PHPUnit Mock Objects 참조.
  11. 서브클래스에서 테스트할 메서드/속성에 protected 가시성 사용: 이를 통해 공개하지 않고 테스트 서브클래스에서 재정의할 수 있으며, 익명 클래스 모킹에 특히 유용합니다.

PHPUnit 설정

먼저 Composer를 사용하여 Flight PHP 프로젝트에 PHPUnit를 설정하세요. 자세한 내용은 PHPUnit Getting Started guide를 참조하세요.

  1. 프로젝트 디렉토리에서 실행:

    composer require --dev phpunit/phpunit

    이는 최신 PHPUnit를 개발 의존성으로 설치합니다.

  2. 테스트 파일을 위한 프로젝트 루트에 tests 디렉토리를 만듭니다.

  3. 편의를 위해 composer.json에 테스트 스크립트를 추가:

    // other composer.json content
"scripts": {
   "test": "phpunit --configuration phpunit.xml"
}

  4. 루트에 phpunit.xml 파일 생성:

    <?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="vendor/autoload.php">
   <testsuites>
       <testsuite name="Flight Tests">
           <directory>tests</directory>
       </testsuite>
   </testsuites>
</phpunit>

이제 테스트가 빌드되면 composer test를 실행하여 테스트를 실행할 수 있습니다.

간단한 라우트 핸들러 테스트

사용자 이메일 입력을 유효성 검사하는 기본 route로 시작하겠습니다. 우리는 그 동작을 테스트합니다: 유효한 이메일에 성공 메시지 반환, 유효하지 않은 경우 오류 반환. 이메일 유효성 검사는 filter_var를 사용합니다.

// index.php
$app->route('POST /register', [ UserController::class, 'register' ]);

// UserController.php
class UserController {
    protected $app;

    public function __construct(flight\Engine $app) {
        $this->app = $app;
    }

    public function register() {
        $email = $this->app->request()->data->email;
        $responseArray = [];
        if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
            $responseArray = ['status' => 'error', 'message' => 'Invalid email'];
        } else {
            $responseArray = ['status' => 'success', 'message' => 'Valid email'];
        }

        $this->app->json($responseArray);
    }
}

이를 테스트하기 위해 테스트 파일을 만듭니다. 테스트 구조화에 대한 자세한 내용은 Unit Testing and SOLID Principles 참조:

// tests/UserControllerTest.php
use PHPUnit\Framework\TestCase;
use Flight;
use flight\Engine;

class UserControllerTest extends TestCase {

    public function testValidEmailReturnsSuccess() {
        $app = new Engine();
        $request = $app->request();
        $request->data->email = 'test@example.com'; // Simulate POST data
        $UserController = new UserController($app);
        $UserController->register($request->data->email);
        $response = $app->response()->getBody();
        $output = json_decode($response, true);
        $this->assertEquals('success', $output['status']);
        $this->assertEquals('Valid email', $output['message']);
    }

    public function testInvalidEmailReturnsError() {
        $app = new Engine();
        $request = $app->request();
        $request->data->email = 'invalid-email'; // Simulate POST data
        $UserController = new UserController($app);
        $UserController->register($request->data->email);
        $response = $app->response()->getBody();
        $output = json_decode($response, true);
        $this->assertEquals('error', $output['status']);
        $this->assertEquals('Invalid email', $output['message']);
    }
}

주요 포인트:

composer test를 실행하여 라우트가 예상대로 동작하는지 확인하세요. Flight에서의 requests와 responses에 대한 자세한 내용은 관련 문서를 참조하세요.

테스트 가능한 컨트롤러를 위한 Dependency Injection 사용

더 복잡한 시나리오를 위해 dependency injection (DI)을 사용하여 컨트롤러를 테스트 가능하게 만듭니다. Flight의 전역(예: Flight::set(), Flight::map(), Flight::register())을 피하세요. 이는 전역 상태처럼 작동하여 모든 테스트에서 모킹이 필요합니다. 대신 Flight의 DI 컨테이너, DICE, PHP-DI 또는 수동 DI를 사용하세요.

원시 PDO 대신 flight\database\PdoWrapper를 사용하겠습니다. 이 래퍼는 모킹과 단위 테스트가 훨씬 쉽습니다!

데이터베이스에 사용자 저장하고 환영 이메일 보내는 컨트롤러 예시:

use flight\database\PdoWrapper;

class UserController {
    protected $app;
    protected $db;
    protected $mailer;

    public function __construct(Engine $app, PdoWrapper $db, MailerInterface $mailer) {
        $this->app = $app;
        $this->db = $db;
        $this->mailer = $mailer;
    }

    public function register() {
        $email = $this->app->request()->data->email;
        if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
            // adding the return here helps unit testing to stop execution
            return $this->app->jsonHalt(['status' => 'error', 'message' => 'Invalid email']);
        }

        $this->db->runQuery('INSERT INTO users (email) VALUES (?)', [$email]);
        $this->mailer->sendWelcome($email);

        return $this->app->json(['status' => 'success', 'message' => 'User registered']);
    }
}

주요 포인트:

모킹으로 컨트롤러 테스트

이제 UserController의 동작을 테스트하겠습니다: 이메일 유효성 검사, 데이터베이스 저장, 이메일 발송. 데이터베이스와 메일러를 모킹하여 컨트롤러를 격리합니다.

// tests/UserControllerDICTest.php
use PHPUnit\Framework\TestCase;

class UserControllerDICTest extends TestCase {
    public function testValidEmailSavesAndSendsEmail() {

        // Sometimes mixing mocking styles is necessary
        // Here we use PHPUnit's built-in mock for PDOStatement
        $statementMock = $this->createMock(PDOStatement::class);
        $statementMock->method('execute')->willReturn(true);
        // Using an anonymous class to mock PdoWrapper
        $mockDb = new class($statementMock) extends PdoWrapper {
            protected $statementMock;
            public function __construct($statementMock) {
                $this->statementMock = $statementMock;
            }

            // When we mock it this way, we are not really making a database call.
            // We can further setup this to alter the PDOStatement mock to simulate failures, etc.
            public function runQuery(string $sql, array $params = []): PDOStatement {
                return $this->statementMock;
            }
        };
        $mockMailer = new class implements MailerInterface {
            public $sentEmail = null;
            public function sendWelcome($email): bool {
                $this->sentEmail = $email;
                return true;    
            }
        };
        $app = new Engine();
        $app->request()->data->email = 'test@example.com';
        $controller = new UserControllerDIC($app, $mockDb, $mockMailer);
        $controller->register();
        $response = $app->response()->getBody();
        $result = json_decode($response, true);
        $this->assertEquals('success', $result['status']);
        $this->assertEquals('User registered', $result['message']);
        $this->assertEquals('test@example.com', $mockMailer->sentEmail);
    }

    public function testInvalidEmailSkipsSaveAndEmail() {
         $mockDb = new class() extends PdoWrapper {
            // An empty constructor bypasses the parent constructor
            public function __construct() {}
            public function runQuery(string $sql, array $params = []): PDOStatement {
                throw new Exception('Should not be called');
            }
        };
        $mockMailer = new class implements MailerInterface {
            public $sentEmail = null;
            public function sendWelcome($email): bool {
                throw new Exception('Should not be called');
            }
        };
        $app = new Engine();
        $app->request()->data->email = 'invalid-email';

        // Need to map jsonHalt to avoid exiting
        $app->map('jsonHalt', function($data) use ($app) {
            $app->json($data, 400);
        });
        $controller = new UserControllerDIC($app, $mockDb, $mockMailer);
        $controller->register();
        $response = $app->response()->getBody();
        $result = json_decode($response, true);
        $this->assertEquals('error', $result['status']);
        $this->assertEquals('Invalid email', $result['message']);
    }
}

주요 포인트:

너무 많은 모킹

코드의 너무 많은 부분을 모킹하지 않도록 주의하세요. 아래에 UserController를 사용한 예를 들어 왜 이것이 나쁜지 설명하겠습니다. 우리는 그 검사를 isEmailValid 메서드( filter_var 사용)로 변경하고 다른 새로운 추가를 registerUser라는 별도의 메서드로 만듭니다.

use flight\database\PdoWrapper;
use flight\Engine;

// UserControllerDICV2.php
class UserControllerDICV2 {
    protected $app;
    protected $db;
    protected $mailer;

    public function __construct(Engine $app, PdoWrapper $db, MailerInterface $mailer) {
        $this->app = $app;
        $this->db = $db;
        $this->mailer = $mailer;
    }

    public function register() {
        $email = $this->app->request()->data->email;
        if (!$this->isEmailValid($email)) {
            // adding the return here helps unit testing to stop execution
            return $this->app->jsonHalt(['status' => 'error', 'message' => 'Invalid email']);
        }

        $this->registerUser($email);

        $this->app->json(['status' => 'success', 'message' => 'User registered']);
    }

    protected function isEmailValid($email) {
        return filter_var($email, FILTER_VALIDATE_EMAIL) !== false;
    }

    protected function registerUser($email) {
        $this->db->runQuery('INSERT INTO users (email) VALUES (?)', [$email]);
        $this->mailer->sendWelcome($email);
    }
}

이제 아무것도 실제로 테스트하지 않는 과도한 모킹 단위 테스트:

use PHPUnit\Framework\TestCase;

class UserControllerTest extends TestCase {
    public function testValidEmailSavesAndSendsEmail() {
        $app = new Engine();
        $app->request()->data->email = 'test@example.com';
        // we are skipping the extra dependency injection here cause it's "easy"
        $controller = new class($app) extends UserControllerDICV2 {
            protected $app;
            // Bypass the deps in the construct
            public function __construct($app) {
                $this->app = $app;
            }

            // We'll just force this to be valid.
            protected function isEmailValid($email) {
                return true; // Always return true, bypassing real validation
            }

            // Bypass the actual DB and mailer calls
            protected function registerUser($email) {
                return false;
            }
        };
        $controller->register();
        $response = $app->response()->getBody();
        $result = json_decode($response, true);
        $this->assertEquals('success', $result['status']);
        $this->assertEquals('User registered', $result['message']);
    }
}

축하합니다. 단위 테스트가 있고 통과합니다! 하지만 isEmailValid 또는 registerUser의 내부 작동을 실제로 변경하면 어떨까요? 테스트는 여전히 통과할 것입니다. 왜냐하면 모든 기능을 모킹했기 때문입니다. 제가 의미하는 바를 보여드리겠습니다.

// UserControllerDICV2.php
class UserControllerDICV2 {

    // ... other methods ...

    protected function isEmailValid($email) {
        // Changed logic
        $validEmail = filter_var($email, FILTER_VALIDATE_EMAIL) !== false;
        // Now it should only have a specific domain
        $validDomain = strpos($email, '@example.com') !== false; 
        return $validEmail && $validDomain;
    }
}

위 단위 테스트를 실행하면 여전히 통과합니다! 하지만 동작을 테스트하지 않았기 때문에(코드의 일부를 실제로 실행하지 않음), 프로덕션에서 발생할 잠재적 버그를 코딩했을 수 있습니다. 테스트는 새로운 동작을 고려하도록 수정되어야 하며, 예상과 다른 동작의 반대도 마찬가지입니다.

전체 예제

Flight PHP 프로젝트와 단위 테스트의 전체 예제를 GitHub에서 찾을 수 있습니다: n0nag0n/flight-unit-tests-guide. 더 깊은 이해를 위해 Unit Testing and SOLID Principles 참조.

일반적인 함정

단위 테스트로 확장

단위 테스트는 큰 프로젝트나 몇 달 후 코드 재방문 시 빛을 발합니다. 동작을 문서화하고 회귀를 포착하여 앱을 다시 배우는 데서 구합니다. 솔로 개발자에게는 중요한 경로(예: 사용자 가입, 결제 처리)를 테스트하세요. 팀에게는 기여 전반에서 일관된 동작을 보장합니다. 프레임워크와 테스트의 이점에 대한 자세한 내용은 Why Frameworks? 참조.

Flight PHP 문서 저장소에 자신의 테스트 팁을 기여하세요!

n0nag0n에 의해 작성 2025

Guides/blog

Flight PHP로 간단한 블로그 만들기

이 가이드는 Flight PHP 프레임워크를 사용하여 기본 블로그를 만드는 과정을 안내합니다. 프로젝트를 설정하고, 경로를 정의하고, JSON으로 게시물을 관리하고, Latte 템플릿 엔진으로 렌더링합니다. 모든 과정에서 Flight의 간단함과 유연성을 보여줍니다. 마지막에는 홈페이지와 개별 게시물 페이지, 생성 양식이 포함된 기능적인 블로그를 만들게 됩니다.

필수 조건

1단계: 프로젝트 설정

새 프로젝트 디렉토리를 생성하고 Composer를 통해 Flight를 설치합니다.

  1. 디렉토리 생성:

    mkdir flight-blog
cd flight-blog

  2. Flight 설치:

    composer require flightphp/core

  3. 공용 디렉토리 생성: Flight는 단일 진입점(index.php)을 사용합니다. 이를 위해 public/ 폴더를 생성합니다:

    mkdir public

  4. 기본 index.php: 간단한 "hello world" 경로로 public/index.php를 생성합니다:

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

Flight::route('/', function () {
   echo '안녕하세요, Flight!';
});

Flight::start();

  5. 내장 서버 실행: PHP의 개발 서버로 설정을 테스트합니다:

    php -S localhost:8000 -t public/

    http://localhost:8000을 방문하여 "안녕하세요, Flight!"를 확인합니다.

2단계: 프로젝트 구조 정리

정리된 설정을 위해 프로젝트를 다음과 같이 구조화합니다:

flight-blog/
├── app/
│   ├── config/
│   └── views/
├── data/
├── public/
│   └── index.php
├── vendor/
└── composer.json

3단계: Latte 설치 및 구성

Latte는 Flight와 잘 통합되는 경량 템플릿 엔진입니다.

  1. Latte 설치:

    composer require latte/latte

  2. Flight에서 Latte 구성: public/index.php를 업데이트하여 Latte를 뷰 엔진으로 등록합니다:

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

use Latte\Engine;

Flight::register('view', Engine::class, [], function ($latte) {
   $latte->setTempDirectory(__DIR__ . '/../cache/');
   $latte->setLoader(new \Latte\Loaders\FileLoader(__DIR__ . '/../app/views/'));
});

Flight::route('/', function () {
   Flight::view()->render('home.latte', ['title' => '내 블로그']);
});

Flight::start();

  3. 레이아웃 템플릿 생성: app/views/layout.latte에 다음을 추가합니다:

    <!DOCTYPE html>
<html>
<head>
<title>{$title}</title>
</head>
<body>
<header>
    <h1>내 블로그</h1>
    <nav>
        <a href="/">홈</a> | 
        <a href="/create">게시물 작성</a>
    </nav>
</header>
<main>
    {block content}{/block}
</main>
<footer>
    <p>&copy; {date('Y')} Flight 블로그</p>
</footer>
</body>
</html>

  4. 홈 템플릿 만들기: app/views/home.latte에:

    {extends 'layout.latte'}

{block content}
    <h2>{$title}</h2>
    <ul>
    {foreach $posts as $post}
        <li><a href="/post/{$post['slug']}">{$post['title']}</a></li>
    {/foreach}
    </ul>
{/block}

    서버를 재시작하고 http://localhost:8000을 방문하여 렌더링된 페이지를 확인하세요.

  5. 데이터 파일 생성:

    간단하게 데이터베이스를 시뮬레이션하기 위해 JSON 파일을 사용합니다.

    data/posts.json에:

    [
   {
       "slug": "first-post",
       "title": "내 첫 번째 게시물",
       "content": "이것은 Flight PHP로 작성한 첫 번째 블로그 게시물입니다!"
   }
]

4단계: 경로 정의

보다 나은 구성을 위해 경로를 구성 파일에 분리합니다.

  1. routes.php 생성: app/config/routes.php에:

    <?php
Flight::route('/', function () {
   Flight::view()->render('home.latte', ['title' => '내 블로그']);
});

Flight::route('/post/@slug', function ($slug) {
   Flight::view()->render('post.latte', ['title' => '게시물: ' . $slug, 'slug' => $slug]);
});

Flight::route('GET /create', function () {
   Flight::view()->render('create.latte', ['title' => '게시물 작성']);
});

  2. index.php 업데이트: 경로 파일을 포함합니다:

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

use Latte\Engine;

Flight::register('view', Engine::class, [], function ($latte) {
   $latte->setTempDirectory(__DIR__ . '/../cache/');
   $latte->setLoader(new \Latte\Loaders\FileLoader(__DIR__ . '/../app/views/'));
});

require '../app/config/routes.php';

Flight::start();

5단계: 블로그 게시물 저장 및 검색

게시물을 불러오고 저장하는 메서드를 추가합니다.

  1. 게시물 메서드 추가: index.php에 게시물을 불러오는 메서드를 추가합니다:

    Flight::map('posts', function () {
   $file = __DIR__ . '/../data/posts.json';
   return json_decode(file_get_contents($file), true);
});

  2. 경로 업데이트: app/config/routes.php를 수정하여 게시물을 사용합니다:

    <?php
Flight::route('/', function () {
   $posts = Flight::posts();
   Flight::view()->render('home.latte', [
       'title' => '내 블로그',
       'posts' => $posts
   ]);
});

Flight::route('/post/@slug', function ($slug) {
   $posts = Flight::posts();
   $post = array_filter($posts, fn($p) => $p['slug'] === $slug);
   $post = reset($post) ?: null;
   if (!$post) {
       Flight::notFound();
       return;
   }
   Flight::view()->render('post.latte', [
       'title' => $post['title'],
       'post' => $post
   ]);
});

Flight::route('GET /create', function () {
   Flight::view()->render('create.latte', ['title' => '게시물 작성']);
});

6단계: 템플릿 생성

게시물을 표시하도록 템플릿을 업데이트합니다.

  1. 게시물 페이지 (app/views/post.latte):

    {extends 'layout.latte'}

{block content}
    <h2>{$post['title']}</h2>
    <div class="post-content">
        <p>{$post['content']}</p>
    </div>
{/block}

7단계: 게시물 작성 추가

새 게시물을 추가하기 위해 양식 제출을 처리합니다.

  1. 양식 생성 (app/views/create.latte):

    {extends 'layout.latte'}

{block content}
    <h2>{$title}</h2>
    <form method="POST" action="/create">
        <div class="form-group">
            <label for="title">제목:</label>
            <input type="text" name="title" id="title" required>
        </div>
        <div class="form-group">
            <label for="content">내용:</label>
            <textarea name="content" id="content" required></textarea>
        </div>
        <button type="submit">게시물 저장</button>
    </form>
{/block}

  2. POST 경로 추가: app/config/routes.php에:

    Flight::route('POST /create', function () {
   $request = Flight::request();
   $title = $request->data['title'];
   $content = $request->data['content'];
   $slug = strtolower(str_replace(' ', '-', $title));

   $posts = Flight::posts();
   $posts[] = ['slug' => $slug, 'title' => $title, 'content' => $content];
   file_put_contents(__DIR__ . '/../../data/posts.json', json_encode($posts, JSON_PRETTY_PRINT));

   Flight::redirect('/');
});

  3. 테스트:

    • http://localhost:8000/create를 방문합니다.
    • 새 게시물(예: "두 번째 게시물" 및 내용)을 제출합니다.
    • 홈페이지를 확인하여 목록에 표시되는지 확인합니다.

8단계: 오류 처리 향상

더 나은 404 경험을 위해 notFound 메서드를 오버라이드합니다.

index.php에:

Flight::map('notFound', function () {
    Flight::view()->render('404.latte', ['title' => '페이지를 찾을 수 없습니다']);
});

app/views/404.latte를 생성합니다:

{extends 'layout.latte'}

{block content}
    <h2>404 - {$title}</h2>
    <p>죄송합니다, 그 페이지는 존재하지 않습니다!</p>
{/block}

다음 단계

결론

Flight PHP로 간단한 블로그를 만들었습니다! 이 가이드는 경로 설정, Latte로 템플릿화, 양식 제출 처리 등 핵심 기능을 보여줍니다. Flight의 문서를 살펴보고 블로그를 더 발전시켜 보세요!

License

MIT 라이센스 (MIT)

=====================

Copyright © 2024 @mikecao, @n0nag0n

어떠한 제약 없이 이 소프트웨어 및 관련 문서를 소유하고 있는 모든 사람에게 무료로 사용 권한이 제공됩니다. ("Software"), 여기에는 사용, 복사, 수정, 병합, 발행, 배포, 하위 라이선스, 판매권 등이 포함됩니다. 소프트웨어의 사본을 획득한 사람은 상기 조건에 따라 소프트웨어를 다룰 수 있으며, 소프트웨어가 제공되는 사람들에게 소프트웨어를 사용할 권리가 부여됩니다. 다음 조건에 따라 조건부로 허용됩니다.

상기 저작권 고지 및 이 권한 통지는 소프트웨어의 모든 복사본 또는 상당한 부분에 포함되어야합니다.

소프트웨어는 "있는 그대로" 제공되며 어떠한 종류의 보증도 없이, 명시적이든 묵시적이든, 상품성, 특정 목적에의 적합성 및 비침해성을 포함하되 이에 한하지 않는 보증이 포함됩니다. 등의 사건에서 발생하는 모든 청구, 손해 또는 기타 책임에 대해 제작자 또는 저작권 소유자가 책임지지 않습니다. 계약, 불법 행위 또는 기타, 소프트웨어 또는 사용 또는 기타 거래에 대한 이러한 저작물로부터의 파생작품.

About

Flight PHP 프레임워크

Flight은 빠르고, 간단하며, 확장 가능한 PHP 프레임워크입니다. 개발자들이 빠르게 작업을 완료하고 싶을 때, 불필요한 복잡함 없이 사용할 수 있도록 설계되었습니다. 클래식 웹 앱, 빠른 API, 또는 최신 AI 기반 도구 실험을 하든, Flight의 낮은 부하와 직관적인 설계가 완벽한 선택입니다. Flight은 경량으로 설계되었지만, 기업급 아키텍처 요구사항도 처리할 수 있습니다.

왜 Flight을 선택하나요?

비디오 개요

그렇게 간단하죠?
자세히 알아보기 Flight 문서에서 Flight에 대해!

빠른 시작

빠른 기본 설치하기 위해 Composer를 사용하세요:

composer require flightphp/core

또는 여기에서 레포 저장소를 ZIP으로 다운로드할 수 있습니다. 그런 다음 기본 index.php 파일은 다음과 같습니다:

<?php

// 컴포저로 설치된 경우
require 'vendor/autoload.php';
// 또는 ZIP 파일로 수동 설치한 경우
// require 'flight/Flight.php';

Flight::route('/', function() {
  echo 'hello world!';
});

Flight::route('/json', function() {
  Flight::json([
    'hello' => 'world'
  ]);
});

Flight::start();

그게 다예요! 기본 Flight 애플리케이션이 완성되었습니다. 이제 php -S localhost:8000 명령으로 파일을 실행하고 브라우저에서 http://localhost:8000을 방문하면 출력을 볼 수 있습니다.

Skeleton/Boilerplate 앱

Flight으로 프로젝트를 시작하는 데 도움이 되는 예제 앱이 있습니다. 구조화된 레이아웃, 기본 설정, 그리고 Composer 스크립트를 바로 사용할 수 있습니다! flightphp/skeleton을 확인하거나, 예제 페이지를 방문하여 영감을 얻으세요. AI가 어떻게 적용되는지 궁금하시면? AI 기반 예제 탐색하기.

Skeleton 앱 설치

쉽습니다!

# 새 프로젝트 생성
composer create-project flightphp/skeleton my-project/
# 새 프로젝트 디렉터리로 이동
cd my-project/
# 로컬 개발 서버를 바로 시작하세요!
composer start

프로젝트 구조를 생성하고, 필요한 파일을 설정하며, 바로 시작할 수 있습니다!

높은 성능

Flight은 가장 빠른 PHP 프레임워크 중 하나입니다. 경량의 코어 덕분에 오버헤드가 적고 속도가 더 빠르며, 전통적인 앱과 현대적인 AI 기반 프로젝트에 적합합니다. 모든 벤치마크는 TechEmpower에서 확인할 수 있습니다.

아래는 다른 인기 PHP 프레임워크와의 벤치마크입니다.

Framework Plaintext Reqs/sec JSON Reqs/sec
Flight 190,421 182,491
Yii 145,749 131,434
Fat-Free 139,238 133,952
Slim 89,588 87,348
Phalcon 95,911 87,675
Symfony 65,053 63,237
Lumen 40,572 39,700
Laravel 26,657 26,901
CodeIgniter 20,628 19,901

Flight과 AI

AI를 어떻게 처리하는지 궁금하시나요? 발견하기 Flight이 좋아하는 코딩 LLM과 쉽게 작업할 수 있도록 합니다!

커뮤니티

우리는 Matrix 채팅에 있습니다.

Matrix

그리고 Discord에도 있습니다.

기여

Flight에 기여하는 두 가지 방법이 있습니다:

  1. core repository를 방문하여 코어 프레임워크에 기여하세요.
  2. 문서를 더 좋게 만드세요! 이 문서 웹사이트는 Github에 호스팅됩니다. 오류를 발견하거나 개선할 점이 있으면, 풀 리퀘스트를 제출하세요. 우리는 업데이트와 새로운 아이디어, 특히 AI와 신기술 관련 아이디어를 사랑합니다!

요구사항

Flight은 PHP 7.4 이상을 필요로 합니다.

노트: PHP 7.4는 2024년 현재 일부 LTS Linux 배포판의 기본 버전이기 때문에 지원됩니다. PHP >8로 강제 이동하면 사용자들에게 문제가 될 수 있으므로, 프레임워크는 PHP >8도 지원합니다.

라이선스

Flight은 MIT 라이선스 하에 배포됩니다.

Awesome-plugins/php_cookie

쿠키

overclokk/cookie은 앱 내에서 쿠키를 관리하는 간단한 라이브러리입니다.

설치

컴포저를 사용하여 설치가 간단합니다.

composer require overclokk/cookie

사용

사용법은 Flight 클래스에 새로운 메소드를 등록하는 것만큼 간단합니다.


use Overclokk\Cookie\Cookie;

/*
 * 부트스트랩 또는 public/index.php 파일에서 설정
 */

Flight::register('cookie', Cookie::class);

/**
 * ExampleController.php
 */

class ExampleController {
    public function login() {
        // 쿠키 설정

        // 새로운 인스턴스를 받으려면 false로 설정해야 합니다
        // 자동완성을 위해 아래 주석을 사용하려면
        /** @var \Overclokk\Cookie\Cookie $cookie */
        $cookie = Flight::cookie(false);
        $cookie->set(
            'stay_logged_in', // 쿠키의 이름
            '1', // 설정할 값
            86400, // 쿠키가 유지될 시간(초)
            '/', // 쿠키가 유효한 경로
            'example.com', // 쿠키가 유효한 도메인
            true, // 안전한 HTTPS 연결로만 쿠키를 전송
            true // HTTP 프로토콜을 통해서만 쿠키에 접근 가능
        );

        // 선택적으로, 기본값을 유지하고 오랫동안 쿠키를 설정하려는 경우
        $cookie->forever('stay_logged_in', '1');
    }

    public function home() {
        // 쿠키가 있는지 확인
        if (Flight::cookie()->has('stay_logged_in')) {
            // 예를 들어 사용자를 대시보드 영역에 넣습니다.
            Flight::redirect('/dashboard');
        }
    }
}

Awesome-plugins/php_encryption

PHP 암호화

defuse/php-encryption은 데이터를 암호화하고 복호화하는 데 사용할 수 있는 라이브러리입니다. 시작하고 실행하는 것은 암호화하고 복호화하는 것이 상당히 간단합니다. 그들은 라이브러리 사용법과 암호화에 관한 중요한 보안 요소에 대해 설명하는 훌륭한 튜토리얼이 있습니다.

설치

composer로 간단히 설치할 수 있습니다.

composer require defuse/php-encryption

설정

그런 다음 암호화 키를 생성해야 합니다.

vendor/bin/generate-defuse-key

이 과정에서 안전하게 보관해야 할 키가 표시됩니다. 이 키를 파일 하단에 있는 배열 안에 app/config/config.php 파일에 저장할 수 있습니다. 완벽한 위치는 아니지만 적어도 어딘가에 있습니다.

사용법

이제 라이브러리와 암호화 키가 준비되었으므로 데이터를 암호화하고 복호화할 수 있습니다.

use Defuse\Crypto\Crypto;
use Defuse\Crypto\Key;

/*
 * 부트스트랩 또는 public/index.php 파일에 설정
 */

// 암호화 메서드
Flight::map('encrypt', function($raw_data) {
    $encryption_key = /* $config['encryption_key'] 또는 키가 위치한 파일에 대한 file_get_contents */;
    return Crypto::encrypt($raw_data, Key::loadFromAsciiSafeString($encryption_key));
});

// 복호화 메서드
Flight::map('decrypt', function($encrypted_data) {
    $encryption_key = /* $config['encryption_key'] 또는 키가 위치한 파일에 대한 file_get_contents */;
    try {
        $raw_data = Crypto::decrypt($encrypted_data, Key::loadFromAsciiSafeString($encryption_key));
    } catch (Defuse\Crypto\Exception\WrongKeyOrModifiedCiphertextException $ex) {
        // 공격! 잘못된 키가 로드되었거나 암호문이 생성된 후 변경되었습니다. 데이터베이스에서 손상된 상태이거나 악의적으로 수정되어 있는 경우입니다.

        // ... 응용 프로그램에 적합한 방식으로 이 경우를 처리합니다 ...
    }
    return $raw_data;
});

Flight::route('/encrypt', function() {
    $encrypted_data = Flight::encrypt('비밀 정보입니다');
    echo $encrypted_data;
});

Flight::route('/decrypt', function() {
    $encrypted_data = '...'; // 어딘가에서 암호화된 데이터 가져오기
    $decrypted_data = Flight::decrypt($encrypted_data);
    echo $decrypted_data;
});

Awesome-plugins/php_file_cache

flightphp/cache

Wruczek/PHP-File-Cache에서 포크된 가볍고 간단하며 독립적인 PHP 인파일 캐싱 클래스입니다.

장점

이 문서 사이트는 이 라이브러리를 사용하여 각 페이지를 캐싱합니다!

코드 보기 위해 여기를 클릭하세요.

설치

Composer를 통해 설치:

composer require flightphp/cache

사용법

사용법은 상당히 간단합니다. 이는 캐시 디렉토리에 캐시 파일을 저장합니다.

use flight\Cache;

$app = Flight::app();

// 생성자에 캐시가 저장될 디렉토리를 전달합니다
$app->register('cache', Cache::class, [ __DIR__ . '/../cache/' ], function(Cache $cache) {

    // 이는 프로덕션 모드에서만 캐시를 사용하도록 보장합니다
    // ENVIRONMENT는 부트스트랩 파일이나 앱의 다른 곳에서 설정된 상수입니다
    $cache->setDevMode(ENVIRONMENT === 'development');
});

캐시 값 가져오기

캐시된 값을 가져오려면 get() 메서드를 사용합니다. 만료된 경우 캐시를 새로 고치는 편의 메서드를 원하시면 refreshIfExpired()를 사용할 수 있습니다.


// 캐시 인스턴스 가져오기
$cache = Flight::cache();
$data = $cache->refreshIfExpired('simple-cache-test', function () {
    return date("H:i:s"); // 캐시할 데이터 반환
}, 10); // 10초

// 또는
$data = $cache->get('simple-cache-test');
if(empty($data)) {
    $data = date("H:i:s");
    $cache->set('simple-cache-test', $data, 10); // 10초
}

캐시 값 저장

캐시에 값을 저장하려면 set() 메서드를 사용합니다.

Flight::cache()->set('simple-cache-test', 'my cached data', 10); // 10초

캐시 값 삭제

캐시에 있는 값을 삭제하려면 delete() 메서드를 사용합니다.

Flight::cache()->delete('simple-cache-test');

캐시 값 존재 확인

캐시에 값이 존재하는지 확인하려면 exists() 메서드를 사용합니다.

if(Flight::cache()->exists('simple-cache-test')) {
    // 무언가 수행
}

캐시 지우기

전체 캐시를 지우려면 flush() 메서드를 사용합니다.

Flight::cache()->flush();

캐시와 함께 메타데이터 추출

캐시 항목에 대한 타임스탬프와 기타 메타데이터를 추출하려면 올바른 매개변수로 true를 전달해야 합니다.

$data = $cache->refreshIfExpired("simple-cache-meta-test", function () {
    echo "Refreshing data!" . PHP_EOL;
    return date("H:i:s"); // 캐시할 데이터 반환
}, 10, true); // true = 메타데이터와 함께 반환
// 또는
$data = $cache->get("simple-cache-meta-test", true); // true = 메타데이터와 함께 반환

/*
메타데이터와 함께 검색된 예시 캐시 항목:
{
    "time":1511667506, <-- 저장된 유닉스 타임스탬프
    "expire":10,       <-- 초 단위 만료 시간
    "data":"04:38:26", <-- 역직렬화된 데이터
    "permanent":false
}

메타데이터를 사용하면, 예를 들어 항목이 저장된 시점이나 만료 시점을 계산할 수 있습니다
"data" 키로 데이터 자체에도 액세스할 수 있습니다
*/

$expiresin = ($data["time"] + $data["expire"]) - time(); // 데이터가 만료되는 유닉스 타임스탬프를 가져와 현재 타임스탬프를 빼기
$cacheddate = $data["data"]; // "data" 키로 데이터 자체에 액세스

echo "최신 캐시 저장: $cacheddate, $expiresin초 후 만료";

문서

코드를 보려면 https://github.com/flightphp/cache를 방문하세요. 캐시를 사용하는 추가 방법을 보려면 examples 폴더를 확인하세요.

Awesome-plugins/permissions

플라이트PHP/권한

이것은 여러 역할이 있는 앱에서 사용할 수있는 권한 모듈입니다. 각 역할마다 약간 다른 기능이 있는 경우 사용할 수 있습니다. 이 모듈을 사용하면 각 역할에 대한 권한을 정의한 다음 현재 사용자가 특정 페이지에 액세스하거나 특정 작업을 수행할 수 있는 권한이 있는지 확인할 수 있습니다.

여기를 클릭하여 GitHub의 저장소를 확인하십시오.

설치

composer require flightphp/permissions를 실행하면 됩니다!

사용법

먼저 권한을 설정해야하고, 앱에 권한이 무엇을 의미하는지 알려야합니다. 최종적으로 $Permissions->has(), ->can(), 또는 is()를 사용하여 권한을 확인할 수 있습니다. has()와 can()은 기능적으로 동일하지만 코드를 더 읽기 쉽게 만들기 위해 이름을 다르게 지었습니다.

기본 예제

앱에서 사용자가 로그인되어 있는지 확인하는 기능이있는 경우를 가정해 보겠습니다. 다음과 같이 권한 개체를 생성할 수 있습니다.

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

// 일부 코드

// 그런 다음 현재 사용자의 현재 역할을 알려주는 코드가 있을 것입니다.
// 아마도 현재 역할을 가져오는 코드가 있을 것입니다.
// 현재 역할을 정의하는 세션 변수에서 현재 역할을 가져오는 경우가 일반적일 것입니다.
// 그렇게하면 누군가 로그인한 후가 아니면 'guest' 또는 'public' 역할이있을 것입니다.
$current_role = 'admin';

// 권한 설정
$permission = new \flight\Permission($current_role);
$permission->defineRule('loggedIn', function($current_role) {
    return $current_role !== 'guest';
});

// 이 개체를 Flight 어딘가에 지속적으로 저장하는 것이 좋습니다
Flight::set('permission', $permission);

그런 다음 컨트롤러 어딘가에 다음과 같은 것이있을 수 있습니다.

<?php

// 일부 컨트롤러
class SomeController {
    public function someAction() {
        $permission = Flight::get('permission');
        if ($permission->has('loggedIn')) {
            // 어떤 작업 수행
        } else {
            // 다른 작업 수행
        }
    }
}

또한이를 사용하여 응용 프로그램에서 작업을 수행할 수 있는 권한이 있는지 추적할 수도 있습니다. 예를 들어, 소프트웨어에서 게시물 작성과 상호 작용할 수있는 방법이있는 경우 특정 작업을 수행할 수 있는지 확인할 수 있습니다.

$current_role = 'admin';

// 권한 설정
$permission = new \flight\Permission($current_role);
$permission->defineRule('post', function($current_role) {
    if($current_role === 'admin') {
        $permissions = ['create', 'read', 'update', 'delete'];
    } else if($current_role === 'editor') {
        $permissions = ['create', 'read', 'update'];
    } else if($current_role === 'author') {
        $permissions = ['create', 'read'];
    } else if($current_role === 'contributor') {
        $permissions = ['create'];
    } else {
        $permissions = [];
    }
    return $permissions;
});
Flight::set('permission', $permission);

그런 다음 컨트롤러 어딘가에...

class PostController {
    public function create() {
        $permission = Flight::get('permission');
        if ($permission->can('post.create')) {
            // 어떤 작업 수행
        } else {
            // 다른 작업 수행
        }
    }
}

의존성 주입

권한을 정의하는 클로저에 의존성을 주입할 수 있습니다. 확인하려는 일부 토글, ID 또는 기타 데이터 지점이 있는 경우 유용합니다. Class->Method 유형 호출의 경우 메서드에서 인수를 정의해야합니다.

클로저

$Permission->defineRule('order', function(string $current_role, MyDependency $MyDependency = null) {
    // ... 코드
});

// 컨트롤러 파일에서
public function createOrder() {
    $MyDependency = Flight::myDependency();
    $permission = Flight::get('permission');
    if ($permission->can('order.create', $MyDependency)) {
        // 어떤 작업 수행
    } else {
        // 다른 작업 수행
    }
}

클래스

namespace MyApp;

class Permissions {

    public function order(string $current_role, MyDependency $MyDependency = null) {
        // ... 코드
    }
}

클래스로 권한 설정하는 바로 가기

클래스를 사용하여 권한을 정의할 수도 있습니다. 많은 권한이있고 코드를 깔끔하게 유지하려는 경우 유용합니다. 다음과 같이 할 수 있습니다:

<?php

// 부트스트랩 코드
$Permissions = new \flight\Permission($current_role);
$Permissions->defineRule('order', 'MyApp\Permissions->order');

// myapp/Permissions.php
namespace MyApp;

class Permissions {

    public function order(string $current_role, int $user_id) {
        // 미리 설정한 것으로 가정합니다
        /** @var \flight\database\PdoWrapper $db */
        $db = Flight::db();
        $allowed_permissions = [ 'read' ]; // 누구나 주문을 볼 수 있음
        if($current_role === 'manager') {
            $allowed_permissions[] = 'create'; // 매니저는 주문을 만들 수 있음
        }
        $some_special_toggle_from_db = $db->fetchField('SELECT some_special_toggle FROM settings WHERE id = ?', [ $user_id ]);
        if($some_special_toggle_from_db) {
            $allowed_permissions[] = 'update'; // 사용자가 특별 토글을 가지고있으면 주문을 업데이트 할 수 있음
        }
        if($current_role === 'admin') {
            $allowed_permissions[] = 'delete'; // 관리자는 주문을 삭제 할 수 있음
        }
        return $allowed_permissions;
    }
}

멋진 부분은 클래스에 대해 모든 메서드를 권한에 매핑하는 바로 가기가 있으며 (캐시 가능함!!!), 이렇게하면 $Permissions->has('order.read') 또는 $Permissions->has('company.read')를 실행하여 작동됩니다. 이를 정의하는 것은 매우 어렵기 때문에 여기에 머무르십시오. 그냥 이렇게하면됩니다:

그룹화하려는 권한 클래스를 작성합니다.

class MyPermissions {
    public function order(string $current_role, int $order_id = 0): array {
        // 권한을 확인하는 코드
        return $permissions_array;
    }

    public function company(string $current_role, int $company_id): array {
        // 권한을 확인하는 코드
        return $permissions_array;
    }
}

그런 다음이 라이브러리를 사용하여 권한을 발견할 수 있도록 합니다.

$Permissions = new \flight\Permission($current_role);
$Permissions->defineRulesFromClassMethods(MyApp\Permissions::class);
Flight::set('permissions', $Permissions);

마지막으로 코드베이스에서 사용자가 특정 권한을 수행할 수 있는지 확인하려면 권한을 호출하십시오.

class SomeController {
    public function createOrder() {
        if(Flight::get('permissions')->can('order.create') === false) {
            die('주문을 만들 수 없습니다. 죄송합니다!');
        }
    }
}

캐싱

캐싱을 활성화하려면 간단한 wruczak/phpfilecache 라이브러리를 참조하십시오. 아래에 캐싱을 활성화하는 예제가 있습니다.


// 이 $app은 귀하의 코드의 일부일 수 있거나
// null을 전달하여 클래스 외부에서 가져올 수 있습니다.
$app = Flight::app();

// 현재는이 파일 캐시를 사용합니다. 나중에 다른 캐시를 쉽게 추가할 수 있습니다.
$Cache = new Wruczek\PhpFileCache\PhpFileCache;

$Permissions = new \flight\Permission($current_role, $app, $Cache);
$Permissions->defineRulesFromClassMethods(MyApp\Permissions::class, 3600); // 3600은 캐시로 저장되는 시간(초)입니다. 캐시를 사용하지 않으려면 이것을 뺍니다

Awesome-plugins/simple_job_queue

간단한 작업 큐

간단한 작업 큐는 비동기적으로 작업을 처리하는 데 사용할 수 있는 라이브러리입니다. beanstalkd, MySQL/MariaDB, SQLite 및 PostgreSQL과 함께 사용할 수 있습니다.

설치

composer require n0nag0n/simple-job-queue

사용법

이 기능이 작동하려면 작업을 큐에 추가하는 방법과 작업을 처리하는 방법(작업자)이 필요합니다. 아래는 큐에 작업을 추가하는 방법과 작업을 처리하는 방법의 예입니다.

Flight에 추가하기

Flight에 이를 추가하는 것은 간단하며 register() 메서드를 사용하여 수행됩니다. 아래는 이를 Flight에 추가하는 방법의 예입니다.

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

// beanstalkd를 사용하려면 ['mysql']을 ['beanstalkd']로 변경하십시오.
Flight::register('queue', n0nag0n\Job_Queue::class, ['mysql'], function($Job_Queue) {
    // Flight::db();에서 이미 PDO 연결이 있는 경우
    $Job_Queue->addQueueConnection(Flight::db());

    // 또는 beanstalkd/Pheanstalk를 사용하는 경우
    $pheanstalk = Pheanstalk\Pheanstalk::create('127.0.0.1');
    $Job_Queue->addQueueConnection($pheanstalk);
});

새로운 작업 추가하기

작업을 추가할 때는 파이프라인(큐)을 지정해야 합니다. 이는 RabbitMQ의 채널 또는 beanstalkd의 튜브에 해당합니다.

<?php
Flight::queue()->selectPipeline('send_important_emails');
Flight::queue()->addJob(json_encode([ 'something' => 'that', 'ends' => 'up', 'a' => 'string' ]));

작업자 실행하기

작업자를 실행하는 방법에 대한 예제 파일입니다.

<?php

require 'vendor/autoload.php';

$Job_Queue = new n0nag0n\Job_Queue('mysql');
// PDO 연결
$PDO = new PDO('mysql:dbname=testdb;host=127.0.0.1', 'user', 'pass');
$Job_Queue->addQueueConnection($PDO);

// 또는 beanstalkd/Pheanstalk를 사용하는 경우
$pheanstalk = Pheanstalk\Pheanstalk::create('127.0.0.1');
$Job_Queue->addQueueConnection($pheanstalk);

$Job_Queue->watchPipeline('send_important_emails');
while(true) {
    $job = $Job_Queue->getNextJobAndReserve();

    // 당신이 편안하게 잘 수 있도록 조정하세요 (데이터베이스 큐에만 해당, beanstalkd는 이 조건문이 필요하지 않습니다)
    if(empty($job)) {
        usleep(500000);
        continue;
    }

    echo "처리 중 {$job['id']}\n";
    $payload = json_decode($job['payload'], true);

    try {
        $result = doSomethingThatDoesSomething($payload);

        if($result === true) {
            $Job_Queue->deleteJob($job);
        } else {
            // 이는 준비된 큐에서 제거하고 나중에拾게 하거나 "찔러넣기"할 수 있는 다른 큐에 넣습니다.
            $Job_Queue->buryJob($job);
        }
    } catch(Exception $e) {
        $Job_Queue->buryJob($job);
    }
}

Supervisord로 긴 프로세스 처리하기

Supervisord는 작업자 프로세스가 지속적으로 실행되는 것을 보장하는 프로세스 제어 시스템입니다. 다음은 간단한 작업 큐 작업자와 함께 설정하는 방법에 대한 보다 완전한 가이드입니다:

Supervisord 설치하기

# Ubuntu/Debian에서
sudo apt-get install supervisor

# CentOS/RHEL에서
sudo yum install supervisor

# macOS에서 Homebrew를 사용하여
brew install supervisor

작업자 스크립트 만들기

우선, 작업자 코드를 전용 PHP 파일에 저장합니다:

<?php

require 'vendor/autoload.php';

$Job_Queue = new n0nag0n\Job_Queue('mysql');
// PDO 연결
$PDO = new PDO('mysql:dbname=your_database;host=127.0.0.1', 'username', 'password');
$Job_Queue->addQueueConnection($PDO);

// 감시할 파이프라인 설정
$Job_Queue->watchPipeline('send_important_emails');

// 작업자 시작 로그
echo date('Y-m-d H:i:s') . " - 작업자 시작됨\n";

while(true) {
    $job = $Job_Queue->getNextJobAndReserve();

    if(empty($job)) {
        usleep(500000); // 0.5초 동안 일시 정지
        continue;
    }

    echo date('Y-m-d H:i:s') . " - 작업 {$job['id']} 처리 중\n";
    $payload = json_decode($job['payload'], true);

    try {
        $result = doSomethingThatDoesSomething($payload);

        if($result === true) {
            $Job_Queue->deleteJob($job);
            echo date('Y-m-d H:i:s') . " - 작업 {$job['id']} 성공적으로 완료됨\n";
        } else {
            $Job_Queue->buryJob($job);
            echo date('Y-m-d H:i:s') . " - 작업 {$job['id']} 실패, 묻힘\n";
        }
    } catch(Exception $e) {
        $Job_Queue->buryJob($job);
        echo date('Y-m-d H:i:s') . " - 작업 {$job['id']} 처리 중 예외: {$e->getMessage()}\n";
    }
}

Supervisord 구성하기

작업자에 대한 구성 파일을 생성합니다:

[program:email_worker]
command=php /path/to/worker.php
directory=/path/to/project
autostart=true
autorestart=true
startretries=3
stderr_logfile=/var/log/simple_job_queue_err.log
stdout_logfile=/var/log/simple_job_queue.log
user=www-data
numprocs=2
process_name=%(program_name)s_%(process_num)02d

주요 구성 옵션:

Supervisorctl로 작업자 관리하기

구성을 생성하거나 수정한 후:

# supervisor 구성 다시 로드
sudo supervisorctl reread
sudo supervisorctl update

# 특정 작업자 프로세스 제어
sudo supervisorctl start email_worker:*
sudo supervisorctl stop email_worker:*
sudo supervisorctl restart email_worker:*
sudo supervisorctl status email_worker:*

여러 파이프라인 실행하기

여러 개의 파이프라인을 위해 별도의 작업자 파일 및 구성을 생성합니다:

[program:email_worker]
command=php /path/to/email_worker.php
# ... 기타 설정 ...

[program:notification_worker]
command=php /path/to/notification_worker.php
# ... 기타 설정 ...

모니터링 및 로그

로그를 확인하여 작업자 활동을 모니터링합니다:

# 로그 보기
sudo tail -f /var/log/simple_job_queue.log

# 상태 확인
sudo supervisorctl status

이 설정은 작업 큐 시스템이 충돌, 서버 재부팅 또는 기타 문제 발생 후에도 계속 실행되도록 하여 프로덕션 환경에서 신뢰할 수 있는 시스템이 되도록 보장합니다.

Awesome-plugins/jwt

Firebase JWT - JSON Web Token 인증을 위한 Flight

JWT (JSON Web Tokens)는 애플리케이션과 클라이언트 간에 클레임을 나타내는 컴팩트하고 URL-안전한 방법입니다. 서버 측 세션 저장소가 필요 없는 stateless API 인증에 완벽합니다! 이 가이드는 Firebase JWT를 Flight와 통합하여 안전한 토큰 기반 인증을 구현하는 방법을 보여줍니다.

전체 문서와 세부 사항은 Github 저장소를 방문하세요.

JWT란 무엇인가?

JSON Web Token은 세 부분을 포함하는 문자열입니다:

  1. 헤더: 토큰에 대한 메타데이터 (알고리즘, 유형)
  2. 페이로드: 데이터 (사용자 ID, 역할, 만료 등)
  3. 서명: 진위성을 확인하기 위한 암호화 서명

예제 JWT: eyJ0eXAiOiJKV1QiLCJhbGc... (무의미해 보이지만 구조화된 데이터입니다!)

JWT를 사용하는 이유는?

설치

Composer를 통해 설치하세요:

composer require firebase/php-jwt

기본 사용법

JWT 생성 및 확인의 간단한 예제입니다:

use Firebase\JWT\JWT;
use Firebase\JWT\Key;

// 비밀 키 (이것을 안전하게 보관하세요!)
$secretKey = 'your-256-bit-secret-key-here-keep-it-safe';

// 토큰 생성
$payload = [
    'user_id' => 123,
    'username' => 'johndoe',
    'role' => 'admin',
    'iat' => time(),              // 발급 시각
    'exp' => time() + 3600        // 1시간 후 만료
];

$jwt = JWT::encode($payload, $secretKey, 'HS256');
echo "Token: " . $jwt;

// 토큰 확인 및 디코딩
try {
    $decoded = JWT::decode($jwt, new Key($secretKey, 'HS256'));
    echo "User ID: " . $decoded->user_id;
} catch (Exception $e) {
    echo "Invalid token: " . $e->getMessage();
}

Flight를 위한 JWT 미들웨어 (권장 접근법)

Flight에서 JWT를 가장 일반적이고 유용하게 사용하는 방법은 API 경로를 보호하는 미들웨어입니다. 여기 완전하고 프로덕션 준비된 예제가 있습니다:

1단계: JWT 미들웨어 클래스 생성

// app/middleware/JwtMiddleware.php
use Firebase\JWT\JWT;
use Firebase\JWT\Key;
use Firebase\JWT\ExpiredException;
use Firebase\JWT\SignatureInvalidException;
use flight\Engine;

class JwtMiddleware {

    protected Engine $app;
    protected string $secretKey;

    public function __construct(Engine $app) {
        $this->app = $app;
        // 비밀 키를 app/config/config.php에 저장하세요. 하드코딩하지 마세요!
        $this->secretKey = $app->get('config')['jwt_secret'];
    }

    public function before(array $params) {
        $authHeader = $this->app->request()->getHeader('Authorization');

        // Authorization 헤더 존재 확인
        if (empty($authHeader)) {
            $this->app->jsonHalt(['error' => 'No authorization token provided'], 401);
        }

        // "Bearer <token>" 형식에서 토큰 추출
        if (!preg_match('/Bearer\s+(.*)$/i', $authHeader, $matches)) {
            $this->app->jsonHalt(['error' => 'Invalid authorization format. Use: Bearer <token>'], 401);
        }

        $jwt = $matches[1];

        try {
            // 토큰 디코딩 및 확인
            $decoded = JWT::decode($jwt, new Key($this->secretKey, 'HS256'));

            // 라우트 핸들러에서 사용할 사용자 데이터를 요청에 저장
            $this->app->request()->data->user = $decoded;

        } catch (ExpiredException $e) {
            $this->app->jsonHalt(['error' => 'Token has expired'], 401);
        } catch (SignatureInvalidException $e) {
            $this->app->jsonHalt(['error' => 'Invalid token signature'], 401);
        } catch (Exception $e) {
            $this->app->jsonHalt(['error' => 'Invalid token: ' . $e->getMessage()], 401);
        }
    }
}

2단계: 구성에 JWT 비밀 등록

// app/config/config.php
return [
    'jwt_secret' => getenv('JWT_SECRET') ?: 'your-fallback-secret-for-development'
];

// app/config/bootstrap.php 또는 index.php
// 구성에 앱을 노출하려면 이 줄을 추가하세요
$app->set('config', $config);

보안 주의: 비밀 키를 하드코딩하지 마세요! 프로덕션에서는 환경 변수를 사용하세요.

3단계: 미들웨어로 경로 보호

// 단일 경로 보호
Flight::route('GET /api/user/profile', function() {
    $user = Flight::request()->data->user; // 미들웨어에서 설정
    Flight::json([
        'user_id' => $user->user_id,
        'username' => $user->username,
        'role' => $user->role
    ]);
})->addMiddleware( JwtMiddleware::class);

// 전체 경로 그룹 보호 (더 일반적!)
Flight::group('/api', function() {
    Flight::route('GET /users', function() { /* ... */ });
    Flight::route('GET /posts', function() { /* ... */ });
    Flight::route('POST /posts', function() { /* ... */ });
    Flight::route('DELETE /posts/@id', function($id) { /* ... */ });
}, [ JwtMiddleware::class ]); // 이 그룹의 모든 경로가 보호됩니다!

미들웨어에 대한 자세한 내용은 미들웨어 문서를 참조하세요.

일반적인 사용 사례

1. 로그인 엔드포인트 (토큰 생성)

성공적인 인증 후 JWT를 생성하는 경로를 만드세요:

Flight::route('POST /api/login', function() {
    $data = Flight::request()->data;
    $username = $data->username ?? '';
    $password = $data->password ?? '';

    // 자격 증명 확인 (예제 - 자체 로직 사용!)
    $user = validateUserCredentials($username, $password);

    if (!$user) {
        Flight::jsonHalt(['error' => 'Invalid credentials'], 401);
    }

    // JWT 생성
    $secretKey = Flight::get('config')['jwt_secret'];
    $payload = [
        'user_id' => $user->id,
        'username' => $user->username,
        'role' => $user->role,
        'iat' => time(),
        'exp' => time() + (60 * 60) // 1시간 만료
    ];

    $jwt = JWT::encode($payload, $secretKey, 'HS256');

    Flight::json([
        'success' => true,
        'token' => $jwt,
        'expires_in' => 3600
    ]);
});

function validateUserCredentials($username, $password) {
    // 데이터베이스 조회 및 비밀번호 확인 로직
    // 예제:
    $db = Flight::db();
    $user = $db->fetchRow("SELECT * FROM users WHERE username = ?", [$username]);

    if ($user && password_verify($password, $user['password_hash'])) {
        return (object) [
            'id' => $user['id'],
            'username' => $user['username'],
            'role' => $user['role']
        ];
    }
    return null;
}

2. 토큰 새로고침 흐름

장기 세션을 위한 새로고침 토큰 시스템을 구현하세요:

Flight::route('POST /api/login', function() {
    // ... 자격 증명 확인 ...

    $secretKey = Flight::get('config')['jwt_secret'];
    $refreshSecret = Flight::get('config')['jwt_refresh_secret'];

    // 단기 액세스 토큰 (15분)
    $accessToken = JWT::encode([
        'user_id' => $user->id,
        'type' => 'access',
        'iat' => time(),
        'exp' => time() + (15 * 60)
    ], $secretKey, 'HS256');

    // 장기 새로고침 토큰 (7일)
    $refreshToken = JWT::encode([
        'user_id' => $user->id,
        'type' => 'refresh',
        'iat' => time(),
        'exp' => time() + (7 * 24 * 60 * 60)
    ], $refreshSecret, 'HS256');

    Flight::json([
        'access_token' => $accessToken,
        'refresh_token' => $refreshToken,
        'expires_in' => 900
    ]);
});

Flight::route('POST /api/refresh', function() {
    $refreshToken = Flight::request()->data->refresh_token ?? '';
    $refreshSecret = Flight::get('config')['jwt_refresh_secret'];

    try {
        $decoded = JWT::decode($refreshToken, new Key($refreshSecret, 'HS256'));

        // 새로고침 토큰인지 확인
        if ($decoded->type !== 'refresh') {
            Flight::jsonHalt(['error' => 'Invalid token type'], 401);
        }

        // 새 액세스 토큰 생성
        $secretKey = Flight::get('config')['jwt_secret'];
        $accessToken = JWT::encode([
            'user_id' => $decoded->user_id,
            'type' => 'access',
            'iat' => time(),
            'exp' => time() + (15 * 60)
        ], $secretKey, 'HS256');

        Flight::json([
            'access_token' => $accessToken,
            'expires_in' => 900
        ]);

    } catch (Exception $e) {
        Flight::jsonHalt(['error' => 'Invalid refresh token'], 401);
    }
});

3. 역할 기반 액세스 제어

미들웨어를 확장하여 사용자 역할을 확인하세요:

class JwtRoleMiddleware {

    protected Engine $app;
    protected array $allowedRoles;

    public function __construct(Engine $app, array $allowedRoles = []) {
        $this->app = $app;
        $this->allowedRoles = $allowedRoles;
    }

    public function before(array $params) {
        // JwtMiddleware가 이미 실행되어 사용자 데이터를 설정했다고 가정
        $user = $this->app->request()->data->user ?? null;

        if (!$user) {
            $this->app->jsonHalt(['error' => 'Authentication required'], 401);
        }

        // 필요한 역할이 있는지 확인
        if (!empty($this->allowedRoles) && !in_array($user->role, $this->allowedRoles)) {
            $this->app->jsonHalt(['error' => 'Insufficient permissions'], 403);
        }
    }
}

// 사용: 관리자 전용 경로
Flight::route('DELETE /api/users/@id', function($id) {
    // 사용자 삭제 로직
})->addMiddleware([
    JwtMiddleware::class,
    new JwtRoleMiddleware(Flight::app(), ['admin'])
]);

4. 사용자별 속도 제한이 있는 공용 API

세션 없이 JWT를 사용하여 사용자 추적 및 속도 제한:

class RateLimitMiddleware {

    public function before(array $params) {
        $user = Flight::request()->data->user ?? null;
        $userId = $user ? $user->user_id : Flight::request()->ip;

        $cacheKey = "rate_limit:$userId";
        // app/config/services.php에 캐시 서비스를 설정하세요
        $requests = Flight::cache()->get($cacheKey, 0);

        if ($requests >= 100) { // 시간당 100 요청
            Flight::jsonHalt(['error' => 'Rate limit exceeded'], 429);
        }

        Flight::cache()->set($cacheKey, $requests + 1, 3600);
    }
}

보안 모범 사례

1. 강력한 비밀 키 사용

// 안전한 비밀 키 생성 (한 번 실행 후 .env 파일에 저장)
$secretKey = base64_encode(random_bytes(32));
echo $secretKey; // .env 파일에 저장하세요!

2. 환경 변수에 비밀 저장

// 비밀을 버전 제어에 커밋하지 마세요!
// .env 파일과 vlucas/phpdotenv 같은 라이브러리 사용

// .env 파일:
// JWT_SECRET=your-base64-encoded-secret-here
// JWT_REFRESH_SECRET=another-base64-encoded-secret-here

// app/config/config.php 파일에도 비밀을 저장할 수 있습니다
// 구성 파일이 버전 제어에 커밋되지 않도록 하세요
// return [
//     'jwt_secret' => 'your-base64-encoded-secret-here',
//     'jwt_refresh_secret' => 'another-base64-encoded-secret-here',
// ];

// 앱에서:
$secretKey = getenv('JWT_SECRET');

3. 적절한 만료 시간 설정

// 모범 사례: 단기 액세스 토큰
'exp' => time() + (15 * 60)  // 15분

// 새로고침 토큰: 더 긴 만료
'exp' => time() + (7 * 24 * 60 * 60)  // 7일

4. 프로덕션에서 HTTPS 사용

JWT는 항상 HTTPS를 통해 전송해야 합니다. 프로덕션에서 평문 HTTP로 토큰을 보내지 마세요!

5. 토큰 클레임 확인

중요한 클레임을 항상 확인하세요:

$decoded = JWT::decode($jwt, new Key($secretKey, 'HS256'));

// 만료 확인은 라이브러리에서 자동 처리
// 하지만 사용자 지정 확인을 추가할 수 있습니다:
if ($decoded->iat > time()) {
    throw new Exception('Token used before it was issued');
}

if (isset($decoded->nbf) && $decoded->nbf > time()) {
    throw new Exception('Token not yet valid');
}

6. 로그아웃을 위한 토큰 블랙리스트 고려

추가 보안을 위해 무효화된 토큰의 블랙리스트를 유지하세요:

Flight::route('POST /api/logout', function() {
    $authHeader = Flight::request()->getHeader('Authorization');
    preg_match('/Bearer\s+(.*)$/i', $authHeader, $matches);
    $jwt = $matches[1];

    // 토큰 만료 추출
    $decoded = Flight::request()->data->user;
    $ttl = $decoded->exp - time();

    // 만료까지 캐시/Redis에 저장
    Flight::cache()->set("blacklist:$jwt", true, $ttl);

    Flight::json(['message' => 'Successfully logged out']);
});

// JwtMiddleware에 추가:
public function before(array $params) {
    // ... JWT 추출 ...

    // 블랙리스트 확인
    if (Flight::cache()->get("blacklist:$jwt")) {
        $this->app->jsonHalt(['error' => 'Token has been revoked'], 401);
    }

    // ... 토큰 확인 ...
}

알고리즘 및 키 유형

Firebase JWT는 여러 알고리즘을 지원합니다:

대칭 알고리즘 (HMAC)

$jwt = JWT::encode($payload, $secretKey, 'HS256');
$decoded = JWT::decode($jwt, new Key($secretKey, 'HS256'));

비대칭 알고리즘 (RSA/ECDSA)

// 키 생성: openssl genrsa -out private.key 2048
// openssl rsa -in private.key -pubout -out public.key

$privateKey = file_get_contents('/path/to/private.key');
$publicKey = file_get_contents('/path/to/public.key');

// 비공개 키로 인코딩
$jwt = JWT::encode($payload, $privateKey, 'RS256');

// 공개 키로 디코딩
$decoded = JWT::decode($jwt, new Key($publicKey, 'RS256'));

RSA를 사용할 때: 확인을 위해 공개 키를 배포해야 할 때 사용 (예: 마이크로서비스, 타사 통합). 단일 애플리케이션의 경우 HS256이 더 간단하고 충분합니다.

문제 해결

"만료된 토큰" 오류

토큰의 exp 클레임이 과거입니다. 새 토큰을 발급하거나 토큰 새로고침을 구현하세요.

"서명 확인 실패"

use Firebase\JWT\JWT;

JWT::$leeway = 60; // 60초 시계 왜곡 허용
$decoded = JWT::decode($jwt, new Key($secretKey, 'HS256'));

요청에서 토큰이 전송되지 않음

클라이언트가 Authorization 헤더를 보내는지 확인하세요:

// JavaScript 예제
fetch('/api/users', {
    headers: {
        'Authorization': 'Bearer ' + token
    }
});

메서드

Firebase JWT 라이브러리는 다음 핵심 메서드를 제공합니다:

이 라이브러리를 사용하는 이유는?

관련 자료

라이선스

Firebase JWT 라이브러리는 BSD 3-Clause License로 라이선스되었습니다. 세부 사항은 Github 저장소를 참조하세요.

Awesome-plugins/n0nag0n_wordpress

워드프레스 통합: n0nag0n/wordpress-integration-for-flight-framework

워드프레스 사이트에서 Flight PHP를 사용하고 싶으신가요? 이 플러그인은 이를 매우 쉽게 만들어줍니다! n0nag0n/wordpress-integration-for-flight-framework를 사용하면 WordPress 설치와 함께 완전한 Flight 앱을 실행할 수 있습니다—커스텀 API, 마이크로서비스, 또는 완전한 기능을 갖춘 앱을 빌드하는 데 완벽합니다.

이 플러그인이 하는 일?

설치

  1. flight-integration 폴더를 /wp-content/plugins/ 디렉터리에 업로드합니다.
  2. WordPress 관리자(플러그인 메뉴)에서 플러그인을 활성화합니다.
  3. 설정 > Flight Framework로 이동하여 플러그인을 구성합니다.
  4. Flight 설치의 벤더 경로를 설정합니다(또는 Composer를 사용하여 Flight를 설치).
  5. 앱 폴더 경로를 구성하고 폴더 구조를 생성합니다(플러그인이 이를 도와줍니다!).
  6. Flight 애플리케이션 빌드를 시작합니다!

사용 예시

기본 라우트 예시

앱의 app/config/routes.php 파일에서:

Flight::route('GET /api/hello', function() {
    Flight::json(['message' => 'Hello World!']);
});

컨트롤러 예시

app/controllers/ApiController.php에 컨트롤러를 생성합니다:

namespace app\controllers;

use Flight;

class ApiController {
    public function getUsers() {
        // 워드프레스 함수를 Flight 내부에서 사용할 수 있습니다!
        $users = get_users();
        $result = [];
        foreach($users as $user) {
            $result[] = [
                'id' => $user->ID,
                'name' => $user->display_name,
                'email' => $user->user_email
            ];
        }
        Flight::json($result);
    }
}

그런 다음, routes.php에서:

Flight::route('GET /api/users', [app\controllers\ApiController::class, 'getUsers']);

FAQ

Q: 이 플러그인을 사용하려면 Flight를 알아야 하나요?
A: 네, 이는 WordPress 내에서 Flight를 사용하고 싶어하는 개발자를 위한 것입니다. Flight의 라우팅과 요청 처리에 대한 기본 지식이 권장됩니다.

Q: 이 플러그인이 WordPress 사이트 속도를 저하시킬까요?
A: 아니요! 플러그인은 Flight 라우트와 일치하는 요청만 처리합니다. 다른 모든 요청은 평소처럼 WordPress로 이동합니다.

Q: Flight 앱에서 WordPress 함수를 사용할 수 있나요?
A: 물론입니다! Flight 라우트와 컨트롤러 내에서 모든 WordPress 함수, 후크, 전역 변수에 완전히 접근할 수 있습니다.

Q: 커스텀 라우트를 어떻게 생성하나요?
A: 앱 폴더의 config/routes.php 파일에서 라우트를 정의합니다. 폴더 구조 생성기가 만든 샘플 파일을 참조하여 예시를 확인하세요.

변경 로그

1.0.0
초기 릴리스.

추가 정보는 GitHub repo를 확인하세요.

Awesome-plugins/ghost_session

Ghostff/Session

PHP 세션 관리자 (비동기식, 플래시, 세그먼트, 세션 암호화). PHP open_ssl을 사용하여 세션 데이터를 선택적으로 암호화/복호화합니다. File, MySQL, Redis, 및 Memcached를 지원합니다.

클릭 여기 코드를 보기 위해.

설치

Composer를 사용하여 설치하세요.

composer require ghostff/session

기본 구성

기본 설정을 사용하려면 아무것도 전달할 필요가 없습니다. 더 많은 설정에 대해서는 Github Readme를 참조하세요.

use Ghostff\Session\Session;

require 'vendor/autoload.php';

$app = Flight::app();

$app->register('session', Session::class);

// 한 가지 기억할 점은 각 페이지 로드 시 세션을 커밋해야 한다는 것입니다
// 또는 구성에서 auto_commit을 실행해야 합니다.

간단한 예제

사용 방법의 간단한 예제입니다.

Flight::route('POST /login', function() {
    $session = Flight::session();

    // 여기에 로그인 로직을 수행하세요
    // 비밀번호를 검증하는 등

    // 로그인 성공 시
    $session->set('is_logged_in', true);
    $session->set('user', $user);

    // 세션에 작성할 때마다 의도적으로 커밋해야 합니다.
    $session->commit();
});

// 이 검사는 제한된 페이지 로직에서 수행되거나 미들웨어로 래핑될 수 있습니다.
Flight::route('/some-restricted-page', function() {
    $session = Flight::session();

    if(!$session->get('is_logged_in')) {
        Flight::redirect('/login');
    }

    // 여기에서 제한된 페이지 로직을 수행하세요
});

// 미들웨어 버전
Flight::route('/some-restricted-page', function() {
    // 일반 페이지 로직
})->addMiddleware(function() {
    $session = Flight::session();

    if(!$session->get('is_logged_in')) {
        Flight::redirect('/login');
    }
});

더 복잡한 예제

사용 방법의 더 복잡한 예제입니다.

use Ghostff\Session\Session;

require 'vendor/autoload.php';

$app = Flight::app();

// 세션 구성 파일의 사용자 정의 경로를 첫 번째 인자로 설정하세요
// 또는 사용자 정의 배열을 제공하세요
$app->register('session', Session::class, [ 
    [
        // 세션 데이터를 데이터베이스에 저장하려는 경우 (예: "모든 장치에서 로그아웃" 기능과 같은 것)
        Session::CONFIG_DRIVER        => Ghostff\Session\Drivers\MySql::class,
        Session::CONFIG_ENCRYPT_DATA  => true,
        Session::CONFIG_SALT_KEY      => hash('sha256', 'my-super-S3CR3T-salt'), // 이것을 다른 것으로 변경하세요
        Session::CONFIG_AUTO_COMMIT   => true, // 이것이 필요하거나 커밋()하기가 어렵다면만 수행하세요.
                                                // 추가적으로 Flight::after('start', function() { Flight::session()->commit(); });을 사용할 수 있습니다.
        Session::CONFIG_MYSQL_DS         => [
            'driver'    => 'mysql',             # PDO dns용 데이터베이스 드라이버(예: mysql:host=...;dbname=...)
            'host'      => '127.0.0.1',         # 데이터베이스 호스트
            'db_name'   => 'my_app_database',   # 데이터베이스 이름
            'db_table'  => 'sessions',          # 데이터베이스 테이블
            'db_user'   => 'root',              # 데이터베이스 사용자 이름
            'db_pass'   => '',                  # 데이터베이스 비밀번호
            'persistent_conn'=> false,          # 스크립트가 데이터베이스와 통신할 때마다 새로운 연결을 설정하는 오버헤드를 피합니다. 단점은 스스로 찾아보세요
        ]
    ] 
]);

도움! 내 세션 데이터가 유지되지 않아요!

세션 데이터를 설정했는데 요청 사이에 유지되지 않나요? 세션 데이터를 커밋하는 것을 잊었을 수 있습니다. 세션 데이터를 설정한 후 $session->commit()을 호출하세요.

Flight::route('POST /login', function() {
    $session = Flight::session();

    // 여기에 로그인 로직을 수행하세요
    // 비밀번호를 검증하는 등

    // 로그인 성공 시
    $session->set('is_logged_in', true);
    $session->set('user', $user);

    // 세션에 작성할 때마다 의도적으로 커밋해야 합니다.
    $session->commit();
});

이것을 해결하는 다른 방법은 세션 서비스를 설정할 때 구성에 auto_commit을 true로 설정하는 것입니다. 이렇게 하면 각 요청 후 세션 데이터를 자동으로 커밋합니다.

$app->register('session', Session::class, [ 'path/to/session_config.php', bin2hex(random_bytes(32)) ], function(Session $session) {
        $session->updateConfiguration([
            Session::CONFIG_AUTO_COMMIT   => true,
        ]);
    }
);

또한 Flight::after('start', function() { Flight::session()->commit(); });을 사용하여 각 요청 후 세션 데이터를 커밋할 수 있습니다.

문서

전체 문서를 위해 Github Readme를 방문하세요. 구성 옵션은 default_config.php 파일 자체에 잘 문서화되어 있습니다. 이 패키지를 직접 살펴보고 싶다면 코드는 이해하기 쉽습니다.

Awesome-plugins/async

Async

Async는 Flight 프레임워크를 위한 작은 패키지로, Swoole, AdapterMan, ReactPHP, Amp, RoadRunner, Workerman 등의 비동기 서버와 런타임에서 Flight 앱을 실행할 수 있게 합니다. 기본적으로 Swoole과 AdapterMan 어댑터를 포함합니다.

목표: PHP-FPM(또는 내장 서버)으로 개발하고 디버그한 후, 프로덕션에서 Swoole(또는 다른 비동기 드라이버)로 최소한의 변경으로 전환합니다.

요구 사항

설치

Composer를 통해 설치하세요:

composer require flightphp/async

Swoole로 실행할 계획이라면 확장을 설치하세요:

# pecl 사용
pecl install swoole
# 또는 openswoole
pecl install openswoole

# 또는 패키지 관리자 사용 (Debian/Ubuntu 예시)
sudo apt-get install php-swoole

간단한 Swoole 예제

아래는 동일한 코드베이스를 사용하여 PHP-FPM(또는 내장 서버)와 Swoole을 모두 지원하는 최소 설정입니다.

프로젝트에서 필요한 파일:

index.php

이 파일은 개발 시 앱을 PHP 모드로 강제 실행하는 간단한 스위치입니다.

// index.php
<?php

define('NOT_SWOOLE', true);

include 'swoole_server.php';

swoole_server.php

이 파일은 Flight 앱을 부트스트랩하고, NOT_SWOOLE이 정의되지 않으면 Swoole 드라이버를 시작합니다.

// swoole_server.php
<?php

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

$app = Flight::app();

$app->route('/', function() use ($app) {
    $app->json(['hello' => 'world']);
});

if (!defined('NOT_SWOOLE')) {
    // Swoole 모드에서 실행될 때 SwooleServerDriver 클래스를 요구합니다.
    require_once __DIR__ . '/SwooleServerDriver.php';

    Swoole\Runtime::enableCoroutine();
    $Swoole_Server = new SwooleServerDriver('127.0.0.1', 9501, $app);
    $Swoole_Server->start();
} else {
    $app->start();
}

SwooleServerDriver.php

AsyncBridge와 Swoole 어댑터를 사용하여 Swoole 요청을 Flight로 연결하는 간결한 드라이버입니다.

// SwooleServerDriver.php
<?php

use flight\adapter\SwooleAsyncRequest;
use flight\adapter\SwooleAsyncResponse;
use flight\AsyncBridge;
use flight\Engine;
use Swoole\HTTP\Server as SwooleServer;
use Swoole\HTTP\Request as SwooleRequest;
use Swoole\HTTP\Response as SwooleResponse;

class SwooleServerDriver {
    protected $Swoole;
    protected $app;

    public function __construct(string $host, int $port, Engine $app) {
        $this->Swoole = new SwooleServer($host, $port);
        $this->app = $app;

        $this->setDefault();
        $this->bindWorkerEvents();
        $this->bindHttpEvent();
    }

    protected function setDefault() {
        $this->Swoole->set([
            'daemonize'             => false,
            'dispatch_mode'         => 1,
            'max_request'           => 8000,
            'open_tcp_nodelay'      => true,
            'reload_async'          => true,
            'max_wait_time'         => 60,
            'enable_reuse_port'     => true,
            'enable_coroutine'      => true,
            'http_compression'      => false,
            'enable_static_handler' => true,
            'document_root'         => __DIR__,
            'static_handler_locations' => ['/css', '/js', '/images', '/.well-known'],
            'buffer_output_size'    => 4 * 1024 * 1024,
            'worker_num'            => 4,
        ]);

        $app = $this->app;
        $app->map('stop', function (?int $code = null) use ($app) {
            if ($code !== null) {
                $app->response()->status($code);
            }
        });
    }

    protected function bindHttpEvent() {
        $app = $this->app;
        $AsyncBridge = new AsyncBridge($app);

        $this->Swoole->on('Start', function(SwooleServer $server) {
            echo "Swoole http server is started at http://127.0.0.1:9501\n";
        });

        $this->Swoole->on('Request', function (SwooleRequest $request, SwooleResponse $response) use ($AsyncBridge) {
            $SwooleAsyncRequest = new SwooleAsyncRequest($request);
            $SwooleAsyncResponse = new SwooleAsyncResponse($response);

            $AsyncBridge->processRequest($SwooleAsyncRequest, $SwooleAsyncResponse);

            $response->end();
            gc_collect_cycles();
        });
    }

    protected function bindWorkerEvents() {
        $createPools = function() {
            // 여기서 워커별 연결 풀을 생성합니다.
        };
        $closePools = function() {
            // 여기서 풀을 닫거나 정리합니다.
        };
        $this->Swoole->on('WorkerStart', $createPools);
        $this->Swoole->on('WorkerStop', $closePools);
        $this->Swoole->on('WorkerError', $closePools);
    }

    public function start() {
        $this->Swoole->start();
    }
}

서버 실행

팁: 프로덕션에서는 TLS, 정적 파일, 로드 밸런싱을 처리하기 위해 Swoole 앞에 리버스 프록시(Nginx)를 사용하세요.

구성 노트

Swoole 드라이버는 여러 구성 옵션을 노출합니다:

호스트 리소스와 트래픽 패턴에 맞게 조정하세요.

오류 처리

AsyncBridge는 Flight 오류를 적절한 HTTP 응답으로 변환합니다. 라우트 수준 오류 처리도 추가할 수 있습니다:

$app->route('/*', function() use ($app) {
    try {
        // 라우트 로직
    } catch (Exception $e) {
        $app->response()->status(500);
        $app->json(['error' => $e->getMessage()]);
    }
});

AdapterMan 및 기타 런타임

AdapterMan은 대안 런타임 어댑터로 지원됩니다. 이 패키지는 적응 가능하게 설계되었습니다 — 다른 어댑터를 추가하거나 사용하는 것은 일반적으로 동일한 패턴을 따릅니다: AsyncBridge와 런타임별 어댑터를 통해 서버 요청/응답을 Flight의 요청/응답으로 변환합니다.

Awesome-plugins/migrations

마이그레이션

프로젝트의 마이그레이션은 프로젝트에 관련된 모든 데이터베이스 변경 사항을 추적합니다.
byjg/php-migration 는 시작하는 데 매우 유용한 기본 라이브러리입니다.

설치

PHP 라이브러리

프로젝트에 PHP 라이브러리만 사용하고 싶다면:

composer require "byjg/migration"

명령 줄 인터페이스

명령 줄 인터페이스는 독립형이며 프로젝트와 함께 설치할 필요가 없습니다.

글로벌로 설치하고 심볼릭 링크를 생성할 수 있습니다.

composer require "byjg/migration-cli"

Migration CLI에 대한 더 많은 정보를 얻으려면 byjg/migration-cli를 방문해 주세요.

지원되는 데이터베이스

데이터베이스 드라이버 연결 문자열
Sqlite pdo_sqlite sqlite:///path/to/file
MySql/MariaDb pdo_mysql mysql://username:password@hostname:port/database
Postgres pdo_pgsql pgsql://username:password@hostname:port/database
Sql Server pdo_dblib, pdo_sysbase Linux dblib://username:password@hostname:port/database
Sql Server pdo_sqlsrv Windows sqlsrv://username:password@hostname:port/database

작동 방식은?

데이터베이스 마이그레이션은 데이터베이스 버전 관리를 위해 PURE SQL을 사용합니다.
작동하게 하려면 다음이 필요합니다:

SQL 스크립트

스크립트는 세 가지 세트로 나뉩니다:

스크립트 디렉토리는 다음과 같습니다:

 <root dir>
     |
     +-- base.sql
     |
     +-- /migrations
              |
              +-- /up
                   |
                   +-- 00001.sql
                   +-- 00002.sql
              +-- /down
                   |
                   +-- 00000.sql
                   +-- 00001.sql

다중 개발 환경

여러 개발자와 여러 브랜치에서 작업하는 경우 다음 숫자를 결정하기가 너무 어렵습니다.

그 경우에는 버전 번호 뒤에 "-dev" 접미사를 추가해야 합니다.

시나리오는 다음과 같습니다:

두 경우 모두 개발자는 43-dev.sql이라는 파일을 생성할 것입니다. 두 개발자는 문제 없이 업그레이드하고 다운그레이드를 수행할 것이며, 로컬 버전은 43이 될 것입니다.

하지만 개발자 1이 변경 사항을 병합하고 최종 버전 43.sql을 생성했습니다(git mv 43-dev.sql 43.sql). 개발자 2가 로컬 브랜치를 업데이트하면 그는 43.sql(개발자 1의 파일)과 43-dev.sql를 갖게 됩니다.
그가 업그레이드하거나 다운그레이드를 시도하면 마이그레이션 스크립트는 다운되고 두 개의 버전 43이 있다고 경고합니다. 그 경우 개발자 2는 자신의 파일을 44-dev.sql로 업데이트하고 병합할 때까지 작업을 계속해야 합니다.

PHP API 사용 및 프로젝트에 통합하기

기본 사용법은 다음과 같습니다:

예제를 보세요:

<?php
// 연결 URI 생성
// 추가 정보: https://github.com/byjg/anydataset#connection-based-on-uri
$connectionUri = new \ByJG\Util\Uri('mysql://migrateuser:migratepwd@localhost/migratedatabase');

// 데이터베이스 또는 데이터베이스를 등록할 수 있습니다:
\ByJG\DbMigration\Migration::registerDatabase(\ByJG\DbMigration\Database\MySqlDatabase::class);

// Migration 인스턴스 생성
$migration = new \ByJG\DbMigration\Migration($connectionUri, '.');

// 실행 중 정보를 받기 위한 콜백 진행 함수를 추가합니다.
$migration->addCallbackProgress(function ($action, $currentVersion, $fileInfo) {
    echo "$action, $currentVersion, ${fileInfo['description']}\n";
});

// "base.sql" 스크립트를 사용하여 데이터베이스를 복원합니다
// 그리고 데이터베이스 버전을 최신 버전으로 업그레이드하기 위해 모든 기존 스크립트를 실행합니다
$migration->reset();

// 현재 버전에서 시작하여 $version 번호까지 데이터베이스 버전을 업그레이드하거나 다운그레이드하기 위해 모든 기존 스크립트를 실행합니다;
// 버전 번호가 지정되지 않으면 마지막 데이터베이스 버전까지 마이그레이션
$migration->update($version = null);

Migration 객체는 데이터베이스 버전을 관리합니다.

프로젝트에서 버전 관리 생성

<?php
// 데이터베이스 또는 데이터베이스를 등록할 수 있습니다:
\ByJG\DbMigration\Migration::registerDatabase(\ByJG\DbMigration\Database\MySqlDatabase::class);

// Migration 인스턴스 생성
$migration = new \ByJG\DbMigration\Migration($connectionUri, '.');

// 이 명령은 데이터베이스에 버전 테이블을 생성합니다
$migration->createVersion();

현재 버전 가져오기

<?php
$migration->getCurrentVersion();

진행 상황 제어를 위한 콜백 추가

<?php
$migration->addCallbackProgress(function ($command, $version, $fileInfo) {
    echo "명령 실행 중: $command, 버전 $version - ${fileInfo['description']}, ${fileInfo['exists']}, ${fileInfo['file']}, ${fileInfo['checksum']}\n";
});

Db 드라이버 인스턴스 가져오기

<?php
$migration->getDbDriver();

사용하려면 다음을 방문해 주세요: https://github.com/byjg/anydataset-db

부분 마이그레이션 방지 (MySQL에 대해 사용할 수 없음)

부분 마이그레이션은 마이그레이션 스크립트가 오류 또는 수동 중단으로 인해 프로세스 중간에 중단되는 경우입니다.

마이그레이션 테이블은 partial up 또는 partial down 상태이므로 다시 마이그레이션하기 전에 수동으로 수정해야 합니다.

이 상황을 피하기 위해 마이그레이션이 트랜잭션 컨텍스트 내에서 실행되도록 명시할 수 있습니다.
마이그레이션 스크립트가 실패하면 트랜잭션이 롤백되고 마이그레이션 테이블은 complete로 표시되며, 버전은 오류를 일으킨 스크립트 이전의 가장 최근 버전이 될 것입니다.

이 기능을 사용하려면 withTransactionEnabled 메서드를 호출하고 true를 매개변수로 전달해야 합니다:

<?php
$migration->withTransactionEnabled(true);

참고: 이 기능은 MySQL에서 사용할 수 없습니다. MySQL은 트랜잭션 내에서 DDL 명령을 지원하지 않기 때문입니다.
이 메서드를 MySQL에서 사용하면 Migration은 그를 무시합니다.
자세한 내용: https://dev.mysql.com/doc/refman/8.0/en/cannot-roll-back.html

Postgres에 대한 SQL 마이그레이션 작성 팁

트리거 및 SQL 함수 생성 시

-- DO
CREATE FUNCTION emp_stamp() RETURNS trigger AS $emp_stamp$
    BEGIN
        -- empname과 salary가 주어졌는지 확인
        IF NEW.empname IS NULL THEN
            RAISE EXCEPTION 'empname cannot be null'; -- 이 주석이 비어 있든 지 여부는 중요하지 않음
        END IF; --
        IF NEW.salary IS NULL THEN
            RAISE EXCEPTION '% cannot have null salary', NEW.empname; --
        END IF; --

        -- 누가 우리를 위해 일하며 언제 대가를 지불해야 하는가?
        IF NEW.salary < 0 THEN
            RAISE EXCEPTION '% cannot have a negative salary', NEW.empname; --
        END IF; --

        -- 누가 언제 급여를 변경했는지 기억
        NEW.last_date := current_timestamp; --
        NEW.last_user := current_user; --
        RETURN NEW; --
    END; --
$emp_stamp$ LANGUAGE plpgsql;

-- DON'T
CREATE FUNCTION emp_stamp() RETURNS trigger AS $emp_stamp$
    BEGIN
        -- empname과 salary가 주어졌는지 확인
        IF NEW.empname IS NULL THEN
            RAISE EXCEPTION 'empname cannot be null';
        END IF;
        IF NEW.salary IS NULL THEN
            RAISE EXCEPTION '% cannot have null salary', NEW.empname;
        END IF;

        -- 누가 우리를 위해 일하며 언제 대가를 지불해야 하는가?
        IF NEW.salary < 0 THEN
            RAISE EXCEPTION '% cannot have a negative salary', NEW.empname;
        END IF;

        -- 누가 언제 급여를 변경했는지 기억
        NEW.last_date := current_timestamp;
        NEW.last_user := current_user;
        RETURN NEW;
    END;
$emp_stamp$ LANGUAGE plpgsql;

PDO 데이터베이스 추상화 계층은 SQL 문 전체를 배치로 실행할 수 없기 때문에, byjg/migration이 마이그레이션 파일을 읽을 때 SQL 파일의 전체 내용을 세미콜론에서 나누고 명령을 하나씩 실행해야 합니다. 그러나 하나의 종류의 명령은 본체에 여러 개의 세미콜론을 가질 수 있습니다: 함수입니다.

함수를 올바르게 파싱할 수 있도록 하기 위해, byjg/migration 2.1.0에서는 마이그레이션 파일을 단순히 세미콜론 대신 세미콜론 + EOL 시퀀스에서 나누도록 변경되었습니다. 이렇게 하면 각 함수 정의의 내부 세미콜론 뒤에 빈 주석을 추가하면 byjg/migration이 올바르게 파싱할 수 있습니다.

불행히도 이러한 주석을 추가하는 것을 잊으면 라이브러리는 CREATE FUNCTION 문을 여러 부분으로 나누고 마이그레이션이 실패하게 됩니다.

콜론 문자(:) 피하기

-- DO
CREATE TABLE bookings (
  booking_id UUID PRIMARY KEY,
  booked_at  TIMESTAMPTZ NOT NULL CHECK (CAST(booked_at AS DATE) <= check_in),
  check_in   DATE NOT NULL
);

-- DON'T
CREATE TABLE bookings (
  booking_id UUID PRIMARY KEY,
  booked_at  TIMESTAMPTZ NOT NULL CHECK (booked_at::DATE <= check_in),
  check_in   DATE NOT NULL
);

PDO는 준비된 문에서 이름 있는 매개변수를 접두사로 붙이는 데 콜론 문자를 사용하므로, 다른 컨텍스트에서 이 사용이 문제를 발생시킬 수 있습니다.

예를 들어, PostgreSQL에서는 값을 타입 간에 캐스팅할 때 ::를 사용할 수 있습니다. 반면, PDO는 이를 잘못된 컨텍스트에서 잘못된 이름 있는 매개변수로 읽고 실행하려고 할 때 실패합니다.

이 inconsistency를 수정하는 유일한 방법은 콜론을 완전히 피하는 것입니다 (이 경우 PostgreSQL은 대안 구문인 CAST(value AS type)도 제공합니다).

SQL 편집기 사용

마지막으로, 수동 SQL 마이그레이션 작성은 힘들 수 있지만 SQL 문법을 이해할 수 있는 편집기를 사용하면 훨씬 쉬워집니다.
자동 완성, 현재 데이터베이스 스키마 탐색 및/또는 코드 자동 포맷팅을 제공하는 편집기를 사용하는 것이 좋습니다.

동일한 스키마 내에서 서로 다른 마이그레이션 처리하기

동일한 스키마 내에서 서로 다른 마이그레이션 스크립트와 버전을 생성해야 하는 경우 가능하지만 너무 위험하며 전혀 추천하지 않습니다.

이렇게 하려면 생성자에 매개변수를 전달하여 서로 다른 "마이그레이션 테이블"을 만들어야 합니다.

<?php
$migration = new \ByJG\DbMigration\Migration("db:/uri", "/path", true, "NEW_MIGRATION_TABLE_NAME");

보안상의 이유로 이 기능은 명령 줄에서 사용할 수 없지만, 환경 변수 MIGRATION_VERSION을 사용하여 이름을 저장할 수 있습니다.

이 기능을 사용하지 않는 것을 강력히 권장합니다. 권장 사항은 하나의 스키마에 대해 하나의 마이그레이션입니다.

단위 테스트 실행

기본 단위 테스트는 다음과 같이 실행할 수 있습니다:

vendor/bin/phpunit

데이터베이스 테스트 실행

통합 테스트를 실행하려면 데이터베이스가 시작되고 실행 중이어야 합니다.
우리는 테스트를 위해 데이터베이스를 시작하는 데 사용할 수 있는 기본 docker-compose.yml을 제공했습니다.

데이터베이스 실행하기

docker-compose up -d postgres mysql mssql

테스트 실행하기

vendor/bin/phpunit
vendor/bin/phpunit tests/SqliteDatabase*
vendor/bin/phpunit tests/MysqlDatabase*
vendor/bin/phpunit tests/PostgresDatabase*
vendor/bin/phpunit tests/SqlServerDblibDatabase*
vendor/bin/phpunit tests/SqlServerSqlsrvDatabase*

선택적으로 단위 테스트에서 사용하는 호스트와 비밀번호를 설정할 수 있습니다.

export MYSQL_TEST_HOST=localhost     # 기본값은 localhost
export MYSQL_PASSWORD=newpassword    # 비밀번호가 null이면 '.' 사용
export PSQL_TEST_HOST=localhost      # 기본값은 localhost
export PSQL_PASSWORD=newpassword     # 비밀번호가 null이면 '.' 사용
export MSSQL_TEST_HOST=localhost     # 기본값은 localhost
export MSSQL_PASSWORD=Pa55word
export SQLITE_TEST_HOST=/tmp/test.db      # 기본값은 /tmp/test.db

Awesome-plugins/comment_template

CommentTemplate

CommentTemplate은 자산 컴파일, 템플릿 상속, 변수 처리 기능을 갖춘 강력한 PHP 템플릿 엔진입니다. 내장된 CSS/JS 최소화 및 캐싱을 통해 템플릿을 간단하고 유연하게 관리할 수 있습니다.

기능

설치

Composer를 사용하여 설치하세요.

composer require knifelemon/comment-template

기본 구성

시작하기 위한 기본 구성 옵션이 있습니다. 이에 대해 더 자세히 읽으려면 CommentTemplate Repo를 참조하세요.

방법 1: 콜백 함수 사용

<?php
require_once 'vendor/autoload.php';

use KnifeLemon\CommentTemplate\Engine;

$app = Flight::app();

$app->register('view', Engine::class, [], function (Engine $engine) use ($app) {
    // 루트 디렉토리 (index.php가 있는 곳) - 웹 애플리케이션의 문서 루트
    $engine->setPublicPath(__DIR__);

    // 템플릿 파일 디렉토리 - 상대 경로와 절대 경로 모두 지원
    $engine->setSkinPath('views');             // 공용 경로에 상대적

    // 컴파일된 자산이 저장될 위치 - 상대 경로와 절대 경로 모두 지원
    $engine->setAssetPath('assets');           // 공용 경로에 상대적

    // 템플릿 파일 확장자
    $engine->setFileExtension('.php');
});

$app->map('render', function(string $template, array $data) use ($app): void {
    echo $app->view()->render($template, $data);
});

방법 2: 생성자 매개변수 사용

<?php
require_once 'vendor/autoload.php';

use KnifeLemon\CommentTemplate\Engine;

$app = Flight::app();

// __construct(string $publicPath = "", string $skinPath = "", string $assetPath = "", string $fileExtension = "")
$app->register('view', Engine::class, [
    __DIR__,                // publicPath - 루트 디렉토리 (index.php가 있는 곳)
    'views',                // skinPath - 템플릿 경로 (상대/절대 경로 지원)
    'assets',               // assetPath - 컴파일된 자산 경로 (상대/절대 경로 지원)
    '.php'                  // fileExtension - 템플릿 파일 확장자
]);

$app->map('render', function(string $template, array $data) use ($app): void {
    echo $app->view()->render($template, $data);
});

경로 구성

CommentTemplate은 상대 경로와 절대 경로 모두에 대한 지능적인 경로 처리를 제공합니다:

공용 경로

공용 경로는 웹 애플리케이션의 루트 디렉토리로, 일반적으로 index.php가 있는 위치입니다. 이는 웹 서버가 파일을 제공하는 문서 루트입니다.

// 예: index.php가 /var/www/html/myapp/index.php에 있는 경우
$template->setPublicPath('/var/www/html/myapp');  // 루트 디렉토리

// Windows 예: index.php가 C:\xampp\htdocs\myapp\index.php에 있는 경우
$template->setPublicPath('C:\\xampp\\htdocs\\myapp');

템플릿 경로 구성

템플릿 경로는 상대 경로와 절대 경로 모두를 지원합니다:

$template = new Engine();
$template->setPublicPath('/var/www/html/myapp');  // 루트 디렉토리 (index.php가 있는 곳)

// 상대 경로 - 공용 경로와 자동으로 결합
$template->setSkinPath('views');           // → /var/www/html/myapp/views/
$template->setSkinPath('templates/pages'); // → /var/www/html/myapp/templates/pages/

// 절대 경로 - 그대로 사용 (Unix/Linux)
$template->setSkinPath('/var/www/templates');      // → /var/www/templates/
$template->setSkinPath('/full/path/to/templates'); // → /full/path/to/templates/

// Windows 절대 경로
$template->setSkinPath('C:\\www\\templates');     // → C:\www\templates\
$template->setSkinPath('D:/projects/templates');  // → D:/projects/templates/

// UNC 경로 (Windows 네트워크 공유)
$template->setSkinPath('\\\\server\\share\\templates'); // → \\server\share\templates\

자산 경로 구성

자산 경로도 상대 경로와 절대 경로 모두를 지원합니다:

// 상대 경로 - 공용 경로와 자동으로 결합
$template->setAssetPath('assets');        // → /var/www/html/myapp/assets/
$template->setAssetPath('static/files');  // → /var/www/html/myapp/static/files/

// 절대 경로 - 그대로 사용 (Unix/Linux)
$template->setAssetPath('/var/www/cdn');           // → /var/www/cdn/
$template->setAssetPath('/full/path/to/assets');   // → /full/path/to/assets/

// Windows 절대 경로
$template->setAssetPath('C:\\www\\static');       // → C:\www\static\
$template->setAssetPath('D:/projects/assets');    // → D:/projects/assets/

// UNC 경로 (Windows 네트워크 공유)
$template->setAssetPath('\\\\server\\share\\assets'); // → \\server\share\assets\

스마트 경로 감지:

작동 방식:

Tracy 디버거 통합

CommentTemplate은 개발 로깅 및 디버깅을 위해 Tracy Debugger와 통합됩니다.

Comment Template Tracy

설치

composer require tracy/tracy

사용법

<?php
use KnifeLemon\CommentTemplate\Engine;
use Tracy\Debugger;

// Tracy 활성화 (출력 전에 호출되어야 함)
Debugger::enable(Debugger::DEVELOPMENT);
Flight::set('flight.content_length', false);

// 템플릿 재정의
$app->register('view', Engine::class, [], function (Engine $builder) use ($app) {
    $builder->setPublicPath($app->get('flight.views.topPath'));
    $builder->setAssetPath($app->get('flight.views.assetPath'));
    $builder->setSkinPath($app->get('flight.views.path'));
    $builder->setFileExtension($app->get('flight.views.extension'));
});
$app->map('render', function(string $template, array $data) use ($app): void {
    echo $app->view()->render($template, $data);
});

$app->start();

디버그 패널 기능

CommentTemplate은 Tracy의 디버그 바에 4개의 탭이 있는 사용자 정의 패널을 추가합니다:

로깅되는 항목

참고: Tracy가 설치되지 않았거나 비활성화된 경우 성능에 영향이 없습니다.

Flight PHP와 함께 사용하는 완전한 예제를 참조하세요.

템플릿 지시어

레이아웃 상속

공통 구조를 생성하기 위해 레이아웃을 사용하세요:

layout/global_layout.php:

<!DOCTYPE html>
<html>
<head>
    <title>{$title}</title>
</head>
<body>
    <!--@contents-->
</body>
</html>

view/page.php:

<!--@layout(layout/global_layout)-->
<h1>{$title}</h1>
<p>{$content}</p>

자산 관리

CSS 파일

<!--@css(/css/styles.css)-->          <!-- 최소화 및 캐싱 -->
<!--@cssSingle(/css/critical.css)-->  <!-- 단일 파일, 최소화되지 않음 -->

JavaScript 파일

CommentTemplate은 다양한 JavaScript 로딩 전략을 지원합니다:

<!--@js(/js/script.js)-->             <!-- 최소화, 하단에 로드 -->
<!--@jsAsync(/js/analytics.js)-->     <!-- 최소화, 하단에 async로 로드 -->
<!--@jsDefer(/js/utils.js)-->         <!-- 최소화, 하단에 defer로 로드 -->
<!--@jsTop(/js/critical.js)-->        <!-- 최소화, head에 로드 -->
<!--@jsTopAsync(/js/tracking.js)-->   <!-- 최소화, head에 async로 로드 -->
<!--@jsTopDefer(/js/polyfill.js)-->   <!-- 최소화, head에 defer로 로드 -->
<!--@jsSingle(/js/widget.js)-->       <!-- 단일 파일, 최소화되지 않음 -->
<!--@jsSingleAsync(/js/ads.js)-->     <!-- 단일 파일, 최소화되지 않음, async -->
<!--@jsSingleDefer(/js/social.js)-->  <!-- 단일 파일, 최소화되지 않음, defer -->

CSS/JS 파일 내 자산 지시어

CommentTemplate은 컴파일 중 CSS 및 JavaScript 파일 내 자산 지시어를 처리합니다:

CSS 예시:

/* CSS 파일 내 */
@font-face {
    font-family: 'CustomFont';
    src: url('<!--@asset(fonts/custom.woff2)-->') format('woff2');
}

.background-image {
    background: url('<!--@asset(images/bg.jpg)-->');
}

.inline-icon {
    background: url('<!--@base64(icons/star.svg)-->');
}

JavaScript 예시:

/* JS 파일 내 */
const fontUrl = '<!--@asset(fonts/custom.woff2)-->';
const imageData = '<!--@base64(images/icon.png)-->';

Base64 인코딩

<!--@base64(images/logo.png)-->       <!-- 데이터 URI로 인라인 -->

예시: 

<!-- 더 빠른 로딩을 위해 작은 이미지를 데이터 URI로 인라인 -->
<img src="<!--@base64(images/logo.png)-->" alt="Logo">
<div style="background-image: url('<!--@base64(icons/star.svg)-->');">
    배경으로 작은 아이콘
</div>

자산 복사

<!--@asset(images/photo.jpg)-->       <!-- 단일 자산을 공용 디렉토리로 복사 -->
<!--@assetDir(assets)-->              <!-- 전체 디렉토리를 공용 디렉토리로 복사 -->

예시: 

<!-- 정적 자산 복사 및 참조 -->
<img src="<!--@asset(images/hero-banner.jpg)-->" alt="Hero Banner">
<a href="<!--@asset(documents/brochure.pdf)-->" download>브로슈어 다운로드</a>

<!-- 전체 디렉토리 복사 (폰트, 아이콘 등) -->
<!--@assetDir(assets/fonts)-->
<!--@assetDir(assets/icons)-->

템플릿 포함

<!--@import(components/header)-->     <!-- 다른 템플릿 포함 -->

예시: 

<!-- 재사용 가능한 컴포넌트 포함 -->
<!--@import(components/header)-->

<main>
    <h1>웹사이트에 오신 것을 환영합니다</h1>
    <!--@import(components/sidebar)-->

    <div class="content">
        <p>여기에 주요 콘텐츠...</p>
    </div>
</main>

<!--@import(components/footer)-->

변수 처리

기본 변수

<h1>{$title}</h1>
<p>{$description}</p>

변수 필터

{$title|upper}                       <!-- 대문자로 변환 -->
{$content|lower}                     <!-- 소문자로 변환 -->
{$html|striptag}                     <!-- HTML 태그 제거 -->
{$text|escape}                       <!-- HTML 이스케이프 -->
{$multiline|nl2br}                   <!-- 개행을 <br>로 변환 -->
{$html|br2nl}                        <!-- <br> 태그를 개행으로 변환 -->
{$description|trim}                  <!-- 공백 제거 -->
{$subject|title}                     <!-- 제목 형식으로 변환 -->

변수 명령어

{$title|default=Default Title}       <!-- 기본값 설정 -->
{$name|concat= (Admin)}              <!-- 텍스트 연결 -->

변수 명령어

{$content|striptag|trim|escape}      <!-- 여러 필터 체인 -->

주석

템플릿 주석은 출력에서 완전히 제거되며 최종 HTML에 나타나지 않습니다:

{* 이것은 한 줄 템플릿 주석입니다 *}

{* 
   이것은 여러 줄 
   템플릿 주석입니다 
   여러 줄에 걸칩니다
*}

<h1>{$title}</h1>
{* 디버그 주석: title 변수가 작동하는지 확인 *}
<p>{$content}</p>

참고: 템플릿 주석 {* ... *}은 HTML 주석 <!-- ... -->과 다릅니다. 템플릿 주석은 처리 중 제거되며 브라우저에 도달하지 않습니다.

예시 프로젝트 구조

project/
├── source/
│   ├── layouts/
│   │   └── default.php
│   ├── components/
│   │   ├── header.php
│   │   └── footer.php
│   ├── css/
│   │   ├── bootstrap.min.css
│   │   └── custom.css
│   ├── js/
│   │   ├── app.js
│   │   └── bootstrap.min.js
│   └── homepage.php
├── public/
│   └── assets/           # 생성된 자산
│       ├── css/
│       └── js/
└── vendor/

Awesome-plugins/session

FlightPHP 세션 - 경량 파일 기반 세션 핸들러

이것은 Flight PHP Framework의 경량 파일 기반 세션 핸들러 플러그인입니다. 비동기 세션 읽기, 선택적 암호화, 자동 커밋 기능, 개발을 위한 테스트 모드 등의 기능을 제공하는 간단하면서도 강력한 세션 관리 솔루션입니다. 세션 데이터는 파일에 저장되므로 데이터베이스를 필요하지 않은 애플리케이션에 이상적입니다.

데이터베이스를 사용하고 싶다면, 이와 유사한 기능이 있지만 데이터베이스 백엔드를 가진 ghostff/session 플러그인을 확인하세요.

전체 소스 코드와 세부 사항을 위해 Github 저장소를 방문하세요.

설치

플러그인을 Composer를 통해 설치하세요:

composer require flightphp/session

기본 사용법

Flight 애플리케이션에서 flightphp/session 플러그인을 사용하는 간단한 예제입니다:

require 'vendor/autoload.php';

use flight\Session;  // 세션 서비스를 등록합니다

$app = Flight::app();

// 세션 서비스를 등록합니다
$app->register('session', Session::class);

// 세션 사용 예제 라우트
Flight::route('/login', function() {
    $session = Flight::session();
    $session->set('user_id', 123);
    $session->set('username', 'johndoe');
    $session->set('is_admin', false);

    echo $session->get('username'); // johndoe를 출력합니다
    echo $session->get('preferences', 'default_theme'); // default_theme를 출력합니다

    if ($session->get('user_id')) {
        Flight::json(['message' => '사용자가 로그인되었습니다!', 'user_id' => $session->get('user_id')]);
    }
});

Flight::route('/logout', function() {
    $session = Flight::session();
    $session->clear();  // 모든 세션 데이터를 지웁니다
    Flight::json(['message' => '로그아웃되었습니다']);
});

Flight::start();

주요 포인트

구성

등록할 때 배열 옵션을 전달하여 세션 핸들러를 사용자 정의할 수 있습니다:

// 예, 이중 배열입니다 :)
$app->register('session', Session::class, [ [
    'save_path' => '/custom/path/to/sessions',         // 세션 파일을 저장할 디렉터리
    'prefix' => 'myapp_',                              // 세션 파일의 접두사
    'encryption_key' => 'a-secure-32-byte-key-here',   // AES-256-CBC 암호화를 활성화 (32바이트 추천)
    'auto_commit' => false,                            // 자동 커밋을 비활성화하여 수동 제어
    'start_session' => true,                           // 세션을 자동으로 시작 (기본: true)
    'test_mode' => false,                              // 개발을 위한 테스트 모드 활성화
    'serialization' => 'json',                         // 직렬화 방법: 'json' (기본) 또는 'php' (레거시)
] ]);

구성 옵션

옵션 설명 기본 값
save_path 세션 파일이 저장되는 디렉터리 sys_get_temp_dir() . '/flight_sessions'
prefix 저장된 세션 파일의 접두사 sess_
encryption_key AES-256-CBC 암호화 키 (선택적) null (암호화 없음)
auto_commit 종료 시 세션 데이터 자동 저장 true
start_session 세션을 자동으로 시작 true
test_mode PHP 세션을 영향을 주지 않는 테스트 모드 실행 false
test_session_id 테스트 모드의 사용자 정의 세션 ID (선택적) 설정되지 않으면 무작위 생성
serialization 직렬화 방법: 'json' (기본, 안전) 또는 'php' (레거시, 객체 허용) 'json'

직렬화 모드

기본적으로 이 라이브러리는 JSON 직렬화를 사용하여 세션 데이터를 처리하며, 이는 안전하고 PHP 객체 주입 취약점을 방지합니다. 세션에 PHP 객체를 저장해야 하는 경우 (대부분의 앱에서는 권장되지 않음) 레거시 PHP 직렬화를 선택할 수 있습니다:

노트: JSON 직렬화를 사용하면 객체를 저장하려고 시도하면 예외가 발생합니다.

고급 사용법

수동 커밋

자동 커밋을 비활성화하면 변경 사항을 수동으로 커밋해야 합니다:

$app->register('session', Session::class, ['auto_commit' => false]);

Flight::route('/update', function() {
    $session = Flight::session();
    $session->set('key', 'value');
    $session->commit();  // 변경 사항을 명시적으로 저장합니다
});

암호화된 세션 보안

민감한 데이터를 위해 암호화를 활성화하세요:

$app->register('session', Session::class, [
    'encryption_key' => 'your-32-byte-secret-key-here'
]);

Flight::route('/secure', function() {
    $session = Flight::session();
    $session->set('credit_card', '4111-1111-1111-1111');  // 자동으로 암호화됩니다
    echo $session->get('credit_card');  // 검색 시 복호화됩니다
});

세션 재생성

보안상 세션 ID를 재생성하세요 (예: 로그인 후):

Flight::route('/post-login', function() {
    $session = Flight::session();
    $session->regenerate();  // 새 ID, 데이터 유지
    // 또는
    $session->regenerate(true);  // 새 ID, 기존 데이터 삭제
});

미들웨어 예제

세션 기반 인증으로 라우트를 보호하세요:

Flight::route('/admin', function() {
    Flight::json(['message' => '관리자 패널에 오신 것을 환영합니다']);
})->addMiddleware(function() {
    $session = Flight::session();
    if (!$session->get('is_admin')) {
        Flight::halt(403, '접근 거부');
    }
});

이것은 미들웨어에서 사용하는 간단한 예제입니다. 더 자세한 예제는 middleware 문서를 참조하세요.

메서드

Session 클래스는 다음 메서드를 제공합니다:

get()과 id()를 제외한 모든 메서드는 체이닝을 위해 Session 인스턴스를 반환합니다.

이 플러그인을 사용하는 이유?

기술 세부 사항

기여

기여를 환영합니다! 저장소를 포크하여 변경 사항을 만들고 풀 요청을 제출하세요. 버그 보고나 기능 제안은 Github 이슈 트래커를 통해 하세요.

라이선스

이 플러그인은 MIT 라이선스 under입니다. 자세한 내용은 Github 저장소를 참조하세요.

Awesome-plugins/runway

Runway

Runway는 Flight 애플리케이션을 관리하는 데 도움을 주는 CLI 애플리케이션입니다. 컨트롤러를 생성하고, 모든 경로를 표시하며, 그 외 더 많은 기능을 제공합니다. 이는 우수한 adhocore/php-cli 라이브러리를 기반으로 합니다.

코드 보기 위해 여기를 클릭하세요.

설치

Composer를 사용하여 설치하세요.

composer require flightphp/runway

기본 구성

Runway를 처음 실행할 때, app/config/config.php의 'runway' 키를 통해 runway 구성을 찾으려고 시도합니다.

<?php
// app/config/config.php
return [
    'runway' => [
        'app_root' => 'app/',
        'public_root' => 'public/',
    ],
];

참고 - v1.2.0부터 .runway-config.json은 더 이상 사용되지 않습니다. 구성을 app/config/config.php로 이전하세요. php runway config:migrate 명령으로 쉽게 할 수 있습니다.

프로젝트 루트 감지

Runway는 하위 디렉토리에서 실행하더라도 프로젝트 루트를 충분히 스마트하게 감지합니다. composer.json, .git, 또는 app/config/config.php와 같은 지표를 찾아 프로젝트 루트가 어디인지 결정합니다. 따라서 프로젝트의 어디서든 Runway 명령을 실행할 수 있습니다!

사용법

Runway는 Flight 애플리케이션을 관리하는 데 사용할 수 있는 여러 명령을 가지고 있습니다. Runway를 사용하는 두 가지 쉬운 방법이 있습니다.

  1. 스켈레톤 프로젝트를 사용 중이라면 프로젝트 루트에서 php runway [command]를 실행할 수 있습니다.
  2. Composer를 통해 설치된 패키지로 Runway를 사용 중이라면 프로젝트 루트에서 vendor/bin/runway [command]를 실행할 수 있습니다.

명령 목록

php runway 명령을 실행하여 사용 가능한 모든 명령 목록을 볼 수 있습니다.

php runway

명령 도움말

모든 명령에 대해 --help 플래그를 전달하여 명령 사용 방법에 대한 자세한 정보를 얻을 수 있습니다.

php runway routes --help

다음은 몇 가지 예입니다:

컨트롤러 생성

runway.app_root의 구성에 기반하여 app/controllers/ 디렉토리에 컨트롤러를 생성합니다.

php runway make:controller MyController

Active Record 모델 생성

먼저 Active Record 플러그인이 설치되었는지 확인하세요. runway.app_root의 구성에 기반하여 app/records/ 디렉토리에 레코드를 생성합니다.

php runway make:record users

예를 들어 users 테이블이 id, name, email, created_at, updated_at 스키마를 가진 경우, app/records/UserRecord.php 파일에 다음과 유사한 파일이 생성됩니다:

<?php

declare(strict_types=1);

namespace app\records;

/**
 * users 테이블에 대한 ActiveRecord 클래스.
 * @link https://docs.flightphp.com/awesome-plugins/active-record
 * 
 * @property int $id
 * @property string $name
 * @property string $email
 * @property string $created_at
 * @property string $updated_at
 * // $relations 배열에 정의한 후 관계를 여기에 추가할 수도 있습니다
 * @property CompanyRecord $company 관계의 예
 */
class UserRecord extends \flight\ActiveRecord
{
    /**
     * @var array $relations 모델의 관계 설정
     *   https://docs.flightphp.com/awesome-plugins/active-record#relationships
     */
    protected array $relations = [];

    /**
     * 생성자
     * @param mixed $databaseConnection 데이터베이스 연결
     */
    public function __construct($databaseConnection)
    {
        parent::__construct($databaseConnection, 'users');
    }
}

모든 경로 표시

현재 Flight에 등록된 모든 경로를 표시합니다.

php runway routes

특정 경로만 보려면 플래그를 전달하여 경로를 필터링할 수 있습니다.

# GET 경로만 표시
php runway routes --get

# POST 경로만 표시
php runway routes --post

# 등.

Runway에 사용자 지정 명령 추가

Flight용 패키지를 생성하거나 프로젝트에 사용자 지정 명령을 추가하려면 src/commands/, flight/commands/, app/commands/, 또는 commands/ 디렉토리를 프로젝트/패키지에 생성하세요. 추가 사용자 지정이 필요하다면 아래 구성 섹션을 참조하세요.

명령을 생성하려면 AbstractBaseCommand 클래스를 확장하고 최소한 __construct 메서드와 execute 메서드를 구현하세요.

<?php

declare(strict_types=1);

namespace flight\commands;

class ExampleCommand extends AbstractBaseCommand
{
    /**
     * 생성자
     *
     * @param array<string,mixed> $config app/config/config.php의 구성
     */
    public function __construct(array $config)
    {
        parent::__construct('make:example', '문서화를 위한 예제 생성', $config);
        $this->argument('<funny-gif>', '재미있는 GIF의 이름');
    }

    /**
     * 함수 실행
     *
     * @return void
     */
    public function execute()
    {
        $io = $this->app()->io();

        $io->info('예제 생성 중...');

        // 여기에 무언가 수행

        $io->ok('예제 생성됨!');
    }
}

Flight 애플리케이션에 사용자 지정 명령을 구축하는 방법에 대한 자세한 정보는 adhocore/php-cli 문서를 참조하세요!

구성 관리

v1.2.0부터 구성이 app/config/config.php로 이동되었으므로 구성 관리를 위한 몇 가지 도우미 명령이 있습니다.

이전 구성 이전

이전 .runway-config.json 파일이 있다면 다음 명령으로 app/config/config.php로 쉽게 이전할 수 있습니다:

php runway config:migrate

구성 값 설정

config:set 명령을 사용하여 구성 값을 설정할 수 있습니다. 파일을 열지 않고 구성 값을 업데이트하려는 경우 유용합니다.

php runway config:set app_root "app/"

구성 값 가져오기

config:get 명령을 사용하여 구성 값을 가져올 수 있습니다.

php runway config:get app_root

모든 Runway 구성

Runway 구성을 사용자 지정해야 한다면 app/config/config.php에 이러한 값을 설정할 수 있습니다. 아래는 설정할 수 있는 추가 구성입니다:

<?php
// app/config/config.php
return [
    // ... 다른 구성 값들 ...

    'runway' => [
        // 애플리케이션 디렉토리가 위치한 곳
        'app_root' => 'app/',

        // 루트 인덱스 파일이 위치한 디렉토리
        'index_root' => 'public/',

        // 다른 프로젝트의 루트 경로들
        'root_paths' => [
            '/home/user/different-project',
            '/var/www/another-project'
        ],

        // 기본 경로는 구성할 필요가 거의 없지만, 필요하다면 여기에 있습니다
        'base_paths' => [
            '/includes/libs/vendor', // 벤더 디렉토리 등에 정말 독특한 경로가 있는 경우
        ],

        // 최종 경로는 프로젝트 내 명령 파일을 검색할 위치
        'final_paths' => [
            'src/diff-path/commands',
            'app/module/admin/commands',
        ],

        // 전체 경로를 추가하려면 (프로젝트 루트에 대한 절대 또는 상대 경로)
        'paths' => [
            '/home/user/different-project/src/diff-path/commands',
            '/var/www/another-project/app/module/admin/commands',
            'app/my-unique-commands'
        ]
    ]
];

구성 접근

구성 값을 효과적으로 접근해야 한다면 __construct 메서드나 app() 메서드를 통해 접근할 수 있습니다. 또한 app/config/services.php 파일이 있는 경우 해당 서비스도 명령에 사용할 수 있습니다.

public function execute()
{
    $io = $this->app()->io();

    // 구성 접근
    $app_root = $this->config['runway']['app_root'];

    // 데이터베이스 연결 같은 서비스 접근
    $database = $this->config['database']

    // ...
}

AI 도우미 래퍼

Runway에는 AI가 명령을 생성하기 쉽게 하는 몇 가지 도우미 래퍼가 있습니다. Symfony Console과 유사하게 addOption과 addArgument를 사용할 수 있습니다. AI 도구를 사용하여 명령을 생성할 때 유용합니다.

public function __construct(array $config)
{
    parent::__construct('make:example', '문서화를 위한 예제 생성', $config);

    // name 옵션은 null이고 완전히 선택적입니다
    $this->addOption('name', '예제의 이름', null);
}

Awesome-plugins/tracy_extensions

Tracy Flight 패널 확장

이것은 Flight 작업을 더 풍부하게 만드는 확장 세트입니다.

이것이 패널입니다

Flight Bar

그리고 각 패널은 애플리케이션에 대한 매우 유용한 정보를 표시합니다!

Flight Data Flight Database Flight Request

코드 보기 여기를 클릭하세요.

설치

composer require flightphp/tracy-extensions --dev를 실행하면 시작할 수 있습니다!

구성

이것을 시작하는 데 필요한 구성은 거의 없습니다. 이 https://tracy.nette.org/en/guide를 사용하기 전에 Tracy 디버거를 시작해야 합니다:

<?php

use Tracy\Debugger;
use flight\debug\tracy\TracyExtensionLoader;

// 부트스트랩 코드
require __DIR__ . '/vendor/autoload.php';

Debugger::enable();
// 환경을 지정해야 할 수 있습니다: Debugger::enable(Debugger::DEVELOPMENT)

// 앱에서 데이터베이스 연결을 사용하는 경우, 
// 개발에서만 사용해야 하는 필수 PDO 래퍼가 있습니다 (프로덕션에서는 사용하지 마세요!)
// 일반 PDO 연결과 동일한 매개변수를 가집니다
$pdo = new PdoQueryCapture('sqlite:test.db', 'user', 'pass');
// 또는 Flight 프레임워크에 연결하는 경우
Flight::register('db', PdoQueryCapture::class, ['sqlite:test.db', 'user', 'pass']);
// 이제 쿼리를 실행할 때마다 시간, 쿼리 및 매개변수를 캡처합니다

// 이것이 연결을 연결합니다
if(Debugger::$showBar === true) {
    // 이것이 false여야 Tracy가 실제로 렌더링할 수 있습니다 :(
    Flight::set('flight.content_length', false);
    new TracyExtensionLoader(Flight::app());
}

// 더 많은 코드

Flight::start();

추가 구성

세션 데이터

커스텀 세션 핸들러(예: ghostff/session)를 사용하는 경우, 세션 데이터를 Tracy에 배열로 전달할 수 있으며 자동으로 출력됩니다. TracyExtensionLoader 생성자의 두 번째 매개변수의 session_data 키로 전달합니다.


use Ghostff\Session\Session;
// 또는 flight\Session 사용;

require 'vendor/autoload.php';

$app = Flight::app();

$app->register('session', Session::class);

if(Debugger::$showBar === true) {
    // 이것이 false여야 Tracy가 실제로 렌더링할 수 있습니다 :(
    Flight::set('flight.content_length', false);
    new TracyExtensionLoader(Flight::app(), [ 'session_data' => Flight::session()->getAll() ]);
}

// 라우트 및 기타 사항...

Flight::start();

Latte

이 섹션에는 PHP 8.1+가 필요합니다.

프로젝트에 Latte가 설치된 경우, Tracy는 템플릿을 분석하기 위해 Latte와 네이티브 통합을 제공합니다. Latte 인스턴스에 확장을 등록하기만 하면 됩니다.


require 'vendor/autoload.php';

$app = Flight::app();

$app->map('render', function($template, $data, $block = null) {
    $latte = new Latte\Engine;

    // 기타 구성...

    // Tracy 디버그 바로만 확장을 추가합니다
    if(Debugger::$showBar === true) {
        // 여기에 Latte 패널을 Tracy에 추가합니다
        $latte->addExtension(new Latte\Bridges\Tracy\TracyExtension);
    }

    $latte->render($template, $data, $block);
});

Awesome-plugins/apm

FlightPHP APM 문서

FlightPHP APM에 오신 것을 환영합니다—앱의 개인 성능 코치입니다! 이 가이드는 FlightPHP와 함께 Application Performance Monitoring (APM)을 설정, 사용, 마스터하는 로드맵입니다. 느린 요청을 추적하든 지연 차트에 몰두하든, 모든 것을 다루겠습니다. 앱을 더 빠르게, 사용자를 더 행복하게, 디버깅 세션을 쉽게 만들어 보겠습니다!

Flight Docs 사이트의 대시보드 데모를 여기에서 확인하세요.

FlightPHP APM

APM이 중요한 이유

이 장면을 상상해 보세요: 앱이 바쁜 레스토랑입니다. 주문 처리 시간이 얼마나 걸리는지나 주방이 어디서 지연되는지 추적할 방법이 없으면, 고객이 왜 불만족스럽게 떠나는지 추측할 수밖에 없습니다. APM은 부주방장 역할을 합니다—들어오는 요청부터 데이터베이스 쿼리까지 모든 단계를 감시하고, 속도를 늦추는 것을 플래그합니다. 느린 페이지는 사용자를 잃게 만듭니다 (연구에 따르면 사이트 로딩이 3초 이상 걸리면 53%가 이탈합니다!), APM은 이러한 문제를 미리 잡아줍니다. 사전적 안심—더 적은 "이게 왜 고장 났지?" 순간, 더 많은 "이게 얼마나 부드럽게 작동하나 봐!" 승리입니다.

설치

Composer로 시작하세요:

composer require flightphp/apm

필요한 것:

지원 데이터베이스

FlightPHP APM은 현재 메트릭을 저장하기 위해 다음 데이터베이스를 지원합니다:

구성 단계(아래 참조)에서 데이터베이스 유형을 선택할 수 있습니다. PHP 환경에 필요한 확장(pdo_sqlite 또는 pdo_mysql 등)이 설치되어 있는지 확인하세요.

시작하기

APM의 멋진 단계별 가이드입니다:

1. APM 등록

추적을 시작하기 위해 index.php 또는 services.php 파일에 다음을 추가하세요:

use flight\apm\logger\LoggerFactory;
use flight\database\PdoWrapper;
use flight\Apm;

$ApmLogger = LoggerFactory::create(__DIR__ . '/../../.runway-config.json');
$Apm = new Apm($ApmLogger);
$Apm->bindEventsToFlightInstance($app);

// 데이터베이스 연결을 추가하는 경우
// Tracy Extensions의 PdoWrapper 또는 PdoQueryCapture여야 합니다
$pdo = new PdoWrapper('mysql:host=localhost;dbname=example', 'user', 'pass', null, true); // <-- APM 추적을 활성화하려면 True가 필요합니다.
$Apm->addPdoConnection($pdo);

여기서 무슨 일이 일어나나요?

프로 팁: 샘플링 앱이 바쁘면 모든 요청을 로깅하면 과부하가 올 수 있습니다. 샘플 레이트(0.0에서 1.0)를 사용하세요:

$Apm = new Apm($ApmLogger, 0.1); // 요청의 10%를 로깅합니다

이렇게 하면 성능을 유지하면서도 견고한 데이터를 얻을 수 있습니다.

2. 구성

.runway-config.json을 생성하려면 다음을 실행하세요:

php vendor/bin/runway apm:init

이게 뭘 하나요?

이 과정에서 이 설정에 대한 마이그레이션을 실행할지 물어봅니다. 처음 설정하는 경우 답은 yes입니다.

왜 두 위치인가요? 원시 메트릭은 빠르게 쌓입니다(필터링되지 않은 로그를 생각하세요). 워커가 이를 구조화된 대상으로 처리하여 대시보드를 위한 것입니다. 깔끔하게 유지합니다!

3. 워커로 메트릭 처리

워커는 원시 메트릭을 대시보드 준비 데이터로 변환합니다. 한 번 실행하세요:

php vendor/bin/runway apm:worker

무엇을 하나요?

지속 실행 라이브 앱의 경우 지속적인 처리를 원할 것입니다. 옵션은 다음과 같습니다:

왜 신경 쓰나요? 워커 없이 대시보드는 비어 있습니다. 원시 로그와 실행 가능한 인사이트 사이의 다리입니다.

4. 대시보드 실행

앱의 생체 신호를 확인하세요:

php vendor/bin/runway apm:dashboard

이게 뭔가요?

커스터마이징:

php vendor/bin/runway apm:dashboard --host 0.0.0.0 --port 8080 --php-path=/usr/local/bin/php

브라우저에서 URL을 열고 탐색하세요!

프로덕션 모드

프로덕션에서 대시보드를 실행하려면 방화벽과 기타 보안 조치로 인해 몇 가지 기술을 시도해야 할 수 있습니다. 몇 가지 옵션:

다른 대시보드를 원하나요?

원하는 대시보드를 직접 만들 수 있습니다! 데이터를 제시하는 방법에 대한 아이디어를 위해 vendor/flightphp/apm/src/apm/presenter 디렉토리를 확인하세요!

대시보드 기능

대시보드는 APM 본부입니다—여기서 볼 수 있는 것:

추가:

예시: /users 요청은 다음과 같이 보일 수 있음:

커스텀 이벤트 추가

API 호출이나 결제 프로세스처럼 아무거나 추적:

use flight\apm\CustomEvent;

$app->eventDispatcher()->trigger('apm.custom', new CustomEvent('api_call', [
    'endpoint' => 'https://api.example.com/users',
    'response_time' => 0.25,
    'status' => 200
]));

어디에 나타나나요? 대시보드의 요청 세부 정보에서 "Custom Events" 아래—예쁜 JSON 형식으로 확장 가능.

사용 사례:

$start = microtime(true);
$apiResponse = file_get_contents('https://api.example.com/data');
$app->eventDispatcher()->trigger('apm.custom', new CustomEvent('external_api', [
    'url' => 'https://api.example.com/data',
    'time' => microtime(true) - $start,
    'success' => $apiResponse !== false
]));

이제 그 API가 앱을 끌어내리는지 볼 수 있습니다!

데이터베이스 모니터링

PDO 쿼리를 이렇게 추적:

use flight\database\PdoWrapper;

$pdo = new PdoWrapper('sqlite:/path/to/db.sqlite', null, null, null, true); // <-- APM 추적을 활성화하려면 True가 필요합니다.
$Apm->addPdoConnection($pdo);

얻는 것:

주의:

예시 출력:

워커 옵션

워커를 원하는 대로 조정:

예시:

php vendor/bin/runway apm:worker --daemon --batch_size 100 --timeout 3600

한 시간 동안 실행되며, 한 번에 100개 메트릭 처리.

앱의 요청 ID

각 요청은 추적을 위한 고유 요청 ID를 가집니다. 앱에서 이 ID를 사용하여 로그와 메트릭을 상관관계지을 수 있습니다. 예를 들어 오류 페이지에 요청 ID를 추가:

Flight::map('error', function($message) {
    // 응답 헤더 X-Flight-Request-Id에서 요청 ID 가져오기
    $requestId = Flight::response()->getHeader('X-Flight-Request-Id');

    // 추가로 Flight 변수에서 가져올 수 있음
    // swoole나 다른 비동기 플랫폼에서는 이 방법이 잘 작동하지 않음.
    // $requestId = Flight::get('apm.request_id');

    echo "Error: $message (Request ID: $requestId)";
});

업그레이드

APM의 최신 버전으로 업그레이드할 때 데이터베이스 마이그레이션이 필요할 수 있습니다. 다음 명령으로 실행:

php vendor/bin/runway apm:migrate

이것은 데이터베이스 스키마를 최신 버전으로 업데이트하기 위해 필요한 모든 마이그레이션을 실행합니다.

참고: APM 데이터베이스가 크면 이 마이그레이션은 시간이 걸릴 수 있습니다. 피크 시간 외에 실행하는 것이 좋습니다.

0.4.3 -> 0.5.0 업그레이드

0.4.3에서 0.5.0으로 업그레이드할 때 다음 명령을 실행:

php vendor/bin/runway apm:config-migrate

이것은 .runway-config.json 파일을 사용하는 이전 형식에서 config.php 파일에 키/값을 저장하는 새 형식으로 구성을 마이그레이션합니다.

오래된 데이터 삭제

데이터베이스를 깔끔하게 유지하려면 오래된 데이터를 삭제할 수 있습니다. 특히 바쁜 앱을 실행 중이고 데이터베이스 크기를 관리하려면 유용합니다. 다음 명령으로 실행:

php vendor/bin/runway apm:purge

이것은 데이터베이스에서 30일 이상 된 모든 데이터를 제거합니다. --days 옵션으로 다른 값을 전달하여 일수 조정:

php vendor/bin/runway apm:purge --days 7

이것은 데이터베이스에서 7일 이상 된 모든 데이터를 제거합니다.

문제 해결

막혔나요? 다음을 시도:

Awesome-plugins/tracy

트레이시 (Tracy)

트레이시는 Flight와 함께 사용할 수 있는 놀라운 에러 핸들러입니다. 애플리케이션을 디버깅하는 데 도움이 되는 여러 패널을 갖고 있습니다. 또한 손쉽게 확장하여 사용자 정의 패널을 추가할 수 있습니다. Flight 팀은 flightphp/tracy-extensions 플러그인을 통해 Flight 프로젝트를 위해 몇 가지 패널을 특별히 만들었습니다.

설치

컴포저로 설치합니다. 실제로 이것은 Tracy가 프로덕션 에러 핸들링 구성 요소와 함께 제공되므로 개발 버전 없이 설치하는 것이 좋습니다.

composer require tracy/tracy

기본 구성

시작하려면 몇 가지 기본 구성 옵션이 있습니다. 더 자세한 내용은 Tracy 문서를 참조하십시오.

require 'vendor/autoload.php';

use Tracy\Debugger;

// Tracy를 활성화합니다
Debugger::enable();
// Debugger::enable(Debugger::DEVELOPMENT) // 경우에 따라 명시적으로 설정해야 할 수도 있습니다 (또한 Debugger::PRODUCTION)
// Debugger::enable('23.75.345.200'); // IP 주소의 배열을 제공할 수도 있습니다

// 여기에 오류와 예외가 기록됩니다. 이 디렉터리가 존재하고 쓰기 가능한지 확인하십시오.
Debugger::$logDirectory = __DIR__ . '/../log/';
Debugger::$strictMode = true; // 모든 오류 표시
// Debugger::$strictMode = E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED; // 사용되지 않은 공지를 제외한 모든 오류
if (Debugger::$showBar) {
    $app->set('flight.content_length', false); // Debugger 표시줄이 표시되는 경우 Flight에서 내용 길이를 설정할 수 없습니다

    // 이것은 Tracy Extension for Flight에 특화된 사항이며, 해당 항목을 포함했을 경우만 활성화합니다
    // 그렇지 않으면 주석 처리하십시오.
    new TracyExtensionLoader($app);
}

유용한 팁

코드를 디버깅하는 경우 데이터를 출력하기 위한 매우 유용한 함수들이 있습니다.

Awesome-plugins/active_record

Flight Active Record

액티브 레코드는 데이터베이스 엔티티를 PHP 객체에 매핑하는 것입니다. 간단히 말해, 데이터베이스에 users 테이블이 있으면 테이블의 행을 코드베이스의 User 클래스와 $user 객체로 "번역"할 수 있습니다. 기본 예제를 참조하세요.

GitHub의 저장소를 보려면 여기를 클릭하세요.

기본 예제

다음과 같은 테이블이 있다고 가정해 보겠습니다:

CREATE TABLE users (
    id INTEGER PRIMARY KEY, 
    name TEXT, 
    password TEXT 
);

이제 이 테이블을 나타내는 새 클래스를 설정할 수 있습니다:

/**
 * ActiveRecord 클래스는 보통 단수형입니다
 * 
 * 테이블의 속성을 주석으로 여기에 추가하는 것이 강력히 권장됩니다
 * 
 * @property int    $id
 * @property string $name
 * @property string $password
 */ 
class User extends flight\ActiveRecord {
    public function __construct($database_connection)
    {
        // 이렇게 설정할 수 있습니다
        parent::__construct($database_connection, 'users');
        // 또는 이렇게
        parent::__construct($database_connection, null, [ 'table' => 'users']);
    }
}

이제 마법이 일어나는 것을 보세요!

// sqlite의 경우
$database_connection = new PDO('sqlite:test.db'); // 이것은 예제일 뿐입니다. 실제 데이터베이스 연결을 사용할 가능성이 큽니다

// mysql의 경우
$database_connection = new PDO('mysql:host=localhost;dbname=test_db&charset=utf8bm4', 'username', 'password');

// 또는 mysqli
$database_connection = new mysqli('localhost', 'username', 'password', 'test_db');
// 또는 객체 기반이 아닌 mysqli 생성
$database_connection = mysqli_connect('localhost', 'username', 'password', 'test_db');

$user = new User($database_connection);
$user->name = 'Bobby Tables';
$user->password = password_hash('some cool password');
$user->insert();
// 또는 $user->save();

echo $user->id; // 1

$user->name = 'Joseph Mamma';
$user->password = password_hash('some cool password again!!!');
$user->insert();
// 여기서 $user->save()를 사용할 수 없으며, 업데이트로 인식할 것입니다!

echo $user->id; // 2

새 사용자를 추가하는 것이 이렇게 쉬웠습니다! 이제 데이터베이스에 사용자 행이 있으므로, 이를 어떻게 가져오나요?

$user->find(1); // 데이터베이스에서 id = 1을 찾아 반환합니다.
echo $user->name; // 'Bobby Tables'

모든 사용자를 찾고 싶다면?

$users = $user->findAll();

특정 조건으로?

$users = $user->like('name', '%mamma%')->findAll();

얼마나 재미있나요? 설치하고 시작해 보세요!

설치

Composer로 간단히 설치하세요

composer require flightphp/active-record

사용법

이것은 독립 라이브러리로 사용하거나 Flight PHP Framework와 함께 사용할 수 있습니다. 완전히 당신의 선택입니다.

독립 사용

생성자에 PDO 연결을 전달하기만 하세요.

$pdo_connection = new PDO('sqlite:test.db'); // 이것은 예제일 뿐입니다. 실제 데이터베이스 연결을 사용할 가능성이 큽니다

$User = new User($pdo_connection);

생성자에서 항상 데이터베이스 연결을 설정하지 않으려면? 데이터베이스 연결 관리를 참조하세요!

Flight에서 메서드로 등록

Flight PHP Framework를 사용 중이라면, ActiveRecord 클래스를 서비스로 등록할 수 있지만, 꼭 해야 하는 것은 아닙니다.

Flight::register('user', 'User', [ $pdo_connection ]);

// 그런 다음 컨트롤러, 함수 등에서 이렇게 사용할 수 있습니다.

Flight::user()->find(1);

runway 메서드

runway는 Flight를 위한 CLI 도구로, 이 라이브러리에 대한 사용자 지정 명령어를 가지고 있습니다. 

# 사용법
php runway make:record database_table_name [class_name]

# 예제
php runway make:record users

이것은 app/records/ 디렉토리에 UserRecord.php로 새 클래스를 생성하며, 다음과 같은 내용을 포함합니다:

<?php

declare(strict_types=1);

namespace app\records;

/**
 * users 테이블을 위한 ActiveRecord 클래스.
 * @link https://docs.flightphp.com/awesome-plugins/active-record
 *
 * @property int $id
 * @property string $username
 * @property string $email
 * @property string $password_hash
 * @property string $created_dt
 */
class UserRecord extends \flight\ActiveRecord
{
    /**
     * @var array $relations 모델의 관계 설정
     *   https://docs.flightphp.com/awesome-plugins/active-record#relationships
     */
    protected array $relations = [
        // 'relation_name' => [ self::HAS_MANY, 'RelatedClass', 'foreign_key' ],
    ];

    /**
     * 생성자
     * @param mixed $databaseConnection 데이터베이스 연결
     */
    public function __construct($databaseConnection)
    {
        parent::__construct($databaseConnection, 'users');
    }
}

CRUD 함수

find($id = null) : boolean|ActiveRecord

하나의 레코드를 찾아 현재 객체에 할당합니다. $id를 전달하면 해당 값으로 기본 키를 조회합니다. 아무것도 전달하지 않으면 테이블의 첫 번째 레코드를 찾습니다.

또한 테이블을 쿼리하기 위해 다른 도우미 메서드를 전달할 수 있습니다.

// 사전 조건으로 레코드 찾기
$user->notNull('password')->orderBy('id DESC')->find();

// 특정 id로 레코드 찾기
$id = 123;
$user->find($id);

findAll(): array<int,ActiveRecord>

지정된 테이블의 모든 레코드를 찾습니다.

$user->findAll();

isHydrated(): boolean (v0.4.0)

현재 레코드가 데이터베이스에서 로드(hydrated)되었는지 true를 반환합니다.

$user->find(1);
// 데이터가 있는 레코드가 발견되면...
$user->isHydrated(); // true

insert(): boolean|ActiveRecord

현재 레코드를 데이터베이스에 삽입합니다.

$user = new User($pdo_connection);
$user->name = 'demo';
$user->password = md5('demo');
$user->insert();
텍스트 기반 기본 키

텍스트 기반 기본 키(예: UUID)가 있으면, 삽입 전에 기본 키 값을 두 가지 방법 중 하나로 설정할 수 있습니다.

$user = new User($pdo_connection, [ 'primaryKey' => 'uuid' ]);
$user->uuid = 'some-uuid';
$user->name = 'demo';
$user->password = md5('demo');
$user->insert(); // 또는 $user->save();

또는 이벤트를 통해 기본 키를 자동으로 생성할 수 있습니다.

class User extends flight\ActiveRecord {
    public function __construct($database_connection)
    {
        parent::__construct($database_connection, 'users', [ 'primaryKey' => 'uuid' ]);
        // 위 배열 대신 이렇게 기본 키를 설정할 수도 있습니다.
        $this->primaryKey = 'uuid';
    }

    protected function beforeInsert(self $self) {
        $self->uuid = uniqid(); // 또는 고유 ID를 생성하는 방법에 따라
    }
}

삽입 전에 기본 키를 설정하지 않으면 rowid로 설정되고 데이터베이스가 생성하지만, 테이블에 해당 필드가 없으면 지속되지 않습니다. 따라서 이벤트를 사용해 자동으로 처리하는 것이 권장됩니다.

update(): boolean|ActiveRecord

현재 레코드를 데이터베이스에 업데이트합니다.

$user->greaterThan('id', 0)->orderBy('id desc')->find();
$user->email = 'test@example.com';
$user->update();

save(): boolean|ActiveRecord

현재 레코드를 데이터베이스에 삽입하거나 업데이트합니다. 레코드에 id가 있으면 업데이트하고, 없으면 삽입합니다.

$user = new User($pdo_connection);
$user->name = 'demo';
$user->password = md5('demo');
$user->save();

참고: 클래스에 관계가 정의되어 있으면, 정의되고 인스턴스화된 관계 중 업데이트할 더티 데이터가 있는 경우 재귀적으로 저장합니다. (v0.4.0 이상)

delete(): boolean

현재 레코드를 데이터베이스에서 삭제합니다.

$user->gt('id', 0)->orderBy('id desc')->find();
$user->delete();

사전에 검색을 실행하여 여러 레코드를 삭제할 수도 있습니다.

$user->like('name', 'Bob%')->delete();

dirty(array $dirty = []): ActiveRecord

더티 데이터는 레코드에서 변경된 데이터를 가리킵니다.

$user->greaterThan('id', 0)->orderBy('id desc')->find();

// 이 시점에서 아무것도 "더티"하지 않습니다.

$user->email = 'test@example.com'; // 이제 이메일이 변경되어 "더티"로 간주됩니다.
$user->update();
// 이제 업데이트되어 데이터베이스에 지속되었으므로 더티 데이터가 없습니다

$user->password = password_hash()'newpassword'); // 이제 이것이 더티입니다
$user->dirty(); // 아무것도 전달하지 않으면 모든 더티 항목을 지웁니다.
$user->update(); // 아무것도 업데이트되지 않습니다. 더티로 캡처된 것이 없기 때문입니다.

$user->dirty([ 'name' => 'something', 'password' => password_hash('a different password') ]);
$user->update(); // 이름과 비밀번호가 모두 업데이트됩니다.

copyFrom(array $data): ActiveRecord (v0.4.0)

dirty() 메서드의 별칭입니다. 무엇을 하는지 더 명확합니다.

$user->copyFrom([ 'name' => 'something', 'password' => password_hash('a different password') ]);
$user->update(); // 이름과 비밀번호가 모두 업데이트됩니다.

isDirty(): boolean (v0.4.0)

현재 레코드가 변경되었는지 true를 반환합니다.

$user->greaterThan('id', 0)->orderBy('id desc')->find();
$user->email = 'test@email.com';
$user->isDirty(); // true

reset(bool $include_query_data = true): ActiveRecord

현재 레코드를 초기 상태로 재설정합니다. 루프 유형 동작에서 사용하기 좋습니다. true를 전달하면 현재 객체를 찾는 데 사용된 쿼리 데이터도 재설정합니다 (기본 동작).

$users = $user->greaterThan('id', 0)->orderBy('id desc')->find();
$user_company = new UserCompany($pdo_connection);

foreach($users as $user) {
    $user_company->reset(); // 깨끗한 상태로 시작
    $user_company->user_id = $user->id;
    $user_company->company_id = $some_company_id;
    $user_company->insert();
}

getBuiltSql(): string (v0.4.1)

find(), findAll(), insert(), update(), 또는 save() 메서드를 실행한 후 생성된 SQL을 가져와 디버깅에 사용할 수 있습니다.

SQL 쿼리 메서드

select(string $field1 [, string $field2 ... ])

테이블의 일부 컬럼만 선택할 수 있습니다 (많은 컬럼이 있는 넓은 테이블에서 더 성능이 좋습니다)

$user->select('id', 'name')->find();

from(string $table)

기술적으로 다른 테이블을 선택할 수도 있습니다! 왜 안 되나요?!

$user->select('id', 'name')->from('user')->find();

join(string $table_name, string $join_condition)

데이터베이스의 다른 테이블에 조인할 수도 있습니다.

$user->join('contacts', 'contacts.user_id = users.id')->find();

where(string $where_conditions)

사용자 지정 where 인수를 설정할 수 있습니다 (이 where 문에서 params를 설정할 수 없습니다)

$user->where('id=1 AND name="demo"')->find();

보안 주의 - $user->where("id = '{$id}' AND name = '{$name}'")->find();처럼 할 수 있지만, 절대 이렇게 하지 마세요!!! 이것은 SQL 인젝션 공격에 취약합니다. 온라인에 많은 기사가 있습니다. "sql injection attacks php"를 Google하면 이 주제에 대한 많은 기사를 찾을 수 있습니다. 이 라이브러리에서 이를 처리하는 올바른 방법은 where() 메서드 대신 $user->eq('id', $id)->eq('name', $name)->find();처럼 하는 것입니다. 반드시 이렇게 해야 한다면, PDO 라이브러리의 $pdo->quote($var)를 사용해 이스케이프하세요. quote()를 사용한 후에만 where() 문에서 사용할 수 있습니다.

group(string $group_by_statement)/groupBy(string $group_by_statement)

특정 조건으로 결과를 그룹화합니다.

$user->select('COUNT(*) as count')->groupBy('name')->findAll();

order(string $order_by_statement)/orderBy(string $order_by_statement)

반환된 쿼리를 특정 방식으로 정렬합니다.

$user->orderBy('name DESC')->find();

limit(string $limit)/limit(int $offset, int $limit)

반환되는 레코드 수를 제한합니다. 두 번째 int가 주어지면 SQL처럼 offset, limit이 됩니다.

$user->orderby('name DESC')->limit(0, 10)->findAll();

WHERE 조건

equal(string $field, mixed $value) / eq(string $field, mixed $value)

Where field = $value

$user->eq('id', 1)->find();

notEqual(string $field, mixed $value) / ne(string $field, mixed $value)

Where field <> $value

$user->ne('id', 1)->find();

isNull(string $field)

Where field IS NULL

$user->isNull('id')->find();

isNotNull(string $field) / notNull(string $field)

Where field IS NOT NULL

$user->isNotNull('id')->find();

greaterThan(string $field, mixed $value) / gt(string $field, mixed $value)

Where field > $value

$user->gt('id', 1)->find();

lessThan(string $field, mixed $value) / lt(string $field, mixed $value)

Where field < $value

$user->lt('id', 1)->find();

greaterThanOrEqual(string $field, mixed $value) / ge(string $field, mixed $value) / gte(string $field, mixed $value)

Where field >= $value

$user->ge('id', 1)->find();

lessThanOrEqual(string $field, mixed $value) / le(string $field, mixed $value) / lte(string $field, mixed $value)

Where field <= $value

$user->le('id', 1)->find();

like(string $field, mixed $value) / notLike(string $field, mixed $value)

Where field LIKE $value 또는 field NOT LIKE $value

$user->like('name', 'de')->find();

in(string $field, array $values) / notIn(string $field, array $values)

Where field IN($value) 또는 field NOT IN($value)

$user->in('id', [1, 2])->find();

between(string $field, array $values)

Where field BETWEEN $value AND $value1

$user->between('id', [1, 2])->find();

OR 조건

조건을 OR 문으로 감쌀 수 있습니다. startWrap()와 endWrap() 메서드를 사용하거나 필드와 값 다음에 조건의 3번째 매개변수를 채워서 합니다.

// 방법 1
$user->eq('id', 1)->startWrap()->eq('name', 'demo')->or()->eq('name', 'test')->endWrap('OR')->find();
// 이는 `id = 1 AND (name = 'demo' OR name = 'test')`로 평가됩니다

// 방법 2
$user->eq('id', 1)->eq('name', 'demo', 'OR')->find();
// 이는 `id = 1 OR name = 'demo'`로 평가됩니다

관계

이 라이브러스를 사용해 여러 종류의 관계를 설정할 수 있습니다. 테이블 간 one->many 및 one->one 관계를 설정할 수 있습니다. 이는 클래스에서 약간의 추가 설정이 필요합니다.

$relations 배열 설정은 어렵지 않지만, 올바른 구문을 추측하는 것은 혼란스러울 수 있습니다.

protected array $relations = [
    // 키 이름을 원하는 대로 지정할 수 있습니다. ActiveRecord 이름이 좋습니다. 예: user, contact, client
    'user' => [
        // 필수
        // self::HAS_MANY, self::HAS_ONE, self::BELONGS_TO
        self::HAS_ONE, // 이는 관계 유형입니다

        // 필수
        'Some_Class', // 이는 참조할 "다른" ActiveRecord 클래스입니다

        // 필수
        // 관계 유형에 따라 다름
        // self::HAS_ONE = 조인 참조 외래 키
        // self::HAS_MANY = 조인 참조 외래 키
        // self::BELONGS_TO = 조인 참조 로컬 키
        'local_or_foreign_key',
        // 참고로, 이는 "다른" 모델의 기본 키에만 조인됩니다

        // 선택
        [ 'eq' => [ 'client_id', 5 ], 'select' => 'COUNT(*) as count', 'limit' 5 ], // 관계 조인 시 원하는 추가 조건
        // $record->eq('client_id', 5)->select('COUNT(*) as count')->limit(5))

        // 선택
        'back_reference_name' // 이 관계를 다시 자신으로 백 참조하려면 예: $user->contact->user;
    ];
]
class User extends ActiveRecord{
    protected array $relations = [
        'contacts' => [ self::HAS_MANY, Contact::class, 'user_id' ],
        'contact' => [ self::HAS_ONE, Contact::class, 'user_id' ],
    ];

    public function __construct($database_connection)
    {
        parent::__construct($database_connection, 'users');
    }
}

class Contact extends ActiveRecord{
    protected array $relations = [
        'user' => [ self::BELONGS_TO, User::class, 'user_id' ],
        'user_with_backref' => [ self::BELONGS_TO, User::class, 'user_id', [], 'contact' ],
    ];
    public function __construct($database_connection)
    {
        parent::__construct($database_connection, 'contacts');
    }
}

이제 참조가 설정되었으므로 매우 쉽게 사용할 수 있습니다!

$user = new User($pdo_connection);

// 가장 최근 사용자 찾기.
$user->notNull('id')->orderBy('id desc')->find();

// 관계를 사용해 연락처 가져오기:
foreach($user->contacts as $contact) {
    echo $contact->id;
}

// 또는 반대로 할 수 있습니다.
$contact = new Contact();

// 하나의 연락처 찾기
$contact->find();

// 관계를 사용해 사용자 가져오기:
echo $contact->user->name; // 이는 사용자 이름입니다

꽤 멋지지 않나요?

Eager Loading

개요

Eager loading은 관계를 미리 로드하여 N+1 쿼리 문제를 해결합니다. 각 레코드의 관계에 대해 별도의 쿼리를 실행하는 대신, 관계당 하나의 추가 쿼리로 모든 관련 데이터를 가져옵니다.

참고: Eager loading은 v0.7.0 이상에서만 사용할 수 있습니다.

기본 사용법

with() 메서드를 사용해 eager load할 관계를 지정하세요:

// N+1 대신 2개의 쿼리로 사용자와 연락처 로드
$users = $user->with('contacts')->findAll();
foreach ($users as $u) {
    foreach ($u->contacts as $contact) {
        echo $contact->email; // 추가 쿼리 없음!
    }
}

다중 관계

한 번에 여러 관계 로드:

$users = $user->with(['contacts', 'profile', 'settings'])->findAll();

관계 유형

HAS_MANY
// 각 사용자에 대한 모든 연락처 eager load
$users = $user->with('contacts')->findAll();
foreach ($users as $u) {
    // $u->contacts는 이미 배열로 로드됨
    foreach ($u->contacts as $contact) {
        echo $contact->email;
    }
}
HAS_ONE
// 각 사용자에 대한 하나의 연락처 eager load
$users = $user->with('contact')->findAll();
foreach ($users as $u) {
    // $u->contact는 이미 객체로 로드됨
    echo $u->contact->email;
}
BELONGS_TO
// 모든 연락처에 대한 부모 사용자 eager load
$contacts = $contact->with('user')->findAll();
foreach ($contacts as $c) {
    // $c->user는 이미 로드됨
    echo $c->user->name;
}
find()와 함께

Eager loading은 findAll() 및 find() 와 모두 작동합니다:

$user = $user->with('contacts')->find(1);
// 사용자와 모든 연락처가 2개의 쿼리로 로드됨

성능 이점

Eager loading 없이 (N+1 문제):

$users = $user->findAll(); // 1 쿼리
foreach ($users as $u) {
    $contacts = $u->contacts; // N 쿼리 (사용자당 하나!)
}
// 총: 1 + N 쿼리

Eager loading과 함께:

$users = $user->with('contacts')->findAll(); // 총 2 쿼리
foreach ($users as $u) {
    $contacts = $u->contacts; // 추가 쿼리 0!
}
// 총: 2 쿼리 (사용자 1 + 모든 연락처 1)

10명의 사용자에 대해 쿼리를 11개에서 2개로 줄여 82% 감소!

중요한 주의사항

제한사항

사용자 지정 데이터 설정

때때로 ActiveRecord에 고유한 것을 첨부해야 할 수 있습니다. 예를 들어 템플릿에 전달될 객체에 간단히 첨부할 수 있는 사용자 지정 계산입니다.

setCustomData(string $field, mixed $value)

setCustomData() 메서드로 사용자 지정 데이터를 첨부하세요.

$user->setCustomData('page_view_count', $page_view_count);

그런 다음 일반 객체 속성처럼 참조하세요.

echo $user->page_view_count;

이벤트

이 라이브러리의 또 다른 멋진 기능은 이벤트에 관한 것입니다. 이벤트는 호출하는 특정 메서드에 기반해 특정 시점에 트리거됩니다. 데이터를 자동으로 설정하는 데 매우 유용합니다.

onConstruct(ActiveRecord $ActiveRecord, array &config)

기본 연결을 설정해야 할 때 매우 유용합니다.

// index.php 또는 bootstrap.php
Flight::register('db', 'PDO', [ 'sqlite:test.db' ]);

//
//
//

// User.php
class User extends flight\ActiveRecord {

    protected function onConstruct(self $self, array &$config) { // & 참조를 잊지 마세요
        // 연결을 자동으로 설정하려면 이렇게 할 수 있습니다
        $config['connection'] = Flight::db();
        // 또는 이렇게
        $self->transformAndPersistConnection(Flight::db());

        // 테이블 이름도 이렇게 설정할 수 있습니다.
        $config['table'] = 'users';
    } 
}

beforeFind(ActiveRecord $ActiveRecord)

각 쿼리 조작이 필요할 때만 유용할 것입니다.

class User extends flight\ActiveRecord {

    public function __construct($database_connection)
    {
        parent::__construct($database_connection, 'users');
    }

    protected function beforeFind(self $self) {
        // id >= 0을 항상 실행하려면
        $self->gte('id', 0); 
    } 
}

afterFind(ActiveRecord $ActiveRecord)

이 레코드가 가져올 때마다 항상 로직을 실행해야 할 때 더 유용할 것입니다. 무언가를 복호화해야 하나요? 매번 사용자 지정 카운트 쿼리를 실행해야 하나요 (성능이 좋지 않지만 어쨌든)?

class User extends flight\ActiveRecord {

    public function __construct($database_connection)
    {
        parent::__construct($database_connection, 'users');
    }

    protected function afterFind(self $self) {
        // 무언가 복호화
        $self->secret = yourDecryptFunction($self->secret, $some_key);

        // 쿼리처럼 사용자 지정 무언가를 저장?
        $self->setCustomData('view_count', $self->select('COUNT(*) count')->from('user_views')->eq('user_id', $self->id)['count']; 
    } 
}

beforeFindAll(ActiveRecord $ActiveRecord)

각 쿼리 조작이 필요할 때만 유용할 것입니다.

class User extends flight\ActiveRecord {

    public function __construct($database_connection)
    {
        parent::__construct($database_connection, 'users');
    }

    protected function beforeFindAll(self $self) {
        // id >= 0을 항상 실행하려면
        $self->gte('id', 0); 
    } 
}

afterFindAll(array<int,ActiveRecord> $results)

afterFind()와 유사하지만 모든 레코드에 적용할 수 있습니다!

class User extends flight\ActiveRecord {

    public function __construct($database_connection)
    {
        parent::__construct($database_connection, 'users');
    }

    protected function afterFindAll(array $results) {

        foreach($results as $self) {
            // afterFind()처럼 멋진 일을 하세요
        }
    } 
}

beforeInsert(ActiveRecord $ActiveRecord)

매번 기본 값을 설정해야 할 때 매우 유용합니다.

class User extends flight\ActiveRecord {

    public function __construct($database_connection)
    {
        parent::__construct($database_connection, 'users');
    }

    protected function beforeInsert(self $self) {
        // 합리적인 기본값 설정
        if(!$self->created_date) {
            $self->created_date = gmdate('Y-m-d');
        }

        if(!$self->password) {
            $self->password = password_hash((string) microtime(true));
        }
    } 
}

afterInsert(ActiveRecord $ActiveRecord)

삽입 후 데이터를 변경해야 하는 사용 사례가 있나요?

class User extends flight\ActiveRecord {

    public function __construct($database_connection)
    {
        parent::__construct($database_connection, 'users');
    }

    protected function afterInsert(self $self) {
        // 당신의 방식대로 하세요
        Flight::cache()->set('most_recent_insert_id', $self->id);
        // 또는 무엇이든....
    } 
}

beforeUpdate(ActiveRecord $ActiveRecord)

업데이트 시 매번 기본 값을 설정해야 할 때 매우 유용합니다.

class User extends flight\ActiveRecord {

    public function __construct($database_connection)
    {
        parent::__construct($database_connection, 'users');
    }

    protected function beforeInsert(self $self) {
        // 합리적인 기본값 설정
        if(!$self->updated_date) {
            $self->updated_date = gmdate('Y-m-d');
        }
    } 
}

afterUpdate(ActiveRecord $ActiveRecord)

업데이트 후 데이터를 변경해야 하는 사용 사례가 있나요?

class User extends flight\ActiveRecord {

    public function __construct($database_connection)
    {
        parent::__construct($database_connection, 'users');
    }

    protected function afterInsert(self $self) {
        // 당신의 방식대로 하세요
        Flight::cache()->set('most_recently_updated_user_id', $self->id);
        // 또는 무엇이든....
    } 
}

beforeSave(ActiveRecord $ActiveRecord)/afterSave(ActiveRecord $ActiveRecord)

삽입 또는 업데이트 시 이벤트가 발생하기를 원할 때 유용합니다. 긴 설명은 생략하겠지만, 무엇인지 추측할 수 있을 것입니다.

class User extends flight\ActiveRecord {

    public function __construct($database_connection)
    {
        parent::__construct($database_connection, 'users');
    }

    protected function beforeSave(self $self) {
        $self->last_updated = gmdate('Y-m-d H:i:s');
    } 
}

beforeDelete(ActiveRecord $ActiveRecord)/afterDelete(ActiveRecord $ActiveRecord)

여기서 무엇을 하고 싶은지 모르겠지만, 판단하지 않습니다! 해보세요!

class User extends flight\ActiveRecord {

    public function __construct($database_connection)
    {
        parent::__construct($database_connection, 'users');
    }

    protected function beforeDelete(self $self) {
        echo 'He was a brave soldier... :cry-face:';
    } 
}

데이터베이스 연결 관리

이 라이브러리를 사용할 때 데이터베이스 연결을 여러 방식으로 설정할 수 있습니다. 생성자에서 연결을 설정하거나, $config['connection'] 설정 변수로 설정하거나 setDatabaseConnection() (v0.4.1)을 사용할 수 있습니다. 

$pdo_connection = new PDO('sqlite:test.db'); // 예제용
$user = new User($pdo_connection);
// 또는
$user = new User(null, [ 'connection' => $pdo_connection ]);
// 또는
$user = new User();
$user->setDatabaseConnection($pdo_connection);

액티브 레코드를 호출할 때마다 항상 $database_connection을 설정하지 않으려면, 이를 피할 방법이 있습니다!

// index.php 또는 bootstrap.php
// Flight에서 등록된 클래스로 설정
Flight::register('db', 'PDO', [ 'sqlite:test.db' ]);

// User.php
class User extends flight\ActiveRecord {

    public function __construct(array $config = [])
    {
        $database_connection = $config['connection'] ?? Flight::db();
        parent::__construct($database_connection, 'users', $config);
    }
}

// 이제 인수 불필요!
$user = new User();

참고: 단위 테스트를 계획 중이라면, 이 방식은 단위 테스트에 약간의 도전을 추가할 수 있지만, setDatabaseConnection() 또는 $config['connection']으로 연결을 주입할 수 있으므로 전체적으로 나쁘지 않습니다.

데이터베이스 연결을 새로 고쳐야 할 때, 예를 들어 장기 실행 CLI 스크립트를 실행 중이고 연결을 주기적으로 새로 고쳐야 한다면, $your_record->setDatabaseConnection($pdo_connection)으로 재설정할 수 있습니다.

기여

참여해 주세요. :D

설정

기여할 때 composer test-coverage를 실행해 100% 테스트 커버리지를 유지하세요 (이것은 진짜 단위 테스트 커버리지가 아니라 통합 테스트에 가깝습니다).

또한 composer beautify와 composer phpcs를 실행해 린팅 오류를 수정하세요.

라이선스

MIT

Awesome-plugins/latte

Latte

Latte는 매우 사용하기 쉽고 Twig나 Smarty보다 PHP 문법에 더 가까운 느낌을 주는 완전한 기능을 갖춘 템플릿 엔진입니다. 또한 확장하기 쉽고 사용자 정의 필터와 함수를 추가할 수 있습니다.

설치

Composer를 사용하여 설치하세요.

composer require latte/latte

기본 구성

시작하기 위한 기본 구성 옵션이 있습니다. 이에 대해 더 자세히 읽으려면 Latte 문서를 참조하세요.


require 'vendor/autoload.php';

$app = Flight::app();

$app->map('render', function(string $template, array $data, ?string $block): void {
    $latte = new Latte\Engine;

    // Latte가 캐시를 저장하는 위치
    $latte->setTempDirectory(__DIR__ . '/../cache/');

    $finalPath = Flight::get('flight.views.path') . $template;

    $latte->render($finalPath, $data, $block);
});

간단한 레이아웃 예제

다음은 레이아웃 파일의 간단한 예제입니다. 이는 다른 모든 뷰를 감싸는 데 사용될 파일입니다.

<!-- app/views/layout.latte -->
<!doctype html>
<html lang="en">
    <head>
        <title>{$title ? $title . ' - '}My App</title>
        <link rel="stylesheet" href="style.css">
    </head>
    <body>
        <header>
            <nav>
                <!-- 여기에 네비게이션 요소를 추가하세요 -->
            </nav>
        </header>
        <div id="content">
            <!-- 여기가 바로 마법입니다 -->
            {block content}{/block}
        </div>
        <div id="footer">
            &copy; Copyright
        </div>
    </body>
</html>

이제 그 콘텐츠 블록 내부에 렌더링될 파일입니다:

<!-- app/views/home.latte -->
<!-- 이는 Latte에게 이 파일이 layout.latte 파일 "내부"에 있음을 알려줍니다 -->
{extends layout.latte}

<!-- 이는 레이아웃 내부 콘텐츠 블록에 렌더링될 콘텐츠입니다 -->
{block content}
    <h1>Home Page</h1>
    <p>Welcome to my app!</p>
{/block}

함수나 컨트롤러 내부에서 이를 렌더링할 때 다음과 같이 합니다:

// 간단한 라우트
Flight::route('/', function () {
    Flight::render('home.latte', [
        'title' => 'Home Page'
    ]);
});

// 또는 컨트롤러를 사용하는 경우
Flight::route('/', [HomeController::class, 'index']);

// HomeController.php
class HomeController
{
    public function index()
    {
        Flight::render('home.latte', [
            'title' => 'Home Page'
        ]);
    }
}

Latte를 최대한 활용하는 방법에 대한 자세한 정보는 Latte 문서를 참조하세요!

Tracy를 사용한 디버깅

이 섹션에는 PHP 8.1+가 필요합니다.

Tracy를 사용하여 Latte 템플릿 파일을 바로 디버깅할 수도 있습니다! 이미 Tracy가 설치되어 있다면 Tracy에 Latte 확장을 추가해야 합니다.

// services.php
use Tracy\Debugger;

$app->map('render', function(string $template, array $data, ?string $block): void {
    $latte = new Latte\Engine;

    // Latte가 캐시를 저장하는 위치
    $latte->setTempDirectory(__DIR__ . '/../cache/');

    $finalPath = Flight::get('flight.views.path') . $template;

    // 이는 Tracy 디버그 바로가 활성화된 경우에만 확장을 추가합니다
    if (Debugger::$showBar === true) {
        // 여기에 Latte 패널을 Tracy에 추가합니다
        $latte->addExtension(new Latte\Bridges\Tracy\TracyExtension);
    }
    $latte->render($finalPath, $data, $block);
});

Awesome-plugins/awesome_plugins

멋진 플러그인

Flight는 놀라울 정도로 확장 가능합니다. Flight 애플리케이션에 기능을 추가하는 데 사용할 수 있는 여러 플러그인이 있습니다. 일부는 Flight 팀에서 공식적으로 지원하며, 다른 일부는 시작하는 데 도움을 주는 마이크로/라이트 라이브러리입니다.

API 문서화

API 문서화는 모든 API에 필수적입니다. 개발자들이 API와 상호 작용하는 방법을 이해하고 반환되는 것을 예상할 수 있도록 도와줍니다. Flight 프로젝트에 대한 API 문서화를 생성하는 데 도움이 되는 몇 가지 도구가 있습니다.

애플리케이션 성능 모니터링 (APM)

애플리케이션 성능 모니터링 (APM)은 모든 애플리케이션에 필수적입니다. 애플리케이션이 어떻게 작동하는지 이해하고 병목 현상이 어디에 있는지 파악하는 데 도움을 줍니다. Flight와 함께 사용할 수 있는 여러 APM 도구가 있습니다.

비동기

Flight는 이미 빠른 프레임워크이지만, 터보 엔진을 장착하면 모든 것이 더 재미있고 (도전적) 됩니다!

권한 부여/권한

권한 부여와 권한은 누가 무엇에 접근할 수 있는지에 대한 제어가 필요한 모든 애플리케이션에 필수적입니다.

인증

인증은 사용자 ID를 확인하고 API 엔드포인트를 보호해야 하는 애플리케이션에 필수적입니다.

캐싱

캐싱은 애플리케이션을 가속화하는 훌륭한 방법입니다. Flight와 함께 사용할 수 있는 여러 캐싱 라이브러리가 있습니다.

CLI

CLI 애플리케이션은 애플리케이션과 상호 작용하는 훌륭한 방법입니다. 컨트롤러 생성, 모든 라우트 표시 등에 사용할 수 있습니다.

쿠키

쿠키는 클라이언트 측에서 작은 데이터 조각을 저장하는 훌륭한 방법입니다. 사용자 선호도, 애플리케이션 설정 등을 저장하는 데 사용할 수 있습니다.

디버깅

디버깅은 로컬 환경에서 개발할 때 필수적입니다. 디버깅 경험을 향상시킬 수 있는 몇 가지 플러그인이 있습니다.

데이터베이스

데이터베이스는 대부분의 애플리케이션의 핵심입니다. 데이터를 저장하고 검색하는 방법입니다. 일부 데이터베이스 라이브러리는 쿼리를 작성하는 단순한 래퍼이고, 일부는 완전한 ORM입니다.

암호화

암호화는 민감한 데이터를 저장하는 모든 애플리케이션에 필수적입니다. 데이터를 암호화하고 복호화하는 것은 그리 어렵지 않지만, 암호화 키를 적절히 저장하는 것은 어렵습니다 있습니다 입니다. 가장 중요한 것은 암호화 키를 공개 디렉토리에 저장하거나 코드 저장소에 커밋하지 않는 것입니다.

작업 큐

작업 큐는 작업을 비동기적으로 처리하는 데 매우 유용합니다. 이메일 보내기, 이미지 처리 또는 실시간으로 수행할 필요가 없는 모든 작업에 사용할 수 있습니다.

세션

세션은 API에는 별로 유용하지 않지만, 웹 애플리케이션을 구축할 때 상태와 로그인 정보를 유지하는 데 필수적일 수 있습니다.

템플릿

템플릿은 UI가 있는 모든 웹 애플리케이션의 핵심입니다. Flight와 함께 사용할 수 있는 여러 템플릿 엔진이 있습니다.

WordPress 통합

WordPress 프로젝트에서 Flight를 사용하고 싶으신가요? 이를 위한 편리한 플러그인이 있습니다!

기여

공유하고 싶은 플러그인이 있나요? 목록에 추가하기 위해 풀 리퀘스트를 제출하세요!

Media

미디어

우리는 Flight와 관련된 인터넷상의 다양한 미디어 유형을 추적하려고 노력했습니다. Flight에 대해 더 알아보기 위해 사용할 수 있는 다양한 리소스를 아래에서 확인하세요.

기사 및 글

비디오 및 튜토리얼

누락된 내용이 있나요?

우리가 놓친 당신이 작성하거나 녹음한 내용이 있나요? 이슈나 풀 리퀘스트로 알려주세요!

Examples

빠른 시작이 필요하신가요?

새로운 Flight 프로젝트를 시작하는 데 두 가지 옵션이 있습니다:

커뮤니티 기여 예제:

영감을 얻고 싶으신가요?

이것들은 Flight 팀에서 공식적으로 후원하지는 않지만, Flight로 구축된 자신의 프로젝트를 구조화하는 데 아이디어를 줄 수 있습니다!

자신의 예제를 공유하고 싶으신가요?

공유하고 싶은 프로젝트가 있으시면, 이 목록에 추가하기 위해 풀 리퀘스트를 제출해 주세요!

Install/install

설치 지침

Flight를 설치하기 전에 몇 가지 기본 전제 조건이 있습니다. 구체적으로 다음을 수행해야 합니다:

  1. 시스템에 PHP 설치
  2. 최고의 개발자 경험을 위해 Composer 설치.

기본 설치

Composer를 사용 중이라면 다음 명령어를 실행할 수 있습니다:

composer require flightphp/core

이것은 시스템에 Flight 코어 파일만 설치합니다. 프로젝트 구조 정의, 레이아웃, 의존성, 설정, 자동 로딩 등을 정의해야 합니다. 이 방법은 Flight 외에 다른 의존성을 설치하지 않도록 보장합니다.

또는 파일 다운로드 를 직접 수행하고 웹 디렉토리에 추출할 수도 있습니다.

권장 설치

새 프로젝트의 경우 flightphp/skeleton 앱으로 시작하는 것을 강력히 권장합니다. 설치는 매우 간단합니다.

composer create-project flightphp/skeleton my-project/

이것은 프로젝트 구조를 설정하고, 네임스페이스와 함께 자동 로딩을 구성하며, Tracy, Tracy Extensions, Runway와 같은 다른 도구를 제공합니다.

웹 서버 구성

내장 PHP 개발 서버

이것은 실행을 시작하는 가장 간단한 방법입니다. 내장 서버를 사용하여 애플리케이션을 실행할 수 있으며, 심지어 데이터베이스로 SQLite를 사용할 수도 있습니다 (시스템에 sqlite3가 설치되어 있는 한) 그리고 거의 아무것도 필요하지 않습니다! PHP가 설치된 후 다음 명령어를 실행하세요:

php -S localhost:8000
# 또는 skeleton 앱과 함께
composer start

그런 다음 브라우저를 열고 http://localhost:8000로 이동하세요.

프로젝트의 문서 루트를 다른 디렉토리로 만들고 싶다면 (예: 프로젝트가 ~/myproject이지만 문서 루트가 ~/myproject/public/인 경우), ~/myproject 디렉토리에 있는 경우 다음 명령어를 실행할 수 있습니다:

php -S localhost:8000 -t public/
# skeleton 앱과 함께, 이는 이미 구성되어 있습니다
composer start

그런 다음 브라우저를 열고 http://localhost:8000로 이동하세요.

Apache

시스템에 Apache가 이미 설치되어 있는지 확인하세요. 그렇지 않다면, 시스템에 Apache를 설치하는 방법을 구글링하세요.

Apache의 경우, 다음으로 .htaccess 파일을 편집하세요:

RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php [QSA,L]

참고: 하위 디렉토리에서 flight를 사용해야 하는 경우 RewriteEngine On 바로 다음에 RewriteBase /subdir/ 줄을 추가하세요.

참고: 서버 파일을 모두 보호하고 싶다면, db나 env 파일처럼. .htaccess 파일에 다음을 넣으세요:

RewriteEngine On
RewriteRule ^(.*)$ index.php

Nginx

시스템에 Nginx가 이미 설치되어 있는지 확인하세요. 그렇지 않다면, 시스템에 Nginx를 설치하는 방법을 구글링하세요.

Nginx의 경우, 서버 선언에 다음을 추가하세요:

server {
  location / {
    try_files $uri $uri/ /index.php;
  }
}

index.php 파일 생성

기본 설치를 수행 중이라면 시작할 수 있는 코드가 필요합니다.

<?php

// Composer를 사용 중이라면, 자동 로더를 요구하세요.
require 'vendor/autoload.php';
// Composer를 사용하지 않는다면, 프레임워크를 직접 로드하세요
// require 'flight/Flight.php';

// 그런 다음 라우트를 정의하고 요청을 처리할 함수를 할당하세요.
Flight::route('/', function () {
  echo 'hello world!';
});

// 마지막으로, 프레임워크를 시작하세요.
Flight::start();

skeleton 앱과 함께라면, 이는 이미 app/config/routes.php 파일에서 구성되고 처리됩니다. 서비스는 app/config/services.php에서 구성됩니다.

PHP 설치

시스템에 이미 php가 설치되어 있다면, 이 지침을 건너뛰고 다운로드 섹션으로 이동하세요.

macOS

Homebrew를 사용한 PHP 설치

  1. Homebrew 설치 (이미 설치되어 있지 않은 경우):

    • 터미널을 열고 실행: 
      /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

  2. PHP 설치:

    • 최신 버전 설치: 
      brew install php
    • 특정 버전을 설치하려면, 예를 들어 PHP 8.1: 
      brew tap shivammathur/php
brew install shivammathur/php/php@8.1

  3. PHP 버전 전환:

    • 현재 버전을 언링크하고 원하는 버전을 링크: 
      brew unlink php
brew link --overwrite --force php@8.1
    • 설치된 버전 확인: 
      php -v

Windows 10/11

PHP 수동 설치

  1. PHP 다운로드:

    • PHP for Windows를 방문하여 최신 버전 또는 특정 버전 (예: 7.4, 8.0)을 비스레드-세이프 zip 파일로 다운로드하세요.

  2. PHP 추출:

    • 다운로드한 zip 파일을 C:\php로 추출하세요.

  3. 시스템 PATH에 PHP 추가:

    • 시스템 속성 > 환경 변수로 이동.
    • 시스템 변수에서 Path를 찾아 편집을 클릭.
    • C:\php 경로 (또는 PHP를 추출한 위치)를 추가.
    • 모든 창을 닫기 위해 확인을 클릭.

  4. PHP 구성:

    • php.ini-development를 php.ini로 복사.
    • php.ini를 편집하여 PHP를 필요에 따라 구성 (예: extension_dir 설정, 확장 활성화).

  5. PHP 설치 확인:

    • 명령 프롬프트를 열고 실행: 
      php -v

여러 버전의 PHP 설치

  1. 위 단계를 반복 각 버전에 대해, 각각 별도의 디렉토리에 배치 (예: C:\php7, C:\php8).

  2. 버전 전환 시스템 PATH 변수를 원하는 버전 디렉토리를 가리키도록 조정하여.

Ubuntu (20.04, 22.04 등)

apt를 사용한 PHP 설치

  1. 패키지 목록 업데이트:

    • 터미널을 열고 실행: 
      sudo apt update

  2. PHP 설치:

    • 최신 PHP 버전 설치: 
      sudo apt install php
    • 특정 버전을 설치하려면, 예를 들어 PHP 8.1: 
      sudo apt install php8.1

  3. 추가 모듈 설치 (선택):

    • 예를 들어 MySQL 지원 설치: 
      sudo apt install php8.1-mysql

  4. PHP 버전 전환:

    • update-alternatives 사용: 
      sudo update-alternatives --set php /usr/bin/php8.1

  5. 설치된 버전 확인:

    • 실행: 
      php -v

Rocky Linux

yum/dnf를 사용한 PHP 설치

  1. EPEL 저장소 활성화:

    • 터미널을 열고 실행: 
      sudo dnf install epel-release

  2. Remi 저장소 설치:

    • 실행: 
      sudo dnf install https://rpms.remirepo.net/enterprise/remi-release-8.rpm
sudo dnf module reset php

  3. PHP 설치:

    • 기본 버전 설치: 
      sudo dnf install php
    • 특정 버전을 설치하려면, 예를 들어 PHP 7.4: 
      sudo dnf module install php:remi-7.4

  4. PHP 버전 전환:

    • dnf 모듈 명령 사용: 
      sudo dnf module reset php
sudo dnf module enable php:remi-8.0
sudo dnf install php

  5. 설치된 버전 확인:

    • 실행: 
      php -v

일반 참고 사항

Guides

가이드

Flight PHP는 간단하면서도 강력하게 설계되었으며, 우리 가이드는 실세계 애플리케이션을 단계적으로 구축하는 데 도움이 됩니다. 이러한 실용적인 튜토리얼은 완전한 프로젝트를 통해 Flight를 효과적으로 사용할 수 있는 방법을 보여줍니다.

공식 가이드

블로그 빌딩

Flight PHP로 기능적인 블로그 애플리케이션을 만드는 방법을 배웁니다. 이 가이드는 다음을 안내합니다:

이 튜토리얼은 모든 부분이 실제 애플리케이션에서 어떻게 연결되는지 보고 싶은 초보자에게 적합합니다.

Unit Testing and SOLID Principles

이 가이드에서는 Flight PHP 애플리케이션의 단위 테스팅 기본을 다룹니다. 포함 내용:

비공식 가이드

이 가이드들은 Flight 팀에 의해 공식적으로 유지되지 않지만, 커뮤니티에서 만들어진 귀중한 자원입니다. 다양한 주제와 용례를 다루며, Flight PHP 사용에 대한 추가 통찰을 제공합니다.

Flight Framework를 사용한 RESTful API 생성

이 가이드는 Flight PHP 프레임워크를 사용하여 RESTful API를 생성하는 과정을 안내합니다. API 설정 기본, 라우트 정의, JSON 응답 반환을 다룹니다.

간단한 블로그 빌딩

이 가이드는 Flight PHP 프레임워크를 사용하여 기본 블로그를 만드는 과정을 안내합니다. 실제로 2개의 부분으로 구성되어 있습니다: 하나는 기본을 다루고, 다른 하나는 프로덕션 준비 블로그를 위한 고급 주제와 개선을 다룹니다.

PHP로 Pokémon API 빌딩: 초보자 가이드

이 재미있는 가이드는 Flight PHP를 사용하여 간단한 Pokémon API를 만드는 과정을 안내합니다. API 설정 기본, 라우트 정의, JSON 응답 반환을 다룹니다.

기여

가이드 아이디어가 있나요? 실수를 발견했나요? 기여를 환영합니다! 우리 가이드는 FlightPHP 문서 저장소에서 유지됩니다.

Flight로 흥미로운 것을 만들었고, 가이드로 공유하고 싶다면 풀 리퀘스트를 제출하세요. 지식을 공유하면 Flight 커뮤니티가 성장합니다.

API 문서 찾기?

Flight의 핵심 기능과 메서드에 대한 구체적인 정보를 찾고 있다면, 우리 문서의 Learn 섹션을 확인하세요.