在 MacOS 上为 PHPStorm 安装 Xdebug

Question

我在 macOS 上安装 Xdebug 时遇到了很多问题。

从 phpinfo 页面，我看到我正在使用的 php.ini 文件在/etc/php.ini 中。在遵循this 等一些教程时，有人提到应该将[xdebug] section 注释掉。我碰巧在页面底部根本看不到它，只是按照教程将其包含在内，此后更改我的php -v 将产生此输出

Failed loading /Applications/MAMP/bin/php/php7.3.9/lib/php/extensions/no-debug-non-zts-20180731/xdebug.so:  dlopen(/Applications/MAMP/bin/php/php7.3.9/lib/php/extensions/no-debug-non-zts-20180731/xdebug.so, 0x0009): code signature in (/Applications/MAMP/bin/php/php7.3.9/lib/php/extensions/no-debug-non-zts-20180731/xdebug.so) not valid for use in process: mapping process is a platform binary, but mapped file is not
PHP 7.3.9 (cli) (built: Nov  9 2019 08:08:13) ( NTS )
Copyright (c) 1997-2018 The PHP Group
Zend Engine v3.3.9, Copyright (c) 1998-2018 Zend Technologies

在尝试 xdebug 之前，我主要使用php 7.3.9，并且我还尝试了一些解决方案，例如this、this 和this，这主要给了我一个失败的“make”和空白的 PHP API 版本。这是从the first solution运行sudo pecl install xdebug的痕迹

Password:
downloading xdebug-2.9.4.tgz ...
Starting to download xdebug-2.9.4.tgz (243,689 bytes)
..................................................done: 243,689 bytes
91 source files, building
running: phpize
grep: /usr/include/php/main/php.h: No such file or directory
grep: /usr/include/php/Zend/zend_modules.h: No such file or directory
grep: /usr/include/php/Zend/zend_extensions.h: No such file or directory
Configuring for:
PHP Api Version:
Zend Module Api No:
Zend Extension Api No:
building in /private/var/tmp/pear/temp/pear-build-rootvAIHaa/xdebug-2.9.4
running: /private/var/tmp/pear/temp/xdebug/configure --with-php-config=/usr/bin/php-config
checking for grep that handles long lines and -e... /usr/bin/grep
checking for egrep... /usr/bin/grep -E
checking for a sed that does not truncate output... /usr/bin/sed
checking for cc... cc
checking whether the C compiler works... yes
checking for C compiler default output file name... a.out
checking for suffix of executables...
checking whether we are cross compiling... no
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether cc accepts -g... yes
checking for cc option to accept ISO C89... none needed
checking how to run the C preprocessor... cc -E
checking for icc... no
checking for suncc... no
checking whether cc understands -c and -o together... yes
checking for system library directory... lib
checking if compiler supports -R... no
checking if compiler supports -Wl,-rpath,... yes
checking build system type... x86_64-apple-darwin19.2.0
checking host system type... x86_64-apple-darwin19.2.0
checking target system type... x86_64-apple-darwin19.2.0
checking for PHP prefix... /usr
checking for PHP includes... -I/usr/include/php -I/usr/include/php/main -I/usr/include/php/TSRM -I/usr/include/php/Zend -I/usr/include/php/ext -I/usr/include/php/ext/date/lib
checking for PHP extension directory... /usr/lib/php/extensions/no-debug-non-zts-20180731
checking for PHP installed headers prefix... /usr/include/php
checking if debug is enabled... no
checking if zts is enabled... no
checking for re2c... no
configure: WARNING: You will need re2c 0.13.4 or later if you want to regenerate PHP parsers.
checking for gawk... no
checking for nawk... no
checking for awk... awk
checking if awk is broken... no
checking whether to enable Xdebug support... yes, shared
checking whether to enable Xdebug developer build flags... no
checking Check for supported PHP versions... supported (7.3.9)
checking for gettimeofday... yes
checking for ANSI C header files... yes
checking for sys/types.h... yes
checking for sys/stat.h... yes
checking for stdlib.h... yes
checking for string.h... yes
checking for memory.h... yes
checking for strings.h... yes
checking for inttypes.h... yes
checking for stdint.h... yes
checking for unistd.h... yes
checking netinet/in.h usability... yes
checking netinet/in.h presence... yes
checking for netinet/in.h... yes
checking poll.h usability... yes
checking poll.h presence... yes
checking for poll.h... yes
checking sys/poll.h usability... yes
checking sys/poll.h presence... yes
checking for sys/poll.h... yes
checking for cos in -lm... yes
checking for ld used by cc... /Library/Developer/CommandLineTools/usr/bin/ld
checking if the linker (/Library/Developer/CommandLineTools/usr/bin/ld) is GNU ld... no
checking for /Library/Developer/CommandLineTools/usr/bin/ld option to reload object files... -r
checking for BSD-compatible nm... /usr/bin/nm -B
checking whether ln -s works... yes
checking how to recognize dependent libraries... pass_all
checking dlfcn.h usability... yes
checking dlfcn.h presence... yes
checking for dlfcn.h... yes
checking the maximum length of command line arguments... 196608
checking command to parse /usr/bin/nm -B output from cc object... ok
checking for objdir... .libs
checking for ar... ar
checking for ranlib... ranlib
checking for strip... strip
checking for dsymutil... dsymutil
checking for nmedit... nmedit
checking for -single_module linker flag... yes
checking for -exported_symbols_list linker flag... yes
checking if cc supports -fno-rtti -fno-exceptions... yes
checking for cc option to produce PIC... -fno-common
checking if cc PIC flag -fno-common works... yes
checking if cc static flag -static works... no
checking if cc supports -c -o file.o... yes
checking whether the cc linker (/Library/Developer/CommandLineTools/usr/bin/ld) supports shared libraries... yes
checking dynamic linker characteristics... darwin19.2.0 dyld
checking how to hardcode library paths into programs... immediate
checking whether stripping libraries is possible... yes
checking if libtool supports shared libraries... yes
checking whether to build shared libraries... yes
checking whether to build static libraries... no

creating libtool
appending configuration tag "CXX" to libtool
configure: creating ./config.status
config.status: creating config.h
running: make
/bin/sh /private/var/tmp/pear/temp/pear-build-rootvAIHaa/xdebug-2.9.4/libtool --mode=compile cc   -I. -I/private/var/tmp/pear/temp/xdebug -DPHP_ATOM_INC -I/private/var/tmp/pear/temp/pear-build-rootvAIHaa/xdebug-2.9.4/include -I/private/var/tmp/pear/temp/pear-build-rootvAIHaa/xdebug-2.9.4/main -I/private/var/tmp/pear/temp/xdebug -I/usr/include/php -I/usr/include/php/main -I/usr/include/php/TSRM -I/usr/include/php/Zend -I/usr/include/php/ext -I/usr/include/php/ext/date/lib -I/private/var/tmp/pear/temp/xdebug/src -I/private/var/tmp/pear/temp/pear-build-rootvAIHaa/xdebug-2.9.4/src  -DHAVE_CONFIG_H  -g -O2   -c /private/var/tmp/pear/temp/xdebug/xdebug.c -o xdebug.lo
mkdir .libs
 cc -I. -I/private/var/tmp/pear/temp/xdebug -DPHP_ATOM_INC -I/private/var/tmp/pear/temp/pear-build-rootvAIHaa/xdebug-2.9.4/include -I/private/var/tmp/pear/temp/pear-build-rootvAIHaa/xdebug-2.9.4/main -I/private/var/tmp/pear/temp/xdebug -I/usr/include/php -I/usr/include/php/main -I/usr/include/php/TSRM -I/usr/include/php/Zend -I/usr/include/php/ext -I/usr/include/php/ext/date/lib -I/private/var/tmp/pear/temp/xdebug/src -I/private/var/tmp/pear/temp/pear-build-rootvAIHaa/xdebug-2.9.4/src -DHAVE_CONFIG_H -g -O2 -c /private/var/tmp/pear/temp/xdebug/xdebug.c  -fno-common -DPIC -o .libs/xdebug.o
/private/var/tmp/pear/temp/xdebug/xdebug.c:25:10: fatal error: 'php.h' file not found
#include "php.h"
         ^~~~~~~
1 error generated.
make: *** [xdebug.lo] Error 1
ERROR: `make' failed

有人可以告诉我这是什么问题吗？请随时要求我提供更多信息。

Answer 1

问题

主要问题是 Apple 删除了 macOS Catalina 中的 /usr/include，它曾经是任何 C 头文件的位置，并且仍然存在于大多数 *NIX 系统上。尝试安装任何依赖于该特定位置的头文件的东西都会失败。解决办法是手动编译Xdebug，指定头文件的实际位置，还是Xcode提供的，只是在一个完全不同的地方。

安装 Xcode

1) 下载 Xcode

2) 打开Xcode，如果提示同意条款，然后退出。

3) 安装后打开终端：

$ xcode-select --install

4) 验证找到了SDK。

$ xcrun --show-sdk-path

它应该类似于下面的路径；您可能需要稍后相应地编辑路径：

/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk

手动编译 Xdebug

目前版本 2.9.4 似乎是最新的，因此我们将克隆该版本进行编译。

$ git clone https://github.com/xdebug/xdebug.git
$ cd xdebug
$ git tag -l
$ git checkout tags/2.9.4

php化

接下来我们需要复制phpize，然后编辑包含路径：

$ cp /usr/bin/phpize .
$ nano ./phpize

找到这一行（Control + W）：

includedir="`eval echo ${prefix}/include`/php"

用这一行替换它：

includedir="/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/usr/include/php"

运行 phpize：

$ ./phpize

正确的输出类似于：

Configuring for:
PHP Api Version:         20180731
Zend Module Api No:      20180731
Zend Extension Api No:   320180731

配置和构建

$ ./configure --enable-xdebug

完成后运行 make 并将 SDK 位置定义为编译器标志。使用变量来存储 SDK 的路径，以便在更改时更容易编辑：

$ SDK_PATH=$(xcrun --show-sdk-path)
$ make CPPFLAGS="-I${SDK_PATH}/usr/include/php -I${SDK_PATH}/usr/include/php/main -I${SDK_PATH}/usr/include/php/TSRM -I${SDK_PATH}/usr/include/php/Zend -I${SDK_PATH}/usr/include/php/ext -I${SDK_PATH}/usr/include/php/ext/date/lib"

可能会有警告 - 暂时忽略它。最后，运行：

$ make install

此命令将失败，因为它无法将扩展移动到正确的位置； SIP 阻止它。我们将在下一步手动移动它。 make install 仍然是必需的，因为它对 *.so 文件进行了共同设计。

一旦make install 运行（但失败），我们就可以移动可执行文件：

$ sudo mkdir -p /usr/local/php/extensions
$ sudo cp $(php-config --extension-dir)/xdebug.so /usr/local/php/extensions

现在编辑 PHP 配置 (php.ini) 以启用 Xdebug：

$ sudo nano /etc/php.ini

在底部添加以下内容：

[xdebug]
zend_extension=/usr/local/php/extensions/xdebug.so
xdebug.remote_enable=on
xdebug.remote_log="/var/log/xdebug.log"
xdebug.remote_host=localhost
xdebug.remote_handler=dbgp
xdebug.remote_port=9000

重启apache：

$ sudo apachectl restart

最后测试一切正常：

$ php -i | grep "xdebug support"

_{注意事项：感谢 Louis Charette 研究并找到解决此问题的方法。}

↳Installation of Xdebug on MacOS Catalina 10.15