8

考虑到清洁架构的定义,尤其是描述控制器、用例交互器和演示者之间关系的小流程图,我不确定我是否正确理解了“用例输出端口”应该是什么。

清洁架构,如端口/适配器架构,区分主端口(方法)和辅助端口(由适配器实现的接口)。按照通信流程,我希望“用例输入端口”是一个主要端口(因此,只是一个方法),而“用例输出端口”是一个要实现的接口,也许是一个构造函数参数,采用实际的适配器,以便交互者可以使用它。

做一个代码示例,这可能是控制器代码:

Presenter presenter = new Presenter();
Repository repository = new Repository();
UseCase useCase = new UseCase(presenter, repository);
useCase->doSomething();

演示者界面:

// Use Case Output Port
interface Presenter
{
    public void present(Data data);
}

最后,交互器本身:

class UseCase
{
    private Repository repository;
    private Presenter presenter;

    public UseCase(Repository repository, Presenter presenter)
    {
        this.repository = repository;
        this.presenter = presenter;
    }

    // Use Case Input Port
    public void doSomething()
    {
        Data data = this.repository.getData();
        this.presenter.present(data);
    }
}

上述图表本身似乎证实了这种解释,其中控制器和输入端口之间的关系由带有“尖”头的实心箭头表示(UML 为“关联”,意思是“有一个”,其中控制器“有”用例),而演示者和输出端口之间的关系由带有“白色”头部的实心箭头表示(UML 表示“继承”,不是“实现”,但可能就是这样反正意思)。

但是,我对这种方法的问题是用例必须处理演示本身。现在,我看到Presenter接口的目的是足够抽象以表示几种不同类型的演示者(GUI、Web、CLI 等),并且它实际上只是意味着“输出”,这是用例可能的含义很好,但我仍然对它并不完全有信心。

现在,在网上寻找干净架构的应用程序,我似乎只发现人们将输出端口解释为返回一些 DTO 的方法。这将是这样的:

Repository repository = new Repository();
UseCase useCase = new UseCase(repository);
Data data = useCase.getData();
Presenter presenter = new Presenter();
presenter.present(data);

// I'm omitting the changes to the classes, which are fairly obvious

这很有吸引力,因为我们正在将“调用”表示的责任从用例中移出,因此用例不再关心知道如何处理数据,而只是提供数据。此外,在这种情况下,我们仍然没有打破依赖规则,因为用例仍然不知道外层的任何信息。

但是,用例不再控制执行实际演示的时刻(这可能很有用,例如在那一刻做额外的事情,比如记录,或者在必要时完全中止它)。另外,请注意我们丢失了用例输入端口,因为现在控制器只使用getData()方法(这是我们的新输出端口)。此外,在我看来,我们在这里打破了“告诉,不问”的原则,因为我们要求交互者提供一些数据来处理它,而不是告诉它在第一名。

那么,这两种选择中的任何一种都是根据清洁架构对用例输出端口的“正确”解释吗?它们都可行吗?

对另一个问题的回答中,Robert Martin 准确地描述了交互者根据读取请求调用演示者的用例。没有提到MVC,MVVC等,所以我猜Clean Architecture一般不能很好地与MVC配合使用?

单击地图会导致调用 placePinController。它收集点击的位置和任何其他上下文数据,构造一个 placePinRequest 数据结构并将其传递给 PlacePinInteractor,后者检查 pin 的位置,在必要时对其进行验证,创建一个 Place 实体来记录 pin,构造一个 EditPlaceReponse对象并将其传递给 EditPlacePresenter,它会显示位置编辑器屏幕。

一种可能的解释是,传统上会进入控制器的应用程序逻辑在这里被移动到交互器,因为我们不希望任何应用程序逻辑泄漏到应用程序层之外。因此,这里的模型不是调用演示者,因为交互者不是模型,而是控制器的实际实现。模型只是被传递的数据结构。这似乎得到了证实:

该层中的软件是一组适配器,可将数据从最适合用例和实体的格式转换为最适合某些外部机构(如数据库或 Web)的格式。

从原始文章中,谈论接口适配器。由于控制器必须只是将一种数据格式转换为另一种数据格式的瘦适配器,因此它不能包含任何应用程序逻辑,因此将其移至交互器。

4

4 回答 4

5

在与您的问题相关的讨论中,鲍勃叔叔在他的清洁架构中解释了演示者的目的:

鉴于此代码示例:

namespace Some\Controller;

class UserController extends Controller {
    public function registerAction() {
        // Build the Request object
        $request = new RegisterRequest();
        $request->name = $this->getRequest()->get('username');
        $request->pass = $this->getRequest()->get('password');

        // Build the Interactor
        $usecase = new RegisterUser();

        // Execute the Interactors method and retrieve the response
        $response = $usecase->register($request);

        // Pass the result to the view
        $this->render(
            '/user/registration/template.html.twig', 
            array('id' =>  $response->getId()
        );
    }
}

鲍勃叔叔说:

"演示者的目的是将用例与 UI 的格式分离。 在您的示例中,$response 变量由交互器创建,但由视图使用。这将交互器与视图耦合。例如, 假设 $response 对象中的一个字段是日期。该字段将是一个二进制日期对象,可以以许多不同的日期格式呈现。需要一个非常具体的日期格式,可能是 DD/MM/YYYY。创建格式是谁的责任?如果交互者创建了该格式,那么它对 View 了解太多。但如果视图采用二进制日期对象,那么它对交互器了解太多。

“演示者的工作是采取来自响应对象的数据并将其格式化为视图。 视图和交互者都不知道彼此的格式。

——鲍勃叔叔

鉴于鲍勃叔叔的回答,我认为我们是否执行选项#1(让交互者使用演示者)并不重要......

class UseCase
{
    private Presenter presenter;
    private Repository repository;

    public UseCase(Repository repository, Presenter presenter)
    {
        this.presenter = presenter;
        this.repository = repository;
    }

    public void Execute(Request request)
    {
        ...
        Response response = new Response() {...}
        this.presenter.Show(response);
    }
}

...或者我们执行选项#2(让交互者返回响应,在控制器内创建一个演示者,然后将响应传递给演示者)...

class Controller
{
    public void ExecuteUseCase(Data data)
    {
        Request request = ...
        UseCase useCase = new UseCase(repository);
        Response response = useCase.Execute(request);
        Presenter presenter = new Presenter();
        presenter.Show(response);
    }
}

就个人而言,我更喜欢选项#1 因为我希望能够控制何时interactor 显示数据和错误消息,如下例所示:

class UseCase
{
    private Presenter presenter;
    private Repository repository;

    public UseCase(Repository repository, Presenter presenter)
    {
        this.presenter = presenter;
        this.repository = repository;
    }

    public void Execute(Request request)
    {
        if (<invalid request>) 
        {
            this.presenter.ShowError("...");
            return;
        }

        if (<there is another error>) 
        {
            this.presenter.ShowError("another error...");
            return;
        }

        ...
        Response response = new Response() {...}
        this.presenter.Show(response);
    }
}

...我希望能够在交互器内部而不是外部执行if/else与演示相关的这些操作。interactor

另一方面,如果我们执行选项#2,我们将不得不将错误消息存储在对象中,将该对象从 中response返回到 中,然后解析对象...responseinteractorcontrollercontroller response

class UseCase
{
    public Response Execute(Request request)
    {
        Response response = new Response();
        if (<invalid request>) 
        {
            response.AddError("...");
        }

        if (<there is another error>) 
        {
            response.AddError("another error...");
        }

        if (response.HasNoErrors)
        {
            response.Whatever = ...
        }

        ...
        return response;
    }
}
class Controller
{
    private UseCase useCase;

    public Controller(UseCase useCase)
    {
        this.useCase = useCase;
    }

    public void ExecuteUseCase(Data data)
    {
        Request request = new Request() 
        {
            Whatever = data.whatever,
        };
        Response response = useCase.Execute(request);
        Presenter presenter = new Presenter();
        if (response.ErrorMessages.Count > 0)
        {
            if (response.ErrorMessages.Contains(<invalid request>))
            {
                presenter.ShowError("...");
            }
            else if (response.ErrorMessages.Contains("another error")
            {
                presenter.ShowError("another error...");
            }
        }
        else
        {
            presenter.Show(response);
        }
    }
}

我不喜欢response在.controllerinteractorcontroller

此外,如果我们稍后决定重用我们interactor使用控制台呈现数据,例如,我们必须记住将所有这些数据复制粘贴if/elsecontroller我们的控制台应用程序中。

// in the controller for our console app
if (response.ErrorMessages.Count > 0)
{
    if (response.ErrorMessages.Contains(<invalid request>))
    {
        presenterForConsole.ShowError("...");
    }
    else if (response.ErrorMessages.Contains("another error")
    {
        presenterForConsole.ShowError("another error...");
    }
}
else
{
    presenterForConsole.Present(response);
}

如果我们使用选项#1,我们将if/else 只在一个地方拥有它:interactor.


如果您使用的是 ASP.NET MVC(或其他类似的 MVC 框架),选项 #2 是更简单的方法。

但是我们仍然可以在那种环境中执行选项#1。这是在 ASP.NET MVC 中执行选项 #1 的示例:

(请注意,我们需要public IActionResult Result在我们的 ASP.NET MVC 应用程序的演示者中拥有)

class UseCase
{
    private Repository repository;

    public UseCase(Repository repository)
    {
        this.repository = repository;
    }

    public void Execute(Request request, Presenter presenter)
    {
        if (<invalid request>) 
        {
            this.presenter.ShowError("...");
            return;
        }

        if (<there is another error>) 
        {
            this.presenter.ShowError("another error...");
            return;
        }

        ...
        Response response = new Response() {...}
        this.presenter.Show(response);
    }
}
// controller for ASP.NET app

class AspNetController
{
    private UseCase useCase;

    public AspNetController(UseCase useCase)
    {
        this.useCase = useCase;
    }

    [HttpPost("dosomething")]
    public void ExecuteUseCase(Data data)
    {
        Request request = new Request() 
        {
            Whatever = data.whatever,
        };
        var presenter = new AspNetPresenter();
        useCase.Execute(request, presenter);
        return presenter.Result;
    }
}
// presenter for ASP.NET app

public class AspNetPresenter
{
    public IActionResult Result { get; private set; }

    public AspNetPresenter(...)
    {
    }

    public async void Show(Response response)
    {
        Result = new OkObjectResult(new { });
    }

    public void ShowError(string errorMessage)
    {
        Result = new BadRequestObjectResult(errorMessage);
    }
}

(请注意,我们需要public IActionResult Result在我们的 ASP.NET MVC 应用程序的演示者中拥有)

如果我们决定为控制台创建另一个应用程序,我们可以重用UseCase上面的内容ControllerPresenter为控制台创建 and :

// controller for console app

class ConsoleController
{    
    public void ExecuteUseCase(Data data)
    {
        Request request = new Request() 
        {
            Whatever = data.whatever,
        };
        var presenter = new ConsolePresenter();
        useCase.Execute(request, presenter);
    }
}
// presenter for console app

public class ConsolePresenter
{
    public ConsolePresenter(...)
    {
    }

    public async void Show(Response response)
    {
        // write response to console
    }

    public void ShowError(string errorMessage)
    {
        Console.WriteLine("Error: " + errorMessage);
    }
}

(请注意,我们public IActionResult Result的控制台应用程序的演示者中没有)

于 2019-05-31T15:01:51.600 回答
0

符合CQS原则(命令查询分离原则)。

“执行”方法不应返回值,因为它执行命令。因此,响应将提供给您的“execute”方法将接收的实例,然后从这里,您将调用此参数“presenter”,它实现了 UseCase 层中描述的适当接口。

所以从控制器,给定:

private IMyUseCase myUseCase; //Injected in Controller constructor

private IMyUseCaseResponseHandler presenter = new MyPresenter();

MyUseCaseRequest myUseCaseRequest = new MyUseCaseRequest();

不要这样做:

MyUseCaseResponse myUseCaseResponse = 
    this.myUseCase.handleRequest(this.myUseCaseRequest); //doesn't match CQS

this.presenter.present(myUseCaseResponse);

但这样做:

this.myUseCase.handleRequest(this.myUseCaseRequest, this.presenter);

UseCase 将调用名为“present”的 IMyUseCaseResponseHandler 方法,将 MyUseCaseResponse 实例传递给它。

于 2021-05-19T21:41:34.083 回答
0

文章说用例独立于 gui(演示者),因此控制器的工作是与用例(也称为服务或工作流)和演示者交谈

[2017-08-29更新]

如果模型使用演示者接口,这不再是一个干净的 mvc、mvp 或 mvvm 架构,而是其他东西。

于 2017-08-28T17:01:24.517 回答
0

我认为你已经很好地解释了你的问题和你对 k3b 答案的评论中的所有内容。

关键方面是:控制器和演示者是同一个类吗?

如果你使用 Asp.Net MVC 作为 web 框架,例如控制器和演示者是同一个类。在这种情况下,就不需要接口意义上的输出端口。控制器只是调用交互器上的方法并获取一些输出数据作为返回值。

如果控制器和演示者分开类,则需要一种“将结果传递给演示者”的方法。为此,需要输出端口。输出端口实际上是在用例圈中定义并在接口适配器圈中实现的接口。

两种方法都可行

如果您对更详细的示例感兴趣,可以查看我的博客系列:https ://plainionist.github.io/Implementing-Clean-Architecture-UseCases/

更新:我在此处添加了一篇博文以深入探讨此讨论:https ://plainionist.github.io/Implementing-Clean-Architecture-Controller-Presenter/

于 2018-02-12T12:26:10.177 回答