在 PHP 中使用服務層模式實現簡潔且可擴展的程式碼-php教程-PHP中文網

Using the Service Layer Pattern in PHP for Clean and Scalable Code

服務層模式是一種流行的設計方法，用於處理 PHP 應用程式中的業務邏輯。透過將應用程式邏輯與框架分離，我們創建了一個可擴展、可測試且可維護的程式碼庫。在本文中，我們將透過實際範例介紹服務層模式的基礎知識、其優點以及如何在 PHP 應用程式中實現它。

什麼是服務層模式？

服務層模式是在應用程式中建立一個單獨的層，專門用於管理業務邏輯。透過將業務規則和邏輯集中在專用服務類別中，我們將資料庫互動移至這些服務層，從而避免了控制器和模型的臃腫，使我們的程式碼更乾淨、更易於測試。

為什麼要使用服務層模式？

以下是在 PHP 應用程式中應用服務層模式的一些好處：

關注點分離：將業務邏輯與控制器和模型隔離，提高可讀性和可維護性。
可測試性：隔離測試業務邏輯變得更容易，因為服務與框架解耦。
可擴充性：大型應用程式受益於集中式業務規則，減少程式碼庫中的重複。

實現服務層模式

讓我們透過建立一個服務層來管理基本社交應用程式的操作來示範一個範例。在這種情況下，我們將建立一個 PostService 類別來處理與建立和更新貼文相關的業務邏輯。該類別將包含建立貼文、驗證使用者權限和更新帖子元資料的方法。

第 1 步：定義服務類

我們將從建立 PostService 類別開始，該類別將包含處理與貼文相關的操作所需的方法。這個類別應該位於像 app/Services 這樣的目錄中。

<?php

namespace App\Services;

use App\Models\Post;
use Illuminate\Support\Facades\DB;

class PostService
{
    public function createPost(array $postData): Post
    {
        return DB::transaction(function () use ($postData) {
            $post = Post::create($postData);
            $this->updatePostMetadata($post);

            return $post;
        });
    }

    public function updatePostMetadata(Post $post): void
    {
        $post->metadata = json_encode(['likes' => 0, 'shares' => 0]);
        $post->save();
    }
}

登入後複製

第 2 步：使用控制器中的服務層

設定好 PostService 類別後，讓我們將其整合到控制器中。這將使控制器專注於處理 HTTP 請求和回應，而業務邏輯則駐留在服務中。

<?php

namespace App\Http\Controllers;

use App\Services\PostService;
use Illuminate\Http\Request;

class PostController extends Controller
{
    protected function postService(): PostService
    {
        return new PostService();
    }

    public function store(Request $request)
    {
        $validatedData = $request->validate([
            'title' => 'required|string|max:255',
            'content' => 'required|string',
            'user_id' => 'required|integer|exists:users,id'
        ]);

        $post = $this->postService()->createPost($validatedData);

        return response()->json($post, 201);
    }
}

登入後複製

步驟 3：測試服務層

測試服務層對於確保業務邏輯正常運作至關重要。由於服務與 HTTP 請求解耦，因此我們可以建立單元測試來驗證 PostService 類別。

這是我們的 PostService 類別的範例測試：

<?php

namespace Tests\Unit\Services;

use App\Models\Post;
use App\Services\PostService;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

class PostServiceTest extends TestCase
{
    use RefreshDatabase;

    protected $service;

    protected function setUp(): void
    {
        parent::setUp();

        $this->service = new PostService();
    }

    public function test_create_post_sets_initial_metadata()
    {
        $postData = [
            'title' => 'Sample Post',
            'content' => 'This is a test post content.',
            'user_id' => 1
        ];

        $post = $this->service->createPost($postData);

        $metadata = json_decode($post->metadata, true);
        $this->assertEquals(['likes' => 0, 'shares' => 0], $metadata);
    }
}

登入後複製

此測試可確保貼文的初始元資料在 PostService 中正確設定。

服務類別和特定於模型的邏輯

大多數情況下，像 PostService 這樣的服務類別是針對特定模型（在本例中為 Post 模型）量身訂做的。這種特定於模型的重點有助於確保應用程式中每個實體的業務邏輯都是集中的。例如，PostService 包含 createPost 和 updatePostMetadata 等直接對貼文進行操作的方法，將所有與貼文相關的邏輯保留在一個地方。遵循此模式，您可以為其他模型建立單獨的服務類別（例如 UserService、CommentService），確保每個服務專用於其各自的資料和業務規則。