改善C#公共程序类库质量的10种方法(转)
2014-10-28 10:54
288 查看
出处:http://www.cnblogs.com/JamesLi2015/p/3140897.html
最近重构一套代码,运用以下几种方法,供参考。
1公共方法尽可能的使用缓存
这个方法返回的值,可能会被多个地方用到。应该把这个方法的值缓存起来,供程序多次使用。
2使用NArrange格式化代码,这个工具,可以将代码格式化,用region分隔开来。
NArrange0.2.9.0
____________________________________________________________
Copyright(C)2007-2009JamesNiesandNArrangecontributors.
Allrightsreserved.
http://www.NArrange.net
Zipfunctionalitycourtesyofic#code(MikeKrueger,JohnReilly).
经过格式化之后,如上图所示,被分成几个区域,看起来条理更清晰。
3查找重复的代码,提取到公共方法库中。
关于查找程序中重复的代码,有如下工具可以检测重复的代码
1)Simianhttp://www.harukizaemon.com/simian/
2)TeamCityhttp://www.jetbrains.com/teamcity/
3)ResharperpluginAgentRalphhttp://agentralphplugin.googlecode.com/
4)DevExpressCodeRush
5)ResharperFindSimilarCode查找相似的代码
6)CCFinder
7)Duplohttp://sourceforge.net/projects/duplo/
8)VisualStudio2012
9)CloneDetectiveforVisualStudiohttp://www.codeplex.com/CloneDetectiveVS
10)Atomiqhttp://getatomiq.com
11)NDependhttp://www.ndepend.com/
12)CloneDRhttp://www.semanticdesigns.com/Products/Clone
工具相当多,如果使用VS2012开发,已经内置此功能。
4增加测试代码,测试各种情况下公共代码的功能是否正确。
VisualStudio内置的Test工具与技术,再配合Resharper的工具,测试一个方法相当容易实现。
5应用改善效率的代码替换不合适的代码,或是应用.NET框架的方法重写自定义的方法。
效率改善代码,如下举例
1不要用stringax=””判断ax是否为空,ax.Length==0的效率高于ax==string.Emptyu一般用as.IsNullorEmpty
2对于不改变的变量,用常量代替
3用Linq代替大量的foreach查询
4MyTypet=(MyType)t和tasMyType的效率比较,后者效率好,而且转换失败后不会抛出异常
5List<T>代替Array,Haset<T>,Dictionary<K,V>代替Hashtable
.NET的内置的方法,string.Join可以将字符串数组连接成由一个分隔符号连接的一个字符串。比如
例如,如果separator为“,”且value的元素为“apple”、“orange”、“grape”和“pear”,则Join(separator,value)返回“apple,orange,grape,pear”。
如果separator为nullNothingnullptrnull引用(在VisualBasic中为Nothing),则改用空字符串(Empty)。
这个方法,我们常常自己实现。应该改用.NET内置的方法。
6使用并行技术改善系统效率
Parallel.ForEach可以充分利用多核的,提供系统性能。对于一些不需要考虑对数据的前后顺序操作的地方,均可以用这个方法改善。比如删除临时文件。对于需要考虑操作顺序的数据,比如清空数据表数据,要先清除子表,再删除主表,否则会引起外键冲突。应当用lock锁定要删除的数据表,提取出数据后,再进行删除。
7使用Linq和Lambda表达式改善系统的写法
对于只有几行的方法,可以用Lambda来替代。如果方法很通用,可以写成通用的方法。对DataTable的循环遍历操作,首选Linq技术,可减少出错的机率,也使代码简化。
8字符串操作
简单的操作不改变,复杂的匹配与查找改用正则表达式,同时要考虑Encoding的问题。
9公共方法的提取与扩展方法
static类型的公共方法如果过多,因为GC无法回收内存,会影响系统的效率。可以考虑用扩展方法替代,编译时直接被替换为原始类型的静态方法调用。一般添加扩展方法的类型为.NET系统类型,自定义的类型添加扩展方法很少。
10尽量多的给方法注释
使用vsDocman工具,尽可能的为公共方法书写注释,添加用例
最近重构一套代码,运用以下几种方法,供参考。
1公共方法尽可能的使用缓存
publicstaticList<string>GetRegisteredCompany() { Stringsql="SELECTCompanyCodeFROMdbo.CompanyWHERESuspended='N'ORDERBYCompanyCode"; DataTabletable=SqlHelper.ExecuteDataset(BaseCommon.GetSystemConnectionStringBuilder().ConnectionString,sql).Tables[0]; return(fromitemintable.AsEnumerable() selectitem.Field<string>("CompanyCode")).ToList(); }
这个方法返回的值,可能会被多个地方用到。应该把这个方法的值缓存起来,供程序多次使用。
2使用NArrange格式化代码,这个工具,可以将代码格式化,用region分隔开来。
NArrange0.2.9.0
____________________________________________________________
Copyright(C)2007-2009JamesNiesandNArrangecontributors.
Allrightsreserved.
Zipfunctionalitycourtesyofic#code(MikeKrueger,JohnReilly).
经过格式化之后,如上图所示,被分成几个区域,看起来条理更清晰。
3查找重复的代码,提取到公共方法库中。
关于查找程序中重复的代码,有如下工具可以检测重复的代码
1)
2)
3)Resharperplugin
4)DevExpressCodeRush
5)ResharperFindSimilarCode查找相似的代码
6)CCFinder
7)Duplo
8)VisualStudio2012
9)
10)Atomiq
11)
12)
工具相当多,如果使用VS2012开发,已经内置此功能。
4增加测试代码,测试各种情况下公共代码的功能是否正确。
[TestMethod] publicvoidEmpLicenseTestMethod() { DateTimeexpired=newDateTime(2013,12,1); stringlicensee="Administrator"; stringcompany="MicrosoftCorporation"; stringlicense=GenerateLicense(expired,licensee,company); //保存许可文件 XmlDocumentdoc=newXmlDocument(); doc.LoadXml(license); SaveFileDialogdlg=newSaveFileDialog(); dlg.RestoreDirectory=true; dlg.Filter="Licensefile(*.lic)|*.lic|Allfiles(*.*)|*.*"; if(dlg.ShowDialog()==DialogResult.OK) { doc.Save(dlg.FileName); } }
VisualStudio内置的Test工具与技术,再配合Resharper的工具,测试一个方法相当容易实现。
5应用改善效率的代码替换不合适的代码,或是应用.NET框架的方法重写自定义的方法。
效率改善代码,如下举例
1不要用stringax=””判断ax是否为空,ax.Length==0的效率高于ax==string.Emptyu一般用as.IsNullorEmpty
2对于不改变的变量,用常量代替
3用Linq代替大量的foreach查询
4MyTypet=(MyType)t和tasMyType的效率比较,后者效率好,而且转换失败后不会抛出异常
5List<T>代替Array,Haset<T>,Dictionary<K,V>代替Hashtable
.NET的内置的方法,string.Join可以将字符串数组连接成由一个分隔符号连接的一个字符串。比如
例如,如果separator为“,”且value的元素为“apple”、“orange”、“grape”和“pear”,则Join(separator,value)返回“apple,orange,grape,pear”。
如果separator为nullNothingnullptrnull引用(在VisualBasic中为Nothing),则改用空字符串(
这个方法,我们常常自己实现。应该改用.NET内置的方法。
6使用并行技术改善系统效率
Parallel.ForEach可以充分利用多核的,提供系统性能。对于一些不需要考虑对数据的前后顺序操作的地方,均可以用这个方法改善。比如删除临时文件。对于需要考虑操作顺序的数据,比如清空数据表数据,要先清除子表,再删除主表,否则会引起外键冲突。应当用lock锁定要删除的数据表,提取出数据后,再进行删除。
7使用Linq和Lambda表达式改善系统的写法
对于只有几行的方法,可以用Lambda来替代。如果方法很通用,可以写成通用的方法。对DataTable的循环遍历操作,首选Linq技术,可减少出错的机率,也使代码简化。
8字符串操作
简单的操作不改变,复杂的匹配与查找改用正则表达式,同时要考虑Encoding的问题。
9公共方法的提取与扩展方法
static类型的公共方法如果过多,因为GC无法回收内存,会影响系统的效率。可以考虑用扩展方法替代,编译时直接被替换为原始类型的静态方法调用。一般添加扩展方法的类型为.NET系统类型,自定义的类型添加扩展方法很少。
10尽量多的给方法注释
使用vsDocman工具,尽可能的为公共方法书写注释,添加用例
相关文章推荐
- 改善C#公共程序类库质量的10种方法和工具
- Microsoft.VisualBasic.dll的妙用and 改善C#公共程序类库质量的10种方法
- 改善C#公共程序类库质量的10种方法
- 改善C#程序的50种方法(Effective C# 中文版,原书由人民邮电出版社出版)
- Effective C# 中文版改善C#程序的50种方法 完全版
- C#获取项目程序路径的10种方法
- 改善C#程序的50种方法 条款8:确保0为值类型的有效状态
- 改善C#程序的50种方法
- 改善C#程序的50种方法 条款5:总是提供ToString()方法
- 改善C#程序的50种方法(转)
- C#获取项目程序路径的10种方法
- 《Effective C#中文版:“.NET研究”改善C#程序的50种方法》读书笔记
- (C#)获取项目程序路径的10种方法
- 改善C#程序的50种方法 条款2:运行时常量(readonly)优于编译时常量(const)
- 那些年,我们应该读的书 《Effective_C#_中文版_改善C#程序的50种方法》第一章
- C# 获取项目程序路径的10种方法
- 《Effective C#中文版: 改善C#程序的50种方法》De读书笔记(推荐) .
- 改善C#程序的50种方法
- 改善C#程序的50种方法 条款6:明辨值类型和引用类型的使用场合
- 那些年,我们应该读的书 《Effective_C#_中文版_改善C#程序的50种方法》第二章