首页 > 文章 > php教程

Laravel 中的整洁代码架构：实用指南

来源：dev.to

时间：2024-11-04 08:03:55 301浏览收藏

从现在开始，我们要努力学习啦！今天我给大家带来《Laravel 中的整洁代码架构：实用指南》，感兴趣的朋友请继续看下去吧！下文中的内容我们主要会涉及到等等知识点，如果在阅读本文过程中有遇到不清楚的地方，欢迎留言呀！我们一起讨论，一起学习！

如果您使用 laravel 进行开发已经有一段时间了，您可能听说过“干净的代码”这个词。但它在 laravel 开发的背景下实际上意味着什么？更重要的是，你为什么要关心？

“干净的代码”是指易于理解、维护和扩展的代码。干净的代码架构通过提供一种结构使这一点更进一步，使您可以随着应用程序的增长更轻松地保持代码库干净。在这篇博客中，我们将探索如何在 laravel 中实现干净的代码架构，使您的项目更具可扩展性、可维护性和工作乐趣。

什么是干净代码架构？
为什么你应该关心干净的代码
整洁代码架构的关键原则
在 laravel 中实现简洁的代码架构
- 实体和用例
- 存储库和接口
- 控制器和依赖注入
- 服务和业务逻辑
现实示例：构建博客平台
laravel 中整洁代码的最佳实践
最后的想法

什么是干净代码架构？

干净的代码架构是一种组织应用程序的方式，使其更易于维护和扩展。它不依赖于任何特定的框架或语言，并将您的应用程序分为多个层。每一层都有特定的职责，并且与其他层松散耦合。

这种分离可以帮助您避免臭名昭著的“意大利面条代码”，即所有内容都纠缠在一起。借助干净的代码架构，您的业务逻辑与用户界面和数据访问保持分离，允许您对应用程序的一部分进行更改，而不会破坏整个系统。

为什么你应该关心干净的代码

编写干净的代码不仅仅是让你的代码看起来漂亮；而是让你的代码看起来更漂亮。从长远来看，这是为了让您的生活更轻松。当你的代码干净时：

更容易调试：清晰、结构良好的代码可以帮助您更快地发现并修复错误。
更容易扩展：当您的应用程序增长时，干净的代码可以更轻松地添加新功能，而不会破坏现有功能。
与他人合作更容易：无论您是与团队合作还是与开源社区共享项目，干净的代码都更容易让其他人理解。

在像 laravel 这样鼓励快速开发的框架中，人们很容易倾向于专注于快速构建而不是干净构建。但通过遵循干净的代码原则，从长远来看，您最终会节省时间和精力。

干净代码架构的关键原则

在我们深入探讨如何在 laravel 中实现干净的代码架构之前，让我们先回顾一下几个关键原则：

关注点分离：架构中的每一层都应该有特定的职责，并且应该避免混合关注点（例如，不要将数据库逻辑放在控制器中）。
依赖倒置：高层模块不应该依赖于低层模块。相反，两者都应该依赖于抽象（如接口）。
单一职责原则：每个类或函数都应该做一件事，并把它做好。这使得测试和维护代码变得更加容易。

在 laravel 中实现整洁的代码架构

现在，让我们看看如何在 laravel 应用程序中实现干净的代码架构。

实体和用例

干净代码架构的核心是实体和用例。实体是系统中的核心对象（例如帖子或用户），用例定义了您可以使用这些实体执行的操作（例如创建帖子或删除用户）。

在 laravel 中，实体可以表示为 eloquent 模型，而用例通常是在这些模型上执行特定操作的服务。

例如，让我们创建一个简单的用例来创建博客文章：

// app/domain/post/post.php
class post {
    private $title;
    private $content;

    public function __construct($title, $content) {
        $this->title = $title;
        $this->content = $content;
    }

    // getter methods and other domain logic
}

这是创建新帖子的用例：

// app/services/post/createpostservice.php
class createpostservice {
    private $postrepository;

    public function __construct(postrepositoryinterface $postrepository) {
        $this->postrepository = $postrepository;
    }

    public function execute($data) {
        $post = new post($data['title'], $data['content']);
        $this->postrepository->save($post);
    }
}

存储库和接口

在干净的代码架构中，存储库处理数据访问，接口定义存储库应实现的方法。这样，您的业务逻辑不依赖于您正在使用的数据库或 orm，而是依赖于抽象。

让我们为 postrepository 创建一个接口：

// app/repositories/postrepositoryinterface.php
interface postrepositoryinterface {
    public function save(post $post): void;
    public function findbyid($id): ?post;
}

以及此存储库的 eloquent 实现：

// app/repositories/eloquentpostrepository.php
class eloquentpostrepository implements postrepositoryinterface {
    public function save(post $post): void {
        // save post using eloquent
    }

    public function findbyid($id): ?post {
        // fetch post using eloquent
    }
}

控制器和依赖注入

您的控制器应该很薄，这意味着它们应该只处理http请求并将繁重的工作委托给服务。通过使用依赖注入，您可以将必要的服务注入到您的控制器中。

// app/http/controllers/postcontroller.php
class postcontroller {
    private $createpostservice;

    public function __construct(createpostservice $createpostservice) {
        $this->createpostservice = $createpostservice;
    }

    public function store(request $request) {
        $this->createpostservice->execute($request->all());
        return response()->json(['message' => 'post created!']);
    }
}

服务和业务逻辑

所有业务逻辑都应该存在于服务中。这可以使您的控制器保持干净，并确保您的逻辑可以在应用程序的不同部分中重用。

// app/services/post/createpostservice.php
class createpostservice {
    private $postrepository;

    public function __construct(postrepositoryinterface $postrepository) {
        $this->postrepository = $postrepository;
    }

    public function execute($data) {
        $post = new post($data['title'], $data['content']);
        $this->postrepository->save($post);
    }
}

真实示例：构建博客平台

让我们看一下构建简单博客平台的真实示例。以下是如何使用干净的代码架构构建它：

实体：您的帖子和用户模型。
repositories：postrepositoryinterface 和 userrepositoryinterface 等接口，以及 eloquentpostrepository 等实现。
服务：createpostservice、deletepostservice 等
控制器：将工作委托给服务的瘦控制器。

这种分离可确保您的代码保持模块化且易于测试。例如，如果您决定从 eloquent 切换到另一个 orm，您只需要更新存储库实现，而不是整个应用程序。