java - 如何监控用户是否以正确的流程集成我的 android 库？

Question

我正在考虑一种监控用户集成流程的方法。我有一个 Android 库，需要首先初始化，然后用户需要检索我的库的实例并调用我提供的 api 来处理一些数据。例如，

People ppl = new People();

ppl.init();

pp1.walk();

pp1.run();

api有一个顺序，用户必须先调用.init()来先初始化相关资源，以便对象ppl可以处理walk和运行。对于 .walk() 和 .run() 也是如此，用户必须在 .run()< 之前调用 .walk()/。

监控消费者是否正确使用库的最佳实践是什么？换句话说，尽管我提供了集成指南的详细信息，但我如何知道他们是否确实遵循了正确的顺序？

我考虑在我提供的每个方法中添加一些指示符，并将它们放入发送到我的服务器的请求中。例如，如果我在 walk() 中的索引为 1，而在 run() 中的索引为 2。当请求到达后端时，我检查索引的顺序是否为 12 而不是 21。但这些的最佳实践是什么？添加索引似乎不切实际。谢谢。

Answer 1

抛出异常并指出发生了什么。如果您觉得慷慨，可以让您的 API 尝试恢复状态。还要确保您有 API 文档，以便您的用户真正了解正确的用法。

你所描述的基本上听起来像是异常(exception)，只是更加礼貌和困惑。直接、清晰。

Exception: API not initialized

他们会用谷歌搜索或阅读你的文档并找出他们做错了什么。