流畅的 API - 返回这个还是新的?

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

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

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 是通常的,返回以下内容

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。


答案 1

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

对于 instace,取 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

对我来说非常有意义。


答案 2

我倾向于假设流利的方法会返回这个。但是,您提出了一个关于可变性的好观点,这在测试时引起了我的注意。使用你的例子,我可以做这样的事情:

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

在阅读代码时,我想很多人会认为结果会像他们看到calc + 1一样。对于可变流利系统的原因,答案将有所不同,因为将应用。1Add(1).Add(2).Mult(3)

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