如何用node-gyp在不同Linux发行版中兼容引入SDL2类库

问题背景 #

我在Linux系统上构建Node.js Addon项目时，需要链接SDL2和SDL2_image共享库，但不同发行版的库路径不一致：Ubuntu下库文件位于/usr/lib/x86_64-linux-gnu/，Fedora下则在/usr/lib64/。当前binding.gyp使用绝对路径指定库文件，无法跨发行版兼容；尝试改用-lSDL2的方式时，Ubuntu可以正常构建，但Fedora会报错：/usr/bin/ld: cannot find -lSDL2: File or directory does not exist。

当前的binding.gyp内容如下：

{
    'targets': [
        {
            'target_name': 'canvas_sdl2',
            'sources': [
                'src/init.cpp',
                'src/sdl2node.cpp',
                'src/sdl2image_node.cpp',
                'src/common.cpp'
            ],
            'cflags!': ['-fno-exceptions'],
            'cflags_cc!': ['-fno-exceptions'],
            'xcode_settings': {
                'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
                'CLANG_CXX_LIBRARY': 'libc++',
                'MACOSX_DEPLOYMENT_TARGET': '10.7'
            },
            'msvs_settings': {
                'VCCLCompilerTool': {'ExceptionHandling': 1},
            },
            'dependencies': [
                "<!(node -p \"require('node-addon-api').gyp\")"
            ],
            'include_dirs': [
                        "<(module_root_dir)/include/sdl/",
                        "<(module_root_dir)/include/sdlimg/",
                        "<!@(node -p \"require('node-addon-api').include\")",
                    ],
            'conditions': [
                ["OS==\"win\"", {
                    'libraries': [
                        "<(module_root_dir)/bin/sdl/winx64/SDL2.lib",
                        "<(module_root_dir)/bin/sdlimg/winx64/SDL2_image.lib",
                    ],
                    'copies': [
                        {
                            'destination': '<(module_root_dir)/build/Release/',
                            'files': [
                                '<(module_root_dir)/bin/sdl/winx64/SDL2.dll',
                                '<(module_root_dir)/bin/sdlimg/winx64/SDL2_image.dll'
                            ]
                        }
                    ]
                }],
                ["OS==\"linux\"", {
                    "libraries": [
                        "/lib/x86_64-linux-gnu/libSDL2-2.0.so.0",
                        "/lib/x86_64-linux-gnu/libSDL2_image-2.0.so.0",
                    ]
                    # How can I make it compatible with other distributions?
                }]
            ]
        }
    ]
}

解决方案 #

核心思路：使用pkg-config自动获取库路径 #

SDL2和SDL2_image官方支持pkg-config工具，它能自动识别当前系统的库路径和编译链接参数，完美解决跨发行版路径不一致的问题。

1. 安装依赖开发包

先在对应发行版上安装SDL2和SDL2_image的开发包：

• Ubuntu/Debian系：

  sudo apt-get install libsdl2-dev libsdl2-image-dev
  

• Fedora/RHEL系：

  sudo dnf install SDL2-devel SDL2_image-devel
  

2. 修改binding.gyp的Linux条件块

将原Linux部分的libraries配置替换为调用pkg-config的命令，让它自动生成适配当前系统的链接参数：

["OS==\"linux\"", {
    "libraries": [
        "<!(pkg-config --libs SDL2 SDL2_image)"
    ]
}]

修改后的完整binding.gyp

{
    'targets': [
        {
            'target_name': 'canvas_sdl2',
            'sources': [
                'src/init.cpp',
                'src/sdl2node.cpp',
                'src/sdl2image_node.cpp',
                'src/common.cpp'
            ],
            'cflags!': ['-fno-exceptions'],
            'cflags_cc!': ['-fno-exceptions'],
            'xcode_settings': {
                'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
                'CLANG_CXX_LIBRARY': 'libc++',
                'MACOSX_DEPLOYMENT_TARGET': '10.7'
            },
            'msvs_settings': {
                'VCCLCompilerTool': {'ExceptionHandling': 1},
            },
            'dependencies': [
                "<!(node -p \"require('node-addon-api').gyp\")"
            ],
            'include_dirs': [
                        "<(module_root_dir)/include/sdl/",
                        "<(module_root_dir)/include/sdlimg/",
                        "<!@(node -p \"require('node-addon-api').include\")",
                    ],
            'conditions': [
                ["OS==\"win\"", {
                    'libraries': [
                        "<(module_root_dir)/bin/sdl/winx64/SDL2.lib",
                        "<(module_root_dir)/bin/sdlimg/winx64/SDL2_image.lib",
                    ],
                    'copies': [
                        {
                            'destination': '<(module_root_dir)/build/Release/',
                            'files': [
                                '<(module_root_dir)/bin/sdl/winx64/SDL2.dll',
                                '<(module_root_dir)/bin/sdlimg/winx64/SDL2_image.dll'
                            ]
                        }
                    ]
                }],
                ["OS==\"linux\"", {
                    "libraries": [
                        "<!(pkg-config --libs SDL2 SDL2_image)"
                    ]
                }]
            ]
        }
    ]
}

原理说明 #

pkg-config --libs SDL2 SDL2_image会输出当前系统下链接SDL2和SDL2_image所需的所有参数：比如在Ubuntu下可能输出-L/usr/lib/x86_64-linux-gnu -lSDL2 -lSDL2_image，在Fedora下则输出-L/usr/lib64 -lSDL2 -lSDL2_image，自动适配不同发行版的路径差异。

之前直接用-lSDL2报错，是因为Fedora的链接器默认搜索路径未包含/usr/lib64，而pkg-config会自动补充正确的-L路径参数。

内容的提问来源于stack exchange，提问作者Simone Ancona