使用shared_ptr作为输出参数

Using shared_ptr as output parameter

本文关键字：输出 参数 ptr shared 使用      更新时间：2023-10-16

我正在开发一个C++API，它从DLL导出几个类。

公共类接口应该遵循以下约定：

  • 所有函数都返回一个错误代码
  • 输出参数用于其他返回值
  • 传递指针用于输出参数
  • 传递常量引用用于输入参数（基元类型的传递值）
  • 当客户端应该获得输出参数的所有权时，使用shared_ptr，否则使用普通指针

示例接口：

typedef std::shared_ptr<Object> ObjectPtr;
class APIClass
{
    ErrorCode SetSomething(int i);
    ErrorCode IsSomethingSet(bool* ask);
    ErrorCode DoSomething();
    ErrorCode GetSomething(ObjectPtr* outObj);
}

示例用法：

ErrorCode res;
ObjectPtr obj;
res = myApiClass->GetSomething(&obj);

GetSomething实现：

ErrorCode APIClass::GetSomething(ObjectPtr* outObj)
{
   ObjectPtr temp(new Object(), CleanUpFunction<Object>);
   // Do something with object temp.
   ...
   *outObj= temp;
   return OK;
}

以这种方式使用shared_ptr是否保存，或者是否存在我应该注意的可能问题？

这很好，但我想问在这种情况下是否真的需要共享指针。主要是因为你不能以任何理智的方式从shared_ptr释放指针。。。这可能会导致以后出现问题。shared_ptr实际上意味着对底层资源的未指定或共享所有权。

我通常会记录该功能，并使用以下内容：

// Caller must delete the outObj once done.
ErrorCode APIClass::GetSomething( Object* & outObj )
{
  // I use auto_ptr so I can release it later...
  // Mostly I hate auto_ptr, but for this its invaluable.
  auto_ptr<Object> obj( new Object );
  ...
  outObj = obj.release();
  return OK;
}

这样，客户端就可以决定将指针存储到什么位置，而且很明显，对象的所有权会传递给调用者。

然后，客户端代码可以使用适当的容器。

Object * obj_raw;
ErrorCode ec = apiClass.GetSomething( obj_raw )
if( ec!=OK ) { .. do something with ec .. }
shared_ptr<Object> obj( obj_raw );

或

auto_ptr<Object> obj( obj_raw );

或

scoped_ptr<Object> obj( obj_raw);

等等。

请注意，如果您将函数定义更改为：，这可以变得更整洁

// Caller must delete the return value.
// On error, NULL is returned and e filled in appropriately.
Object* APIClass::GetSomething( ErrorCode & e )
{
   auto_ptr<Object> obj( new Object );
   ..
   e = OK;
   return obj.release();
}
//Now using it looks like this:
ErrorCode ec;
shared_ptr<Object> obj( apiObject.GetSomething(ec) ); 
if(!obj)
{
   .. do something with ec ..
}
相关文章：