C# 条件编译 (#if 和 Conditional)

本文主要讲述C#中,使用 #if 和 Conditional 特性来按条件编译代码的不同原理和适用场景。


本文参考了c# Conditional用法详解.NET/C# 使用 #if 和 Conditional 特性来按条件编译代码的不同原理和适用场景


条件编译符号和预处理符号

我们有时会使用 #if DEBUG 或者 [Conditional("DEBUG")] 来让我们的代码仅在特定的条件下编译。

而这里的 DEBUG 是什么呢?

在我们编写的 C# 代码中,这个叫做 “条件编译符号”(Conditional compilation symbols)
在项目的构建过程中,这个叫做 “定义常量”(Define constants)
而在将 C# 代码编译到 dll 的编译环节,这个叫做 “预处理符号”(Preprocessor symbols)
本文要讨论的是 #if 和 Conditional 的使用,这是在 C# 代码中的使用场景,因此,本文后面都将其称之为 “条件编译符号”。

对于C#,与 C 和 C++ 不同,您不能对符号赋予数值;C# 中的 #if 语句是 Boolean,仅测试符号是否已定义。

在项目ConsoleApp1设置中的生成中定义一个条件编译符号CONDITIONA。



下面请看ConsoleApp1的示例

using System;

namespace ConsoleApp1
{
    public class Class1
    {
        [Conditional("CONDITIONA")]
        public static void Hello1()
        {
            Console.WriteLine("Hello,我是Conditional条件下才可以执行的函数1");
        }

        public static void Hello2()
        {
#if CONDITIONA
            Console.WriteLine("Hello,我是#if条件下才可以执行的函数语句2");
#endif
        }
    }

    class Hello
    {
        static void Main(string[] args)
        {
            Class1.Hello1();
            Class1.Hello2();
            Console.ReadKey();
        }
    }
}

执行结果

由此,我们得到了#if与Conditional的第一个区别:
在这段代码中,#if CONDITIONA和 #endif 之间的代码仅在设置CONDITIONA后会编译,不配置是不会编译的。
Conditional影响的,是调用这个方法的代码。调用这个方法的代码,仅在 CONDITIONA下会编译,在其他配置下是不会编译的。

这也引出了#if与Conditional的第二个区别:
因为 #if CONDITIONA和 #endif 仅仅影响包含在其内的代码块,因此其仅仅影响写的这点代码所在的项目(或者说程序集)。于是使用 #if 只会影响实现代码。
而 [Conditional("CONDITIONA")] 影响的是调用它的代码,因此可以设计作为 API 使用——让目标项目(或者程序集)仅在目标项目特定的配置下才会编译。

上面是博主吕毅的官方解释,我这里举个例子吧。
我们新建一个ConsoleApp2,,添加引用ConsoleApp1.



写一个新类

using System;
using ConsoleApp1;

namespace ConsoleApp2
{
    class Program
    {
        static void Main(string[] args)
        {
            Class1.Hello1();//Class1是ConsoleApp1中的类
            Class1.Hello2();
            Console.ReadKey();
        }
    }
}

关键就在于设置这个条件编译变量上
当你为ConsoleApp1项目设置了CONDITIONA,Hello2()打印字符串。
当你为ConsoleApp2项目设置了CONDITIONA,执行Hello1(),打印字符串。

实验:
为ConsoleApp1项目设置CONDITIONA,不为ConsoleApp2项目设置CONDITIONA。
Hello,我是#if条件下才可以执行的函数语句2

不为ConsoleApp1项目设置CONDITIONA,为ConsoleApp2项目设置CONDITIONA。
Hello,我是Conditional条件下才可以执行的函数1

为ConsoleApp1项目设置CONDITIONA,为ConsoleApp2项目设置CONDITIONA。
Hello,我是Conditional条件下才可以执行的函数1
Hello,我是#if条件下才可以执行的函数语句2

以此为例,就可以深刻体会以下的结论了:
因为 #if CONDITIONA和 #endif 仅仅影响包含在其内的代码块,因此其仅仅影响写的这点代码所在的项目(或者说程序集)。于是使用 #if 只会影响实现代码。
而 [Conditional("CONDITIONA")] 影响的是调用它的代码,因此可以设计作为 API 使用——让目标项目(或者程序集)仅在目标项目特定的配置下才会编译。

用Conditional属性的方式,方法是否生效是取决于调用方,而用#if方式,方法是否生效是取决于方法定义所在的程序集。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,776评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,527评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,361评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,430评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,511评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,544评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,561评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,315评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,763评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,070评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,235评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,911评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,554评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,173评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,424评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,106评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,103评论 2 352

推荐阅读更多精彩内容

  • Swift1> Swift和OC的区别1.1> Swift没有地址/指针的概念1.2> 泛型1.3> 类型严谨 对...
    cosWriter阅读 11,094评论 1 32
  • 官网 中文版本 好的网站 Content-type: text/htmlBASH Section: User ...
    不排版阅读 4,380评论 0 5
  • 专业考题类型管理运行工作负责人一般作业考题内容选项A选项B选项C选项D选项E选项F正确答案 变电单选GYSZ本规程...
    小白兔去钓鱼阅读 8,983评论 0 13
  • Lua 5.1 参考手册 by Roberto Ierusalimschy, Luiz Henrique de F...
    苏黎九歌阅读 13,781评论 0 38
  • 一、温故而知新 1. 内存不够怎么办 内存简单分配策略的问题地址空间不隔离内存使用效率低程序运行的地址不确定 关于...
    SeanCST阅读 7,791评论 0 27