queryFi를 사용하여 Laravel에서 확장 가능한 저장소 구조 설계

소개

새로운 Laravel 프로젝트를 시작할 때 어떤 구조를 사용해야 할지 고민할 때가 많았습니다.
Laravel은 매우 잘 구조화되어 있으므로 오해하지 마십시오.
그러나 문제가 있습니다. 필요한 모든 로직을 UserController.php와 같은 컨트롤러에 넣지 않으려면 어떻게 해야 할까요?
이번 글에서는 이 문제에 초점을 맞춰보겠습니다. 몇 가지 모범 사례와 함께 사용 사례를 다루기 위해 선호하는 구조를 공유하고 queryFi 통합 방법을 설명하겠습니다.

---

시작하기

여기까지 오셨으니 이미 Laravel 프로젝트가 있거나 프로젝트 생성 방법을 알고 계시리라 가정하고 해당 단계를 건너뛰겠습니다. API가 설정되어 있는지 확인하세요.

우리는 다음 구조를 사용할 것입니다:

app
├── Repositories
|   ├── Interfaces
|   |   ├── EloquentRepositoryInterface.php
|   └── Eloquent
|       ├── BaseRepository.php
|       └── UserRepository.php
├── Resources
    ├── BaseResource.php
    └── ExtendedJsonResource.php

여기에서 Resources 폴더와 사용자 정의 로거를 찾을 수 있습니다.

---

1. 쿼리파이 설치

# Backend
composer require z3rka/queryfi

# Frontend
npm i queryfi

---

2. 리포지토리 인터페이스 추가

<?php namespace App\Repositories\Interfaces;

use Illuminate\Http\Resources\Json\JsonResource;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Http\Request;

interface EloquentRepositoryInterface
{
    public function create(array $attributes = [], ?string $successMessage, ?string $errorMessage): JsonResource;

    public function all(Request $request, ?string $errorMessage): JsonResource;

    public function one(Request $request, Model $model, ?string $errorMessage): JsonResource;

    public function update(Request $request, Model $model, ?string $successMessage, ?string $errorMessage): JsonResource;

    public function destroy(Request $request, ?string $successMessage, ?string $errorMessage): JsonResource;
}

---

3. 기본 저장소 클래스 추가

반복적인 코드로 공간을 어수선하게 하지 않고 깔끔하게 유지하기 위해 여기에 세 가지 방법만 추가하겠습니다.
나머지는 여기에서 확인하실 수 있습니다.

<?php namespace App\Repositories\Eloquent;

use Z3rka\Queryfi\HasRelations;

class BaseRepository implements EloquentRepositoryInterface {
    use HasRelations;

    public function __construct(protected Model $model)
    {
        //
    }

    public function create(array $attributes = [], ?string $successMessage, ?string $errorMessage): BaseResource
    {
        try {
            return new BaseResource(
                true,
                $successMessage,
                $this->model->create($attributes)
            );
        } catch (Exception $e) {
            return new BaseResource(
                false,
                $errorMessage,
                [
                    'error' => $e
                ]
            );
        }
    }

    public function all(Request $request, ?string $errorMessage): BaseResource
    {
        try {
            return new BaseResource(
              true, 
              'Success', 
              $this->processModel($request, $this->model)
            );
        } catch (Exception $e) {
            $this->spitError($e);
            return new BaseResource(
                false,
                "Fail",
                $this->model->get(),
                [
                    "error" => $e,
                ]
            );
        }
    }

    public function one(Request $request, Model $model, ?string $errorMessage): BaseResource
    {
        try {
            return new BaseResource(
              true, 
              "success", 
              $this->processModel($request, $model)
            )
        } catch (Exception $e) {
            $this->spitError($e);
            return new BaseResource(
                false,
                "Fail",
                $model,
                [
                    "error" => $e,
                ]
            );
        }
    }
}

일반적으로 모델에서 무언가를 반환하려면 ->get() 또는 찾아서 ->first()를 수행해야 하지만 여기서는 queryFi 패키지를 사용하여 다음을 수행할 수 있으므로 그렇지 않습니다.

$this->processModel($request, $this->model)

이것은 쿼리에 getter(여기에서 getter 확인)가 구성되지 않은 경우 기본적으로 ->get()을 자동으로 처리합니다.

---

4. 사용자 저장소

<?php namespace App\Repositories\Eloquent;
use App\Models\User;
use Z3rka\Queryfi\HasRelations;

class UserRepository extends BaseRepository
{
    use HasRelations;

    public function __construct(User $model)
    {
        parent::__construct($model);
    }
}

---

5. 사용자 컨트롤러

<?php namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\Repositories\Eloquent\UserRepository;

class UserController extends Controller
{
    public function __construct(public UserRepository $userRepository)
    {
    }

    public function index(Request $request)
    {
      return $this->userRepository
                  ->all($request, "Ooops, there was an error fetching all the users.")
    }

    public function show(Request $request, User $user)
    {
      return $this->userRepository->one(
            $request,
            $user,
            "Ooops, there was an error fetching the user."
        );
    }
}

---

6. API 경로

Route::resource('users', UserController::class)->only(['index', 'show'])

---

모든 설정이 완료되면 다음과 같은 쿼리 매개변수를 직접 전달하여 브라우저에서 요청할 수 있습니다.

url?where[name]=john&select=name&getter=first

또는 더 깔끔한 접근 방식을 위해 프런트엔드에서 queryFi TypeScript 패키지를 사용할 수 있습니다.

import { createQuery } from "queryfi";

const query = createQuery('/api/users', {
    baseUrl: "http://localhost:8000"
  })
  .where({
    id: 1
  })
  .first() // will return an object with the user if it exists.

생성된 쿼리는 다음과 같습니다

http://localhost:8000/api/users?where[id]=1&getter=first

이 코드는 ID = 1인 사용자를 반환합니다.
.find()를 사용하면 응답이 자동으로 객체가 됩니다.
.get()을 사용하면 배열이 반환됩니다.

놀이터에서 반응이 어떻게 나타나는지 확인할 수 있습니다.

HasRelations 특성을 사용하고 있으므로 여기에 표시된 것처럼 프론트엔드 쿼리를 연결하여 데이터가 반환되기 전에 백엔드에서 직접 데이터를 변환할 수 있습니다.

import { createQuery } from "queryfi";

const query = createQuery('/api/users', {
    baseUrl: "http://localhost:8000"
  })
  .where({
    id: 1
  })
  .select(['email', 'id', 'name'])
  .get() // will return an array with one entry if it exists.

사용할 수 있는 더 많은 방법을 보려면 queryFi 문서를 확인하세요

---

끝

그리고 그게 다입니다! ? 이제 전문가처럼 API를 구축할 수 있는 견고하고 강력한 출발점이 생겼습니다.
코딩 능력을 발휘하여 멋진 것을 만들어 보세요! ??

github, Linkedin, queryFi에 문의하세요

위 내용은 queryFi를 사용하여 Laravel에서 확장 가능한 저장소 구조 설계의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!