Java 编程规约【04】OOP 规约
1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成本,直接用 类名来访问即可。
2. 【强制】所有的覆写方法,必须加 @Override
注解。
说明:getObject()
与 get0bject()
的问题。一个是字母的 O,一个是数字的 0,加 @Override
可以准确判断是否覆盖 成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编译报错。
3. 【强制】相同参数类型,相同业务含义,才可以使用的可变参数,参数类型避免定义为 Object。
说明:可变参数必须放置在参数列表的最后。(建议开发者尽量不用可变参数编程)
正例:public List<User> listUsers(String type, Long... ids) {...}
4. 【强制】外部正在调用的接口或者二方库依赖的接口,不允许修改方法签名,避免对接口调用方产生影 响。接口过时必须加 @Deprecated
注解,并清晰地说明采用的新接口或者新服务是什么。
- 设计时没有考虑周全,需要改造接口,需要通过增加新接口,迁移后下线老接口的方式实现。
- REST接口只能增加参数,不能减少参数,返回值的内容也是只增不减。
5. 【强制】不能使用过时的类或方法。