【问题标题】:Fluent APIs - return this or new?Fluent APIs - 返回这个还是新的?
【发布时间】:2013-11-19 10:20:10
【问题描述】:

我最近提出了一个有趣的问题,流畅的方法应该返回什么?他们应该改变当前对象的状态还是创建一个具有新状态的全新对象?

如果这个简短的描述不是很直观,这里有一个(不幸的是)冗长的例子。它是一个计算器。它执行非常繁重的计算,这就是他通过异步回调返回结果的原因:

public interface ICalculator {
    // because calcualations are too lengthy and run in separate thread
    // these methods do not return values directly, but do a callback
    // defined in IFluentParams
    void Add(); 
    void Mult();
    // ... and so on
}

所以,这是一个设置参数和回调的流畅接口:

public interface IFluentParams {
    IFluentParams WithA(int a);
    IFluentParams WithB(int b);
    IFluentParams WithReturnMethod(Action<int> callback);
    ICalculator GetCalculator();
}

对于这个接口实现,我有两个有趣的选择。我会把它们都展示出来,然后我会写下我认为它们各自的好和坏。

所以,first 是一个普通的,它返回 this

public class FluentThisCalc : IFluentParams {
    private int? _a;
    private int? _b;
    private Action<int> _callback;

    public IFluentParams WithA(int a) {
        _a = a;
        return this;
    }

    public IFluentParams WithB(int b) {
        _b = b;
        return this;
    }

    public IFluentParams WithReturnMethod(Action<int> callback) {
        _callback = callback;
        return this;
    }

    public ICalculator GetCalculator() {
        Validate();
        return new Calculator(_a, _b);
    }

    private void Validate() {
        if (!_a.HasValue)
            throw new ArgumentException("a");
        if (!_b.HasValue)
            throw new ArgumentException("bs");
    }
}

第二个版本更复杂,它在每次状态变化时返回一个新对象

public class FluentNewCalc : IFluentParams {
    // internal structure with all data
    private struct Data {
        public int? A;
        public int? B;
        public Action<int> Callback;

        // good - data logic stays with data
        public void Validate() {
            if (!A.HasValue)
                throw new ArgumentException("a");
            if (!B.HasValue)
                throw new ArgumentException("b");
        }
    }

    private Data _data;

    public FluentNewCalc() {
    }

    // used only internally
    private FluentNewCalc(Data data) {
        _data = data;
    }

    public IFluentParams WithA(int a) {
        _data.A = a;
        return new FluentNewCalc(_data);
    }

    public IFluentParams WithB(int b) {
        _data.B = b;
        return new FluentNewCalc(_data);
    }

    public IFluentParams WithReturnMethod(Action<int> callback) {
        _data.Callback = callback;
        return new FluentNewCalc(_data);
    }

    public ICalculator GetCalculator() {
        Validate();
        return new Calculator(_data.A, _data.B);
    }

    private void Validate() {
        _data.Validate();
    }
}

他们如何比较:

专业第一()版本:

  • 更简单更短

  • 常用

  • 似乎更节省内存

  • 还有什么?

专业第二()版本:

  • 将数据存储在单独的容器中,允许单独的数据逻辑和所有处理

  • 允许我们轻松修复部分数据,然后填写其他数据并单独处理。看看:

        var data = new FluentNewCalc()
            .WithA(1);
    
        Parallel.ForEach(new[] {1, 2, 3, 4, 5, 6, 7, 8}, b => {
            var dt = data
                .WithB(b)
                .WithReturnMethod(res => {/* some tricky actions */});
    
            // now, I have another data object for each value of b, 
            // and they have different callbacks.
            // if I were to do it with first version, I would have to create each 
            // and every data object from scratch
            var calc = dt.GetCalculator();
            calc.Add();
        });
    

第二个版本有什么更好的地方?

  • 我可以像这样实现 WithXXX 方法:

    public IFluentParams WithXXX(int xxx) {
        var data = _data;
        data.XXX = xxx;
        return new FluentNewCalc(data);
    }
    

    并将 _data 设为只读(即不可变),一些聪明人认为这很好。

所以问题是,您认为哪种方式更好,为什么? 附言我使用了 c#,但很可能适用于 java。

【问题讨论】:

  • 这本质上是在询问您是否应该使用不可变或可变对象。您是否使用流畅的界面实际上与这个问题无关。
  • @HighCore 你是否在用 C# 和 Java 标记的问题试图引发激烈的战争?
  • @HighCore 仅供参考,当你说“ 不支持 anything”之类的话,然后声称明显的双曲线陈述是“客观的技术事实”,它对你的反映相当差。
  • @Servy 好吧,不完全是,我会说。我想说我在问是否应该将可变或不可变对象与流利的 api 结合使用。问题出现了,因为无论我在哪里谷歌,我都只看到可变流畅的 API,我问自己 - 为什么?也许有什么我不明白的?
  • @GusRustam 真的,因为我宁愿说反话。大多数不可变对象的 API 本质上都是流畅的,如果它不仅仅是一个数据持有者对象的话。看看 string、int、IEnumerable 等。另一方面,可变对象很少有流畅的 API。你会发现更流畅的 API 是不可变的而不是可变的。无论如何,我的观点是你不要坐下来说,“我需要一个流畅的 API,对象应该是不可变的还是可变的?”相反,您应该决定“这个对象应该是可变的还是不可变的”,然后然后决定它的 API 应该是什么样子。

标签: c# java oop design-patterns fluent-interface


【解决方案1】:

当我试图在我的应用程序设计中回答这样的问题时,我总是会考虑在他的应用程序中使用我的代码的人会期望什么。

以 C# DateTime 类型为例。它是一个结构,因此是不可变的。当你要求时

var today = DateTime.Now;
var tomorrow = today.AddDays(1);

如果您不知道DateTime 是不可变的,您会期待什么?没想到今天突然就是明天,那会是一片混乱。

至于您的示例,除非我另有决定,否则我认为仅使用计算器的一个实例来处理数字。这是有道理的,对吧?当我写一个方程时,我不会把每个表达式都写在一个新的行上。我把它连同一个结果一起写出来,然后我跳到下一行以分离关注点。

所以

var calc = new Calculator(1);
calc.Add(1);
calc.PrintCurrentValue(); // imaginary method for printing of a current value of equation

对我来说很有意义。

【讨论】:

  • 有趣的地方。当你写“......我会想象只使用计算器的一个实例来处理数字,除非我另有决定......”,你以某种方式与 David Arno 的回答相矛盾,他举了一个看起来像那里的例子必须是两个计算器。同时,我猜你给出了很好的观点,一个计算器应该被理解(或似乎必须被理解)为一个单独的项目,它不会在每次更新时克隆自己。目前我开始认为流畅的 API 应该是可克隆的,并且可以让用户访问克隆。
  • 是的,我有相反的意见。在我看来,当我只打开一个计算器实例时,我不会期望结果为 1。当我在 Windows 中打开一个计算器实例并添加所有这些值时,我肯定不会得到结果 1,而是 10 (1+2)*3+1。但是,嘿,这只是我的观点。选择对您或您的 API 用户有意义的解决方案。
【解决方案2】:

我倾向于假设流利的方法会返回这个。但是,您提出了一个关于可变性的好观点,这让我在测试时感到困惑。使用你的例子,我可以做类似的事情:

var calc = new Calculator(0);
var newCalc = calc.Add(1).Add(2).Mult(3);
var result = calc.Add(1);

在阅读代码时,我想很多人会假设结果是 1,因为他们会看到 calc + 1。当然,对于可变流畅的系统,答案会有所不同,因为 Add(1).Add(2).Mult(3) 将被应用.

不可变的流式系统更难实现,需要更复杂的代码。关于不变性的好处是否超过了实现它们所需的工作,这似乎是一个非常主观的事情。

【讨论】:

  • 我真的希望有一种方法可以让流利的方法返回一个无法分配给变量的类型,但可以隐式转换为可以的类型。如果X 持有对对象的唯一引用,则语句X=X.Clone() 本质上是一个空操作。在像calc.Add(1).Add(2); 这样的表达式中,如果Add(1) 创建了一个新对象并且不在其返回值之外的任何地方存储引用,那么Add(2) 将作用于宇宙中任何地方对该对象的唯一引用,因此直接变异该对象相当于制作修改后的副本(但要快得多)。
【解决方案3】:

如果不是为了类型推断,人们可以通过实现 API 中定义的不可变 FluentThing 类,以及另一个可变的 FluentThingInternalUseOnly 来“两全其美”,它支持扩大到 @987654323 的转换@。 FluentThing 上的 Fluent 成员将构造 FluentThingInternalUseOnly 的新实例,并将后一种类型作为其返回类型; FluentThingInternalUseOnly 的成员将对this 进行操作并返回。

如果有人说FluentThing newThing = oldFluentThing.WithThis(4).WithThat(3).WithOther(57);WithThis 方法将构造一个新的FluentThingInternalUseOnlyWithThatWithOther 将修改并返回相同的实例;然后将其中的数据复制到新的FluentThing,其引用将存储在newThing中。

这种方法的主要问题是,如果有人说dim newThing = oldFluentThing.WithThis(3);,那么newThing 不会持有对不可变FluentThing 的引用,而是对可变FluentThingInternalUseOnly 的引用,并且那个东西没有办法知道对它的引用已被持久化。

从概念上讲,需要一种使FluentThingInternalUseOnly 足够公开的方法,以便它可以用作公共函数的返回类型,但不能公开到允许外部代码声明其类型的变量。不幸的是,我不知道有什么方法可以做到这一点,尽管可能有一些涉及Obsolete() 标签的技巧。

否则,如果被操作的对象很复杂但操作很简单,那么最好的办法就是让流畅的接口方法返回一个对象,该对象包含对调用它的对象的引用关于应该对该对象做什么的信息[链接流畅的方法将有效地构建一个链接列表]以及对已应用所有适当更改的对象的延迟评估引用。如果调用newThing = myThing.WithBar(3).WithBoz(9).WithBam(42),则在每一步都将创建一个新的包装对象,并且第一次尝试使用newThing 作为事物将必须构造一个Thing 实例并对其应用三个更改,但是原始的myThing 将保持不变,只需创建一个Thing 的新实例而不是三个。

【讨论】:

  • 哇!两个不同的类,调用链表,过时的属性!你肯定会跳出框框思考!我必须至少重读几次才能获得所有想法
  • @Rustam:我不确定 .NET 的实现方式是否会特别好地“减少惊讶”,但平衡语义和性能所需的是一种识别方法一个对象可能只存在一个引用的情况。如果 X 持有对对象“George”的唯一引用,X=X.WithY(5);X.Y=5; 是同义词,因为在任何一种情况下,X 都将引用 Y 为 5 的实例,并且不存在对对象“George”的引用Y 不等于 5。一般来说,跟踪一个对象的引用数量是昂贵的,而且不值得......
  • ...但是一个好的框架应该有助于区分仅存在单个范围内引用的对象和可以共享引用的对象。请注意,从根本上讲,有两种方法可以使用引用封装数据:使用对永远不会改变的事物的共享引用,或对将改变的事物的非共享引用。在正确编写的程序中,这两种范式之间会有明显的区别—​​—某些东西是共享的还是非共享的,不仅仅是任何东西“还”是否共享它的函数。
【解决方案4】:

我想这一切都取决于你的用例。

大多数时候,当我使用 Builder 时,它是由单线程来操作可变数据的。因此,返回 this 是首选,因为没有在任何地方返回新实例的额外开销和内存。

但是,我的许多 Builder 都有一个 copy() 方法,当我需要支持您的“专业第二”用例时,它会返回一个具有当前相同值的新实例

【讨论】:

    猜你喜欢
    • 2013-05-11
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2021-03-19
    • 1970-01-01
    • 2020-07-05
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多