Debugging is the art of determining the cause and/or location of a problem. The purpose of this guide is to provide developers practical, hands-on experience using a variety of debugging techniques to identify problems in code.
As ImageJ is built using the SciJava principles of project management, this guide assumes a basic familiarity with these topics and tools, especially:
Additionally, you should:
- Install an IDE - this guide is written with Eclipse in mind.
- If using Eclipse, install the memory analyzer plugin.
- Clone the imagej-troubleshooting companion repository, which this guide is designed around, and import it as a Maven project into your IDE.
- Install the jvisualvm tool.
Finally, you should read the Debugging in Eclipse section, at least, of Lars Vogel's Eclipse tutorial. Note that there is significant overlap between the topics covered between these tutorials. Vogel's guide does a fantastic job of laying out the debugging interface and tools in Eclipse, while this guide focuses on providing hands-on practice and explaining the reasoning for when to use these tools.
If you find yourself confused when this tutorial asks you to do something in Eclipse (e.g. "start debugging", "step into") it's almost certainly covered in Vogel's guide.
What not to do: print statements
For many developers, the first tool in their debugging toolbox is the print statement. Print statements are easy to lean on as a safety crutch: you don't need any special knowledge to use them, and they often work in identifying answering common questions (e.g. "why is this variable null here?", "how many elements are in my array here?").
However, there are critical drawbacks to trying to debug via print statement:
- They are slow. If you realize you need to move or add a print statement, you need to recompile your code and re-launch your application.
- They are part of the code. Adding print statements changes line numbers, causes git to pick up modifications to the source code, and can even affect performance and/or behavior.
- They aren't even very useful. Even the most basic breakpoint and expression evaluation in Eclipse debug mode gives you vastly more power and flexibility over print statements.
Learning to use debugging tools is, understandably, a burden: it's "one more thing" to learn as a developer. But if you want to develop ImageJ plugins, you will almost certainly run into cases where debugging is necessary. So you may as well start familiarizing yourself with the tools now, gaining skills and perspectives that will serve you well, ideally throughout your career.
Using this guide
Remember the goal of these exercises is not to solve the problems, but to learn how and when to use the myriad of troubleshooting techniques available. Given the inherent complexity that comes with a combined work, all of these techniques have their time and place when working on a rich application like ImageJ.
Because this project is intended to help new developers practice troubleshooting skills, it uses contrived examples, limited in complexity. If you have complete, perfect knowledge of the code then there isn't really a need for troubleshooting, as it is trivial to see why something is behaving incorrectly. Thus the source of these exercises is divided into
visible packages. Users are strongly recommended to only inspect and set breakpoints from the
visible classes. From a development point of view, consider the
hidden package a 3rd-party library that you may not have control over.
Changing the source code to actually fix changes is outside the scope of this guide, but motivated users are of course welcome to do so for practice.
If at any time you need to revert changes to this repository, you can always do so via the command:
git reset --hard origin/master
Exercise 1: Breakpoints
- Practice setting breakpoints in Eclipse
- Use the Variables window to inspect variable values
- Use the navigation commands to traverse code while in Debug mode
The first thing we want to do is open the source file,
E1BasicBreakpoints, and run it to get an idea of what's going on. We should see a simple stack trace:
Stack traces are a common starting point for debugging, as they indicate something has gone wrong in Java that the program was not prepared to handle. In this case, the stack trace tells us we know the what (tried to use a
null object) and the where (the topmost line number), but not why the object was
null at that point - the actual root cause of the exception.
- Set a breakpoint in the
- Debug the file as a Java application
- When the breakpoint is encountered, step in to the
- step out of the
- In the Variables window, look at the value of the Object variable.
- 'resume' execution until the program completes
Now that you've walked through the program, do you know why we got a
makeAThingdoes create an new Object, that Object isn't actually returned by the method.