2

我目前正准备设计一个 C 或 C++ 库来访问现有的 Rest 服务,但我不确定:

我见过的大多数这样的 API 客户端库只是提供了一种非常接近 ReST API 的调用方式,您必须阅读 ReST API 文档才能使用它。它们并不是真正用语言的原生风格编写的,IMO。他们基本上包装了一个 http 库,可能是一个 XML/JSON 库并处理一些特殊的东西,比如 auth:

风格1:

paramList.add( "name", "Joe" )
response = makeARestCall( POST, "path/to/resource", paramList, miscAuthData );
if( result.code == 200 ) {
    //success
    xml = response.getXml();
    somethingWeCareAbout = xpath.parse( xml, "response/something/we/care/about" );
    print somethingWeCareAbout
} else {
    print "Something went wrong"
}

对我来说,使用语言的约定而不是 API 似乎更自然。考虑将 API 用作调用函数而不是访问资源。

风格2:

try {
   Api.setName( UserId, "Joe" );
   print Api.getSomethingWeCareAbout();
} catch( ApiException e ) {
   print e.getMessage();
}

我用后一种风格编写了 API 库,它们需要做更多的工作,但我发现它们更自然地使用和集成到应用程序中,特别是对于复杂的 ReST API,但我在这方面并不是很有经验。

一种风格明显优于另一种风格吗?除了易于开发之外,是否有其他原因,大多数似乎都是以第一种风格编写的?

这个库肯定会在多线程应用程序和 UI 中使用,所以请记住线程。

4

1 回答 1

1

在考虑了这一点之后,我自己的问题的部分答案是第一种样式可能更容易多线程。使用该库的人可以创建如下函数:

void asyncRestCall( Method method, String resource, map<String,String> parameters, misc misc, function onCompletion ) {
    //fork a new thread
    ...

    //do the call
    result = makeARestCall( method, resource, parameters misc );

    //back in original thread
    ...

    onCompletion( result );
}

而对于样式 2 中的每个函数调用都执行一次,则工作量要大得多。

于 2012-08-16T19:25:33.680 回答