如何正确地使用参数

方法定义方并不能保证调用方会按照预期传入参数,因此在方法体中应该对传入的参数保持理性的不信任。

方法的第一步骤并不是功能实现,而应该是参数预处理。

参数预处理包括两种:

入参保护

“入参保护”被提及的频率和认知度远低于参数校验,但是其重要性却不能被忽略。入参保护实质上是对服务提供方的保护,常见于批量接口。虽然批量接口能处理一批数据,但其处理能力并不是无限的,因此需要对入参的数据进行判断和控制,如果超出处理能力,可以直接返回错误给客户端。

某也五曾发生过一个严重故障,就是由一个用户批量查询的接口导致的。虽然在API文件中约定了每次最多支持查询的用户ID个数,但是接口视线中没有任何入参保护,导致当前用方传入万级的用户ID集合查询信息时,服务器内存被塞满,进程假死,再无任何处理能力。

参数校验

参数作为方法间交互和传递信息的媒介,其重要性不言而喻。基于防御式编程理念,在方法内,无论是对方法调用方传入参数的理性不信任,还是对参数有效值的检测都是非常有必要的。但是,由于方法间交互是非常频繁的,如果所有方法都进行参数校验,就会导致重复代码及不必要的检查影响代码性能。综合两个方面考虑,汇总需要进行参数校验和无需校验的场景。

需要进行参数校验的场景如下:

如何正确地使用参数

不需要进行参数校验的场景如下:

如何正确地使用参数