모든 컴퓨터 책이 그렇듯 어떤 언어나 프로젝트의 창시자가 쓴 책은 믿고 봐도 된다는 게 정설이다(물론 번역서는 번역의 품질이라는 변수가 있지만). 이번에 ANTLR 프로젝트의 창시자인 Terence Parr가 쓴 『The Definitive ANTLR 4 Reference』의 번역서가 나왔다. 자바 기반의 파서 제너레이터인 ANTLR 프로젝트는 그동안 자바 개발자들에게 많은 사랑을 받아온 프로젝트다. ANTLR은 나도 잠깐 3 버전을 SQL 비슷한 문법을 파싱하기 위해 쓴 적이 있고, 역시 Terence Parr가 만든 템플릿 엔진(ANTLR 내에서도 사용한다)은 그 이후로도 종종 쓴 적이 있다. 컴퓨터 공학 전공이 아니라서 컴파일러 및 프로그래밍 언어론 같은 수업을 들은 적이 없다 보니 처음엔 ANTLR을 사용하기가 어려웠는데, 이 분야에 관심이 있거나 기본적인 배경지식을 갖춘 분이라면 ANTLR을 활용하는 데 어려움이 없을 것 같다. 그리고 나 같은 사람에게 ANTLR의 장점은 ANTLRWorks라는 GUI 도구 및 인텔리J IDEA나 이클립스용 플러그인이 있어서 문법을 시각적으로 확인하고 편집할 수 있다는 것이었다. 아무튼 이처럼 결코 대중적이지 않은 주제의 책이 나와서 반갑다. 문자열 파싱이나 문법 처리에 관심이 있는 분들이 읽어볼 만한 책.
로그를 이용해 디버깅하는 법
로깅은 로그라고 하는 정보성 기록을 만들어도록 시스템을 작성하는 실천법입니다. 임시 코드 출력(Printlining)은 간단하고, 대개 임시로 쓸 로그를 만들어내는 것입니다. 초보자는 프로그래밍 지식이 제한적이기 때문에 로그를 이해하고 사용해야 하고, 시스템 아키텍트는 시스템의 복잡성 때문에 로그를 이해하고 사용해야 합니다. 로그에서 제공하는 정보의 양은 설정 가능해야 합니다(이상적인 경우 프로그램이 실행 중인 동안에도). 일반적으로 로그는 세 가지 기본적인 이점을 제공합니다.
- 로그는 재현하기 힘든 버그(배포 환경에서는 발생하지만 테스트 환경에서는 재현할 수 없는 것과 같은)에 관한 유용한 정보를 제공할 수 있습니다.
- 로그는 성능과 관련된 통계와 데이터를 제공할 수 있습니다(예: 두 문장 사이에 소요된 시간).
- 로그를 설정할 수 있는 경우, 예상치 못한 특정 문제를 디버깅하기 위해 해당 문제만를 해결하는 코드를 수정 및(또는) 재배포할 필요 없이 일반적인 정보를 확보할 수 있습니다.
로그에 출력하는 내용의 양은 정보와 간결성 사이에서 절충 가능합니다. 정보가 너무 많으면 로그를 처리하는 비용이 높아지고 스크롤의 압박이 생겨서 원하는 정보를 찾기가 힘들어집니다. 반면 정보가 너무 적으면 필요한 정보가 포함돼 있지 않을지도 모릅니다. 이러한 이유로 로그에 출력하는 내용을 설정 가능하게 만들면 아주 유용합니다. 대개 로그상의 각 레코드는 소스 코드 상의 위치, 실행된 스레드, 정확한 실행 시간, 그리고 공통적으로 특정 변수의 값, 여유 메모리의 양, 데이터 객체의 수 등과 같이 추가적인 유용한 정보를 파악하게 해줍니다. 이러한 로그문은 소스코드 도처에 흩어져 있으며, 특히 주요 기능 지점과 위험성 있는 코드 주변에 지정돼 있습니다. 각 로그문에는 레벨을 할당할 수 있고 시스템이 현재 해당 레벨로 설정돼 있는 경우에만 로그 레코드를 출력할 것입니다. 로그문은 예상되는 문제를 해결하도록 설계해야 합니다. 성능 측정의 필요성을 예상해 보십시오.
영구적인 로그가 있다면 로그 레코드 측면에서 임시 코드 출력(Printlining)을 해볼 수 있으며, 아마도 그러한 디버깅 문장의 일부는 영구적으로 로깅 시스템에 추가될 것입니다.
- 다음 항목: 성능 문제를 이해하는 법
오류를 제거하는 법
지금까지는 일부러 프로그램 실행을 검사하는 활동과 오류를 고치는 활동을 나눴습니다. 하지만 물론 디버깅은 버그를 제거하는 것을 의미하기도 합니다. 이상적인 경우라면 코드를 완벽하게 이해하고 오류와 그것을 고치는 방법이 훤히 드러나는 ‘아하!’라고 깨닫는 순간에 도달해야 할 것입니다. 하지만 프로그램은 여러분이 명확하게 알기 힘든, 불충분하게 문서화된 시스템을 사용하는 경우도 있을 것이므로 이러한 순간이 늘 오지는 않을 것입니다. 어떤 경우에는 코드가 너무 복잡해서 완벽하게 이해하지 못하는 경우도 있을 것입니다.
버그를 고칠 때는 가장 작은 부분만 변경해서 해당 버그를 고치고 싶을 것입니다. 개선이 필요한 다른 부분이 보일지도 모릅니다. 하지만 그것들을 동시에 고치지는 마십시오. 한 번에 딱 하나만 변경하는 과학적 방법론을 활용하려고 하십시오. 이를 위한 최선의 방법은 버그를 손쉽게 재현한 다음, 고친 코드를 올바른 자리에 놓고, 프로그램을 다시 실행해서 버그가 더는 존재하지 않는지 관찰하는 것입니다. 물론 때로는 한 줄 이상을 변경해야 하겠지만 그럼에도 개념적으로는 단 하나의 최소한의 변경사항을 적용해 버그를 고쳐야 합니다.
간혹 여러 개의 버그가 하나로 보일 때도 있습니다. 버그를 정의하고 그것을 한번에 고치는 것은 여러분에게 달려 있습니다. 때로는 프로그램이 어떻게 동작해야 하거나 원 제작자가 의도한 바가 명확하지 않은 경우도 있습니다. 이 경우 경험과 판단을 발휘해 해당 코드에 여러분만의 의미를 부여해야 합니다. 프로그램이 어떻게 동작해야 할지를 결정하고 그것을 주석으로 남기거나 다른 어떤 방법으로 분명히 밝힌 다음 코드가 여러분이 의미한 바를 따르게 하십시오. 이는 맨 처음에 원래의 함수를 작성하는 것보다 더 어려운 중급 또는 고급 기술이며, 현실 세계는 깔끔하게 맞아떨어지지 않을 때가 많습니다. 어쩌면 재작성할 수 없는 시스템을 고쳐야 할 수도 있습니다.
- 다음 항목: 로그를 이용해 디버깅하는 법
