改善C#编程的50个建议(1-5)

最新推荐文章于 2024-07-11 10:26:17 发布

Cryking

最新推荐文章于 2024-07-11 10:26:17 发布

阅读量2k

点赞数

分类专栏： C#

C# 专栏收录该内容

30 篇文章 0 订阅

订阅专栏

-------------------------翻译By Cryking------------------------------
-----------------------转载请注明出处,谢谢!------------------------

翻译自Effective C#

1、属性(properties)
抽象属性可以放在接口的定义里。如:
public interface INameValuePair<T>
{
string Name { get; }
T Value{ get; set; }
}
所有私有字段的访问都建议使用属性来处理,类中所有的数据成员都应当是私有的。
属性在FCL内部其实就是一个方法。
属性也可以是虚拟的(virtual),针对单独的get或set访问器可以有单独的访问修饰符。如:
public virtual string Name
{
get;
protected set;
}
JIT编译时使属性称为内联方法,所以速度和普通数据成员几乎一样.
属性里不要做冗长的计算或者跨应用的访问(如查询数据库).

2、偏爱readonly而不是const
C#有两种常量类型:编译时常量(用const声明)与运行时常量(用readonly声明)。
编译时常量可以在方法内声明,而运行时常量不可以。
编译时常量只能是原子类型(内置整型、浮点型、枚举、string等),而运行时常量可以是任何类型。
最重要的是Readonly类型变量在运行时被解释,IL会生成对应对象的常引用,而const变量会被IL生成对应的值,而这样会对后期的维护造成不便。如下代码:
public class UsefulValues
{
public static readonly int StartValue = 5;
public const int EndValue = 10;
}
而在另一程序集,你引用了这些值:
for(int i = UsefulValues.StartValue;i<UsefulValues.EndValue; i++)
Console.WriteLine("value is {0}", i);
然后经过一段事件你对原程序集进行了修改,修改后:
public class UsefulValues
{
public static readonly int StartValue = 105;
public const int EndValue = 120;
}
此时你希望输出是
value is 105
value is 106
...
value is 119
而实际将什么都不输出,因为此时的for循环已经是如下代码:
for(int i = UsefulValues.StartValue;i<10; i++)
Console.WriteLine("value is {0}", i);
const变量会比readonly变量要稍微快一点,因为IL是直接为其生成常量字符串或数字,而readonly的灵活性要更好,因此我们应当偏爱readonly.

3.偏爱is和as而不是Cast
请使用as来进行类型转换,因为它更安全、更有效。
as与is操作符不能执行任何的用户自定义类型转换,它从不自己构造新对象。而Cast则可实现类型转换,它会转换一个对象为请求的类型,如果转换一个高精度类型到低精度类型,则可能会丢失信息。
注意:as操作符不能用于值类型,值类型只能用Cast,而此时会产生装箱/拆箱操作,而此时一般建议会使用is操作符来先判断。如:
object o = Factory.GetValue();
int i = 0;
if(o is int)
i=(int)o;
is操作符应该用在不能使用as操作符进行转换的时候。
好的面向对象设计应当避免进行类型转换,但是有时你不得不进行类型转换的时候,使用as和is操作符可以更清晰地表达你的目的。

4.使用条件特性来代替#if
#if/#endif太容易滥用,创建的代码也很难理解和调试。C#增加了条件特性来指示一个方法是否应该被调用。它比#if/#endif更清晰。
#if/#endif方式:
private void CheckStateBad()
{
// The Old way:
#if DEBUG
Trace.WriteLine("Entering CheckState for Person");
// Grab the name of the calling routine:
string methodName = new StackTrace().GetFrame(1).GetMethod().Name;
Debug.Assert(lastName != null, methodName, "Last Name cannot be null");
Debug.Assert(lastName.Length > 0, methodName, "Last Name cannot be blank");
Debug.Assert(firstName != null, methodName, "First Name cannot be null");
Debug.Assert(firstName.Length > 0, methodName, "First Name cannot be blank");
Trace.WriteLine("Exiting CheckState for Person");
#endif
}
如果在Release模式编译生成,此方法将会是一个空方法。如果频繁地调用该方法也会产生一部分开销。而有时因为#if/#endif的位置不当,Release编译时会产生一些错误,如:
public void Func()
{
string msg = null;
#if DEBUG
msg = GetDiagnostics();
#endif
Console.WriteLine(msg);
}
如果在Release模式编译,则此时会产生错误。
条件特性方式:
[Conditional("DEBUG")]
private void CheckStateBad()
{
...
}
该特性告诉编译器该方法只有在检测到有DEBUG环境变量时有效.
条件特性相比#if/#endif会生成更有效的IL代码.

5、总是提供ToString()
System.Object.ToString()是.NET环境中最常用的方法之一。你应当为所有客户端的类提供一个合理的ToString()版本。默认的System.Object.ToString()会返回类型的完全限定名,如:System.Drawing.Rect。通过实现IFormattable.ToString方法,你可以按照你自己的格式进行输出。一般情况下你应当在所有你的类型中重写ToString()方法,并且输出简短合理的信息。在特定情况下,需要输出特定信息的时候,应当通过实现IFormattable接口和ICustomFormatter接口的相应方法来完成。