PHP Fractal- API를 줘요.

이 기사는 Viraj Khatavkar가 동료 검토했습니다. Sitepoint 콘텐츠를 최대한 활용 한 Sitepoint의 모든 동료 검토 자에게 감사합니다!

이전에 API를 구축 한 경우, 데이터를 응답으로 직접 출력하는 데 사용됩니다. 올바르게 수행되면 해로울 수는 없지만이 문제를 해결하는 데 도움이되는 실용적인 대안이 있습니다.

사용 가능한 솔루션 중 하나는 Fractal입니다. 모델을 응답으로 반환하기 전에 모델에 대한 새로운 변환 계층을 만들 수 있습니다. 응용 프로그램이나 프레임 워크에 매우 유연하고 쉽게 통합 할 수 있습니다.

---

키 포인트

PHP Fractal은 개발자가 모델에 대한 새로운 변환 계층을 응답으로 반환하기 전에 JSON 데이터를보다 쉽게 ​​관리하고 일관성있게 만들 수있는 솔루션입니다.

프랙탈은 유연하고 응용 프로그램이나 프레임 워크에 쉽게 통합 할 수 있습니다. 변압기를 사용하여 복잡한 데이터 구조를 더 간단한 형식으로 변환하고 Serializer를 사용하여 최종 출력을 포맷합니다.

Fractal을 사용하면 사용자가 요청할 때 하위 자원 (관계)을 응답에 포함시켜 다른 유연성 및 제어 계층을 데이터 렌더링에 추가 할 수 있습니다.

Fractal을 사용하면 관계를 한 번에로드하여 쿼리 성능을 최적화 할 수 있으므로 웅변적인 게으른 하중이 종종 발생하는 N 1 문제를 해결할 수 있습니다.

설치 우리는 Laravel 5.3 응용 프로그램을 사용하여 예제를 구축하고 프랙탈 패키지를 통합하여 Composer를 통해 설치 프로그램을 사용하거나 새 Laravel 애플리케이션을 만듭니다.

• 또는
그런 다음 폴더 내에 프랙탈 패키지가 필요합니다.
데이터베이스를 만듭니다 데이터베이스에는 사용자 및 역할 테이블이 포함되어 있습니다. 각 사용자는 역할이 있으며 각 역할에는 권한 목록이 있습니다.
변압기를 만들어 우리는 각 모델에 대한 변압기를 만들 것입니다. userTransformer 클래스는 다음과 같습니다

예, 변압기를 만드는 것이 간단합니다! 개발자가 관리 할 수있는 방식으로 데이터를 변환하고 ORM 또는 저장소로 맡기지 않습니다.

우리는 변압기 트랙 클래스를 확장하고 사용자 인스턴스를 사용하여 호출되는 변환 메소드를 정의합니다. Roletransformer 클래스의 경우에도 마찬가지입니다.
컨트롤러를 만듭니다 <code>laravel new demo</code> 컨트롤러는 데이터를 사용자에게 다시 전송하기 전에 데이터를 변환해야합니다. 이제 사용자 Controller 클래스를 처리하고 인덱스 및 표시 작업 만 일시적으로 정의합니다.
인덱스 작업은 데이터베이스에서 모든 사용자를 쿼리하고 사용자 목록 및 변환기를 사용하여 리소스 모음을 작성한 다음 실제 변환 프로세스를 수행합니다.

<code>composer create-project laravel/laravel demo</code>

물론 모든 사용자를 한 번에 반환하는 것이 합리적이지 않으며이를 위해 호출기를 구현해야합니다.

Pagination 라 라벨은 사물을 단순화하는 경향이 있습니다. 우리는 다음과 같은 페이지 매김을 구현할 수 있습니다 :

그러나 Fractal과 함께 작동하려면 데이터를 변환하고 호출기를 호출하기 위해 코드를 추가해야 할 수도 있습니다.

<code>laravel new demo</code>

첫 번째 단계는 모델에서 데이터를 이끄는 것입니다. 다음으로, 우리는 이전과 같이 리소스 컬렉션을 만들고 컬렉션에 호출기를 설정합니다.

Fractal은 Laravel에 Paginator 어댑터를 제공하여 Longhearepaginator 클래스를 변환하며 Symfony 및 Zend에 대한 어댑터도 제공합니다.

<code>composer create-project laravel/laravel demo</code>

는 페이징 세부 사항에 추가 필드를 추가합니다. 문서에서 페이징에 대한 자세한 내용을 읽을 수 있습니다.

는 하위 자원 를 포함합니다 이제 우리는 Fractal에 익숙해 져서 사용자가 요청할 때 하위 자원 (관계)을 응답에 포함시키는 방법을 배울 때입니다.

우리는 추가 리소스를 응답에 포함 시키라고 요청할 수 있습니다 (예 : http://demo.vaprobash.dev/users?include=role. 변환기는 요청중인 것을 자동으로 감지하고 포함 매개 변수를 구문 분석 할 수 있습니다.

<code>composer require league/fractal</code>

$ this- & gt; fractal- & gt; parseincludes 라인은 구문 분석을 담당합니다. 사용자 목록을 요청하면 다음과 같은 것을 볼 수 있습니다.

각 사용자가 역할 목록이 있으면 변환기를 다음과 같은 것으로 변경할 수 있습니다.

에 해당 자원이 포함되어 있으면 포인트 표기법 를 사용하여 관계를 사용할 수 있습니다. 각 역할에 별도의 테이블에 저장된 권한 목록이 있다고 가정하고 우리는 사용자의 역할과 권한이있는 사용자를 나열하려고합니다. 우리는 = 역할 .permissions를 포함 할 수 있습니다.

때때로, 우리는 주소 협회와 같은 기본적으로 필요한 협회를 기본적으로 포함시켜야합니다. 컨버터에서 $ defaultincludes 속성을 사용하여이를 수행 할 수 있습니다.

프랙탈 패키지에서 내가 가장 좋아하는 것 중 하나는 매개 변수를 포함하도록 매개 변수를 전달하는 기능입니다. 문서의 좋은 예는 순서대로 정렬됩니다. 다음과 같이 예제에 적용 할 수 있습니다.

여기서 중요한 부분은 List ($ OrderCol, $ orderby) = $ parambag- & gt; get ( 'order')? : [ 'created_at', 'desc']; 사용자는 쿼리 빌더에 포함하고 적용합니다.

// app/User.php

class User extends Authenticatable
{
    protected $fillable = [
        'name',
        'email',
        'password',
        'role_id',
    ];

    protected $hidden = [
        'password', 'remember_token',
    ];

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function role()
    {
        return $this->belongsTo(Role::class);
    }
}

이제 매개 변수를 전달하여 포함 된 사용자 목록을 순서대로 정렬 할 수 있습니다 (/역할? 포함 = 사용자 : Order (name | asc)). 문서에 리소스를 포함시키는 것에 대한 자세한 내용을 읽을 수 있습니다.

그러나 사용자가 관련 역할이 없으면 어떻게됩니까? NULL 대신 유효한 데이터를 기대하기 때문에 중지되고 오류가 나타납니다. 널 값을 표시하는 대신 응답에서 관계를 제거합시다.

<code>laravel new demo</code>

<<<> 비상 하중

에 액세스 할 때 웅변적인 모델을로드하는 것이 지연되기 때문에 <🎜 🎜> n 1

문제가 발생할 수 있습니다. 이는 일회성 열망 로딩 관계에 의해 해결되어 쿼리를 최적화 할 수 있습니다.

이 방법으로 모델 관계에 액세스 할 때 추가 쿼리가 없습니다.

결론 <🎜 🎜> 나는 필 스터 곤 (Phil Sturgeon)의 "API를 건축하지 않을 것"을 읽는 동안 프랙탈을 우연히 발견했습니다.

<code>composer create-project laravel/laravel demo</code>

API를 구축 할 때 변환기를 사용 했습니까? 동일한 작업을 수행하는 선호하는 패키지가 있습니까? 아니면 JSON_ENCODE를 사용하고 있습니까? 아래 의견 섹션에서 알려주십시오!

php 프랙탈 faq

PHP 프랙탈이란 무엇이며 왜 중요한가?

PHP Fractal은 API의 데이터 렌더링 및 변환에 도움이되는 강력한 도구입니다. 복잡한 중첩 된 데이터 구조를 출력하는 표준화 된 방법을 제공하므로 API의 데이터 출력이 일관되고 잘 구조적이며 이해하기 쉽도록해야합니다. 이를 통해 개발자가 API를보다 쉽게 ​​사용하고 오류 가능성을 줄일 수 있습니다.

PHP 프랙탈은 어떻게 작동합니까?

PHP 프랙탈은 복잡한 데이터 구조를 취하고 사용하기 쉬운 형식으로 변환하여 작동합니다. 변압기와 세리어 라이저의 두 가지 주요 구성 요소를 통해 구현됩니다. Transformer는 복잡한 데이터를 더 간단한 형식으로 변환하는 반면 Serializer는 최종 출력을 형식화합니다.

PHP 프랙탈의 변압기는 무엇입니까?

PHP 프랙탈의 변압기는 API 응답에서 응용 프로그램 데이터가 어떻게 출력되어야하는지 정의하는 클래스입니다. 복잡한 데이터 구조를 취해 더 간단하고 사용하기 쉬운 형식으로 변환합니다. 이를 통해 API 응답에 포함 된 데이터와 구성 방법을 정확하게 제어 할 수 있습니다.

PHP 프랙탈에서 세리어 라이저 란 무엇입니까?

PHP 프랙탈의 시리얼 라이저는 API의 최종 출력을 형식화하는 데 도움이됩니다. 변압기로 변환 된 데이터를 가져와 특정 구조로 포맷합니다. 이를 통해 API의 출력이 일관되고 이해하기 쉽도록 할 수 있습니다.

내 프로젝트에서 PHP 프랙탈을 어떻게 구현합니까?

프로젝트에서 PHP 프랙탈을 구현하려면 작곡가를 통해 프랙탈 라이브러리를 설치하고 데이터 용 변압기를 생성 한 다음 프랙탈 클래스를 사용하여 변압기를 사용하여 데이터를 변환해야합니다. 그런 다음 Fractal의 직렬화기 중 하나를 사용하여 변환 된 데이터를 출력 할 수 있습니다. PHP 프로젝트에서 PHP 프랙탈을 사용할 수 있습니까?

예, PHP Fractal은 모든 PHP 프로젝트와 함께 사용할 수있는 독립형 라이브러리입니다. 특정 프레임 워크 나 플랫폼에 의존하지 않으므로 PHP 개발자에게 보편적 인 도구가됩니다.

PHP 프랙탈 사용의 이점은 무엇입니까?

PHP 프랙탈을 사용하면 많은 이점이 있습니다. API의 출력이 일관되고 잘 구조화되어 개발자가 더 쉽게 사용할 수 있도록합니다. 또한 복잡한 데이터 구조를 변환하여 오류의 가능성을 줄이고 코드를보다 쉽게 ​​유지할 수있는 표준화 된 방법을 제공합니다.

PHP 프랙탈은 다른 데이터 변환 도구와 어떻게 비교됩니까?

PHP 프랙탈은 단순성과 유연성으로 두드러집니다. 복잡한 데이터 구조를 변환 할 수있는 간단한 방법을 제공하며 변압기 및 직렬 라이저를 사용하여 높은 사용자 정의 할 수 있습니다. 이를 통해 API를 사용하는 모든 개발자에게 강력한 도구가됩니다.

PHP 프랙탈의 출력을 사용자 정의 할 수 있습니까?

예, PHP 프랙탈은 사용자 정의 가능합니다. 데이터 변환 방법을 정확하게 제어하기 위해 사용자 정의 변압기를 만들 수 있으며 다른 직렬화기를 사용하여 다양한 방식으로 출력을 포맷 할 수 있습니다. 이를 통해 API의 출력을 특정 요구 사항으로 조정할 수 있습니다.

PHP Fractal에 대해 어디에서 더 배울 수 있습니까?

PHP 프랙탈에 대해 더 많이 배우는 데 도움이되는 자원이 많이 있습니다. 공식 PHP 리그 웹 사이트는 포괄적 인 문서를 제공하며 온라인으로 많은 자습서와 블로그 게시물이 있습니다. 또한 PHP Fractal Github 저장소는 코드를 탐색하고 사용 방법에 대한 예를 볼 수있는 좋은 장소입니다.

위 내용은 PHP Fractal- API를 줘요.의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!