使用 deprecated 声明防止开发人员使用危险的系统函数

在 linux 下开发时有一些系统函数初看起来很易用,其实却非常危险,比如 dirnamebasename ,其中 dirname 用来获取路径除去文件名的部分, basename 用来获取文 件名部分,函数原型定义如下:

char *dirname(char *path);
char *basename(char *path);

从原型可以初步看出,很难有安全的实现方式,要么直接修改参数 path ,要么返回一个 新的 buffer 存放获取到的文件路径部分,没有标准来明确应该使用哪种实现方式。

也就是说这两个函数是有负作用的,并没有想像中的那么易用。而开发人员在开发过程中很 容易就忽略了它的负作用,导致未定义的行为。

对于一个有大量开发人员参与的项目,很难防止开发人员误用这些系统函数,加强对开发人 员的教育以及代码 review 可以减少危险,但是无法从根本上解决问题。

一个比较好的方式添加 deprecated 声明,项目代码中一旦用到这些函数则报编译告警。以 basename 为例,在项目通用的头文件中添加 deprecated 声明:

 __attribute__ ((deprecated))
char *dirname(char *path);

所有用到 dirname 的地方都会编译告警,开发人员通过使用安全版本的系统函数(如: dirname_r )来修复编译告警。