Reputation: 36463
In .NET why is String.Empty
read only instead of a constant? I'm just wondering if anyone knows what the reasoning was behind that decision.
Upvotes: 215
Views: 27434
Reputation: 66641
String.Empty read only instead of a constant?
If you make any string constant, then the compiler is replace with the actually string everywhere you call it and you fill your code with the same string all over and when the code runs is also need to read again and again that string from the different memory data.
If you leave your string read only on one place as it is the String.Empty
, the program keep the same string only on one place and read it, or refer to it - keeping the data in memory minimum.
Also if you compile any dll using the String.Empty as const, and for any reason the String.Empty change, then the compiled dll will not work any more the same, because the cost
make the inside code to actually keep a copy of the string on every call.
See this code for example:
public class OneName
{
const string cConst = "constant string";
static string cStatic = "static string";
readonly string cReadOnly = "read only string";
protected void Fun()
{
string cAddThemAll ;
cAddThemAll = cConst;
cAddThemAll = cStatic ;
cAddThemAll = cReadOnly;
}
}
will be come by the compiler as:
public class OneName
{
// note that the const exist also here !
private const string cConst = "constant string";
private readonly string cReadOnly;
private static string cStatic;
static OneName()
{
cStatic = "static string";
}
public OneName()
{
this.cReadOnly = "read only string";
}
protected void Fun()
{
string cAddThemAll ;
// look here, will replace the const string everywhere is finds it.
cAddThemAll = "constant string";
cAddThemAll = cStatic;
// but the read only will only get it from "one place".
cAddThemAll = this.cReadOnly;
}
}
and the assembly call
cAddThemAll = cConst;
0000003e mov eax,dword ptr ds:[09379C0Ch]
00000044 mov dword ptr [ebp-44h],eax
cAddThemAll = cStatic ;
00000047 mov eax,dword ptr ds:[094E8C44h]
0000004c mov dword ptr [ebp-44h],eax
cAddThemAll = cReadOnly;
0000004f mov eax,dword ptr [ebp-3Ch]
00000052 mov eax,dword ptr [eax+0000017Ch]
00000058 mov dword ptr [ebp-44h],eax
Edit: Corrected typo
Upvotes: 8
Reputation: 32698
This answer exists for historical purposes.
Originally:
Because String
is a class and therefore cannot be a constant.
Extended Discussion:
A lot of useful dialog was hammered out in vetting this answer, and rather than deleting it, this content is reproduced directly:
In .NET, (unlike in Java) string and String are exactly the same. And yes, you can have string literal constants in .NET – DrJokepu Feb 3 '09 at 16:57
Are you saying that a Class cannot have constants? – StingyJack Feb 3 '09 at 16:58
Yes, objects have to use readonly. Only structs can do constants. I think when you use
string
instead ofString
the compiler changes the const into a readonly for you. All to do with keeping C programmers happy. – Garry Shutler Feb 3 '09 at 16:59tvanfosson just explained it a little bit more verbose. "X cannot be a constant, because the containing Y is a class" was just a little bit too context-free ;) – Leonidas Feb 3 '09 at 17:01
string.Empty is static property that returns an instance of the String class, namely the empty string, not the string class itself. – tvanfosson Feb 3 '09 at 17:01
Empty is a readonly instance (it's not a property) of the String class. – senfo Feb 3 '09 at 17:02
Head hurting. I still think I'm right, but now I'm less certain. Research required tonight! – Garry Shutler Feb 3 '09 at 17:07
The empty string is an instance of the string class. Empty is a static field (not a property, I stand corrected) on the String class. Basically the difference between a pointer and the thing it points to. If it weren't readonly we could change which instance the Empty field refers to. – tvanfosson Feb 3 '09 at 17:07
Garry, you don't need to do any research. Think about it. String is a class. Empty is an instance of a String. – senfo Feb 3 '09 at 17:12
There is something I don't quite get: how on earth can the static constructor of the String class create an instance of the String class ? Isn't that some sort of "chicken or the egg" scenario? – DrJokepu Feb 3 '09 at 17:12 5
This answer would be correct for nearly any other class but System.String. .NET does a lot of performance special-casing for strings, and one of them is that you CAN have string constants, just try it. In this case, Jeff Yates has the correct answer. – Joel Mueller Feb 3 '09 at 19:25
As described in §7.18, a constant-expression is an expression that can be fully evaluated at compile-time. Since the only way to create a non-null value of a reference-type other than string is to apply the new operator, and since the new operator is not permitted in a constant-expression, the only possible value for constants of reference-types other than string is null. The previous two comments were taken directly from the C# language specification and reiterate what Joel Mueller mentioned. – senfo Feb 4 '09 at 15:05 5
Upvotes: -1
Reputation: 48265
I think there is a lot of confusion and bad responses here.
First of all, const
fields are static
members (not instance members).
Check section 10.4 Constants of the C# language specification.
Even though constants are considered static members, a constant-declaration neither requires nor allows a static modifier.
If public const
members are static, one could not consider that a constant will create a new Object.
Given this, the following lines of code do exactly the same thing in respect to the creation of a new Object.
public static readonly string Empty = "";
public const string Empty = "";
Here is a note from Microsoft that explains the difference between the 2:
The readonly keyword is different from the const keyword. A const field can only be initialized at the declaration of the field. A readonly field can be initialized either at the declaration or in a constructor. Therefore, readonly fields can have different values depending on the constructor used. Also, while a const field is a compile-time constant, the readonly field can be used for runtime constants, ...
So I find that the only plausible answer here is Jeff Yates's.
Upvotes: 28
Reputation: 62377
The reason that static readonly
is used instead of const
is due to use with unmanaged code, as indicated by Microsoft here in the Shared Source Common Language Infrastructure 2.0 Release. The file to look at is sscli20\clr\src\bcl\system\string.cs
.
The Empty constant holds the empty string value. We need to call the String constructor so that the compiler doesn't mark this as a literal.
Marking this as a literal would mean that it doesn't show up as a field which we can access from native.
I found this information from this handy article at CodeProject.
Upvotes: 170