【问题标题】:Laravel Controller -> API classLaravel 控制器 -> API 类
【发布时间】:2018-10-23 17:50:29
【问题描述】:

我正在努力按照最佳做法正确执行此操作。这可能很难解释,但我会在这里尽力而为。

我有一个外部 API,我需要对其进行很多不同的调用。所以我现在所做的是在 App 文件夹中创建一个名为 Api.php 的类。它使用 Guzzle 进行 API 调用。

在视图的 Controller 中,我在所需的函数中创建 Api 对象,并在 API 类中调用相应的函数。

控制器

public function uploadDevice(Request $request)
{
  ## Validation etc is performed

  // Calling the API
  $api = new Api();
  $api->uploadDevice();
}

Api.php

class Api
{

    private $token;

    public function __construct(){}

    public function checkIfHasToken(){}

    public function getTokenFromSession(){}

    public function getFreshToken(){}

    public function uploadDevice(){}

}

一些问题

  1. checkIfHasToken() 需要在每个请求之前调用。应该在constructor、first in each function doing API calls还是directly from the Controller完成?
  2. 例外:我应该在哪里进行 Try/catch 等操作?应该在需要的 Api 类中完成,还是在 Controller 中通过调用 API 类中的每个函数并将其包装在 try/catch 中来完成?
  3. 重定向:我想重定向回请求来自的路由,其中​​包含所有可能的错误或成功消息。因此,如果我有一个 try/catch,我想重定向包含 catch 的结果。把这个逻辑放在哪里?从嵌套函数重定向似乎不起作用。那么我又要从Controller中一一调用Api类中的每一个函数,并在Controller中分别处理异常/错误/验证?

也许我在这方面想得太多,或者让它变得比需要的更复杂。不确定了。

【问题讨论】:

  • 您正在调用的 API(如 uploadDevice())是否会转到外部服务?
  • 我使用Adapter Pattern (wrapper) 进行任何类型的 API 集成,您是否检查过您尝试使用的 API 没有现成的包?我也使用容器来解决它,所以没有new Api;,而是在构造函数中对其进行类型提示。如果它不是简单的类,则需要将其绑定到服务提供者中。
  • @DevinGray 是的。 uploadDevice 使用标头中的令牌向 Guzzle 发出 API 请求。
  • 那么我相信您正在寻求创建一个服务/助手类作为最佳实践。给我几分钟来建立答案或与我聊天,我会告诉你一些想法
  • @Kyslik 一点也不。 API 适用于 Cisco APIC-EM

标签: php laravel guzzle


【解决方案1】:
// Controller
public function __construct(ApiService $apiService)
{
    $this->api = $apiService;
}


public function uploadDevice(Request $request)
{
    // Ensure that the user has a token in a custom HTTP request or in a middleware somewhere
    try {
        $this->api->uploadDevice();
    }
    catch (Exception $exception){
        return redirect()->back();
        //You can include errors from $exception here.
    }
}

// Service
class ApiService
{

    public function uploadDevice()
    {
        return 'I did a thing';
    }

}

说明

Laravel 有很多方法可以做同样的事情,这完全取决于您需要什么以及您希望应用程序如何扩展。

检查令牌是否存在或有效应该在中间件中完成。

try catch 可以在任何地方,具体取决于您需要在异常中看到多少,通常只在控制器中是可以的,但您可以 以多种方式做到这一点。我个人喜欢做一个事件监听器 对于任何 http 错误。

从控制器返回重定向总是可以重定向到调用控制器的地方

【讨论】:

  • 谢谢。午饭后回来。
  • 中间件是只检查令牌是否存在于会话中(真/假)还是会同时获取它?
  • 通常我会为 API 令牌构建一个 JWT 帮助程序,运行许多函数,检查是否存在,检查是否有效,如果不检查刷新,检索新的等。中间件是一个类,所以你可以在其中做很多事情,但它们不应该太重。大多数 JWT 包已经内置了这个
【解决方案2】:

需要在每次请求之前调用 checkIfHasToken()。应该 它在构造函数中完成,首先在每个函数中进行 API 调用 还是直接来自控制器?

如果需要为每个请求调用它,我建议将其作为中间件,因为它是为此目的而制作的。

例外:我应该在哪里做 Try/catch 等?是否应该这样做 在需要它的 Api 类中或通过调用在 Controller 中 API类中的每个函数并将其包装在 尝试/捕捉?

这取决于,如果您希望能够在发生异常时控制输出,那么您可能希望它在您的控制器中。如果您可以在异常发生时编写某些操作(例如返回不成功),请在较低级别(api)中执行。

重定向:我想重定向回请求来自的路由 包括所有可能的错误或成功消息。所以如果我有一个 try/catch 我想重定向包含 catch 的结果。 把这个逻辑放在哪里?从嵌套函数重定向不 似乎工作。那么我回到调用每个函数 Controller中的Api类一一处理 异常/错误/验证分别在 Controller 中?

您可以返回 redirect()->back() 作为响应返回,显示错误的最佳方式是将它们包含在某处。我建议为此使用session()->flash()。这些调用可以通过 try/catch 进行。

【讨论】:

    猜你喜欢
    • 2013-12-09
    • 2015-11-02
    • 1970-01-01
    • 2020-07-07
    • 2017-09-20
    • 2021-09-03
    • 2021-10-24
    • 2019-01-15
    • 2018-07-15
    相关资源
    最近更新 更多