设计系统API的原则

测试的时候发现同事的代码有一个BUG：一个返回分组查询SQL文select子句的方法，其中一个参数如果为NULL的话，返回的select子句有语法错误。向同事提出，并建议增加一段代码，对NULL值做特别处理。

可同事不同意，理由是：如果按我说的修改，再配合其它方法做成的where子句、orderBy子句，SQL文前后的逻辑也会出问题。

他的理由很好反驳：SQL文可以没有where子句和orderBy子句，但select不能有语法错误。

经过讨论，最后我的方法得到了头儿的支持。

 

不过发现好像大家对API的开发还没有特别深刻的认识，一些原则并不明确，包括我自己。

所以在这里做一点总结，以后有章可循，不迷惑：

 

1、 类、方法，必须是各自独立的。多个类或方法配合使用才正确的想法是绝对错误的。这也是耦合性和内聚性的基本要求。

2、 独立运行一个方法，返回值或运行结果必须是正确的可用的。例如上面的例子，每一个做SQL文的方法返回的语句都应该是正确没有语法错误的。对每一个参数，只要是允许输入的值都应该返回正确的结果；不允许输入的值要抛异常。

3、 代码注释和异常消息信息要准确，描述要全面，语言要简洁。

 

    （先总结这几条，以后想到什么再追加。 to be continue......）