인텔리제이(IntelliJ) - 디버깅(Debugging) 하기

📎  글또 6기 포스팅

1. 미치도록 더웠던 7월의 회고

 

2. 사용자가 게시물을 작성할 때의 트랜잭션 처리

 

3. Spring AOP - (1) 프록시 패턴, 데코레이터 패턴

 

4. [MySQL] - 트랜잭션의 격리 수준(Isolation level)

 

5. Spring AOP - (2) AOP 개념 및 실습

 

6. 인텔리제이(IntelliJ) - 디버깅(Debugging) 하기

 

7. [Java, 디자인패턴] - 싱글턴 패턴(Singleton Pattern)

 

8. 월간 코드리뷰 Ver_0.1: 커리어 성장 CODE 세미나 정리

 

9. 포스트맨(API 테스트) 활용하기

 

10. 뜻깊은 2021년 회고

---

 

📎  인텔리제이(IntelliJ) - 디버깅(Debugging)하기

안녕하세요, 이번 시간에 정리할 내용은 인텔리제이에서 디버깅 하는 방법입니다.

 

먼저 디버깅의 사전적 의미는 다음과 같습니다.

디버깅(debugging) 또는 디버그(debug)는 컴퓨터 프로그램 개발 단계 중에 발생하는 시스템의 논리적인 오류나 비정상적 연산(버그)를 찾아내서 그 원인을 밝히고 수정하는 작업 과정을 뜻한다. 일반적으로 디버깅을 하는 방법으로 테스트 상의 체크, 기계를 사용하는 테스트, 실제 데이터를 사용해 테스트하는 법이 있다.

출처: 위키백과

 

디버깅을 잘 하는 능력은 개발자에게 정말 중요하다 라는 언급을 많이 들어왔었습니다.

정말 다양한 자료들과 영상들이 존재하지만, 제가 즐겨 보는 백기선님과 엘리님의 영상에도 다음과 같은 자료들이 존재합니다.

 

더 나은 개발자로 성장하는 팁 "개발자라면 디버거 사용법은 꼭 알아야죠"

코딩의 시작과 끝, 디버깅 | 실력있는 개발자의 필수 무기 🐛🐞

 

그럼 이러한 디버깅 능력은 왜 중요한지, 간단한 사례를 통해 설명하고 이후 제가 주로 사용하는 개발도구인 인텔리제이에서 디버깅을 하는 방법에 대해 상세히 알아보겠습니다. 

 

 

 

🎯 디버깅 상황

해당 코드는 스프링부트와 소셜로그인(google)을 구현하는 일부 코드입니다.

 

저의 현재 상황은 소셜 로그인을 하는 인증 클라이언트가 구글, 네이버, 카카오 등 어떠한 식별자인지에 따라 구현 방법이 달라지기에 식별자를 알아낼 필요가 있었습니다.

따라서 디버깅을 통해 해당 코드에서 각 변수들이 어떤 데이터를 가지고 있는지 확인해보았습니다.

authentication 변수에 authorizedClientRegistrationId 라는 변수값으로 "google" 값을 확인할 수 있습니다.

하지만 Authentication은 인터페이스이고, OAuth2AuthenticationToken은 클래스 입니다.

Authentication 인터페이스에서는 authorizedClientRegistrationId 변수를 읽어올 수 있는 메소드가 없기 때문에 OAuth2AuthenticationToken 자료형으로 형변환을 해주어야 합니다.

Authentication 인터페이스의 구현체인 OAuth2AuthenticationToken 클래스에 존재하는 getAuthorizedClientRegistrationId() 메소드를 통해 인증 클라이언트를 확인할 수 있습니다.

 

최종적으로는 다음 코드를 통해 인증 클라이언트를 확인할 수 있습니다.

final String socialType = ((OAuth2AuthenticationToken) authentication).getAuthorizedClientRegistrationId();

이와 같이 디버깅을 통해 브레이크 포인트 지점에서 각 변수에 어떠한 데이터들이 존재하는지 확인할 수 있고, 어떠한 데이터를 사용해야 하는지도 확인할 수 있기 때문에 굉장히 수월하게 값을 뽑아올 수 있었습니다.

 

디버깅이 아닌 로그나 System.out.println() 과 같이 출력문을 통해 확인해야 한다면 (저라면) 다음과 같이 진행할 것 같네요.

변수의 값을 하나하나 확인해가면서 필요한 데이터를 뽑아올 것 같습니다.

하지만 위의 가장 큰 문제점은 애플리케이션을 재실행하면서 발생하는 시간적인 비용이라고 생각합니다.

따라서 앞으론 디버깅을 통해 시간을 아껴보도록 합시다 :)

출처: https://blog.isusystem.com/blog/debugging-and-test/

 

 

 

🎯 인텔리제이 디버깅

먼저 인텔리제이에서 디버깅 모드는 우측 상단 벌레 표시를 통해 진행할 수 있습니다.

(단축키는 현재 포커스가 있는 곳은 Ctrl + Shift + D, 상단 탭이 가리키는 곳은 Crtl + D 입니다.)

 

 

디버그는 코드상에 브레이크 포인트를 설정함으로서 진입할 수 있습니다.

브레이크포인트(breakpoint), 중단점, 중지점은 소프트웨어 개발에서 프로그램을 의도적으로 잠시 또는 아예 멈추게 하는 장소를 가리키며 디버깅 목적으로 넣는 것이다.

참고: 위키

 

브레이크 포인트는 위 사진과 같이 코드 왼쪽 숫자가 있는곳에 마우스 왼쪽을 클릭하면 설정할 수 있습니다.

 

 

프로젝트에서 현재 설정한 브레이크 포인트를 확인하려면 상단에 Run > View Breakpoints...(Shift + Command + F8) 를 클릭하여 확인할 수 있습니다.

Breakpoint 확인

 

 

디버깅 모드를 실행해보면 위 사진과 같이 꽤 많은 아이콘들이 존재합니다. 

저도 그동안 주로 Step Over나  Step Into, Step Out정도만 사용을 해왔었는데요, 이번 기회에 좀 더 자세히 알아보겠습니다. 😃

(저는 아이콘을 커스텀했기 때문에 동일한 인텔리제이라도 아이콘 모양은 다르게 나타날 수 있습니다.)

 

 

Resume(Option + Command + R)

• 다음 Break Point로 이동합니다.

 

위 커서에서 Resume를 클릭하면 아래 다음 Break Point로 이동합니다.

 

 

Show Execution Point(Option + F10)

• 위 아이콘을 클릭하면 현재 실행 포인트로 커서가 바로 이동하게 됩니다.

 

Step Over(F8)

• 위 아이콘을 클릭하면 현재 실행 지점에서 다음 줄로 이동합니다.

 

Step Into(F7)

• 위 아이콘을 클릭하면 내부(메소드)로 이동합니다.

 

Force Step Into(Option + Shift + F7)

• 다음 실행되는 라인으로 이동하지만, Step Into와는 다르게 *Stepping을 무시하고 진행합니다.

*Stepping 기능은 디버그의 설정 기능 중 하나로 디버깅 중 건너뛸 수 있는 요소를 지정할 수 있습니다.

 

Stepping 설정을 위해 Command + Shift + a -> Stepping 설정 창으로 이동합니다.

 

아래 설정에서 Skip simple getters 에 체크를 해줍시다.

 

그 후 getter 메소드를 호출하는 곳에 브레이크 포인트를 설정하고 Step Into와 Force Step Into를 눌러가며 확인해봅시다.

 

Step Into(F7)

 

Force Step Into(Option + Shift + F7)

Force Step Into 는 Step Into와는 달리 getter 메소드까지 진입하여서 값을 확인합니다.

따라서 디버깅을 진행할 때 확인할 필요가 없는 getter, 생성자 등에 Stepping 설정을 한 뒤 Skip이 필요할 때는 Step Into로, 만약 전부 확인이 필요하다면 Force Step Into로 이동하면서 디버깅을 하면 됩니다.

 

 

Step Out(Shift + F8)

• 현재 break된 라인에서 호출한 곳으로 빠져나갑니다.(out)

 

Drop Frame

• Call Stack을 거슬러 올라갑니다.
• Step Out과 비슷하지만 Step Out은 해당 라인이 실행된 후 돌아가지만, Drop Frame은 해당 라인이 실행되기 전에 돌아갑니다.

 

Run to Cursor(Option + F9)

• 명령어를 입력하면 커서가 포커스 되어있는 라인으로 이동합니다.

위에서 현재 Break Point는 46라인이고, 커서는 55라인입니다.

이 상태에서 Option + F9를 누르면 break가 55라인으로 이동합니다.

해당 기능은 기존에 Break Point로 설정한게 아닌, 단발성으로 Break를 지정하고 확인할 때 유용하게 사용할 수 있습니다.

 

 

Evaluate Expression(Option + F8)

• Break된 상태에서 코드를 실행해 값을 확인할 수 있습니다.

※ Evaluate에 의해 실행된 코드는 실제 실행되므로 주의할 필요가 있습니다.

 

 

Watch

• Evaluate와 동일한 기능으로 확인하고자 하는 데이터를 추가하면 디버깅 모드에서 값을 확인할 수 있습니다.
• Evaluate의 경우 코드를 수동으로 실행해야 하지만, Watch의 경우 한 번 설정하면 Break 라인이 실행될 때마다 자동으로 실행이 됩니다.

1번(Watch)을 클릭한 후 2번을 클릭하여 데이터를 추가할 수 있습니다.

 

i라는 변수를 추가한 후 디버깅 모드를 실행해보면 i값이 watch에 의해 출력이 됩니다.

 

 

for문 디버깅

    public static void main(String[] args) {
        int i = 0;
        for (i = 0; i < 100; i++) {
            System.out.println(i);
            
            // changeMember(i);
        }
    }

간단하게 위와 같은 for문이 존재할 때, 특정 i값만 확인하고 싶을때가 있습니다. 예를들어, 위 반복문에서 i값이 50일때 값을 확인해보고 싶을때 F8을 무수히 누르다가 실수로 지나쳐버린다면?

이전으로 되돌아 갈 수 없으므로, 처음부터 다시 디버깅을 해야합니다..

 

 

따라서 위와 같이 반복문 내 특정 조건에 해당하는 지점에서 디버깅 모드를 실행하고자 할 때, 브레이크 포인트에서 우클릭을 한 후 Condition: 부분에서 조건문을 설정한 후 Done을 클릭하면 됩니다.

 

그럼 위 사진과 같이 브레이크 포인트 우측에 ? 박스가 하나 나타나게 됩니다.

그 후 디버깅모드를 다시 실행해보면 아래와 같이 조건문에 해당하는 값일때, 브레이크 포인트가 걸리게 됩니다.

 

 

 

🎯 정리

이상으로 인텔리제이에서 디버깅을 하는 방법에 대해 알아보았습니다.

가~끔 커뮤니티에서 "상사분이 디버깅 하지말고, System.out.println()으로 출력해서 확인한다." 라는 글을 꽤(?) 볼 수 있었습니다.

하지만 디버깅 모드는 개발자라면 꼭꼭 익혀야 하는 기술이 아닐까 생각합니다.

 

저또한 아직 자유자재로 디버깅 모드를 사용하며 개발을 하는 정도는 아니지만, 최대한 디버깅을 활용해 좀 더 친해지고 앞으로 유용하게 사용 할 수 있도록 디버깅에 익숙해지고자 합니다.

제가 주로 사용하는 스프링 프레임워크의 내부적으로 추상화가 엄청 잘 되어있기 때문에, 내부적으로 코드를 확인하고자 하면 디버깅은 선택이 아닌 필수인 것 같습니다 :)

 

 

 

 

📝 References

• https://jojoldu.tistory.com/149
• https://www.youtube.com/watch?v=gkutTlwi70s&t=1220s
• https://www.tangunsoft.com/software/news/detail?id=125&before=index