如何使用单个API函数调用不同的操作?

时间:2015-02-12 07:20:08

标签: c++ function switch-statement api-design

我的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)。 因此,根据所选的方法名称,我需要计算网址和标题。

    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;
    ...
    }

问题:有没有办法实现这个目标?我们需要继续为新操作添加开关..因此,我正在寻找其他建议

很抱歉这么久的查询。如果有什么不清楚,请告诉我。

1 个答案:

答案 0 :(得分:6)

我认为你可以在这里使用Command模式。有关详细信息,请参阅http://en.wikipedia.org/wiki/Command_pattern

这个想法是你创建了一个Base类,Request(可能),它暴露了一个方法execute(),你可以调用它。

您可以扩展Request基类并专注于方法类型等。所有与标题形成和URL相关的复杂代码都可以在专门的Request类中封装。所以,你的execute_api()看起来像

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

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

希望它有所帮助。

编辑:

对于请求对象创建,我们可以使用Simple Factory编程习惯用法。与Factory Method Pattern

相比,这种处理方式不同

因此,switch-cases将转移到 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
}