.Net基础——程序集与CIL
1. 程序集和CIL:
- 程序集是由.NET语言的编译器接受源代码文件产生的输出文件，通常分为 exe和dll两类，其中exe包含Main入口方法可以双击执行，dll则需要被其他程序集调用执行。
- CIL（Common Intermediate Language): 公共中间语言①，需要被编译成二进制机器码之后才会被计算机执行。
2. 程序集包含:
- 程序的CIL
- 程序中使用的类型的元数据(metadata)
- 程序集清单
- 一些资源集
程序被编译成程序集（exe为例）之后，双击运行，程序集会被加载入CLR,CLR执行下面的步骤：
1.检查程序集的安全特性。
2.进行内存分配。
3.把程序集中的可执行代码发送给JIT（Just-in-Time）编译器，把其中的一部分代码编译成为本机代码。
其中，JIT只会编译被调用的部分CIL代码，并把编译的结果缓存起来，以备在后面的程序中的多次调用。这保证了编译与运行的效率。
经过JIT编译之后的代码即是本机代码，本机代码最终被CPU执行。
我们通过一段简单的代码来加深理解：
1. 打开VS，用C#编写一段如下程序:
using System;
namespace ILTest
{
public class Program
{
public static void Main(string[] args)
{
Console.WriteLine("Hello Fred");
Console.Read();
}
}
}
2. 使用 ILASM② 工具将程序集反编译为IL(也可生成为ILTest.txt，后缀名不影响文本文件内容)：
ildasm ILTest.exe /output:ILTest.IL
生成文本文件如下：
1 // Microsoft (R) .NET Framework IL Disassembler. Version 4.6.1055.0
2
3 // Metadata version: v4.0.30319
4 .assembly extern mscorlib
5 {
6 .publickeytoken = (B7 7A 5C 56 19 34 E0 89 ) // .z\V.4..
7 .ver 4:0:0:0
8 }
9 .assembly ILTest
10 {
11 .custom instance void [mscorlib]System.Runtime.CompilerServices.CompilationRelaxationsAttribute::.ctor(int32) = ( 01 00 08 00 00 00 00 00 )
12 .custom instance void [mscorlib]System.Runtime.CompilerServices.RuntimeCompatibilityAttribute::.ctor() = ( 01 00 01 00 54 02 16 57 72 61 70 4E 6F 6E 45 78 // ....T..WrapNonEx
13 63 65 70 74 69 6F 6E 54 68 72 6F 77 73 01 ) // ceptionThrows.
14
15 // --- 下列自定义特性会自动添加，不要取消注释 -------
16 // .custom instance void [mscorlib]System.Diagnostics.DebuggableAttribute::.ctor(valuetype [mscorlib]System.Diagnostics.DebuggableAttribute/DebuggingModes) = ( 01 00 07 01 00 00 00 00 )
17
18 .custom instance void [mscorlib]System.Reflection.AssemblyTitleAttribute::.ctor(string) = ( 01 00 06 49 4C 54 65 73 74 00 00 ) // ...ILTest..
19 .custom instance void [mscorlib]System.Reflection.AssemblyDescriptionAttribute::.ctor(string) = ( 01 00 00 00 00 )
20 .custom instance void [mscorlib]System.Reflection.AssemblyConfigurationAttribute::.ctor(string) = ( 01 00 00 00 00 )
21 .custom instance void [mscorlib]System.Reflection.AssemblyCompanyAttribute::.ctor(string) = ( 01 00 00 00 00 )
22 .custom instance void [mscorlib]System.Reflection.AssemblyProductAttribute::.ctor(string) = ( 01 00 06 49 4C 54 65 73 74 00 00 ) // ...ILTest..
23 .custom instance void [mscorlib]System.Reflection.AssemblyCopyrightAttribute::.ctor(string) = ( 01 00 12 43 6F 70 79 72 69 67 68 74 20 C2 A9 20 // ...Copyright ..
24 20 32 30 31 38 00 00 ) // 2018..
25 .custom instance void [mscorlib]System.Reflection.AssemblyTrademarkAttribute::.ctor(string) = ( 01 00 00 00 00 )
26 .custom instance void [mscorlib]System.Runtime.InteropServices.ComVisibleAttribute::.ctor(bool) = ( 01 00 00 00 00 )
27 .custom instance void [mscorlib]System.Runtime.InteropServices.GuidAttribute::.ctor(string) = ( 01 00 24 38 34 66 35 62 34 30 65 2D 39 31 61 65 // ..$84f5b40e-91ae
28 2D 34 62 66 63 2D 61 62 38 39 2D 34 61 30 66 66 // -4bfc-ab89-4a0ff
29 66 36 64 30 38 31 61 00 00 ) // f6d081a..
30 .custom instance void [mscorlib]System.Reflection.AssemblyFileVersionAttribute::.ctor(string) = ( 01 00 07 31 2E 30 2E 30 2E 30 00 00 ) // ...1.0.0.0..
31 .custom instance void [mscorlib]System.Runtime.Versioning.TargetFrameworkAttribute::.ctor(string) = ( 01 00 1C 2E 4E 45 54 46 72 61 6D 65 77 6F 72 6B // ....NETFramework
32 2C 56 65 72 73 69 6F 6E 3D 76 34 2E 36 2E 31 01 // ,Version=v4.6.1.
33 00 54 0E 14 46 72 61 6D 65 77 6F 72 6B 44 69 73 // .T..FrameworkDis
34 70 6C 61 79 4E 61 6D 65 14 2E 4E 45 54 20 46 72 // playName..NET Fr
35 61 6D 65 77 6F 72 6B 20 34 2E 36 2E 31 ) // amework 4.6.1
36 .hash algorithm 0x00008004
37 .ver 1:0:0:0
38 }
39 .module ILTest.exe
40 // MVID: {90543B0E-D1B4-4FFF-9260-57E27FBC4F8B}
41 .imagebase 0x00400000
42 .file alignment 0x00000200
43 .stackreserve 0x00100000
44 .subsystem 0x0003 // WINDOWS_CUI
45 .corflags 0x00020003 // ILONLY 32BITPREFERRED
46 // Image base: 0x00960000
47
48
49 // =============== CLASS MEMBERS DECLARATION ===================
50
51 .class public auto ansi beforefieldinit ILTest.Program
52 extends [mscorlib]System.Object
53 {
54 .method public hidebysig static void Main(string[] args) cil managed
55 {
56 .entrypoint
57 // 代码大小 19 (0x13)
58 .maxstack 8
59 IL_0000: nop
60 IL_0001: ldstr "Hello Fred"
61 IL_0006: call void [mscorlib]System.Console::WriteLine(string)
62 IL_000b: nop
63 IL_000c: call int32 [mscorlib]System.Console::Read()
64 IL_0011: pop
65 IL_0012: ret
66 } // end of method Program::Main
67
68 .method public hidebysig specialname rtspecialname
69 instance void .ctor() cil managed
70 {
71 // 代码大小 8 (0x8)
72 .maxstack 8
73 IL_0000: ldarg.0
74 IL_0001: call instance void [mscorlib]System.Object::.ctor()
75 IL_0006: nop
76 IL_0007: ret
77 } // end of method Program::.ctor
78
79 } // end of class ILTest.Program
80
81
82 //
其中包含了程序的元数据，程序集清单和一些其他资源信息。
它们描述并组成了这段程序的类型信息，安全信息，版本信息以及对其它程序集的引用信息等，使得程序集拥有了自我描述的特性。其中，元数据是反射得以实现的重要条件。
除此之外还包含了IL代码，IL是经过编译器（这里是csc）编译产生的中间语言代码。
我们可以通过修改IL代码来控制程序的执行：
打开生成的文本文件，将Main方法中的输出字符串修改为"Hello Tommy"：
使用ILASM工具将IL文件重新编译成ILTest2.exe：
双击运行exe结果如下：
也许你会觉得纳闷，为什么要把源代码先翻译成CIL再翻译成本机代码，而不是一步到位呢？？
当程序被编译成程序集之后就脱离了语言的限制，.NET平台下的语言通过程序集的调用突破了语言的阻碍。
例如C#程序可以调用VB生成的程序集，将语言的特殊性转换成了CIL这一通用且规范的概念，好比全国各个地方的人讲着不同的方言，彼此之间难以沟通，但是先讲方言翻译成了CIL之一普通话，从此便消除了语言的障碍。
除此之外，如果直接从高级语言编译成机器语言，不同厂商生成的CPU读取不同的指令，如果有x门高级语言，有y种读取不同指令集的CPU，那么需要有x*y种编译器去将不同的语言与CPU指令一一匹配。
有了CIL之后，我们只需x种编译器将高级语言转换成CIL，再经过y种编译器将CIL转换成二进制指令。 一共仅需要x+y种不同的编译器。
原创文章，未经允许禁止转载。
注：①公共中间语言在一些地方也被叫做MSIL(Microsoft Intermediate Language)或IL(Intermediate Language)。本文中的CIL,IL,MSIL指的都是公共中间语言这一概念。
②ILASM和ILDASM工具详见：here
HttpClient封装方法
//post请求
public static string PostRequest(string url, HttpContent data)
{
var handler = new HttpClientHandler() { UseCookies = false };
HttpClient client = new HttpClient(handler);
var message = new HttpRequestMessage(HttpMethod.Post, url);
message.Content = data;
//message.Headers.Authorization = new AuthenticationHeaderValue("Bearer", GetRemoteToken());
var response = client.SendAsync(message).Result;
response.EnsureSuccessStatusCode();
var result = response.Content.ReadAsStringAsync().Result;
return result;
}
//发送文件
public static void SendFile(string url,string path = @"C:\\test.txt")
{
using (var client = new HttpClient())
using (var content = new MultipartFormDataContent())
{
client.BaseAddress = new Uri("http://localhost");
var fileContent1 = new ByteArrayContent(File.ReadAllBytes(path));
fileContent1.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment")
{
FileName = Path.GetFileName(path)
};
content.Add(fileContent1);
var result = client.PostAsync(url, content).Result;
}
}
|
1
2
3
4
5
6
7
8
9
|
//httpcontent类型
//json
HttpContent content1 = new StringContent( "{a:1,b:2}" , Encoding.UTF8, "application/json" );
//from
HttpContent content2 = new FormUrlEncodedContent( new Dictionary< string , string >()
{
{ "email" , "1" },
{ "pwd" , "11" }
});
|
.Net Core 编码规范
.Net Core 编码规范
标签： 未分类
概述
规范制定原则
- 方便代码的交流和维护。
- 不影响编码的效率，不与大众习惯冲突。
- 使代码更美观、阅读更方便。
- 使代码的逻辑更清晰、更易于理解。
术语定义
Pascal 大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例：
BackColor
Camel 大小写
标识符的首字母小写，而每个后面连接的单词的首字母都大写。例：
backColor
匈牙利命名法
匈牙利命名法是一名匈牙利程序员发明的，而且他在微软工作了多年。此命名法就是通过微软的各种产品和文档传出来的。多数有经验的程序员，不管他们用的是哪门儿语言，都或多或少在使用它。
这种命名法的基本原则是：
变量名＝属性＋类型＋对象描述
即一个变量名是由三部分信息组成，这样，程序员很容易理解变量的类型、用途，而且便于记忆。
下边是一些推荐使用的规则例子，你可以挑选使用，也可以根据个人喜好作些修改再用之。
- 属性部分：
- 全局变量： g_
- 常量 ： c_
-
类成员变量： m_
- 类型部分：
- 指针： p
- 句柄： h
- 布尔型： b
- 浮点型： f
-
无符号： u
- 描述部分：
- 初始化： Init
- 临时变量： Tmp
- 目的对象： Dst
- 源对象： Src
-
窗口： Wnd
下边举例说明：
- hwnd： h表示句柄，wnd表示窗口，合起来为“窗口句柄”。
- m_bFlag： m表示成员变量，b表示布尔，合起来为：“某个类的成员变量，布尔型，是一个状态标志”。
代码外观
列宽
代码列宽控制在120字符左右。
换行
当表达式超出或即将超出规定的列宽，遵循以下规则进行换行
- 在逗号后换行。
- 在操作符前换行。
- 规则1优先于规则2。
当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。
缩进
缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。
Visual Studio 设置：工具->选项->文本编辑器->C#->制表符->插入空格，制表符大小=4，缩进大小=4
空行
空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。
在以下情况下使用两个空行
- 接口和类的定义之间。
- 枚举和类的定义之间。
- 类与类的定义之间。
在以下情况下使用一个空行
- 方法与方法、属性与属性之间。
- 方法中变量声明与语句之间。
- 方法与方法之间。
- 方法中不同的逻辑块之间。
- 方法中的返回语句与其他的语句之间。
- 属性与方法、属性与字段、方法与字段之间。
- 注释与它注释的语句间不空行，但与其他的语句间空一行。
空格
在以下情况中要使用到空格
- 关键字和左括符 “(” 应该用空格隔开。如：
while (true)
注意在方法名和左括符 “(” 之间不要使用空格，这样有助于辨认代码中的方法调用与关键字。
- 多个参数用逗号隔开，每个逗号后都应加一个空格。
- 除了 . 之外，所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作数间不需要空格。如：
a += c + d;
a = (a + b)/(c*d);
while (d++ == s++)
{
n++;
}
PrintSize("size is " + size + "\n");- 语句中的表达式之间用空格隔开。如：
for (expr1; expr2; expr3)
括号 - ()
- 左括号“(”不要紧靠关键字，中间用一个空格隔开。
- 左括号“(”与方法名之间不要添加任何空格。
- 没有必要的话不要在返回语句中使用()。
花括号 - {}
- 左花括号 “{” 放于关键字或方法名的下一行并与之对齐。如：
if (condition)
{
}
public int Add(int x, int y) { }- 左花括号 “{” 要与相应的右花括号 “}”对齐。
- 通常情况下左花括号 “{”单独成行，不与任何语句并列一行。
- if、while、do语句后一定要使用{}，即使{}号中为空或只有一条语句。如：
if (somevalue == 1)
{
somevalue = 2;
}- 右花括号 “}” 后建议加一个注释以便于方便的找到与之相应的 {。如:
while(1)
{
if(valid)
{
} // if valid
else { } // not valid } // end forever程序注释
注释概述
- 修改代码时，总是使代码周围的注释保持最新。
- 在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍.
- 避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共制表位处对齐。
- 避免杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。
- 避免在块注释的周围加上印刷框。这样看起来可能很漂亮，但是难于维护。
- 在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。
- 如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。
- 在编写代码时就注释，因为以后很可能没有时间这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。
- 避免多余的或不适当的注释，不应包含个人情绪内容，如幽默的不主要的备注。
- 在编写注释时使用完整的句子。注释应该阐明代码，而不应该增加多义性。
- 使用注释来解释代码的意图。它们不应作为代码的联机翻译。
- 注释代码中不十分明显的内容。
- 为了防止问题反复出现，对错误修复和解决方法代码总是使用注释。
- 对由循环和逻辑分支组成的代码使用注释。这些是帮助源代码读者的主要方面。
- 在整个应用程序中，使用具有一致的标点和结构的统一样式来构造注释。
- 用空白将注释同注释分隔符分开。在没有颜色提示的情况下查看注释时，这样做会使注释很明显且容易被找到。
- 代码修改变更记录不应使用注释标明修改日期和修改人，注释应只针对代码不记录版本，代码版本应该使用代码版本系统进行管理
- 为了使层次清晰，在闭合的右花括号后注释该闭合所对应的起点。
namespace SCB.Framework.Web
{
} // namespace SCB.Framework.Web文档型注释
该类注释采用.Net已定义好的Xml标签来标记，在声明接口、类、方法、属性、字段都应该使用该类注释，以便代码完成后直接生成代码文档，让别人更好的了解代码的实现和接口。如
/// MyMethod is a method in the MyClass class.
/// Here's how you could make a second paragraph in a description. /// /// public static void MyMethod(int Int1) { }注释标签的使用请参考:http://msdn.microsoft.com/zh-cn/library/5ast78ax.aspx
类c注释
该类注释用于
- 复杂程序逻辑说明与技术事项
用法
/*
动态路由算法使用Round-robin算法，原理是...
*/单行注释
该类注释用于
- 方法内的代码注释。如变量的声明、代码或代码段的解释。例：
//
// 注释语句
//
private int number; 或 // 注释语句 private int number;- 方法内变量的声明或花括号后的注释, 例：
if (1 == 1) // always true
{
statement;
} // always true声明
每行声明数
一行只建议作一个声明，并按字母顺序排列。如：
int level; // 推荐
int size; // 推荐
int x, y; // 不推荐初始化
建议在变量声明时就对其做初始化。
位置
变量建议置于块的开始处，不要总是在第一次使用它们的地方做声明。如：
void MyMethod()
{
int int1 = 0; if (condition) { int int2 = 0; ... } }例外情况
for (int i = 0; i < maxLoops; i++)
{
...
}应避免不同层次间的变量重名，如：
int count;
...
void MyMethod() { if (condition) { int count = 0; // 避免 ... } ... }类和接口的声明
- 在方法名与其后的左括号间没有任何空格。
- 左花括号 “{” 出现在声明的下行并与之对齐，单独成行。
- 方法间用一个空行隔开。
字段的声明
不要使用是 public 或 protected 的实例字段。如果避免将字段直接公开给开发人员，可以更轻松地对类进行版本控制，原因是在维护二进制兼容性时字段不能被更改为属性。考虑为字段提供 get 和set 属性访问器，而不是使它们成为公共的。 get 和 set 属性访问器中可执行代码的存在使得可以进行后续改进，如在使用属性或者得到属性更改通知时根据需要创建对象。下面的代码示例阐释带有 get 和 set 属性访问器的私有实例字段的正确使用。例：
public class Control: Component
{
private int handle; public int Handle { get { return handle; } } }命名规范
命名概述
名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现（它们会发生改变）的名称，可以保留简化复杂性的抽象层。例如，可以使用
GetNextStudent()，而不是GetNextArrayElement()。
命名原则是：
选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义，并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读；因此，提供人们可以理解的名称是有意义的。不过，请确保选择的名称符合适用语言的规则和标准。
以下几点是推荐的命名方法：
- 避免容易被主观解释的难懂的名称，如方面名
AnalyzeThis()，或者属性名xxK8。这样的名称会导致多义性。 - 在类属性的名称中包含类名是多余的，如
Book.BookTitle。而是应该使用Book.Title。 - 只要合适，在变量名的末尾或开头加计算限定符
（Avg、Sum、Min、Max、Index）。 - 在变量名中使用互补对，如
min/max、begin/end和open/close。 - 布尔变量名应该包含
Is，这意味着Yes/No或True/False值，如fileIsFound。 - 在命名状态变量时，避免使用诸如
Flag的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用documentFlag，而是使用更具描述性的名称，如documentFormatType。 - 即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如 i 或 j。 可能的情况下，尽量不要使用原义数字（幻数）或原义字符串，如
for (int i = 1; i < 7; i++)。而是使用命名常数，如for (int i = 1; i < NUM_DAYS_IN_WEEK; i++)以便于维护和理解。
大小写规则
大写
- 组织名缩写使用大写
- 两个或者更少字母组成的标识符使用大写。例：
System.IO
System.Web.UI
SCB.Framework.UI下表汇总了大写规则，并提供了不同类型的标识符的示例。
| 标识符 | 大小写 | 示例 |
|---|---|---|
| 类 | Pascal | AppDomain |
| 枚举类型 | Pascal | ErrorLevel |
| 枚举值 | Pascal | FatalError |
| 事件 | Pascal | ValueChange |
| 异常类 | Pascal | WebException 注意: 总是以 Exception 后缀结尾。 |
| 只读的静态字段 | Pascal | RedValue |
| 接口 | Pascal | IDisposable 注意: 总是以 I 前缀开始。 |
| 方法 | Pascal | ToString |
| 命名空间 | Pascal | System.Drawing |
| 属性 | Pascal | BackColor |
| 公共实例字段 | Pascal | RedValue 注意: 应优先使用属性。 |
| 受保护的实例字段 | Camel | redValue 注意: 应优先使用属性。 |
| 私有的实例字段 | Camel | redValue |
| 参数 | Camel | typeName |
| 方法内的变量 | Camel | backColor |
缩写
为了避免混淆和保证跨语言交互操作，请遵循有关区缩写的使用的下列规则：
- 不要将缩写或缩略形式用作标识符名称的组成部分。例如，使用
GetWindow，而不要使用GetWin。 - 不要使用计算机领域中未被普遍接受的缩写。
- 在适当的时候，使用众所周知的缩写替换冗长的词组名称。例如，用
UI作为User Interface缩
写，用OLAP作为On-line Analytical Processing的缩写。 - 在使用缩写时，对于超过两个字符长度的缩写请使用 Pascal 大小写或 Camel 大小写。例如使用
HtmlButton或HTMLButton；但是，应当大写仅有两个字符的缩写，如：System.IO，而不是System.Io。 - 不要在标识符或参数名称中使用缩写。如果必须使用缩写，对于由多于两个字符所组成的缩写请使用Camel 大小写。
命名空间
- 命名命名空间时的一般性规则是使用公司名称，后跟技术名称和可选的功能与设计，如：
CompanyName.TechnologyName[.Feature][.Design]
例如：
namespace SCB.SupplierChain // 赛酷比公司的供应链系统
namespace SCB.SupplierChain.DataRules // 赛酷比公司的供应链系统的业务规则模块- 命名空间使用Pascal大小写。
TechnologyName指的是该项目的英文缩写或软件名。- 命名空间和类不能使用同样的名字。例如，有一个类被命名为
Debug后，就不要再使用Debug作为一个名称空间名。
类
- 使用 Pascal 大小写。
- 用名词或名词短语命名类。
- 使用全称避免缩写，除非缩写已是一种公认的约定，如
URL、HTML - 不要使用类型前缀，如在类名称上对类使用 C 前缀。例如，使用类名称
FileStream，而不是CFileStream。 - 不要使用下划线字符 (_)。
- 有时候需要提供以字母 I 开始的类名称，虽然该类不是接口。只要 I 是作为类名称组成部分的整个单词的第一个字母，这便是适当的。例如，类名称
IdentityStore是适当的。在适当的地方，使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。例如，ApplicationException对于从名为Exception的类派生的类是适当的名称，原因ApplicationException是一种Exception。请在应用该规则时进行合理的判断。例如，Button对于从Control派生的类是适当的名称。尽管按钮是一种控件，但是将Control作为类名称的一部分将使名称不必要地加长。
public class FileStream
public class Button public class String接口
- 用名词或名词短语，或者描述行为的形容词命名接口。例：
- 接口名称
IComponent使用描述性名词 - 接口名称
ICustomAttributeProvider使用名词短语 - 接口名称
IPersistable使用形容词。
- 接口名称
- 使用 Pascal 大小写。
- 少用缩写。
- 给接口名称加上字母 I 前缀，以指示该类型为接口。在定义类/接口对（其中类是接口的标准实现）时使用相似的名称。两个名称的区别应该只是接口名称上有字母 I 前缀。
- 不要使用下划线字符 (_)。
public interface IServiceProvider
public interface IFormatable以下代码示例阐释如何定义 IComponent 接口及其标准实现 Component 类。
public interface IComponent
{
// Implementation code goes here.
}
public class Component: IComponent { // Implementation code goes here. }属性类 (Attribute)
应该总是将后缀 Attribute 添加到自定义属性类。例：
public class ObsoleteAttribute
{
}枚举 (Enum)
枚举 (Enum) 值类型从 Enum 类继承。
- 对于 Enum 类型和值名称使用 Pascal 大小写。
- 少用缩写。
- 不要在 Enum 类型名称上使用 Enum 后缀。
- 对大多数 Enum 类型使用单数名称，但是对作为位域的 Enum 类型使用复数名称。
- 总是将
FlagsAttribute添加到位域 Enum 类型。
参数
- 使用描述性参数名称。参数名称应当具有足够的描述性，以便参数的名称及其类型可用于在大多数情况下确定它的含义。
- 对参数名称使用 Camel 大小写。
- 使用描述参数的含义的名称，而不要使用描述参数的类型的名称。开发工具将提供有关参数的类型的有意义的信息。因此，通过描述意义，可以更好地使用参数的名称。
- 不要给参数名称加匈牙利语类型表示法的前缀，仅在适合使用它们的地方使用它们。
- 不要使用保留的参数。保留的参数是专用参数，如果需要，可以在未来的版本中公开它们。相反，如果在类库的未来版本中需要更多的数据，请为方法添加新的重载。
Type GetType(string typeName)
string Format(string format, object args)方法
- 使用动词或动词短语命名方法。
- 使用 Pascal 大小写。
RemoveAll()
GetCharArray()
Invoke()属性 (property)
- 使用名词或名词短语命名属性。
- 使用 Pascal 大小写。
- 考虑用与属性的基础类型相同的名称创建属性。例如，如果声明名为
Color的属性，则属
性的类型同样应该是 Color。
public class SampleClass
{
public Color BackColor
{
// Code for Get and Set accessors goes here. } }以下代码示例阐释提供其名称与类型相同的属性。
public enum Color
{
// Insert code for Enum here.
}
public class Control { public Color Color { get { // Insert code here. } set { // Insert code here. } } }事件
- 对事件处理程序名称使用
EventHandler后缀。 - 指定两个名为
sender和e的参数。sender参数表示引发事件的对象。sender参数始
终是object类型的，即使在可以使用更为特定的类型时也如此。与事件相关联的状态封装
在名为e的事件类的实例中。对e参数类型使用适当而特定的事件类。 - 用
EventArgs后缀命名事件参数类。 - 考虑用动词命名事件。
- 使用动名词（动词的“ing”形式）创建表示事件前的概念的事件名称，用过去式表示事
件后。例如，可以取消的Close事件应当具有Closing事件和Closed事件。不要使用BeforeXxx/AfterXxx命名模式。 - 不要在类型的事件声明上使用前缀或者后缀。例如，使用
Close，而不要使用OnClose。 - 通常情况下，对于可以在派生类中重写的事件，应在类型上提供一个受保护的方法（称为
OnXxx）。此方法只应具有事件参数e，因为发送方总是类型的实例。
public delegate void MouseEventHandler(object sender, MouseEventArgs e); public class MouseEventArgs : EventArgs { int x; int y; public MouseEventArgs(int x, int y) { this.x = x; this.y = y; } public int X { get { return x; } } public int Y { get { return y; } } }常量 (const)
所有单词大写，多个单词之间用 "_" 隔开。 如：
public const string PAGE_TITLE = "Welcome";
字段
- private、protected 使用 Camel 大小写。
- public 使用 Pascal 大小写。
- 拼写出字段名称中使用的所有单词。仅在开发人员一般都能理解时使用缩写。
class SampleClass
{
string url;
string destinationUrl;
}- 不要对字段名使用匈牙利语表示法。好的名称描述语义，而非类型。
- 不要对字段名或静态字段名应用前缀。具体说来，不要对字段名称应用前缀来区分静态和非静态字段。例如，应用
g_或s_前缀是不正确的。 - 对预定义对象实例使用公共静态只读字段。如果存在对象的预定义实例，则将它们声明为
对象本身的公共静态只读字段。使用 Pascal 大小写，原因是字段是公共的。
public struct Color
{
public static readonly Color Red = new Color(0x0000FF); public Color(int rgb) { // Insert code here. } public Color(byte r, byte g, byte b) { // Insert code here. } public byte RedValue { get { return Color; } } }静态字段
- 使用名词、名词短语或者名词的缩写命名静态字段。
- 使用 Pascal 大小写。
- 建议尽可能使用静态属性而不是公共静态字段。
集合
集合是一组组合在一起的类似的类型化对象，如哈希表、查询、堆栈、字典和列表，集合的命名建议用复数。
措词
避免使用与常用的 .NET 框架命名空间重复的类名称。例如，不要将以下任何名称用作类名称：System、Collections、Forms 或 UI。有关 .NET 框架命名空间的列表，请参阅类库。
另外，避免使用与C#语言关键字冲突的标识符。
语句
每行一个语句
每行最多包含一个语句。如：
a++; // 推荐
b--; // 推荐
a++; b--; // 不推荐复合语句
复合语句是指包含"父语句{子语句;子语句;}"的语句，使用复合语句应遵循以下几点
- 子语句要缩进。
- 左花括号“{” 在复合语句父语句的下一行并与之对齐，单独成行。
- 即使只有一条子语句要不要省略花括号“ {}”。 如：
while(d += s++)
{
n++;
}return 语句
return语句中不使用括号，除非它能使返回值更加清晰。如：
return;
return myDisk.size();
return (size ? size : defaultSize);if、 if-else、if else-if 语句
if、 if-else、if else-if 语句使用格式
if (condition)
{
statements;
}
if (condition)
{
statements;
}
else
{
statements;
}
if (condition)
{
statements;
}
else if (condition) { statements; } else { statements; }for、foreach 语句
for 语句使用格式
for (initialization; condition; update)
{
statements;
}空的 for 语句（所有的操作都在initialization、condition 或 update中实现）使用格式
for (initialization; condition; update); // update user id
foreach 语句使用格式
foreach (object obj in array)
{
statements;
}注意
- 在循环过程中不要修改循环计数器。
- 对每个空循环体给出确认性注释。
while 语句
while 语句使用格式
while (condition)
{
statements;
}空的 while 语句使用格式
while (condition);
do - while 语句
do - while 语句使用格式
do
{
statements;
} while (condition);switch - case 语句
switch - case语句使用格式
switch (condition)
{
case 1:
statements;
break;
case 2: statements; break; default: statements; break; }注意：
- 语句switch中的每个case各占一行。
- 为所有switch语句提供default分支。
- 所有的非空 case 语句必须用 break; 语句结束。
try - catch 语句
try - catch语句使用格式
try
{
statements;
}
catch (ExceptionClass e)
{
statements;
}
finally
{
statements;
}using 块语句
using 块语句使用格式
using (object)
{
statements;
}控件命名规则
命名方法
控件名简写+英文描述，英文描述首字母大写
主要控件名简写对照表
- 控件名 => 简写
- Label => lbl
- TextBox => txt
- Button => btn
- LinkButton => lnkbtn
- ImageButton => imgbtn
- DropDownList => ddl
- ListBox => lst
- DataGrid => dg
- DataList => dl
- CheckBox => chk
- CheckBoxList => chkls
- RadioButton => rdo
- RadioButtonList => rdolt
- Image => img
- Panel => pnl
- Calender => cld
- AdRotator => ar
- Table => tbl
- RequiredFieldValidator => rfv
- CompareValidator => cv
- RangeValidator => rv
- RegularExpressionValidator => rev
- ValidatorSummary => vs
- CrystalReportViewer => rptvew
其他
表达式
- 避免在表达式中用赋值语句
- 避免对浮点类型做等于或不等于判断
类型转换
- 尽量避免强制类型转换。
- 如果不得不做类型转换，尽量用显式方式。
C#中invoke和beginInvoke的使用
1.Control类中的invoke和beginInvoke的定义
- invoke的含义是：在拥有此控件的基础窗口句柄的现呈上同步执行指定的委托（同步）
- beginInvoke的含义是：在创建控件的基础句柄所在线程上异步执行的委托（异步）
- 句柄（Handle）：
句柄是一种抽象的概念，隐藏了内核实现的细节，同时为调用提供了方便，保证了内核的安全性。形象的比喻为“用一个小东西拎起一堆东西的柄”。根据他的概念，我们可以将指针看作一种形式的句柄，但他拥有更独特的含义：指向内存的某个地址。
在系统中有很多内核对象，这些对象大多很庞大，拥有很多的属性。当需要传输这些属性时，首先不能直接复制，因为这样会很慢；其次也不能直接调用这些属性的首地址，这样会暴露属性的位置，进而导致属性被随意更改，影响系统的稳定；最后因为内存的地址可能会随时更改（Windows基于虚拟内存，其内存管理器常常在内存中来回移动对象），直接调用会导致以后使用时找不到地址。
在这个基础上，采用一种句柄的概念。它是一种对对象的进一步抽象的过程（理解面向对象的概念），它会在进程的地址空间中设置一张表格，里面保存着某个对象的编号和这个编号对应的地址，通过这个地址去引用这个对象。这个编号就是句柄。句柄的作用就是将对象的真实地址隐藏起来，同时提供一种对该对象的映射地址方便调用。这样既能保证对象的安全性，也能保证调用的便利。
2.invoke的用法
上面的解释通俗的来说就是在一个应用程序的主线程上调用执行指定的委托。主要目的是让工作的线程完成绝大部分的运算工作，将纯粹的界面更新放到UI线程中去完成，达到减轻UI线程负担的目的（避免UI无响应）。
//this.invoke的使用方法
//第一步：定义修改UI的方法
private void ModifyButton( bool _b ) { this.Button1.Enabled = _b; } //第二步：声明第一步方法的委托 private delegate void ModifyButton_dg( bool _b ); //第三步：调用委托 private void Calldelgate( ) { /*在Windows窗体应用程序中使用this.Invoke 在WPF应用程序中使用this.Dispatcher.Invoke*/ this.Invoke( new ModifyButton_dg( ModifyButton ) ,new object[]{false}); } //第四步：在非UI的线程中调用 //创建线程 Thread _t = new Thread( new ThreadStart( threadmethod )); _t.Start(); //线程入口 private void threadmethod () { Calldelgate(); }
WebServeice 动态代理类
1, webservice是什么?
是一个平台独立的，低耦合的，自包含的、基于可编程的web的应用程序，可使用开放的XML（标准通用标记语言下的一个子集）标准来描述、发布、发现、协调和配置这些应用程序，用于开发分布式的互操作的应用程序。
2, webservice可以用来做什么?
能使得运行在不同机器上的不同应用无须借助附加的、专门的第三方软件或硬件， 就可相互交换数据或集成。依据Web Service规范实施的应用之间， 无论它们所使用的语言、 平台或内部协议是什么， 都可以相互交换数据。Web Service是自描述、 自包含的可用网络模块， 可以执行具体的业务功能。Web Service也很容易部署， 因为它们基于一些常规的产业标准以及已有的一些技术，诸如标准通用标记语言下的子集XML、HTTP。Web Service减少了应用接口的花费。Web Service为整个企业甚至多个组织之间的业务流程的集成提供了一个通用机制。
3, webservice怎么用?
方式一：直接添加服务引用 优点，简单粗暴，直接开干，缺点：服务引用地址更改后，则需要更改相应的源码，相应测试，发布。维护不方便。
方式二：WebService 动态代理类，优点：webservice 可进行配置，有更改时只需要更改相应配置文件即可，无需更改源码；缺点：其实没得啥子缺点，就是要把这个服务类放进项目中而已。代码多了点而已。代理类代码如下
1 ///2 /// webservice动态代理类 3 /// 4 public class WebServiceAgentUtil 5 { 6 ///7 /// 自定义一个代码空间 8 /// 9 private const string CODE_NAMESPACE = "Application.WebServiceAgent.Dynamic"; 10 11 private string _url; 12 13 private object _agent; 14 15 private Type _serviceType; 16 17 ///18 /// 初始化webservice代理 19 /// 20 /// 21 public WebServiceAgentUtil(string url) 22 { 23 _url = url; 24 InitializeDynamicAgent(); 25 } 26 27 ///28 /// 生产代理实例 29 /// 30 private void InitializeDynamicAgent() 31 { 32 try 33 { 34 //获取WSDL 35 var wc = new WebClient(); 36 var stream = wc.OpenRead(_url + "?WSDL"); 37 var sd = ServiceDescription.Read(stream); 38 var classname = sd.Services[0].Name; 39 var sdi = new ServiceDescriptionImporter(); 40 sdi.AddServiceDescription(sd, "", ""); 41 var cn = new CodeNamespace(CODE_NAMESPACE); 42 43 //生成客户端代理类代码 44 var ccu = new CodeCompileUnit(); 45 ccu.Namespaces.Add(cn); 46 sdi.Import(cn, ccu); 47 var csc = new CSharpCodeProvider(); 48 49 //设定编译参数 50 var cplist = new CompilerParameters 51 { 52 GenerateExecutable = false, 53 GenerateInMemory = true 54 }; 55 cplist.ReferencedAssemblies.Add("System.dll"); 56 cplist.ReferencedAssemblies.Add("System.XML.dll"); 57 cplist.ReferencedAssemblies.Add("System.Web.Services.dll"); 58 cplist.ReferencedAssemblies.Add("System.Data.dll"); 59 60 //编译代理类 61 var cr = csc.CompileAssemblyFromDom(cplist, ccu); 62 if (cr.Errors.HasErrors) 63 { 64 var sb = new StringBuilder(); 65 foreach (CompilerError ce in cr.Errors) 66 { 67 sb.Append(ce.ToString()); 68 sb.Append(Environment.NewLine); 69 } 70 throw new Exception(sb.ToString()); 71 } 72 73 //生成代理实例 74 var assembly = cr.CompiledAssembly; 75 _serviceType = assembly.GetType(CODE_NAMESPACE + "." + classname, true, true); 76 _agent = Activator.CreateInstance(_serviceType); 77 } 78 catch 79 { 80 return; 81 } 82 } 83 84 ///85 /// 调用webservice方法 86 /// 87 /// 方法名 88 /// 参数列表 89 ///90 public object InvokeWebService(string methodname, object[] args) 91 { 92 var mi = _serviceType.GetMethod(methodname); 93 return mi.Invoke(_agent, args); 94 } 95 }
调用方式（代码如下）：
1 string url = "webservice 所在地址，此可配置在config文件中";
2 //初始化webservice 代理类
3 var wc = new WebServiceAgentUtil(url);
4 //调用webservice
5 //定义参数数组
6 var arr = new object[] { };
7 //obj 为调用后返回结果集
8 var obj = wc.InvokeWebService("webservice方法名（大小写匹配）", arr);