C++ 符号可见性控制：`__attribute__((visibility(“hidden”)))` 与库设计

好的，咱们今天来聊聊 C++ 里一个挺有意思的东西：符号可见性控制，特别是那个 __attribute__((visibility("hidden")))。咱们的目标是：让你理解它干嘛的，怎么用，以及在设计库的时候，怎么用它来让你的库更牛逼。

开场白：符号，可见性，和库的烦恼

想象一下，你是个建筑师，设计了一栋大楼。这栋楼里有很多房间，有些房间是公开的，谁都可以进，比如大厅；有些房间是私密的，只有特定的人才能进，比如卧室。

在 C++ 的世界里，你的代码就是这栋大楼，函数、变量等等就是房间，而“符号可见性”就是决定哪些“房间”对外开放的规则。

一个库，就是一个预先盖好的“小楼”，你想把它卖给别人用。但你肯定不想把所有房间都暴露给买家，对吧？有些房间是支撑整个楼的结构，买家改动了可能会让楼塌了。

所以，符号可见性控制，就是让你在构建库的时候，能够精确地控制哪些符号（函数、变量、类等等）对外可见，哪些符号只在库内部使用。

__attribute__((visibility("hidden")))：隐身斗篷

__attribute__((visibility("hidden")))，你可以把它想象成一件“隐身斗篷”，给你的符号穿上，它就对外“隐身”了。

干啥的？

简单来说，它告诉编译器：“这个符号，只在我这个编译单元（通常是一个 .cpp 文件）里用，别把它暴露给其他人。”
为啥要用？
- 减少符号污染: 想象一下，如果你的库里有很多内部使用的函数，它们的名字可能和用户的代码里的函数名字冲突。用了 visibility("hidden")，这些内部函数就不会暴露出去，避免了命名冲突。
- 减小库的大小: 有些链接器（比如使用 GNU ld 的 Linux 系统）可以利用隐藏符号的信息，更积极地进行优化，比如删除未使用的代码，从而减小库的大小。
- 隐藏实现细节: 你可能不想让用户知道你的库内部是怎么实现的。隐藏内部符号可以防止用户依赖于你的实现细节，这样你就可以更自由地修改库的内部结构，而不用担心破坏用户的代码。
- 增强安全性: 隐藏一些关键的内部函数，可以防止恶意用户利用这些函数进行攻击。

实战演练：代码说话

来，咱们直接上代码，看看 __attribute__((visibility("hidden"))) 怎么用。

// my_library.h
#ifndef MY_LIBRARY_H
#define MY_LIBRARY_H

#ifdef _WIN32
  #define MY_LIBRARY_API __declspec(dllexport)
  #define MY_LIBRARY_HIDDEN
#else
  #define MY_LIBRARY_API __attribute__((visibility("default")))
  #define MY_LIBRARY_HIDDEN __attribute__((visibility("hidden")))
#endif

MY_LIBRARY_API int public_function(int x); // 对外开放的函数

#endif

// my_library.cpp
#include "my_library.h"
#include <iostream>

MY_LIBRARY_HIDDEN int hidden_function(int x) {
    std::cout << "Hidden function called with " << x << std::endl;
    return x * 2;
}

MY_LIBRARY_API int public_function(int x) {
    std::cout << "Public function called with " << x << std::endl;
    return hidden_function(x) + 1;
}

// main.cpp
#include "my_library.h"
#include <iostream>

int main() {
    int result = public_function(5);
    std::cout << "Result: " << result << std::endl;

    // 尝试调用 hidden_function() 会导致链接错误
    // int hidden_result = hidden_function(5); // 编译错误！

    return 0;
}

代码解释：

my_library.h: 定义了 MY_LIBRARY_API 和 MY_LIBRARY_HIDDEN 宏。
- MY_LIBRARY_API: 用来标记对外开放的符号。在 Windows 下用 __declspec(dllexport)，在其他系统下用 __attribute__((visibility("default")))。
- MY_LIBRARY_HIDDEN: 用来标记隐藏的符号。用 __attribute__((visibility("hidden")))。
my_library.cpp: 实现了 public_function 和 hidden_function。
- hidden_function 用 MY_LIBRARY_HIDDEN 标记，表示它是隐藏的。
- public_function 用 MY_LIBRARY_API 标记，表示它是公开的。
main.cpp: 使用了 my_library。
- 可以正常调用 public_function。
- 尝试直接调用 hidden_function 会导致编译错误或链接错误，因为 hidden_function 对 main.cpp 来说是不可见的。

编译和链接：见证奇迹的时刻

编译 my_library.cpp:
```
g++ -c -fPIC my_library.cpp -o my_library.o
```
-fPIC 是为了生成位置无关代码，这是创建共享库的必要条件。

创建共享库:

g++ -shared my_library.o -o libmylibrary.so

编译 main.cpp:
```
g++ -c main.cpp -o main.o
```
链接 main.o 和 libmylibrary.so:
```
g++ main.o -L. -lmylibrary -o my_program
```
-L. 表示在当前目录查找库文件，-lmylibrary 表示链接 libmylibrary.so。
运行 my_program:
```
./my_program
```
你会看到 public_function 被调用，并且内部调用了 hidden_function，但是 main.cpp 无法直接访问 hidden_function。

进阶用法：类和命名空间

__attribute__((visibility("hidden"))) 不仅可以用于函数，还可以用于类、结构体、枚举等等。

// my_library.h

#ifndef MY_LIBRARY_H
#define MY_LIBRARY_H

#ifdef _WIN32
  #define MY_LIBRARY_API __declspec(dllexport)
  #define MY_LIBRARY_HIDDEN
#else
  #define MY_LIBRARY_API __attribute__((visibility("default")))
  #define MY_LIBRARY_HIDDEN __attribute__((visibility("hidden")))
#endif

namespace MyLibrary {

class MY_LIBRARY_API PublicClass {
public:
    PublicClass(int value);
    int getValue() const;
private:
    MY_LIBRARY_HIDDEN int internalValue;
};

MY_LIBRARY_HIDDEN class HiddenClass {
public:
    HiddenClass(int value);
    int getValue() const;
private:
    int value;
};

MY_LIBRARY_API int public_function(int x);

} // namespace MyLibrary

#endif

// my_library.cpp

#include "my_library.h"
#include <iostream>

namespace MyLibrary {

HiddenClass::HiddenClass(int value) : value(value) {}

int HiddenClass::getValue() const {
    return value;
}

PublicClass::PublicClass(int value) : internalValue(value) {}

int PublicClass::getValue() const {
    return internalValue;
}

int public_function(int x) {
    HiddenClass hidden(x);
    std::cout << "Hidden class value: " << hidden.getValue() << std::endl;
    return x * 3;
}

} // namespace MyLibrary

在这个例子中：

PublicClass 被标记为 MY_LIBRARY_API，所以它是公开的。
HiddenClass 被标记为 MY_LIBRARY_HIDDEN，所以它是隐藏的。
PublicClass 的成员变量 internalValue 也被标记为 MY_LIBRARY_HIDDEN，所以它是隐藏的。

这意味着，用户可以使用 PublicClass，但是无法直接访问 HiddenClass 和 PublicClass 的 internalValue 成员变量。

命名空间：组织代码的利器

使用命名空间可以避免全局命名冲突，让你的代码更清晰。在库设计中，强烈建议使用命名空间。

动态链接库（DLL）和静态链接库

动态链接库（DLL）: 在运行时加载，可以减小可执行文件的大小，并且可以多个程序共享同一个库。__attribute__((visibility("hidden"))) 在动态链接库中尤其有用，因为它可以减小库的大小，并且隐藏内部实现细节。
静态链接库: 在编译时链接到可执行文件中。__attribute__((visibility("hidden"))) 仍然可以用于静态链接库，它可以减小可执行文件的大小，并且避免命名冲突。

注意事项和最佳实践

不要过度使用: 不要把所有符号都隐藏起来。对外开放的符号是库的接口，用户需要使用这些接口来与库交互。
保持一致性: 确保你的库的 API 是一致的。不要随意地改变符号的可见性，这可能会破坏用户的代码。
使用版本控制: 当你修改库的 API 时，一定要更新库的版本号，并且通知用户。
测试: 充分测试你的库，确保隐藏符号不会导致任何问题。
不同编译器的兼容性: 不同的编译器可能对符号可见性的处理方式不同。在使用 __attribute__((visibility("hidden"))) 时，最好进行充分的测试，以确保在不同的编译器下都能正常工作。尤其是在windows和linux之间。
Windows 下的替代方案: 在 Windows 下，可以使用 .def 文件来控制符号的导出。.def 文件是一个文本文件，其中列出了要导出的符号的名称。

一些典型的使用场景

隐藏辅助函数: 库内部使用的一些辅助函数，不需要暴露给用户，可以使用 __attribute__((visibility("hidden"))) 隐藏起来。
```
MY_LIBRARY_HIDDEN int helper_function(int x) {
    // ...
}
```
隐藏私有类: 一些私有类，只在库内部使用，不需要暴露给用户，可以使用 __attribute__((visibility("hidden"))) 隐藏起来。
```
MY_LIBRARY_HIDDEN class PrivateClass {
    // ...
};
```
隐藏实现细节: 库的实现细节，不需要暴露给用户，可以使用 __attribute__((visibility("hidden"))) 隐藏起来。这可以让你更自由地修改库的内部结构，而不用担心破坏用户的代码。

总结：让你的库更上一层楼

__attribute__((visibility("hidden"))) 是一个强大的工具，可以让你更好地控制 C++ 库的符号可见性。通过合理地使用它，你可以：

减少符号污染
减小库的大小
隐藏实现细节
增强安全性

希望通过今天的讲解，你已经掌握了 __attribute__((visibility("hidden"))) 的基本用法和注意事项。在设计库的时候，记得灵活运用它，让你的库更牛逼！记住，代码就像盖房子，好的设计才能盖出稳固漂亮的大楼。而符号可见性控制，就是你手中的蓝图，让你能够精确地控制哪些“房间”对外开放，哪些“房间”保持私密，最终构建出一个高质量、易于维护的库。

C++ 符号可见性控制：`attribute((visibility(“hidden”)))` 与库设计

发表回复取消回复

发表回复 取消回复

发表回复取消回复