在这里插入图片描述

C++ DLL动态链接库开发实战：从入门到精通

在现代软件开发中，动态链接库（DLL, Dynamic Link Library）扮演着至关重要的角色。它们不仅促进了代码的复用和模块化，还显著减少了应用程序的内存占用和磁盘空间。然而，对于初学者来说，C++ DLL的开发和使用可能略显复杂。本文将深入浅出地讲解C++ DLL的基本概念、创建与导出函数、在客户端应用中导入与调用，以及常见问题的解决方法。通过详细的示例和关键注释，帮助开发者掌握C++ DLL动态链接库的开发实战技巧。

🧑 博主简介：CSDN博客专家、CSDN平台优质创作者，高级开发工程师，数学专业，10年以上C/C++, C#, Java等多种编程语言开发经验，拥有高级工程师证书；擅长C/C++、C#等开发语言，熟悉Java常用开发技术，能熟练应用常用数据库SQL server,Oracle,mysql,postgresql等进行开发应用，熟悉DICOM医学影像及DICOM协议,业余时间自学JavaScript,Vue,qt,python等，具备多种混合语言开发能力。撰写博客分享知识，致力于帮助编程爱好者共同进步。欢迎关注、交流及合作，提供技术支持与解决方案。
技术合作请加本人wx（注明来自csdn）：xt20160813

在这里插入图片描述

目录

  1. 基础概念
    • 什么是DLL
    • 静态链接与动态链接的区别
    • 使用DLL的优势
  2. 创建一个C++ DLL
    • 准备开发环境
    • 编写DLL代码
    • 编译生成DLL
  3. 在客户端应用中使用DLL
    • 静态链接方式
      • 编写客户端代码
      • 编译和运行客户端应用
    • 动态加载方式
      • 编写动态加载客户端代码
      • 编译和运行动态加载客户端应用
  4. 高级主题
    • 导出C++类
    • 避免名称修饰
    • 跨DLL传递对象
  5. 常见问题与解决方案
    • 符号无法解析
    • DLL文件找不到
    • 运行时错误
  6. 最佳实践
  7. 总结
  8. 参考资料

基础概念

什么是DLL

**动态链接库（DLL）**是一种将可执行函数和数据存储在单独文件中的技术。DLL允许多个程序共享其中的功能模块，而无需将这些模块嵌入到各自的可执行文件中。这不仅减少了应用程序的体积，还便于功能的复用和更新。

静态链接与动态链接的区别

  • 静态链接：将库文件的代码在编译时嵌入到最终的可执行文件中。每个使用该库的应用程序会包含库的一份拷贝，增加了磁盘和内存的占用。

  • 动态链接：在运行时加载DLL，多个应用程序可以共享同一个DLL文件中的代码，节省了磁盘空间和内存使用。同时，更新DLL文件可以无需重新编译所有使用它的应用程序。

使用DLL的优势

  1. 代码复用：多个应用程序可以共享同一个DLL中的功能，减少了重复代码。

  2. 模块化设计：将功能模块化，便于维护和升级。例如，升级一个DLL可以为所有使用它的应用程序提供新功能或修复。

  3. 内存节省：多个应用程序可以共享同一个DLL加载到内存中的实例，减少内存占用。

  4. 灵活部署：可以按需加载和卸载DLL，提高应用程序的灵活性。

创建一个C++ DLL

准备开发环境

本文以Visual Studio为例，指导如何在Windows平台上创建和使用C++ DLL。当然，类似的概念也适用于其他开发环境和操作系统，但实现细节可能有所不同。

编写DLL代码

假设我们要创建一个简单的数学运算DLL，提供加、减、乘、除四个函数。以下是详细的代码示例和关键注释。

  1. 创建DLL项目

    • 打开Visual Studio。
    • 选择“创建新项目”。
    • 选择“动态链接库（DLL）”模板，命名为MathLibrary。
    • 确保选择了“C++”作为编程语言。

  2. 编写头文件 MathLibrary.h

    头文件中定义了DLL接口，将函数声明标记为导出或导入。这通过使用__declspec(dllexport)和__declspec(dllimport)实现。

    // MathLibrary.h
#pragma once

#ifdef MATHLIBRARY_EXPORTS
#define MATHLIBRARY_API __declspec(dllexport)
#else
#define MATHLIBRARY_API __declspec(dllimport)
#endif

extern "C" {
    // 加法
    MATHLIBRARY_API double Add(double a, double b);
    // 减法
    MATHLIBRARY_API double Subtract(double a, double b);
    // 乘法
    MATHLIBRARY_API double Multiply(double a, double b);
    // 除法
    MATHLIBRARY_API double Divide(double a, double b);
}

    关键注释说明：

    • __declspec(dllexport)：标记导出函数，当DLL被编译时，这些函数将被导出供其他应用程序使用。
    • __declspec(dllimport)：标记导入函数，当其他应用程序使用DLL时，通过该标记导入DLL中的函数。
    • extern "C"：防止C++的名称修饰（Name Mangling），确保函数名在DLL中导出时具有C语言的命名风格，便于调用。

  3. 编写源文件 MathLibrary.cpp

    源文件中实现了加、减、乘、除四个函数。

    // MathLibrary.cpp
#include "MathLibrary.h"

extern "C" {

    // 加法实现
    MATHLIBRARY_API double Add(double a, double b) {
        return a + b;
    }

    // 减法实现
    MATHLIBRARY_API double Subtract(double a, double b) {
        return a - b;
    }

    // 乘法实现
    MATHLIBRARY_API double Multiply(double a, double b) {
        return a * b;
    }

    // 除法实现
    MATHLIBRARY_API double Divide(double a, double b) {
        if (b == 0) {
            // 简单的错误处理，返回0
            return 0;
        }
        return a / b;
    }
}

    关键注释说明：

    • extern "C"保持一致，用于避免名称修饰。
    • 在除法函数中，进行了简单的除以零的错误处理。在实际项目中，应根据需求进行更合理的错误处理。

编译生成DLL

  1. 配置项目属性

    • 确保在DLL项目的“预处理器”定义中添加MATHLIBRARY_EXPORTS，以便在编译DLL时标记为导出函数。

  2. 生成项目

    • 在Visual Studio中，选择“生成”菜单，点击“生成解决方案”。
    • 编译成功后，将在Debug或Release文件夹中生成MathLibrary.dll和相应的MathLibrary.lib。

在客户端应用中使用DLL

有两种主要方式使用DLL：静态链接和动态加载。本文将分别介绍这两种方式，并提供详细的示例代码。

静态链接方式

静态链接方式通过链接DLL的导入库（.lib文件）和头文件，在编译时将DLL的函数导入到应用程序中。

编写客户端代码

  1. 创建客户端项目

    • 在Visual Studio中，选择“创建新项目”。
    • 选择“控制台应用程序”模板，命名为MathClient。
    • 确保选择了“C++”作为编程语言。

  2. 配置项目属性

    • 包含目录：将DLL的头文件路径添加到客户端项目的“C/C++ -> 常规 -> 附加包含目录”。
    • 库目录：将DLL的.lib文件路径添加到“链接器 -> 常规 -> 附加库目录”。
    • 附加依赖项：在“链接器 -> 输入 -> 附加依赖项”中添加MathLibrary.lib。

  3. 编写源文件 main.cpp

    // main.cpp
#include <iostream>
#include "MathLibrary.h" // 导入DLL的头文件

using namespace std;

int main() {
    double a = 20.5;
    double b = 10.0;

    double sum = Add(a, b);
    double diff = Subtract(a, b);
    double prod = Multiply(a, b);
    double quot = Divide(a, b);

    cout << a << " + " << b << " = " << sum << endl;
    cout << a << " - " << b << " = " << diff << endl;
    cout << a << " * " << b << " = " << prod << endl;
    if (b != 0)
        cout << a << " / " << b << " = " << quot << endl;
    else
        cout << "Division by zero is undefined." << endl;

    return 0;
}

    关键注释说明：

    • 引入MathLibrary.h，确保函数声明与DLL导出一致。
    • 使用DLL导出的函数进行数学运算。

  4. 编译和运行客户端应用

    • 确保MathLibrary.dll在客户端可执行文件的可搜索路径中，例如将DLL复制到MathClient.exe所在目录。

    • 在Visual Studio中，选择“生成”菜单，点击“生成解决方案”。

    • 成功后，运行MathClient，将会得到如下输出：

      20.5 + 10 = 30.5
20.5 - 10 = 10.5
20.5 * 10 = 205
20.5 / 10 = 2.05
总结

静态链接方式简单直接，适用于已知DLL位置且接口稳定的场景。然而，它需要在编译时链接导入库，限制了DLL的灵活性。

动态加载方式

动态加载方式在运行时加载DLL，不需要在编译时链接导入库。这种方式适用于需要根据运行时条件加载不同DLL的场景，提升了程序的灵活性和扩展性。

编写动态加载客户端代码

  1. 创建客户端项目

    • 与静态链接方式类似，创建一个新的控制台应用程序项目，命名为DynamicMathClient。

  2. 编写源文件 main.cpp

    // main.cpp
#include <iostream>
#include <windows.h> // 包含Windows API
using namespace std;

typedef double (*MathFunc)(double, double); // 定义函数指针类型

int main() {
    // 加载DLL
    HMODULE hDll = LoadLibrary(TEXT("MathLibrary.dll"));
    if (hDll == NULL) {
        cerr << "Failed to load MathLibrary.dll" << endl;
        return -1;
    }

    // 获取函数地址
    MathFunc Add = (MathFunc)GetProcAddress(hDll, "Add");
    MathFunc Subtract = (MathFunc)GetProcAddress(hDll, "Subtract");
    MathFunc Multiply = (MathFunc)GetProcAddress(hDll, "Multiply");
    MathFunc Divide = (MathFunc)GetProcAddress(hDll, "Divide");

    if (!Add || !Subtract || !Multiply || !Divide) {
        cerr << "Failed to get one or more function addresses." << endl;
        FreeLibrary(hDll);
        return -1;
    }

    double a = 15.0;
    double b = 5.0;

    double sum = Add(a, b);
    double diff = Subtract(a, b);
    double prod = Multiply(a, b);
    double quot = Divide(a, b);

    cout << a << " + " << b << " = " << sum << endl;
    cout << a << " - " << b << " = " << diff << endl;
    cout << a << " * " << b << " = " << prod << endl;
    if (b != 0)
        cout << a << " / " << b << " = " << quot << endl;
    else
        cout << "Division by zero is undefined." << endl;

    // 卸载DLL
    FreeLibrary(hDll);

    return 0;
}

    关键注释说明：

    • 使用LoadLibrary加载DLL。
    • 使用GetProcAddress获取DLL中导出的函数地址。
    • 通过函数指针调用DLL函数。
    • 使用FreeLibrary卸载DLL，释放资源。

  3. 编译和运行动态加载客户端应用

    • 确保MathLibrary.dll在应用程序的可搜索路径中，例如将DLL复制到DynamicMathClient.exe所在目录。

    • 在Visual Studio中，选择“生成”菜单，点击“生成解决方案”。

    • 成功后，运行DynamicMathClient，将会得到如下输出：

      15 + 5 = 20
15 - 5 = 10
15 * 5 = 75
15 / 5 = 3
总结

动态加载方式无需在编译时链接导入库，提升了程序的灵活性。但它需要在运行时手动管理DLL的加载与卸载，并确保函数名称和签名的一致性。

高级主题

导出C++类

除了导出C风格的函数，C++ DLL还可以导出类。导出类比导出函数复杂，因为C++类包含了成员函数、虚函数表等复杂结构。

实现步骤

  1. 修改头文件 MathLibrary.h

    // MathLibrary.h
#pragma once

#ifdef MATHLIBRARY_EXPORTS
#define MATHLIBRARY_API __declspec(dllexport)
#else
#define MATHLIBRARY_API __declspec(dllimport)
#endif

class MATHLIBRARY_API Calculator {
public:
    Calculator();
    double Add(double a, double b);
    double Subtract(double a, double b);
    double Multiply(double a, double b);
    double Divide(double a, double b);
};

  2. 修改源文件 MathLibrary.cpp

    // MathLibrary.cpp
#include "MathLibrary.h"

Calculator::Calculator() {
    // 构造函数实现
}

double Calculator::Add(double a, double b) {
    return a + b;
}

double Calculator::Subtract(double a, double b) {
    return a - b;
}

double Calculator::Multiply(double a, double b) {
    return a * b;
}

double Calculator::Divide(double a, double b) {
    if (b == 0) {
        // 简单的错误处理，返回0
        return 0;
    }
    return a / b;
}

  3. 在客户端应用中使用导出的类

    • 静态链接方式

      // main.cpp
#include <iostream>
#include "MathLibrary.h"
using namespace std;

int main() {
    Calculator calc;
    double a = 25.0;
    double b = 5.0;

    double sum = calc.Add(a, b);
    double diff = calc.Subtract(a, b);
    double prod = calc.Multiply(a, b);
    double quot = calc.Divide(a, b);

    cout << a << " + " << b << " = " << sum << endl;
    cout << a << " - " << b << " = " << diff << endl;
    cout << a << " * " << b << " = " << prod << endl;
    if (b != 0)
        cout << a << " / " << b << " = " << quot << endl;
    else
        cout << "Division by zero is undefined." << endl;

    return 0;
}

    • 动态加载方式

      导出类的动态加载较为复杂，通常不推荐直接动态加载C++类。更常见的做法是导出工厂函数，通过工厂函数创建类实例。

      1. 修改DLL代码，添加工厂函数

        // MathLibrary.h
#pragma once

#ifdef MATHLIBRARY_EXPORTS
#define MATHLIBRARY_API __declspec(dllexport)
#else
#define MATHLIBRARY_API __declspec(dllimport)
#endif

class MATHLIBRARY_API Calculator {
public:
    Calculator();
    double Add(double a, double b);
    double Subtract(double a, double b);
    double Multiply(double a, double b);
    double Divide(double a, double b);
};

extern "C" {
    // 工厂函数，创建Calculator实例
    MATHLIBRARY_API Calculator* CreateCalculator();
    // 销毁Calculator实例
    MATHLIBRARY_API void DestroyCalculator(Calculator* calculator);
}

        // MathLibrary.cpp
#include "MathLibrary.h"

Calculator::Calculator() {
    // 构造函数实现
}

double Calculator::Add(double a, double b) {
    return a + b;
}

double Calculator::Subtract(double a, double b) {
    return a - b;
}

double Calculator::Multiply(double a, double b) {
    return a * b;
}

double Calculator::Divide(double a, double b) {
    if (b == 0) {
        // 简单的错误处理，返回0
        return 0;
    }
    return a / b;
}

extern "C" {

    Calculator* CreateCalculator() {
        return new Calculator();
    }

    void DestroyCalculator(Calculator* calculator) {
        delete calculator;
    }

}

      2. 编写客户端代码

        // main.cpp
#include <iostream>
#include <windows.h>
using namespace std;

typedef class Calculator* (*CreateCalculatorFunc)();
typedef void (*DestroyCalculatorFunc)(Calculator*);

int main() {
    // 加载DLL
    HMODULE hDll = LoadLibrary(TEXT("MathLibrary.dll"));
    if (hDll == NULL) {
        cerr << "Failed to load MathLibrary.dll" << endl;
        return -1;
    }

    // 获取工厂函数地址
    CreateCalculatorFunc CreateCalculator = (CreateCalculatorFunc)GetProcAddress(hDll, "CreateCalculator");
    DestroyCalculatorFunc DestroyCalculator = (DestroyCalculatorFunc)GetProcAddress(hDll, "DestroyCalculator");

    if (!CreateCalculator || !DestroyCalculator) {
        cerr << "Failed to get factory functions." << endl;
        FreeLibrary(hDll);
        return -1;
    }

    // 创建Calculator实例
    Calculator* calc = CreateCalculator();
    if (!calc) {
        cerr << "Failed to create Calculator instance." << endl;
        FreeLibrary(hDll);
        return -1;
    }

    double a = 30.0;
    double b = 6.0;

    double sum = calc->Add(a, b);
    double diff = calc->Subtract(a, b);
    double prod = calc->Multiply(a, b);
    double quot = calc->Divide(a, b);

    cout << a << " + " << b << " = " << sum << endl;
    cout << a << " - " << b << " = " << diff << endl;
    cout << a << " * " << b << " = " << prod << endl;
    if (b != 0)
        cout << a << " / " << b << " = " << quot << endl;
    else
        cout << "Division by zero is undefined." << endl;

    // 销毁Calculator实例
    DestroyCalculator(calc);

    // 卸载DLL
    FreeLibrary(hDll);

    return 0;
}

      关键注释说明：

      • 使用工厂函数CreateCalculator创建类实例，使用DestroyCalculator销毁实例，避免直接在客户端应用中处理C++类的复杂性。
      • 保持类实例的生命周期管理在DLL内部，减少跨DLL边界传递C++对象的风险。

避免名称修饰

C++在编译时对函数和类进行名称修饰（Name Mangling），以支持函数重载和类的成员函数。然而，这会导致DLL导出函数时名称复杂，难以通过GetProcAddress正确获取函数地址。通过使用extern "C"可以避免名称修饰，确保函数以C语言风格导出。

// MathLibrary.h
extern "C" {
    MATHLIBRARY_API double Add(double a, double b);
    // 其他函数...
}

关键注释说明：

  • extern "C"将函数导出为C风格的名称，避免C++的名称修饰，确保在客户端应用中能够正确获取函数地址。

跨DLL传递对象

在C++中，跨DLL传递类对象可能导致运行时错误，如虚函数表不一致、内存管理问题等。为了避免这些问题，推荐通过工厂函数创建和销毁对象，确保对象的创建和销毁都在同一个DLL内进行。

示例：

参见导出C++类章节中的工厂函数实现。

常见问题与解决方案

符号无法解析

问题描述：客户端应用编译时报错，提示无法解析某个符号（未找到函数或类的定义）。

解决方案：

  • 确保客户端项目正确包含了DLL的头文件和导入库（.lib文件）。
  • 检查函数或类的导出声明是否正确（使用__declspec(dllexport)）。
  • 确保DLL在运行时可被找到（DLL文件路径正确，通常与可执行文件在同一目录）。

DLL文件找不到

问题描述：运行客户端应用时报错，提示找不到DLL文件。

解决方案：

  • 将DLL文件复制到客户端应用的可执行文件目录。
  • 将DLL文件路径添加到系统的环境变量PATH中。
  • 使用绝对路径加载DLL。

运行时错误

问题描述：客户端应用在调用DLL函数时崩溃或产生意外行为。

解决方案：

  • 确保导出和导入的函数签名完全一致。
  • 避免跨DLL传递C++对象，使用C风格的接口或工厂函数。
  • 确保DLL函数内部没有未处理的异常。

最佳实践

  1. 使用Header文件管理接口：将DLL的接口声明放在独立的头文件中，便于维护和复用。

  2. 避免跨DLL传递C++对象：尽量使用C风格的接口或工厂函数，减少C++对象在DLL边界上的传递。

  3. 封装DLL实现细节：将DLL的内部实现细节隐藏在源文件中，只暴露必要的接口，提高封装性和安全性。

  4. 使用智能指针管理资源：在DLL和客户端应用中，尽量使用智能指针（如std::unique_ptr、std::shared_ptr）管理动态分配的资源，避免内存泄漏。

  5. 文档化DLL接口：为DLL的接口提供详细的文档说明，确保使用者能够正确理解和调用接口。

  6. 版本控制和兼容性：在DLL发布新版本时，确保接口的兼容性，避免破坏现有的客户端应用。

总结

C++ DLL动态链接库的开发和使用是Windows平台下软件开发的重要技能。通过本文的详细讲解和示例，您已经了解了DLL的基本概念、创建与导出函数的方法，以及在客户端应用中导入与调用DLL的两种主要方式（静态链接和动态加载）。在实际项目中，根据需求选择合适的方式使用DLL，可以有效提升代码复用性、模块化设计和系统性能。

在开发过程中，务必遵循最佳实践，避免常见的跨DLL边界传递C++对象的问题，通过工厂函数等手段确保对象生命周期的正确管理。同时，深入掌握名称修饰的原理和extern "C"的使用，可以确保DLL接口的稳定性和可用性。

掌握C++ DLL的开发实战技巧，将为您的软件开发之路增添强大的工具和方法，使您能够构建更加高效、灵活和可维护的应用程序。

参考资料

  1. Microsoft 官方文档：动态链接库
  2. C++ Reference
  3. C++ Primer - Stanley B. Lippman
  4. Effective C++ - Scott Meyers
  5. Visual Studio 动态链接库教程
  6. Windows API: LoadLibrary
  7. Windows API: GetProcAddress
  8. C++ 动态链接库最佳实践
  9. C++ 设计模式：工厂模式
  10. Boost DLL库

标签

C++、动态链接库、DLL开发、静态链接、动态加载、导出函数、导出类、Windows API、__declspec(dllexport)、__declspec(dllimport)、工厂函数

版权声明

本文版权归作者所有，未经允许，请勿转载。

# 开发语言 # c++ # 性能优化
Logo
乐奇 Rokid 开放社区

更多推荐

Word Embedding ：从分布式假设到神经网络语言模型

Word Embedding（词嵌入）是一种将离散的词汇符号映射到连续的低维稠密向量空间的技术。在这个向量空间中，语义相似的词在几何距离上彼此接近，从而实现了从"符号匹配"到"语义计算"的跨越。核心定义词嵌入是将单词（或多词短语）表示为固定维度的实值向量，这些向量之间的距离（例如余弦相似度）反映了单词之间的相关性，这种相关性基于单词通常出现的上下文。分布式假设（1954）↓统计共现分析（LSA/S

avatar 乐奇 Rokid 开放社区

3 分钟装好 foobox 皮肤：foobar2000 界面升级安装教程

foobox 是一个 foobar2000 的 DUI 皮肤配置，装好后默认界面就变成带亮、暗两套主题的多面板播放器。它适合已经用 foobar2000、只想换界面不想改播放习惯的 Windows 用户：皮肤只动外观，不碰播放器核心。## 先看适不适合你- 你在 Windows 10 1607 或更高版本上用 foobar2000，想要更顺眼的界面；- 你的曲库不小，想要分组管理和搜索；

avatar 乐奇 Rokid 开放社区

镜游小导：运行在 Rokid AR 眼镜上的景区实景讲解智能体

项目以 RokidAIUI 开放智能体形态交付：页面用.ink描述，运行在眼镜端智能体运行时，直接调用系统能力。AGENTS.md身份镜游小导v1.0.0，景区 AR 实景讲解智能体；权限（Capabilities）microphonenetworkaudiogyroscope；技能（Skills）。

avatar 乐奇 Rokid 开放社区