背景
- 使用C语言开发时常会遇到以下问题:多次修改导致代码文件(.c)中的函数定义的参数个数/类型与头文件中的函数声明不一致,编译器无法检测出来,即使是开启了严格的编译选项(-Wall -Werror),如下:
* test.h
int test(int a);
* test.c
#include <stdio.h>
int test(int a, int b)
{
a = 1;
b = 2;
....
}
* main.c
#include <stdio.h>
#include "test.h"
int main()
{
test(1);
}
* 编译正常
gcc -c test.c -Wall -Werror
gcc -c main.c -Wall -Werror
gcc -o a.out test.o main.o
- 虽然参数不一致,如上方法编译一般是不会报错,但是程序运行却可能正常,也可能会出现一些奇怪的现象,往往不好分析也不容易发现。
引发问题
- 内部开发时,多次修改后,未保证参数匹配,出现奇怪问题。
- 代码封装成库推送给客户使用时,客户未注意到只替换了库,或者只替换了头文件,导致程序运行结果异常,并且还不容易发现问题点。
C++
- C++不会存在该问题,因为C++为了支持函数重载(声明多个功能类似的同名函数,但是这些同名函数的形式参数(指参数的个数、类型或者顺序)必须不同),编译时会自动修改函数名,将返回类型,参数类型加到函数名中,这样链接时就能保证返回类型,参数类型的一致,不然链接时会找不到。
解决
- C语言对这种情况的校验机制缺失是明确的,我们无法使用任何编译器选项去将这种问题检测出来,只能采用工程的方法。
工程方法
- 情况1(内部开发),函数定义代码文件(.c)需要包含其函数声明头文件(.h),这样当声明定义不匹配时编译器就能检测出,如下:
* test.h
int test(int a);
* test.c
#include <stdio.h>
#include "test.h"
int test(int a, int b)
{
a = 1;
b = 2;
....
}
- 情况2(封装成库给外部使用),在库中以及头文件中定义版本号,这样用户使用时就能根据版本号来判断是否匹配,如下:
* test.h
#define TEST_VERSION 1.2
int test(int a);
* test.c
#include <stdio.h>
#include "test.h"
static char *version = "test_version:"TEST_VERSION;
int test(int a, int b)
{
a = 1;
b = 2;
....
}
- 以上代码编译成库后,用户可以从头文件中查看TEST_VERSION 获取头文件的版本号,可以使用strings命令获取库的版本号,如下:
* 命令:strings libtest.a | grep test_version
* 结果:test_version:1.2
|