在 Magento 2 REST API 中检查用户类型（客户或访客）

Magento 用户类型常量

在 Magento 中，用户类型通过存储在 MagentoAuthorityModelUserContextInterface 中的常量来定义。这些常量用于确定用户的访问级别，从而帮助开发人员实现基于角色的功能。

Magento 用户类型概述

Magento 提供了多种预定义的用户类型，用于区分不同系统用户的访问权限和操作范围。

了解 Magento 中的用户类型

每种用户类型在 Magento 中都有其特定的用途，以下是主要用户类型的详细说明：

管理员用户

拥有管理产品、订单和系统设置的后端访问权限。
权限可以通过 Magento 的角色管理功能进行控制。
通常具有最高级别的控制权限。

客户用户

表示在商店中注册并拥有账户的用户。
可以下订单、跟踪发货并访问保存的个人数据。
通过客户群管理，支持个性化促销和定价。

访客用户

未登录账户的用户，通常用于浏览商店。
可以将商品添加到购物车并以访客身份结账。
Magento 支持禁用特定商店的访客结账功能。

如何在 Magento 代码中使用用户类型常量？

开发人员可以通过以下代码以编程方式检索用户类型：

use MagentoAuthorizationModelUserContextInterface;

public function getUserType(UserContextInterface $userContext)
{
    $userType = $userContext->getUserType();    switch ($userType) {
        case UserContextInterface::USER_TYPE_ADMIN:
            return "管理员用户";
        case UserContextInterface::USER_TYPE_CUSTOMER:
            return "客户用户";
        case UserContextInterface::USER_TYPE_GUEST:
            return "访客用户";
        case UserContextInterface::USER_TYPE_INTEGRATION:
            return "集成用户";
        default:
            return "未知用户类型";
    }
}

在 Magento 2 中实现用户类型检测

为了检测当前用户是客户还是访客，可以实现以下自定义类。

创建用户类型检测的自定义模型

在以下路径创建新模型文件：

app/code/Emmo/CustomerGuestUserType/Model/CustomerGuestAPI.php

添加以下代码：

namespace EmmoCustomerGuestUserTypeModel;

use MagentoAuthorizationModelUserContextInterface;class CustomerGuestAPI
{
    /**
     * @var UserContextInterface
     */
    private $userContextType;    /**
     * 构造函数
     *
     * @param UserContextInterface $userContextType
     */
    public function __construct(UserContextInterface $userContextType)
    {
        $this->userContextType = $userContextType;
    }    /**
     * 获取客户或访客用户类型
     *
     * @return int|null
     */
    public function getCustomerOrGuestUserType(): ?int
    {
        return $this->userContextType->getUserType();
    }
}

如何使用上述类

调用方法以获取用户类型：

echo $userType = $this->getCustomerOrGuestUserType();

在控制器或块中使用时，需要注入该模型并调用相关方法。如果登录的客户访问此方法，将返回客户类型；如果是访客用户访问，则返回访客类型。

Magento 2 用户类型处理技巧

在处理用户类型时，可以参考以下技巧：

检查用户上下文：在应用访问限制之前，始终验证用户上下文。
使用依赖注入（DI）：通过 DI 获取用户类型，而不是直接实例化类。
会话存储：对于需要多次请求的场景，可以将用户类型存储在会话中。
API 身份验证：确保基于 API 的用户身份验证严格遵循角色权限。

在 REST API 端点中实现用户类型检查

要在 REST API 中实现用户类型检查，可以创建一个自定义端点，返回当前用户类型。

步骤 1：定义 Web API 路由

在模块的 etc/webapi.xml 文件中定义路由。

步骤 2：创建接口

在 Api/UserTypeInterface.php 中定义 API 接口：

namespace EmmoCustomerGuestUserTypeApi;

interface UserTypeInterface
{
    /**
     * 获取用户类型
     *
     * @return int
     */
    public function getUserType();
}

步骤 3：实现 API 接口

创建 API 模型类 Model/UserType.php，并实现接口逻辑。

步骤 4：将 API 模型声明为服务

在 di.xml 文件中注册模型为服务。完成后，调用 API/V1/custom/get-user-type 将返回当前用户类型。

Magento 2 中处理用户类型的最佳实践

在开发过程中，遵循以下最佳实践可以提高性能和安全性：

1. 使用用户类型缓存优化性能

频繁获取用户类型可能会降低性能，特别是在处理登录客户时。通过缓存用户类型，可以减少 API 调用并提高响应速度。

减少 API 调用：避免重复请求用户类型。
增强会话持久性：确保用户类型在整个会话中保持一致。
降低数据库负载：通过内存存储用户类型来优化性能。

2. 基于用户类型限制 API 访问

并非所有用户都应访问每个 API 端点。根据用户类型限制访问可以提高安全性。

public function execute()
{
    $userType = $this->customerGuestUserAPI->getCustomerOrGuestUserType();

    if ($userType !== UserContextInterface::USER_TYPE_CUSTOMER) {
        throw new MagentoFrameworkExceptionLocalizedException(__('拒绝访问'));
    }    return ["message" => "欢迎光临，客户！"];
}

防止未经授权的访问：限制访客和管理员访问敏感端点。
增强安全性：通过严格的身份验证规则保护数据。
提高性能：减少无效 API 调用。

3. 使用中间件进行动态身份验证

通过中间件可以在执行请求之前进行用户验证，从而实现动态访问控制。

4. 调试用户类型检测问题

常见问题及解决方案：

用户类型返回 null：确保用户会话已启动，并正确使用 UserContextInterface。
依赖项缺失：检查 di.xml 文件中是否正确注入了依赖项。
身份验证失败：验证 API 请求头是否包含正确的身份验证信息。

结论

在 Magento 2 REST API 中检测用户类型（客户或访客）是实现访问控制和个性化体验的关键步骤。通过利用 UserContextInterface，开发人员可以有效区分登录客户、访客、管理员或集成用户，从而优化 API 安全性和性能。

通过实施缓存、访问控制中间件和调试技术，您可以显著提升 Magento 2 商店的 API 体验，为用户提供更安全、高效的服务。在不断发展的电子商务环境中，优化 API 策略将帮助企业保持竞争优势。

原文链接: https://emmo.net.co/articles/post/checking-user-type-customer-or-guest-in-magento-2-rest-api.html