第三方库的使用支持（十六）

Posted 2020-11-20

        我们在使用 makefile 时，难免会避免使用到第三方库文件。那么当需要使用第三方库文件时，编译环境中的 makefile 该如何修改呢？在平时的一些经验中，第三方库是通过函数调用的方式提供库中的功能；库文件发布时都附带了声明库函数原型的头文件；编译阶段使用头文件，链接阶段使用库文件。下来我们来看看第三方库在项目中的位置，如下

        我们先来看看第三方库的编译阶段的支持：1、定义变量 DIR_LIBS_INC 用于指示头文件的存储位置，DIR_LIBS_INC := $(DIR_PROJECT)/libs/inc；2、使用 DIR_LIBS_INC 提示 make 头文件的存储位置，vpath %$(TYPE_INC) $(DIR_LIBS_INC)；3、使用 DIR_LIBS_INC 提示编译器头文件的存储位置，CFLAGS += -I$(DIR_LIBS_INC)。

        我们先来看看直接使用第三方库文件会怎样？我们在 main 文件夹下的 main.c 中添加使用第三方库的文件内容，如下

#include <stdio.h>
#include "define.h"
#include "slib.h"
#include "dlib.h"

int main()
{
    printf("Version: %s
", VERSION);
    printf("main()::start main ...
");
    
    common();
    module_main();
    
    printf("Dynamic Lib: %s
", dlib_name());
    printf("2 + 3 = %d
", add(2, 3));
    
    printf("Static Lib: %s
", slib_name());
    printf("4 * 5 = %d
", multi(4, 5));
}

        我们看看编译结果

        我们先来看看具体的 makefile 是怎样写的，基于上节博客的 makefile 来写。

pro-rule.mk 源码

.PHONY : all compile link clean rebuild $(MODULES)

DIR_PROJECT := $(realpath .)
DIR_BUILD_SUB := $(addprefix $(DIR_BUILD)/, $(MODULES))
MODULE_LIB := $(addsuffix .a, $(MODULES))
MODULE_LIB := $(addprefix $(DIR_BUILD)/, $(MODULE_LIB))

APP := $(addprefix $(DIR_BUILD)/, $(APP))

define makemodule
    cd ${1} &&     $(MAKE) all         DEBUG:=$(DEBUG)         DIR_BUILD:=$(addprefix $(DIR_PROJECT)/, $(DIR_BUILD))         DIR_COMMON_INC:=$(addprefix $(DIR_PROJECT)/, $(DIR_COMMON_INC))         DIR_LIBS_INC:=$(addprefix $(DIR_PROJECT)/, $(DIR_LIBS_INC))         CMD_CFG:=$(addprefix $(DIR_PROJECT)/, $(CMD_CFG))         MOD_CFG:=$(addprefix $(DIR_PROJECT)/, $(MOD_CFG))         MOD_RULE:=$(addprefix $(DIR_PROJECT)/, $(MOD_RULE)) &&     cd .. ;
endef

all : compile $(APP)
    @echo "Success! Target ==> $(APP)"

compile : $(DIR_BUILD) $(DIR_BUILD_SUB)
    @echo "Begin to compile ..."
    @set -e;     for dir in $(MODULES);     do         $(call makemodule, $$dir)     done
    @echo "Compile Success!"
    
link $(APP) : $(MODULE_LIB)
    @echo "Begin to link ..."
    $(CC) -o $(APP) -Xlinker "-(" $^ -Xlinker "-)" $(LFLAGS)
    @echo "Link Success!"
    
    
$(DIR_BUILD) $(DIR_BUILD_SUB) : 
    $(MKDIR) [email protected]
    
clean : 
    @echo "Begin to clean ..."
    $(RM) $(DIR_BUILD)
    @echo "Clean Success!"
    
rebuild : clean all

$(MODULES) : $(DIR_BUILD) $(DIR_BUILD)/$(MAKECMDGOALS)
    @echo "Begin to compile [email protected]"
    @set -e;     $(call makemodule, [email protected])

pro-cfg.mk 源码

MODULES := common            module            main
           
MOD_CFG := mod-cfg.mk
MOD_RULE := mod-rule.mk
CMD_CFG := cmd-cfg.mk

DIR_BUILD := build
DIR_COMMON_INC := common/inc
DIR_LIBS_INC := libs/inc

APP := app.out

cmd-cfg.mk 源码

AR := ar
ARFLAGS := crs

CC := gcc
LFLAGS := 
CFLAGS := -I$(DIR_INC) -I$(DIR_COMMON_INC) -I$(DIR_LIBS_INC)

ifeq ($(DEBUG),true)
CFLAGS += -g
endif

MKDIR := mkdir
RM := rm -fr

mod-rule.mk 源码

.PHONY : all

MODULE := $(realpath .)
MODULE := $(notdir $(MODULE))
DIR_OUTPUT := $(addprefix $(DIR_BUILD)/, $(MODULE))

OUTPUT := $(MODULE).a
OUTPUT := $(addprefix $(DIR_BUILD)/, $(OUTPUT))

SRCS := $(wildcard $(DIR_SRC)/*$(TYPE_SRC))
OBJS := $(SRCS:$(TYPE_SRC)=$(TYPE_OBJ))
OBJS := $(patsubst $(DIR_SRC)/%, $(DIR_OUTPUT)/%, $(OBJS))
DEPS := $(SRCS:$(TYPE_SRC)=$(TYPE_DEP))
DEPS := $(patsubst $(DIR_SRC)/%, $(DIR_OUTPUT)/%, $(DEPS))

vpath %$(TYPE_INC) $(DIR_INC)
vpath %$(TYPE_INC) $(DIR_COMMON_INC)
vpath %$(TYPE_INC) $(DIR_LIBS_INC)
vpath %$(TYPE_SRC) $(DIR_SRC)

-include $(DEPS)

all : $(OUTPUT)
    @echo "Success! Target ==> $(OUTPUT)"
    
$(OUTPUT) : $(OBJS)
    $(AR) $(ARFLAGS) [email protected] $^
    
$(DIR_OUTPUT)/%$(TYPE_OBJ) : %$(TYPE_SRC)
    $(CC) $(CFLAGS) -o [email protected] -c $(filter %$(TYPE_SRC), $^)
    
    
$(DIR_OUTPUT)/%$(TYPE_DEP) : %$(TYPE_SRC)
    @echo "Creating [email protected] ..."
    @set -e;     $(CC) $(CFLAGS) -MM -E $(filter %$(TYPE_SRC), $^) | sed 's,(.*).o[ :]*,$(DIR_OUTPUT)/1$(TYPE_OBJ) [email protected] : ,g' > [email protected]

        我们来看看编译是否成功

        我们看到编译已经成功。在编译的时候有几个注意事项：1、定义 DIR_LIBS_LIB := libs/lib（这个是第三方库所在路径）；2、链接时不会直接链接 DIR_LIBS_LIB 中的库文件；3、需要先将库文件拷贝到 DIR_BUILD 文件夹；4、必须考虑拷贝后的库文件和原始库文件的新旧关系，如下

        那么我们直接来试试链接呢？

        我们看到直接链接时保存了。下来我们来看看第三方库的链接阶段的支持，定义变量 EXTERNAL_LIB 用于保存第三方库列表，目标 link 需要依赖于第三方库列表。如下

        我们来看看具体的 makefile 是怎么写的

pro-rule.mk 源码

.PHONY : all compile link clean rebuild $(MODULES)

DIR_PROJECT := $(realpath .)
DIR_BUILD_SUB := $(addprefix $(DIR_BUILD)/, $(MODULES))
MODULE_LIB := $(addsuffix .a, $(MODULES))
MODULE_LIB := $(addprefix $(DIR_BUILD)/, $(MODULE_LIB))
EXTERNAL_LIB := $(wildcard $(DIR_BUILD)/*)
EXTERNAL_LIB :=$(patsub $(DIR_LIBS_INC)/%, $(DIR_BUILD)/%, $(EXTERNAL_LIB))

APP := $(addprefix $(DIR_BUILD)/, $(APP))

define makemodule
    cd ${1} &&     $(MAKE) all         DEBUG:=$(DEBUG)         DIR_BUILD:=$(addprefix $(DIR_PROJECT)/, $(DIR_BUILD))         DIR_COMMON_INC:=$(addprefix $(DIR_PROJECT)/, $(DIR_COMMON_INC))         DIR_LIBS_INC:=$(addprefix $(DIR_PROJECT)/, $(DIR_LIBS_INC))         CMD_CFG:=$(addprefix $(DIR_PROJECT)/, $(CMD_CFG))         MOD_CFG:=$(addprefix $(DIR_PROJECT)/, $(MOD_CFG))         MOD_RULE:=$(addprefix $(DIR_PROJECT)/, $(MOD_RULE)) &&     cd .. ;
endef

all : compile $(APP)
    @echo "Success! Target ==> $(APP)"

compile : $(DIR_BUILD) $(DIR_BUILD_SUB)
    @echo "Begin to compile ..."
    @set -e;     for dir in $(MODULES);     do         $(call makemodule, $$dir)     done
    @echo "Compile Success!"
    
link $(APP) : $(MODULE_LIB) $(EXTERNAL_LIB)
    @echo "Begin to link ..."
    $(CC) -o $(APP) -Xlinker "-(" $^ -Xlinker "-)" $(LFLAGS)
    @echo "Link Success!"
    
$(DIR_BUILD)/% : $(DIR_LIBS_LIB)/%
    $(CP) $^ [email protected]
    
$(DIR_BUILD) $(DIR_BUILD_SUB) : 
    $(MKDIR) [email protected]
    
clean : 
    @echo "Begin to clean ..."
    $(RM) $(DIR_BUILD)
    @echo "Clean Success!"
    
rebuild : clean all

$(MODULES) : $(DIR_BUILD) $(DIR_BUILD)/$(MAKECMDGOALS)
    @echo "Begin to compile [email protected]"
    @set -e;     $(call makemodule, [email protected])

 

cmd-cfg.mk 源码

AR := ar
ARFLAGS := crs

CC := gcc
LFLAGS := 
CFLAGS := -I$(DIR_INC) -I$(DIR_COMMON_INC) -I$(DIR_LIBS_INC)

ifeq ($(DEBUG),true)
CFLAGS += -g
endif

MKDIR := mkdir
RM := rm -fr
CP := cp

pro-cfg.mk 源码

MODULES := common            module            main
           
MOD_CFG := mod-cfg.mk
MOD_RULE := mod-rule.mk
CMD_CFG := cmd-cfg.mk

DIR_BUILD := build
DIR_COMMON_INC := common/inc
DIR_LIBS_INC := libs/inc
DIR_LIBS_LIB := libs/lib

APP := app.out

        我们来看看编译结果

        我们看到已经链接成功了，并且正确运行可执行程序了。那么在实际工作中，第三方的库文件是有可能随时会更新的，我们在 libs/lib 文件夹下重新建立 dlib.so 和 slib.a ，看看会重新链接吗？

        我们看到在第一次 link 时是重新复制的，第二次 link 时不会再去复制了。通过对第三方库的使用的学习，总结如下：1、编译环境必须支持第三方库的使用（静态库或动态库）；2、工程开发中一般会使用特殊的文件夹存放第三方库；3、第三方库所附带的头文件用于声明函数（编译阶段需要）；4、在链接阶段先将库文件拷贝到 build 文件夹，再进行链接。

        欢迎大家一起来学习 makefile 语言，可以加我QQ：243343083。