среда, 5 сентября 2018 г.

Xdebug в BitrixVM (CentOS\PhpStorm)


Статья нацелена помочь 
начинающим, коим я все
 еще себя считаю.

"Век живи - век учись"



В процессе изучения и разработки БУС и особенно Б24, может оказаться очень полезным Xdebug.

Xdebug — средство профилирования и отладки PHP скриптов. XDebug поставляется как расширение для PHP.


Например - нужно понять как работает какой то метод.

Смотрим документацию, там ничего, гуглим и тоже пусто.
Лезем в ядро, находим его но от туда понятно что ничего не понятно и т.д.

По мимо того, что мы возможно так и не поймем как он работает и какие параметры нужны, мы потратим огромное количество времени. По большей части, именно для этого я использую Xdebug (сейчас я занимаюсь B24 коробкой а с документацией там все плохо).

Рассмотрим пример с использованием Xdebug(более конкретно):

Допустим нам нужно создать "Важное" сообщение определенным сотрудникам в Живой ленте портала. С помощью отладки узнаем что этим занимается компонент "socialnetwork.blog.post.edit". Заходим в "component.php" и ужасаемся 2.5к строк кода.

Но с Xdebug мы можем поставить в нашей IDE точку прерывания в начале файла и создать на портале нужный тип сообщения со всеми параметрами. И теперь в IDE по шагам посмотреть как собираются и форматируются данные и многое другое.

Согласитесь, времени на это уйдет меньше и с большей вероятностью вы полностью правильно все сделаете. Учитывая что ТП битрикса часто дает не полные ответы и что то продолжает работать не корректно или вообще крашится база (да и такие советы от ТП бывали...) я считаю Xdebug очень удобным и нужным инструментом, как для тех кто только познакомился с битриксом так и для тех кто с ним уже давно.

Как это вообще будет работать?? Код же выполняется на сервере!

Это не магия!! Так что успокоились, выдохнули и продолжаем.

Когда мы установили и настроили Xdebug он начитает контролировать выполнение всех скриптов, это значит что он может останавливать, ставить на паузу скрипт, получать данные по всем переменным и изменять их в ходе выполнения.
Так же Xdebug является сервером, он ожидает соединения с клиентом по определенному порту. Вы как клиент-xdebug посылаете команды серверу-xdebug который удаленно контролирует выполнение кода.

Теперь перейдем непосредственно к сути.

Установим Xdebug.


Нам потребуется установленный BirixVM (он может быть как на локале так и на сервере если таковой имеется).

Установка и настройка BitrixVM 


Если сервер поднят локально то нужно обязательно проверить есть ли с него доступ во внешнюю сеть. 

После того как вы установили, подняли сайт заходим на сервер под именем "root" и выполняем команды ниже.

 1) Устанавливаем пакет разработки PHP для выполнения команд PHP

yum install php-devel -y
yum install php-pear -y

 2) Затем установите компиляторы GCC и GCC C ++ для компиляции расширения Xdebug самостоятельно.

yum install gcc gcc-c++ autoconf automake

 3) Устанавливаем и компилируем Xdebug

pecl install Xdebug

 4) Находим файл php.ini (/etc/php.ini) добавляем в конец файла

[xdebug]
zend_extension="/usr/lib64/php/modules/xdebug.so"
xdebug.remote_enable = 1

 5) Перезагружаем Apache

service httpd restart

Проверить установился ли Xdebug можно с помощью "phpinfo()".

Подключение к серверу.


Что бы мы могли общаться с xdebug нам нужно подключиться к серверу по порту который указан в настройках xdebug (стандартно 9000). 
Если вы используете для работы Linux\MacOS то вам будет достаточно прописать в командной строке 

ssh -q -R 9000:localhost:9000 username@server_adres

Если как в моем случае предпочитаете работать в Win то есть несколько вариантов. Но я расскажу про тот который не отличается от варианта с Linux\MacOS.
Нужно скачать и распаковать эмулятор консоли Cmder, запустить от имени администратора и ввести строку выше. Все готово, мы подключились!
 (консоль не закрывать!)

Настройки IDE (PhpStorm)

Так как я пользуюсь IDE PhpStorm то и расскажу про него.

Сперва заберем проект с нашей вируалки обычным гитом, инициализировать гит лучше по верх папки "www".
Открываем проект в "шторме", подключаемся к серверу (Remote Host) настраиваем там маппинг.

Пример того как должны выглядеть настройки подключения.


























Теперь нажимаем эту кнопку




Теперь (при условии что вы подключены по ssh к серверу) в браузере открываем наш сайт жмем на установленное нами расширение и выбираем пункт "debug". Перезагружаем страницу.

В шторме откроется окно в нем нужно будет просто нажать "OK" (при условии что маппинги настроены правильно).
После всех этих манипуляций мы увидим желанную информацию.











Так же стоит перейти в настройки (Settings > Languages & Framewirks > PHP > Debug) и убрать чекбокс "Break at first line in PHP scripts" иначе при каждой перезагрузке сайта процесс будет останавливаться на первой строке. Лучше ставить брейкпойнты там где нужно, что бы пропускать кучу ненужного кода.



Xdebug в BitrixVM (CentOS\PhpStorm)