在 PHP 中使用服务层模式实现简洁且可扩展的代码-php教程-PHP中文网

在 PHP 中使用服务层模式实现简洁且可扩展的代码

Barbara Streisand

发布： 2024-11-01 05:26:28

原创

468 人浏览过

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），确保每个服务专用于其各自的数据和业务规则。