使用 honeystone/context 构建多租户应用程序

胖墨同学_9925

胖墨同学_9925

2024-08-11

759人浏览

转载

不要与 laravel 的新上下文库混淆,该包可用于构建多上下文多租户应用程序。大多数多租户库本质上都有一个“租户”上下文,因此如果您需要多个上下文,事情可能会变得有点麻烦。这个新包解决了这个问题。

让我们看一个例子好吗?

示例项目

对于我们的示例应用程序,我们将拥有一个组织成团队的全球用户群,每个团队将有多个项目。这是许多软件即服务应用程序中相当常见的结构。

对于多租户应用程序来说,每个用户群都存在于一个租户上下文中并不罕见,但对于我们的示例应用程序,我们希望用户能够加入多个团队,所以它是全局用户群。
全球用户群与租户用户群图

使用 honeystone/context 构建多租户应用程序

作为 saas,团队很可能是计费实体(即席位),并且某些团队成员将被授予管理团队的权限。不过,我不会在此示例中深入探讨这些实现细节,但希望它提供一些额外的上下文。

安装

为了保持这篇文章的简洁,我不会解释如何启动你的 laravel 项目。已经有许多更好的资源可用,尤其是官方文档。我们假设您已经有一个 laravel 项目,其中包含用户、团队和项目模型,并且您已准备好开始实现我们的上下文包。

安装很简单 作曲家推荐:

composer install honeystone/context

这个库有一个方便的函数 context(),从 laravel 11 开始,它与 laravel 自己的 context 函数发生冲突。这其实并不是一个问题。您可以导入我们的函数:

use function honestone\context\context;

或者直接使用 laravel 的依赖注入容器。在这篇文章中,我将假设您已导入该函数并相应地使用它。

型号

让我们从配置我们的团队模型开始:

<?php declare(strict_types=1);

namespace app\models;

use illuminate\database\eloquent\model;
use illuminate\database\eloquent\relations\belongstomany;
use illuminate\database\eloquent\relations\hasmany;

class team extends model
{
    protected $fillable = ['name'];

    public function members(): belongstomany
    {
        return $this->belongstomany(user::class);
    }

    public function projects(): hasmany
    {
        return $this->hasmany(project::class);
    }
}

团队有名称、成员和项目。在我们的应用程序中,只有团队成员才能访问该团队或其项目。

好吧,让我们看看我们的项目:

<?php declare(strict_types=1);

namespace app\models;

use illuminate\database\eloquent\model;
use illuminate\database\eloquent\relations\belongsto;

class project extends model
{
    protected $fillable = ['name'];

    public function team(): belongsto
    {
        return $this->belongsto(team::class);
    }
}

一个项目有一个名字并且属于一个团队。

确定上下文

当有人访问我们的应用程序时,我们需要确定他们在哪个团队和项目中工作。为了简单起见,我们用路由参数来处理这个问题。我们还假设只有经过身份验证的用户才能访问该应用程序。

既不是团队也不是项目上下文: app.mysaas.dev
仅团队上下文: app.mysaas.dev/my-team
团队和项目上下文: app.mysaas.dev/my-team/my-project

我们的路线将如下所示:

route::middleware('auth')->group(function () {

    route::get('/', dashboardcontroller::class);

    route::middleware(appcontextmiddleware::class)->group(function () {

        route::get('/{team}', teamcontroller::class);
        route::get('/{team}/{project}', projectcontroller::class);
    });
});

考虑到命名空间冲突的可能性,这是一种非常不灵活的方法,但它使示例保持简洁。在现实世界的应用程序中,您需要稍微不同地处理这个问题,也许是 anothersaas.dev/teams/my-team/projects/my-project 或 my-team.anothersas.dev/projects/my-project。

我们应该首先看看我们的appcontextmiddleware。该中间件初始化团队上下文以及项目上下文(如果设置):

<?php declare(strict_types=1);

namespace app\http\middleware;

use function honestone\context\context;

class teamcontextmiddleware
{
    public function handle(request $request, closure $next): mixed
    {
        //pull the team parameter from the route
        $teamid = $request->route('team');
        $request->route()->forgetparameter('team');

        $projectid = null;

        //if there's a project, pull that too
        if ($request->route()->hasparamater('project')) {

            $projectid = $request->route('project');
            $request->route()->forgetparameter('project');
        }

        //initialise the context
        context()->initialize(new appresolver($teamid, $projectid));
    }
}

首先,我们从路线中获取团队 id,然后忘记路线参数。一旦参数进入上下文,我们就不需要到达控制器。如果设置了项目 id,我们也会提取它。然后,我们使用 appresolver 传递团队 id 和项目 id(或 null)来初始化上下文:

<?php declare(strict_types=1);

namespace app\context\resolvers;

use app\models\team;
use honeystone\context\contextresolver;
use honeystone\context\contracts\definescontext;

use function honestone\context\context;

class appresolver extends contextresolver
{
    public function __construct(
        private readonly int $teamid,
        private readonly ?int $projectid = null,
    ) {}

    public function define(definescontext $definition): void 
    {
        $definition
            ->require('team', team::class)
            ->accept('project', project::class);
    }

    public function resolveteam(): ?team
    {
        return team::with('members')->find($this->teamid);
    }

    public function resolveproject(): ?project
    {
        return $this->projectid ?: project::with('team')->find($this->projectid);
    }

    public function checkteam(definescontext $definition, team $team): bool
    {
        return $team->members->find(context()->auth()->getuser()) !== null;
    }

    public function checkproject(definescontext $definition, ?project $project): bool
    {
        return $project === null || $project->team->id === $this->teamid;
    }

    public function deserialize(array $data): self
    {
        return new static($data['team'], $data['project']);
    }
}

这里还有更多事情要做。

GitLab CI 流水线迁移工具
GitLab CI 流水线迁移工具

使用 gitlab-ci-local 解析器和 YAML AST 转换来将 GitLab CI .gitlab-ci.yml 流水线转换为 GitHub Actions 工作流程。将 GitLab 阶段、服务和构件映射到等效的 GitHub Actions 语法。

下载

define() 方法负责定义正在解析的上下文。团队是必需的并且必须是 team 模型,并且项目被接受(即可选)并且必须是 project 模型(或 null)。

resolveteam() 将在初始化时在内部调用。它返回 team 或 null。如果出现空响应,contextinitializer 将抛出 couldnotresolverequiredcontextexception。

resolveproject() 也将在初始化时在内部调用。它返回项目或 null。在这种情况下,空响应不会导致异常,因为定义不需要该项目。

解析团队和项目后,contextinitializer 将调用可选的 checkteam() 和 checkproject() 方法。这些方法执行完整性检查。对于 checkteam(),我们确保经过身份验证的用户是团队的成员,对于 checkproject(),我们检查项目是否属于团队。

最后,每个解析器都需要一个 deserialization() 方法。此方法用于恢复序列化上下文。最值得注意的是,当在排队作业中使用上下文时,会发生这种情况。

现在我们的应用程序上下文已经设置好了,我们应该使用它。

访问上下文

像往常一样,我们会保持简单,尽管有点做作。查看团队时,我们希望看到项目列表。我们可以构建我们的 teamcontroller 来处理这样的需求:

<?php declare(strict_types=1);

namespace app\http\controllers;

use illuminate\view\view;

use function compact;
use function honestone\context\context;
use function view;

class teamcontroller
{
    public function __invoke(request $request): view
    {
        $projects = context('team')->projects;

        return view('team', compact('projects'));
    }
}

足够简单。属于当前团队上下文的项目将传递到我们的视图。想象一下,我们现在需要查询项目以获得更专业的视图。我们可以这样做:

<?php declare(strict_types=1);

namespace app\http\controllers;

use illuminate\view\view;

use function compact;
use function honestone\context\context;
use function view;

class projectquerycontroller
{
    public function __invoke(request $request, string $query): view
    {
        $projects = project::where('team_id', context('team')->id)
            ->where('name', 'like', "%$query%")
            ->get();

        return view('queried-projects', compact('projects'));
    }
}

现在变得有点麻烦,而且很容易意外地忘记按团队“确定查询范围”。我们可以使用项目模型上的 belongstocontext 特征来解决这个问题:

<?php declare(strict_types=1);

namespace app\models;

use honeystone\context\models\concerns\belongstocontext;
use illuminate\database\eloquent\model;
use illuminate\database\eloquent\relations\belongsto;

class project extends model
{
    use belongstocontext;

    protected static array $context = ['team'];

    protected $fillable = ['name'];

    public function team(): belongsto
    {
        return $this->belongsto(team::class);
    }
}

所有项目查询现在都将由团队上下文获取,并且当前的团队模型将自动注入到新的项目模型中。

让我们简化该控制器:

<?php declare(strict_types=1);

namespace App\Http\Controllers;

use Illuminate\View\View;

use function compact;
use function view;

class ProjectQueryController
{
    public function __invoke(Request $request, string $query): View
    {
        $projects = Project::where('name', 'like', "%$query%")->get();

        return view('queried-projects', compact('projects'));
    }
}

这就是大家

从这里开始,您只需构建您的应用程序即可。上下文很容易获得,您的查询是有范围的,排队的作业将自动访问调度它们的相同上下文。

并非所有与上下文相关的问题都得到解决。您可能想要创建一些验证宏来为您的验证规则提供一些上下文,并且不要忘记手动查询不会自动应用上下文。

如果您计划在下一个项目中使用此软件包,我们很乐意听取您的意见。随时欢迎反馈和贡献。

您可以查看 github 存储库以获取其他文档。如果您觉得我们的套餐有用,请给我们一颗星。

下次见..


本文最初发布于 honeystone 博客。如果您喜欢我们的文章,请考虑在那里查看我们的更多内容。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

laravel git composer

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

917

10

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

2024.04.09

875

9

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

2548

10

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.10

5261

7

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

2025.08.05

7830

22

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

2025.08.05

5116

13

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

2025.08.05

9589

7

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

2026.03.04

1556

29

Laravel 框架安装指南
Laravel 框架安装指南

本指南详解 Laravel 框架安装全流程,涵盖 PHP 8.1+ 环境配置、Composer 依赖管理工具安装及国内镜像源优化。重点演示使用 composer create-project 命令创建 Laravel 10/11 项目,解决常见安装错误与依赖冲突。从环境搭建到项目初始化,助您快速完成 Laravel 开发环境部署,为后续 Web 应用开发奠定基础。适合 PHP 初学者与框架迁移开发者参考。

2026.04.09

235

6

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 234人学习

Composer手册
Composer手册

共0课时 | 0人学习