當我開始一個新的 Laravel 專案時，我經常想知道我應該使用什麼結構。
Laravel 的結構非常好，不要誤會我的意思，它很難把事情搞砸。
然而，有一個問題，我們如何避免將我們需要的所有邏輯放入控制器中，例如 UserController.php？
在這篇文章中，我們將重點放在這個問題上。我將分享我的首選結構來涵蓋我的用例，以及一些最佳實踐，並解釋如何整合 queryFi。
既然你在這裡，我假設你已經有一個 Laravel 項目或知道如何創建一個項目，所以我們可以跳過這一步。只需確保 API 已設定即可。
我們將使用以下結構：
app
├── Repositories
| ├── Interfaces
| | ├── EloquentRepositoryInterface.php
| └── Eloquent
| ├── BaseRepository.php
| └── UserRepository.php
├── Resources
├── BaseResource.php
└── ExtendedJsonResource.php
您可以在此處找到資源資料夾，以及自訂記錄器。
# Backend composer require z3rka/queryfi # Frontend npm i queryfi
<?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;
}
我將在此處僅添加三個方法，以保持內容整潔並避免重複程式碼使空間混亂。
您可以在這裡找到其餘的內容。
<?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() 或find 和->first()，這裡的情況並非如此，因為我們使用的是queryFi 包，我們可以這樣做：
$this->processModel($request, $this->model)
如果查詢中沒有配置 getter（在此處檢查 getter），預設會自動覆寫 ->get()。
<?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);
}
}
<?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."
);
}
}
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()，它將傳回一個陣列。
您可以在 Playground 中嘗試一下，看看回應結果如何。
由於我們使用 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中文網其他相關文章！
