如何通过重用单个API函数来调用不同的操作

How to invoque different operations by reusing a single API function?

本文关键字:调用 操作 函数 何通过 单个 API      更新时间:2023-10-16

我的API函数execute_api()应执行以下特定操作:

  • 方法名称:view/create/update/delete/update_all/delete_all
  • 方法类型:get/post

我希望我的代码在execute_api()中重用相同的逻辑,但要调整执行以实现上面列出的任何操作。这里有一个快速代码片段:

    void execute_api()
    {
        void fill_request_vo( Request& req); // Request is a .oml file
        void calculate_url(Request& req); // calculate the url for the server to hit depending upon the operation selected
        void calculate_header(Request& req); // calculate header for the server to hit depending upon the operation selected
        // execute the services based on some conditions 
        // ResponseVO will be filled in case of success scenerio
        void parse_response(Response& res); // does some logic with the response
     }

问题:简而言之,我需要一种更好的方法来对任何方法类型/名称重用这个函数,只需更改参数就是Request.oml.

以下是我对这个问题的解决方案,但需要一些更好的建议。如果你觉得它很长,请忽略下面

我的解决方案:

在Request中填写方法名称(method_name为enum-view/create/update/delete/update_all/delete_all)。因此,根据所选的方法名称,我需要计算url和头。

    switch(req.get_method_name())
    {
    case add:
     // do something - calculate url
     break;
     case view :
     // do something - calculate url
     break;
     .....
     ....
    }

我想对头重复同样的设计,但取决于method_type(get/post)

    switch(req.get_method_type())
    {
    case get:
    // prepare headers accordingly
    break;
    case post:
    // prepare headers accordingly
    break;
    ...
    }

问题:有什么方法可以做到这一点吗?我们需要继续为新的操作增加开关。。因此,我正在寻找的其他建议

很抱歉问了这么长时间。如果有什么不清楚的地方,请告诉我。

我认为您可以在这里使用Command模式。参考http://en.wikipedia.org/wiki/Command_pattern了解更多详细信息。

这个想法是创建一个基类Request(也许),它公开了一个方法execute(),您可以调用它。

您可以扩展Request基类并专门处理方法类型等。所有与头格式和URL相关的复杂代码都可以封装在专门的Request类中。所以,您的execute_api()看起来像

execute_api() {
    ....
    ....
    Response& resp = request.execute(); //Generic for any request type
}

这种模式将确保您的api调度请求不会随着您添加的任何新方法类型而更改。您也可以将这个想法扩展到Response类。

希望能有所帮助。

编辑:

对于请求对象的创建,我们可以使用SimpleFactory编程习惯用法。与工厂方法模式相比,这一处理方式有所不同

因此,切换情况将转移到SimpleRequestFactory,从而本地化任何未来增强所需的代码更改。

上面的代码可能如下所示:

execute_api() {
....
Request& request = SimpleRequestFactory::getInstance()->createRequestObj();  // Singleton SimpleRequestFactory
Response& resp = request.execute(); //Generic for any request type
}

您可以通过引入另一个抽象级别来进一步改进它(例如),通过创建AbstractRequestFactory类,该类可以有PostRequestFactory、GetRequestFactory等子类。因此,execute_api可能看起来如下:

execute_api( AbstractRequestFactory& factory ) {
....
Request& request = factory.getRequestObject(/*pass req params*/);
Response& res = request.execute(); //Generic for any request type
}