如何强制客户端代码按预期/发布使用API

Question

我想开发一个将由第三方使用的API，我们无法控制第三方如何使用该API。通过公共文档传达正确的API使用方式并不能保证API的正确使用。

是否有任何技术或设计模式可以迫使API使用者按预期使用API方法？

以下是API的两个使用示例，它有一个方法来发送状态：

>

用法#1消费者可以通过将字符串数组传递给方法在单个调用中发送多个状态。这是API设计者的预期用途。

用法#2消费者仍然推文多个状态，但一次一个状态，最终调用推文方法十次。这不是预期的用途，可能会导致性能问题。

我正在寻找一种解决方案来强制/防止这种API的使用。

API打包/交付为jar：

package com.api;

public class API {
    public API() {
        // TODO Auto-generated constructor stub
    }

    public void tweet(String [] statuses) {
        // TODO - very expensive db call to store statuses

        // open db connection
        // insert/update
        // close db connection
    }
}

客户端调用API：

package com;

import com.api.API;

public class Example {
    public Example() {
        // TODO Auto-generated constructor stub
    }

    private static void client() {
        API api = new API();

        // API Usage #1 - WAS Expected
        String [] statuses1 = new String[10];
        for (int i = 0; i < 10; i++) {
            statuses1[i] = new String("[" + i + "] - statuses1");
        }
        // one call to process all 10 statuses -- RIGHT
        api.tweet(statuses1);

        // API Usage #2 - NOT Recommended
        String [] statuses2 = new String[1];
        for (int i = 0; i < 10; i++) {
            statuses2[i] = new String("[" + i + "] - statuses2");

            // ten calls to process all 10 statuses -- WRONG
            api.tweet(statuses2);
        }
    }
}

Answer 1

恕我直言，你应该相信你的客户会做正确的事情。但是也许你可以代替他们做批处理：

在API中收集请求。自己推特。也许您可以聚合来自不同客户端的请求。也许您可以在更长的时间内聚合来自单个客户端的请求。

这应该可以解决问题。如果没有，以下是更多的想法：

也许您可以很容易地发现客户端连续多次调用您的方法并抛出异常来教他们艰难的方法。但是我发现最好专门处理这样的客户端，例如，通过聚合他们的调用（而来自更符合要求的客户端的调用会立即传递）。

你写的

    // open db connection
    // insert/update
    // close db connection

这通常是错误的。关闭连接意味着浪费大量时间，连接池是标准的解决方案。