마젠토 디버깅 - Xdebug

이전 포스트에서는 PhpStorm의 설치와 기본 설정 방법에 대해 알아보았습니다. 이번 포스트에서는 디버깅을 위한 Xdebug 설정을 살펴보겠습니다.

​

사실 몇몇 개발자들은 디버깅 툴이나 환경 없이도 쉘 상에서 훌륭하게 개발을 합니다. 이는 그들이 플랫폼에 대한 깊은 이해를 가지고 있기 때문입니다. 플랫폼을 충분히 이해하고 있다면, 꼭 훌륭한 툴이 없어도 개발이 가능하다는 점은 사실입니다.

​

하지만 초보 개발자라면, 디버깅 환경을 구축한 후 개발을 시작하는 것이 매우 중요합니다. 이는 마젠토와 같은 복잡한 플랫폼을 더 잘 이해하고, 문제를 빠르게 해결하는 데 큰 도움이 됩니다.

​

Chapter 2.2 Xdebug 설정

Xdebug는 PHP 디버깅과 개발을 지원하는 강력한 확장 기능입니다. 이전 장에서 이미 Xdebug를 설치(php7.4-xdebug)했으므로, 이번 장에서는 Xdebug의 설정 방법에 대해 알아보겠습니다.

​

Step 1: Xdebug 설정

먼저, PHP에서 Xdebug를 사용할 수 있도록 설정 파일을 수정해야 합니다. /etc/php/7.4/fpm/conf.d/20-xdebug.ini 파일을 열어, 아래의 설정 항목을 추가합니다.

 

xdebug.remote_enable=true

xdebug.remote_host=localhost

xdebug.remote_port=9000

xdebug.remote_handler="dbgp"

xdebug.remote_autostart=On

xdebug.mode=debug

 

이렇게 설정을 마친 후, PHP를 다시 시작하면 Xdebug를 활용한 디버깅 환경이 준비됩니다

 

$> sudo systemctl restart php7.4-fpm

 

다시 PhpStorm 돌아와 File > Settings 을 클릭하면 [그림 2-12]와 같은 새 창이 열립니다. 새 창의 좌측 메뉴에서 Languages & Frameworks> PHP를 선택 후 우측 상단의 … 을 클릭합니다

​

​

창의 좌측 상단의 +을 클릭 후 /usr/bin/php를 선택합니다

​

​

Debugger 정보로 Xdebug 가 나오는 걸 확인 후 OK를 클릭합니다.

​

Step 2: Xdebug 설정: Chrome 확장 프로그램 설치

Xdebug를 효과적으로 사용하기 위해서는 브라우저에 확장 프로그램을 설치해야 합니다. 이 책에서는 Chrome 브라우저를 기준으로 설명하겠습니다. 만약 우분투 데스크톱을 사용 중이라면, 아래 명령어를 통해 Chrome을 설치할 수 있습니다.

 

$> cd

$> wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -

$> sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main">> /etc/apt/sources.list.d/google.list'

$> sudo apt-get update $> sudo apt-get install google-chrome-stable

 

Xdebug Helper 확장 프로그램을 설치 합니다.

(1) Chrome을 실행한 후, Chrome 웹 스토어에 접속합니다.

(2) Xdebug Helper 검색를 검색합니다.

(3) Xdebug Helper를 추가 합니다.

​

 

​

이제 Xdebug Helper 확장 프로그램을 보다 편리하게 사용하기 위해 브라우저 메뉴에 고정해 보겠습니다.

​

(1) Chrome 브라우저의 우측 상단에 있는 조각 모양 아이콘(확장 프로그램 아이콘)을 클릭합니다.

(2) 확장 프로그램 목록에서 Xdebug Helper 옆에 있는 핀 모양 아이콘을 클릭하여 메뉴에 고정합니다.

​

이를 통해 Xdebug Helper 아이콘이 브라우저 상단에 고정되어, 디버깅 모드 전환을 더욱 쉽게 할 수 있습니다.

​

​

디버깅을 활성화하려면 Magento 사이트에서 몇 가지 추가 설정이 필요합니다.

​

(1) 크롬에서 dev.magento.com으로 이동합니다.

(2)사이트 상단에 있는 벌레 모양 아이콘을 클릭해 디버깅 모드를 활성화 합니다.

(3) 벌레 모양의 아이콘이 녹색으로 바뀌었다면 Debug 모드가 활성화 된것입니다.

​

Step 3: Xdebug 정상 작동 여부 확인하기

이제 Xdebug가 제대로 작동하는지 확인해 보겠습니다. 다음 단계들을 따라 테스트를 진행해 주세요.

​

(1) 소스 파일 열기

PhpStorm의 좌측에 있는 소스 파일 탐색기에서 magento/pub/index.php 파일을 엽니다.

​

(2) Breakpoint 설정

37번째 라인 옆의 빈 공간을 클릭하여 Breakpoint를 설정합니다. Breakpoint가 설정되면 해당 라인에 빨간 점이 표시됩니다.

​

(3) 디버깅 모드 활성화

PhpStorm 상단에 있는 전화기 아이콘(디버그 버튼)을 클릭하여 녹색 표시가 되도록 합니다. 이 상태가 되면 디버깅 모드가 활성화됩니다.

​

(4) 크롬 브라우저 새로 고침

크롬 브라우저에서 Magento 사이트를 새로 고침(F5)합니다.

​

​

Step 3: Xdebug 사용정지

디버깅 세션을 마친 후, Xdebug 사용을 중지하는 방법은 다음과 같습니다

​

(1) Xdebug Helper 비활성화

크롬 브라우저에서 Xdebug Helper 아이콘을 클릭하고 Disable 옵션을 선택하여 Xdebug Helper를 비활성화합니다.

​

(2) Breakpoint 해제

PhpStorm에서 index.php 파일의 37번째 라인 옆에 있는 빨간 공(Breakpoint)을 클릭하여 Breakpoint를 해제합니다.

​

(3) 디버깅 모드 종료

PhpStorm 상단의 전화기 아이콘 옆에 있는 빨간 정지 버튼을 클릭하여 디버깅 세션을 종료합니다.

​

(4) 디버깅 아이콘 상태 확인

상단의 전화기 아이콘을 다시 클릭하여 빨간과 녹색 표시가 나타나도록 하여 Xdebug 사용을 완전히 중지합니다.

​

이제 Xdebug를 PhpStorm과 크롬을 함께 사용할수 있게 되었습니다. 시간이 되신다면 각종 버그를 만든후 디버깅을 해보시면 많은 도움이 될것입니다. 다음글에서는 마젠토 개발에 많은 도움이될 디버깅을 위한 마젠토 모듈 을 설치해 보겠습니다.