views:

1206

answers:

7

I used a variable with a lot of data in it, say String data. I wanted to use a small part of this string in the following way:

this.smallpart = data.substring(12,18);

After some hours of debugging (with a memory visualizer) I found out that the objects field smallpart remembered all the data from data, although it only contained the substring.

When I changed the code into:

this.smallpart = data.substring(12,18)+""; 

..the problem was solved! Now my application uses very little memory now!

How is that possible? Can anyone explain this? I think this.smallpart kept referencing towards data, but why?

UPDATE: How can I clear the big String then? Will data = new String(data.substring(0,100)) do the thing?

+55  A: 

Doing the following:

data.substring(x, y) + ""

creates a new (smaller) String object, and throws away the reference to the String created by substring(), thus enabling garbage collection of this.

The important thing to realise is that substring() gives a window onto an existing String - or rather, the character array underlying the original String. Hence it will consume the same memory as the original String. This can be advantageous in some circumstances, but problematic if you want to get a substring and dispose of the original String (as you've found out).

Take a look at the substring() method in the JDK String source for more info.

EDIT: To answer your supplementary question, constructing a new String from the substring will reduce your memory consumption, provided you bin any references to the original String.

Brian Agnew
That's one of the very few cases where the `String(String)` constructor (i.e. the String constructor taking a String as input) is useful: `new String(data.substring(x, y))` does effectively the same thing as appending `""`, but it makes the intent somewhat clearer.
Joachim Sauer
Good point, well made
Brian Agnew
just to precise, substring uses the `value` attribute of the original string. I think that's why the reference is kept.
Valentin Rocher
@Bishiboosh - yes, that's right. I didn't want to expose the particularities of the implementation, but that's precisely what's happening.
Brian Agnew
So strange! How come the API docs say nothing about this?
Neville Flynn
Technically it's an implementation detail. But it's frustrating nonetheless, and catches out a lot of people.
Brian Agnew
If I want to parse the big string step by step, how can I gradually decrease the memory use? please see my UPDATE!
hsmit
@hsmit, you would have to copy the remainder substring to a new string also. Note that by doing that you are copying large amounts of data repeatedly. Your memory performance will improve at the cost of time performance.
PSpeed
+11  A: 

When you use substring, it doesn't actually create a new string. It still refers to your original string, with an offset and size constraint.

So, to allow your original string to be collected, you need to create a new string (using new String, or what you've got).

Chris Jester-Young
+2  A: 

In Java strings are imutable objects and once a string is created, it remains on memory until it's cleaned by the garbage colector (and this cleaning is not something you can take for granted).

When you call the substring method, Java does not create a trully new string, but just stores a range of characters inside the original string.

So, when you created a new string with this code:

this.smallpart = data.substring(12,18)+"";

you actually created a new string when you concatenated the result with the empty string. That's why.

Kico Lobo
+11  A: 

If you look at the source of substring(int, int), you'll see that it returns:

new String(offset + beginIndex, endIndex - beginIndex, value);

where value is the original char[]. So you get a new String but with the same underlying char[].

When you do, data.substring() + "", you get a new String with a new underlying char[].

Actually, your use case is the only situation where you should use the String(String) constructor:

String tiny = new String(huge.substring(12,18));
Pascal Thivent
+2  A: 

I think this.smallpart kept referencing towards data, but why?

Because Java strings consist of a char array, a start offset and a length (and a cached hashCode). Some String operations like substring() create a new String object that shares the original's char array and simply has different offset and/or length fields. This works because the char array of a String is never modified once it has been created.

This can save memory when many substrings refer to the same basic string without replicating overlapping parts. As you have noticed, in some situations, it can keep data that's not needed anymore from being garbage collected.

The "correct" way to fix this is the new String(String) constructor, i.e.

this.smallpart = new String(data.substring(12,18));

BTW, the overall best solution would be to avoid having very large Strings in the first place, and processing any input in smaller chunks, aa few KB at a time.

Michael Borgwardt
A: 

As documented by jwz in 1997:

If you have a huge string, pull out a substring() of it, hold on to the substring and allow the longer string to become garbage (in other words, the substring has a longer lifetime) the underlying bytes of the huge string never go away.

Ken
A: 

Just to sum up, if you create lots of substrings from a small number of big strings, then use

   String subtring = string.substring(5,23)

Since you only use the space to store the big strings, but if you are extracting a just handful of small strings, from losts of big strings, then

   String substring = new String(string.substring(5,23));

Will keep your memory use down, since the big strings can be reclaimed when no longer needed.

That you call new String is a helpful reminder that you really are getting a new string, rather than a reference to the original one.

mdma