Все интереснее, когда код приходится отлаживать не на локальной машине, а внутри docker-контейнера. Особенно, если нужно отладить cli-скрипт внутри контейнера.

Для успешной отладки следует:

1. Настроить docker-контейнер с Xdebug внутри;
2. Настроить Xdebug внутри контейнера;
3. Настроить NetBeans.

При обычной отладке с использованием браузера и при отладке cli-скрипта настройки будут слегка отличаться. Итак, поехали.

Настройка контейнера

Установку Xdebug внутрь контейнера мы обсуждать не будем. Эти настройки можно найти, например, тут.

Интереснее настройки самого Xdebug.

В случае с обычной отладкой:

xdebug.remote_enable=1
xdebug.remote_connect_back=1
xdebug.idekey=netbeans-xdebug

Расшифровка:

• xdebug.remote_enable — разрешает удаленную отладку.
• xdebug.remote_connect_back — автоматическое установление соединения с хостом, который иницирует удаленную отладку. Если не указывать эту опцию, то нужно использовать xdebug.remote_host, где следует указать ip вашего хоста из виртуального docker-адаптера.
• xdebug.idekey — ключ для соединения. Значение netbeans-xdebug задано в NetBeans по умолчанию. Можно не задавать эту опцию и использовать xdebug.remote_autostart=1, но тогда Xdebug будет стартовать в каждом скрипте, даже если это не нужно, что скажется на производительности.

Настройка NetBeans

Для успешной отладки NetBeans должен знать как сопоставить между собой пути внутри docker-контейнера и пути в хостовой машине.

Идем в Свойства проекта, далее Выполнить настройку → Дополнительно. Внизу в разделе Отображение пути добавляем наше сопоставление.

Теперь, если запустить отладку проекта, то отладчик должен автоматически остановить выполнение на первой строке скрипта точки входа в приложение (если активирована соответствующая настройка в IDE).

Если ничего не произошло и вас отключена опция NetBeans Остановить в первой строчке, то удостоверьтесь, что поставили breakpoint где-то по пути выполнения скрипта. Если ни одного breakpoint не установлено, то следует установить его, остановить отладку и запустить снова.

Отладка cli-скрипта

Для отладки cli-скрипта все немного иначе. Главное отличие в том, что опция xdebug.remote_connect_back=1 нам не нужна, ведь соединения от хостовой машины не будет. Вместо этого NetBeans будет ожидать обращений от приложения.

Для начала настроим NetBeans.

Идем по уже известному пути Свойства проекта → Выполнить настройку. Здесь добавляем новую конфигурацию, нажав Создать…. Далее жмем Дополнительно и указываем опцию Не открывать браузер.

После настройки, кликаем правой кнопкой по проекту, выбираем Установить конфигурацию и задаем вариант, который только что создали.

Теперь можно нажать Отладка проекта или просто Ctrl+F5. Браузер не должен открыться.

Идем в меню Окно → IDE и сервис → Терминал. В появившемся терминале выполняем вход в docker-контейнер, выполнив что-то вроде:

$ docker exec -ti %container_id% bash

%container_id% в данном случае id контейнера с вашим приложением.

Теперь самое интересное. Выполняем:

$ export XDEBUG_CONFIG="remote_enable=1 remote_mode=req remote_port=9000 remote_host=%remote_host_ip% remote_connect_back=0 idekey=netbeans-xdebug"

Обратите внимание на указанный remote_host. Именно по этому адресу Xdebug будет ломиться в отладчик. Проставьте свое значение на место %remote_host_ip%.

Теперь можно запустить какой-нибудь cli-скрипт. Например, миграции yii:

$ ./yii migrate

Если отладчик NetBeans запущен, то он должен отловить это событие и прервать выполнение на первой строке скрипта точки входа.

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

Горчие клавиши

Навигация

Alt+Up/Down — следующая/предыдущая позиция установки курсора.

Alt+Left/Alt+Right/Ctrl+Q — навигация по предыдущему/следующему редактированным фрагментам.

Ctrl+Q — перейти к последнему отредактированному фрагменту.

Ctrl+Shift+1 — найти текущий файл в дереве проектов и поставить на него фокус. Удобно чтобы не рыться долго в папках.

Alt+Shift+O — перейти к файлу по имени. Есть нечеткий поиск.

Ctrl+O — перейти к классу по имени.

Cltr+Alt+Shift+O — перейти к символу (например, функция). Полезно когда имя функции в проекте уникальное и помнишь название.

Ctrl+B — перейти к объявлению переменной/класса и т.д. Курсор должен быть установлен на переменной/классе и т.д.

Ctrl+Shift+M — поставить/удалить закладку. Когда нужно переходить в ходе рефакторинга в три-пять мест, чтобы не запоминать строки.

Ctrl+Shift+>, Ctrl+Shift+< — навигация по закладкам.

Ctrl+G — перейти к строке.

Ctrl+Tab — навигация по открытым файлам.

Редактирование

Ctrl+E — удалить текущую строку.

Ctrl+R — переименовать класс/метод/переменную.

Shift+Enter — вставка новой строки ниже, из любого места текущей строки. Чтобы не нажимать End.

Ctrl+Shift+Down/Up — копирование строки вниз/вверх соответственно.

Ctrl+Space — подсказка по функции, методу и т.д.

Ctrl+Shift+C — быстро закомментировать/раскомментировать код.

Alt+Shift+F — отформатировать код.

Ctrl+Shift+I — добавляет use для класса в начало файла.

Окна

Ctrl+Shift+W/F4 — закрыть все вкладки.

Shift+Esc — развернуть окно редактирования кода на весь экран, скрыв другие окна.

Alt+Shift+Enter — полноэкранный режим.

Шаблоны кода

Доступны по пути Сервис → Параметры → Редактор → Шаблоны кода. Эта особенность становится нужной, когда набирать код руками уже лень. :) Если кратко, то шаблоны кода это набор команд, которые разворачиваются в целые фрагменты кода. Обычно это различные рутинные конструкции вроде циклов, ветвлений, обработчиков исключений и прочего.

Шаблоны кода деляется на два типа: те что можно вызвать, набрав заранее известную комбинацию символов и нажав Tab (это действие называется разыменовыванием шаблона) и те что работают с выделенным кодом по нажатию комбинации Alt+Enter.

В редакторе уже предусмотрено множество встроенных шаблонов кода на все случаи жизни. Неплохо их распечатать и иметь под рукой, чтобы не набирать рутинный код.

Например, набрав vdoc можно добавить комментарий к ниже расположенной переменной. Или, набрав cls, получить сигнатуру класса с конструктором внутри. Причем NetBeans сам предложит в случае необходимости заполнить недостающие данные.

Шаблоны кода можно писать самому. Я, например, добавил себе в раздел HTML конструкции для тегов <?php ?> и <?= ?>

ph - <?= ${cursor} ?>
php - <?php ${cursor} ?>

Интересующихся темой ждет подробная документация на сайте NetBeans. Прочитав материал, а так же изучив существующие шаблоны кода, можно научится писать собственные варианты на все случаи жизни.

Кстати, данную заметку я написал прямо в NetBeans с использованием плагина поддержки Markdown и шаблоны кода, идущие в комплекте с плагином, здорово ускоряют оформление поста.

Макросы

Думаю, что такое макрос объяснять не нужно. В NetBeans можно писать свои макросы и навешивать их использование на горячие клавиши. Настройки можно найти по пути Сервис → Параметры → Редактор → Макросы.

Например, многие знают, что NetBeans умеет добавлять комментарии phpdoc к методу. Для этого нужно набрать /** над объявлением метода и нажать Enter. Все бы ничего, но эти символы неудобно расположены на клавиатуре.

Чтобы не мучаться можно написать макрос, который проделывает то же самое по нажатию одной комбинации клавиш. Вот его код:

"/**" insert-break

Можно не писать макросы руками, а записывать их по старинке как, например, в Excel. Для этого предусмотрены пункты меню Правка → Начать запись макроса и Правка → Завершить запись макроса.

Подробный обзор доступных команд есть, например, в статье Александра Макарова. Либо здесь, но уже на английском.

На счастье, для ряда приложений на основе Java есть фикс.

На странице фикса не описан процесс установки для NetBeans. Восполню этот пробел и опишу процесс для версии NetBeans 8.2.

Шаг 1. Скачать фикс

Тут ничего сложного. Идем на страницу фикса, скачиваем и распаковываем, например, в домашнюю папку.

Шаг 2. Обновить конфигурацию NetBeans

Далее идем в папку, где у нас установлена IDE и открываем нужный файл:

$ gedit ~/netbeans-8.2/etc/netbeans.conf

Ищем параметр netbeans_default_options. В конце строки параметра ставим пробел и добавляем что-то вроде -J-javaagent:/home/ilya/javafix/LinuxJavaFixes-1.0.0-SNAPSHOT.jar.

Сохраняем изменения.

Шаг 3. Проверка

Запускаем IDE. Переключаемся на русскую раскладку и жмем, например, Ctrl + F. Если панель поиска появилась, то порядок.