1page.title=Avoiding Memory Leaks 2parent.title=Articles 3parent.link=../browser.html?tag=article 4@jd:body 5 6 7<p>Android applications are, at least on the T-Mobile G1, limited 8to 16 MB of heap. It's both a lot of memory for a phone and yet very 9little for what some developers want to achieve. Even if you do not 10plan on using all of this memory, you should use as little as possible 11to let other applications run without getting them killed. The more 12applications Android can keep in memory, the faster it will be for the 13user to switch between his apps. As part of my job, I ran into memory 14leaks issues in Android applications and they are most of the time due 15to the same mistake: keeping a long-lived reference to a 16{@link android.content.Context Context}.</p> 17 18<p>On Android, a <code>Context</code> is used for many operations 19 but mostly to load and access resources. This is why all the widgets 20receive a <code>Context</code> parameter in their constructor. In a 21regular Android application, you usually have two kinds of 22<code>Context</code>, {@link android.app.Activity} and 23{@link android.app.Application}. It's usually the first one that 24the developer passes to classes and methods that need a <code>Context</code>:</p> 25 26<pre class="prettyprint">@Override 27protected void onCreate(Bundle state) { 28 super.onCreate(state); 29 30 TextView label = new TextView(this); 31 label.setText("Leaks are bad"); 32 33 setContentView(label); 34} 35</pre> 36 37<p>This means that views have a reference to the entire activity and 38therefore to anything your activity is holding onto; usually the entire 39View hierarchy and all its resources. Therefore, if you leak the <code>Context</code> 40("leak" meaning you keep a reference to it thus preventing the GC from 41collecting it), you leak a lot of memory. Leaking an entire activity 42can be really easy if you're not careful.</p> 43 44<p>When the screen orientation changes the system will, by default, 45destroy the current activity and create a new one while preserving its 46state. In doing so, Android will reload the application's UI from the 47resources. Now imagine you wrote an application with a large bitmap 48that you don't want to load on every rotation. The easiest way to keep 49it around and not having to reload it on every rotation is to keep in a 50static field:</p> 51 52<pre class="prettyprint">private static Drawable sBackground; 53 54@Override 55protected void onCreate(Bundle state) { 56 super.onCreate(state); 57 58 TextView label = new TextView(this); 59 label.setText("Leaks are bad"); 60 61 if (sBackground == null) { 62 sBackground = getDrawable(R.drawable.large_bitmap); 63 } 64 label.setBackgroundDrawable(sBackground); 65 66 setContentView(label); 67} 68</pre> 69 70<p>This code is very fast and also very wrong; it leaks the first activity 71created upon the first screen orientation change. When a 72{@link android.graphics.drawable.Drawable Drawable} is attached to a view, the view is set as a 73{@link android.graphics.drawable.Drawable#setCallback(android.graphics.drawable.Drawable.Callback) callback} 74on the drawable. In the code snippet above, this means the drawable has a 75reference to the <code>TextView</code> which itself has a reference to the 76activity (the <code>Context</code>) which in turns has references to 77pretty much anything (depending on your code.)</p> 78 79<p>This example is one of the simplest cases of leaking the 80<code>Context</code> and you can see how we worked around it in the 81<a href="http://android.git.kernel.org/?p=platform/packages/apps/Launcher.git;a=blob;f=src/com/android/launcher/LauncherModel.java;h=0ef2a806b767142b28b2ff3b37f21f4ca16c355d;hb=cupcake">Home screen's source code</a> 82(look for the <code>unbindDrawables()</code> method) by setting the stored 83drawables' callbacks to null when the activity is destroyed. Interestingly 84enough, there are cases where you can create a chain of leaked contexts, 85and they are bad. They make you run out of memory rather quickly.</p> 86 87<p>There are two easy ways to avoid context-related memory leaks. The most 88obvious one is to avoid escaping the context outside of its own scope. The 89example above showed the case of a static reference but inner classes and 90their implicit reference to the outer class can be equally dangerous. The 91second solution is to use the <code>Application</code> context. This 92context will live as long as your application is alive and does not depend 93on the activities life cycle. If you plan on keeping long-lived objects 94that need a context, remember the application object. You can obtain it 95easily by calling 96{@link android.content.Context#getApplicationContext() Context.getApplicationContext()} 97or {@link android.app.Activity#getApplication() Activity.getApplication()}.</p> 98 99<p>In summary, to avoid context-related memory leaks, remember the following:</p> 100<ul> 101<li>Do not keep long-lived references to a context-activity (a reference 102to an activity should have the same life cycle as the activity itself)</li> 103<li>Try using the context-application instead of a context-activity</li> 104<li>Avoid non-static inner classes in an activity if you don't control 105their life cycle, use a static inner class and make a weak reference to 106the activity inside. The solution to this issue is to use a static inner 107class with a {@link java.lang.ref.WeakReference WeakReference} to the 108outer class, as done in <a href="http://android.git.kernel.org/?p=platform/frameworks/base.git;a=blob;f=core/java/android/view/ViewRoot.java;h=9d7a124cb01ab94bf53e34f6e5e8a07f81e2423c;hb=master">ViewRoot</a> 109and its W inner class for instance</li> 110<li>A garbage collector is not an insurance against memory leaks</li> 111</ul> 112