使用 shared_ptr 作为输出参数

Question

我正在开发一个从 DLL 导出多个类的 C++ API。

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

• 所有函数都返回错误代码。
• 输出参数用于附加返回值。
• 指针传递用于输出参数。
• 按常量引用传递用于输入参数（基本类型按值传递）。
• 当客户端应该取得输出参数的所有权时使用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 是否可以节省，或者我应该注意哪些问题？

Answer 1

这很好，但我会问在这种情况下是否真的需要共享指针。主要是因为您无法以任何理智的方式从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 ..
}