哪种结果模式最适合公共 API？为什么？

Question

在公共 API 中返回函数调用结果有几种不同的常见模式。哪种方法是最好的方法并不明显。对于最佳实践是否存在普遍共识，或者至少有令人信服的理由来说明为什么一种模式比其他模式更好？

更新 通过公共 API，我指的是公开给依赖程序集的公共成员。我并非专门指作为 Web 服务公开公开的 API。我们可以假设客户端正在使用.NET。

我在下面编写了一个示例类来说明返回值的不同模式，并且我对它们进行了注释，表达了我对每个模式的关注。

这是一个有点长的问题，但我确信我不是唯一考虑过这个问题的人，希望这个问题对其他人来说会很有趣。

public class PublicApi<T>       //  I am using the class constraint on T, because 
    where T: class              //  I already understand that using out parameters
{                               //  on ValueTypes is discouraged (http://msdn.microsoft.com/en-us/library/ms182131.aspx)

    private readonly Func<object, bool> _validate;
    private readonly Func<object, T> _getMethod;

    public PublicApi(Func<object,bool> validate, Func<object,T> getMethod)
    {
        if(validate== null)
        {
            throw new ArgumentNullException("validate");
        }
        if(getMethod== null)
        {
            throw new ArgumentNullException("getMethod");
        }
        _validate = validate;
        _getMethod = getMethod;
    }

    //  This is the most intuitive signature, but it is unclear
    //  if the function worked as intended, so the caller has to
    //  validate that the function worked, which can complicates 
    //  the client's code, and possibly cause code repetition if 
    //  the validation occurs from within the API's method call.  
    //  It also may be unclear to the client whether or not this 
    //  method will cause exceptions.
    public T Get(object argument)
    {
        if(_validate(argument))
        {
            return _getMethod(argument);
        }
        throw new InvalidOperationException("Invalid argument.");
    }

    //  This fixes some of the problems in the previous method, but 
    //  introduces an out parameter, which can be controversial.
    //  It also seems to imply that the method will not every throw 
    //  an exception, and I'm not certain in what conditions that 
    //  implication is a good idea.
    public bool TryGet(object argument, out T entity)
    {
        if(_validate(argument))
        {
            entity = _getMethod(argument);
            return true;
        }
        entity = null;
        return false;
    }

    //  This is like the last one, but introduces a second out parameter to make
    //  any potential exceptions explicit.  
    public bool TryGet(object argument, out T entity, out Exception exception)
    {
        try
        {
            if (_validate(argument))
            {
                entity = _getMethod(argument);
                exception = null;
                return true;
            }
            entity = null;
            exception = null;   // It doesn't seem appropriate to throw an exception here
            return false;
        }
        catch(Exception ex)
        {
            entity = null;
            exception = ex;
            return false;
        }
    }

    //  The idea here is the same as the "bool TryGet(object argument, out T entity)" 
    //  method, but because of the Tuple class does not rely on an out parameter.
    public Tuple<T,bool> GetTuple(object argument)
    {
        //equivalent to:
        T entity;
        bool success = this.TryGet(argument, out entity);
        return Tuple.Create(entity, success);
    }

    //  The same as the last but with an explicit exception 
    public Tuple<T,bool,Exception> GetTupleWithException(object argument)
    {
        //equivalent to:
        T entity;
        Exception exception;
        bool success = this.TryGet(argument, out entity, out exception);
        return Tuple.Create(entity, success, exception);
    }

    //  A pattern I end up using is to have a generic result class
    //  My concern is that this may be "over-engineering" a simple
    //  method call.  I put the interface and sample implementation below  
    public IResult<T> GetResult(object argument)
    {
        //equivalent to:
        var tuple = this.GetTupleWithException(argument);
        return new ApiResult<T>(tuple.Item1, tuple.Item2, tuple.Item3);
    }
}

//  the result interface
public interface IResult<T>
{

    bool Success { get; }

    T ReturnValue { get; }

    Exception Exception { get; }

}

//  a sample result implementation
public class ApiResult<T> : IResult<T>
{
    private readonly bool _success;
    private readonly T _returnValue;
    private readonly Exception _exception;

    public ApiResult(T returnValue, bool success, Exception exception)
    {
        _returnValue = returnValue;
        _success = success;
        _exception = exception;
    }

    public bool Success
    {
        get { return _success; }
    }

    public T ReturnValue
    {
        get { return _returnValue; }
    }

    public Exception Exception
    {
        get { return _exception; }
    }
}

Answer 1

• Get - 如果验证失败是意外的，或者调用者可以在调用方法之前自行验证参数，则使用此选项。

• TryGet - 如果预期验证会失败，请使用此选项。 TryXXX 模式可以假定为熟悉的，因为它在 .NET Framework 中常见（例如，Int32.TryParse 或 Dictonary.TryGetValue)。

• TryGet with out Exception - 异常可能表示作为委托传递给类的代码中存在错误，因为如果参数无效，则 _validate< /code> 将返回 false 而不是抛出异常，并且 _getMethod 不会被调用。

• GetTuple、GetTupleWithException - 以前从未见过这些。我不会推荐它们，因为 Tuple 不能自我解释，因此对于公共接口来说不是一个好的选择。

• GetResult - 如果 _validate 需要返回比简单布尔值更多的信息，请使用此方法。我不会用它来包装异常（请参阅：TryGet 和 out Exception）。

Answer 2

如果“公共 API”是指一个 API 将被您无法控制的应用程序使用，并且这些客户端应用程序将以多种语言/平台编写，我建议返回非常基本的类型（例如字符串、整数、小数）并使用类似于 JSON 等更复杂的类型。

我认为您不能在公共 API 中公开泛型类，因为您不知道客户端是否支持泛型。

从模式角度来看，我会倾向于类似 REST 的方法而不是 SOAP。 Martin Fowler 有一篇关于这意味着什么的好文章：http://martinfowler.com/articles/richardsonMaturityModel .html

Answer 3

回答之前要考虑的事情：

1- DOTNet 编程语言和语言有一种特殊情况。 Java，因为您可以轻松检索对象，而不仅仅是原始类型。示例：“纯 C”API 可能与 C# API 不同

2 - 如果您的 API 中出现错误，在检索数据时，如何处理，而不中断您的应用程序。

答案：

一种模式，我在几个库中看到过，它是一个函数，它的主要结果是一个整数，其中0表示“成功”，另一个整数值表示特定的错误代码。

该函数可能有多个参数，大部分是只读参数或输入参数，以及单个引用或out参数，该参数可能是原始类型，对对象的引用，可能会更改，或指向对象或数据结构的指针。

如果出现异常，一些开发人员可能会捕获它们并生成特定的错误代码。

public static class MyClass
{

  // not recomended:
  int static GetParams(ref thisObject, object Param1, object Params, object Param99)
  {
    const int ERROR_NONE = 0;

    try
    {
      ...
    }
    catch (System.DivideByZeroException dbz)
    {
      ERROR_NONE = ...;
      return ERROR_NONE;
    }
    catch (AnotherException dbz)
    {
      ERROR_NONE = ...;
      return ERROR_NONE;
    }

    return ERROR_NONE;
  } // method

  // recomended:
  int static Get(ref thisObject, object ParamsGroup)
  {
    const int ERROR_NONE = 0;


    try
    {
      ...
    }
    catch (System.DivideByZeroException dbz)
    {
      ERROR_NONE = ...;
      return ERROR_NONE;
    }
    catch (AnotherException dbz)
    {
      ErrorCode = ...;
      return ERROR_NONE;
    }

    return ERROR_NONE;
  } // method

} // class

它类似于您的 tuple 结果。干杯。

更新 1：提及异常处理。

更新 2：显式声明常量。