尝试了解如何创建流畅的界面以及何时使用它们

Question

如何创建一个流畅的界面而不是更传统的方法？这是一种传统方法：

界面：

interface IXmlDocumentFactory<T>
{
    XmlDocument CreateXml()                    //serializes just the data
    XmlDocument CreateXml(XmlSchema schema)    //serializes data and includes schema
}

interface IXmlSchemaFactory<T>
{
    XmlSchema CreateXmlSchema()                //generates schema dynamically from type
}

用法：

var xmlDocFactory = new XmlDocumentFactory<Foo>(foo);
var xmlDocument = xmlDocFactory.CreateXml();

//or...

var xmlDocFactory = new XmlDocumentFactory<Foo>(foo);
var xmlSchemaFactory = new XmlSchemaFactory<Foo>();
var xmlDocument = xmlDocFactory.CreateXml(xmlSchemaFactory.CreateXmlSchema());

我希望能够说：

var xmlDocument = new XmlDocumentFactory<Foo>(foo).CreateXml().IncludeSchema();
//or...
var xmlDocument = new XmlDocumentFacotry<Foo>(foo).CreateXml(); 

最后，这种情况适合流畅的界面吗？或者更传统的方法会更有意义吗？

Answer 1

使接口流畅的关键是确保方法都返回接口本身的实例，或者也实现可以继续处理的接口的其他对象。

因此，在您的情况下，每个 IXmlDocumentFactory 方法都必须返回 IXmlDocumentFactory，以便您可以继续调用。最后一个方法（如果有的话）返回您真正想要的类型？

它使得代码非常可读，但仍然让我有点不安的一件事是返回检查。您必须非常确保不能返回空值，否则下一个“流畅调用”将会失败。

Answer 2

在我看来，三件事很重要：

1.) 有一个初始方法，它返回您将要使用的流畅接口

2.) 类中实现流畅接口的每个方法都会返回自身，因此你可以继续链接 - 这些是真正的流畅的方法。

3.) 有一个最终方法返回您真正想要构建的类型。

在您的示例中，由于您只有两种方法，因此它的边界很有用 - 通常您会在流畅的界面中拥有更多方法。或者（我个人更喜欢），您可以在 API 中提供两个选项：流畅的 API 和更传统的 API（即带有可选参数）。

在你的情况下会做这样的事情：

编辑以回复评论。

public interface IXmlDocumentFactory<T>
{
    XmlDocument Create();                    //serializes just the data
    IXmlDocumentFactory<T> WithSchema(XmlSchema schema);    //serializes data and includes schema
}

public class DocumentFactory<T> : IXmlDocumentFactory<T>
{
    private XmlSchema _schema;
    private T _data;

    public DocumentFactory(T data)
    {
        _data = data;
    }
    public IXmlDocumentFactory<T> WithSchema(XmlSchema schema)
    {
        _schema = schema;
        return this;
    }
    public XmlDocument Create()
    {
        if (_schema != null)
        {
            //..use schema/data
            return new XmlDocument();
        }
        else //use data
            return new XmlDocument();
    }

    public static IXmlDocumentFactory<T> From(T data)
    {
        return new DocumentFactory<T>(data);
    }
}

然后你可以像这样使用它：

var xmlDoc = DocumentFactory<int>.From(42)
                                 .WithSchema(new XmlSchema())
                                 .Create();

var xmlDoc = DocumentFactory<int>.From(42)
                                 .Create();

Answer 3

在我看来，流畅的 API 确实有其价值。流畅地配置组件感觉更像是英文句子，从头到尾都很容易阅读。开发者的意图更容易被理解。

有关实现示例，请参考诸如 Autofac、Moq 和 Fluent NHibernate >