C# 中的partial 关键字详解

目录
  • 引言
  • 分部类
  • partial 分部限制
  • 分部接口和结构
  • 分部方法
  • this 和 partial 的区别

引言

partial 关键字用于拆分一个类、一个结构、一个接口或一个方法的定义到两个或更多的文件中。 每个源文件包含类型或方法定义的一部分,编译应用程序时将把所有部分组合起来。在设计 Framework 时,可以充分利用 partial 这个特性。

分部类

什么情况下需要拆分类定义呢?

  • 处理大型项目时,使一个类分布于多个独立文件中可以让多位程序员同时对该类进行处理。
  • 当使用自动生成的源文件时,你可以添加代码而不需要重新创建源文件。 Visual Studio 在创建 Windows 窗体、Web 服务包装器代码等时会使用这种方法。 你可以创建使用这些类的代码,这样就不需要修改由 Visual Studio 生成的文件。
  • 使用源生成器在类中生成附加功能时。

例子

Coords 类 分部在 2 个文件中定义。

CoordsOne.cs
定义了 Coords 类的构造函数
注意签名 partial class Coords

namespace ConsoleApp1.PartialClass
{
    public partial class Coords
    {
        private int x;
        private int y;

        public Coords(int x, int y)
        {
            this.x = x;
            this.y = y;
        }
    }
}

CoordsTwo.cs
定义了 Coords 类的一个方法
注意签名 partial class Coords

namespace ConsoleApp1.PartialClass
{
    public partial class Coords
    {
        public void PrintCoords()
        {
            Console.WriteLine("Coords: {0},{1}", x, y);
        }
    }
}

TestPartial.cs
测试一下上面的分部类

using ConsoleApp1.PartialClass;

namespace ConsoleApp1
{
    internal class TestPartial
    {
        static void Main(string[] args)
        {
            Coords coords = new Coords(10, 20);
            coords.PrintCoords();
        }
    }
}

结果:

Coords: 10,20

partial 分部限制

处理分部类定义时需遵循下面的几个规则:

  • 要作为同一类型的各个部分的所有分部类型定义都必须使用 partial 进行修饰。

例如,下面的类声明会生成错误:

public partial class A { }
//public class A { }  // Error, must also be marked partial
  • partial 修饰符只能出现在紧靠关键字 classstructinterface 前面的位置。
  • 分部类型定义中允许使用嵌套的分部类型,如下面的示例中所示:
partial class ClassWithNestedClass
{
    partial class NestedClass { }
}

partial class ClassWithNestedClass
{
    partial class NestedClass { }
}

要成为同一类型的各个部分的所有分部类型定义都必须在同一程序集和同一模块(.exe 或 .dll 文件)中进行定义。 分部定义不能跨越多个模块。经测试这些分部的文件必须在同一命名空间
还是上面的例子,CoordsThree.cs 也定义成 partial 类,但是相比 CoordsOne.csCoordsTwo.cs 不是在同一个命名空间,会出错。

  • 类名和泛型类型参数在所有的分部类型定义中都必须匹配。 泛型类型可以是分部的。 每个分部声明都必须以相同的顺序使用相同的参数名。
  • 如果某关键字出现在一个分部类型定义中,则该关键字不能与在同一类型的其他分部定义中指定的关键字冲突:public,private,protected,internal,abstract,sealed 等

将 CoordsOne.cs 中 public 改成 internal,产生访问属性冲突。

分部接口和结构

同理,也可以开发分部结构和接口

partial interface ITest
{
    void Interface_Test();
}

partial interface ITest
{
    void Interface_Test2();
}

partial struct S1
{
    void Struct_Test() { }
}

partial struct S1
{
    void Struct_Test2() { }
}

分部方法

分部方法在分部类型的一部分中定义了签名,并在该类型的另一部分中定义了实现。 通过分部方法,类设计器可提供与事件处理程序类似的方法挂钩,以便开发者决定是否实现。 如果开发者不提供实现,则编译器在编译时删除签名。 以下条件适用于分部方法:

  • 声明必须以上下文关键字 partial 开头。
  • 分部类型各部分中的签名必须匹配。
  • 构造函数、终结器、重载运算符、属性声明或事件声明中不允许使用 partial 关键字。

例如:

namespace PM
{
    partial class A
    {
        partial void OnSomethingHappened(string s);
    }

    // This part can be in a separate file.
    partial class A
    {
        // Comment out this method and the program
        // will still compile.
        partial void OnSomethingHappened(String s)
        {
            Console.WriteLine("Something happened: {0}", s);
        }
    }
}

在以下情况下,不需要使用分部方法即可实现:

  • 没有任何可访问性修饰符(包括默认的 专用)。
  • 返回 void。
  • 没有任何输出参数。
  • 没有以下任何修饰符:virtual、override、sealed、new 或 extern。

this 和 partial 的区别

C# - this 的用法 一文中有介绍 this 具有扩展类方法的功能,那么 thispartial 有区别是?

  • 概念的区别,this 是对原有功能进行扩展,partial 是将整体分成多个部分存放,便于维护。
  • 实现方式的区别

patial 分部的签名要求一致,必须是 partial class/interface/struct Name,文件名不一样。
this 扩展类名不一样,但必须是静态的类,静态的方法,方法第一个参数必须是 this ClassName

  • 调用的区别

partial 分部的各个文件必须在同一 namespace 命名空间
this 扩展可以在不同命名空间,但是需要导入扩展的 namespace 命名空间后才能调用扩展的方法。

到此这篇关于C# 中的partial 关键字的文章就介绍到这了,更多相关C# partial 关键字内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • 详解C# partial 关键字的使用

    什么是局部类型? C# 2.0 引入了局部类型的概念.局部类型允许我们将一个类.结构或接口分成几个部分,分别实现在几个不同的.cs文件中. 局部类型适用于以下情况: (1) 类型特别大,不宜放在一个文件中实现. (2) 一个类型中的一部分代码为自动化工具生成的代码,不宜与我们自己编写的代码混合在一起. (3) 需要多人合作编写一个类. 例: 在同一命名空间下  在class2类中   写class2 的实例 加关键字 partial 在class3类中   写class2 的实例 加关键字 pa

  • C#中partial关键字的作用

    1. 什么是局部类型? C# 2.0 引入了局部类型的概念.局部类型允许我们将一个类.结构或接口分成几个部分,分别实现在几个不同的.cs文件中. 局部类型适用于以下情况: (1) 类型特别大,不宜放在一个文件中实现. (2) 一个类型中的一部分代码为自动化工具生成的代码,不宜与我们自己编写的代码混合在一起. (3) 需要多人合作编写一个类. 局部类型是一个纯语言层的编译处理,不影响任何执行机制--事实上C#编译器在编译的时候仍会将各个部分的局部类型合并成一个完整的类. public partia

  • C# partial关键字说明

    C# 中可以将类.结构或接口的定义拆分到两个或多个源文件中,在类声明前添加partial关键字即可. 1. 什么是局部类型? C# 2.0 引入了局部类型的概念.局部类型允许我们将一个类.结构或接口分成几个部分,分别实现在几个不同的.cs文件中. 局部类型适用于以下情况: (1) 类型特别大,不宜放在一个文件中实现. (2) 一个类型中的一部分代码为自动化工具生成的代码,不宜与我们自己编写的代码混合在一起. (3) 需要多人合作编写一个类. 局部类型是一个纯语言层的编译处理,不影响任何执行机制-

  • C# 中的partial 关键字详解

    目录 引言 分部类 partial 分部限制 分部接口和结构 分部方法 this 和 partial 的区别 引言 partial 关键字用于拆分一个类.一个结构.一个接口或一个方法的定义到两个或更多的文件中. 每个源文件包含类型或方法定义的一部分,编译应用程序时将把所有部分组合起来.在设计 Framework 时,可以充分利用 partial 这个特性. 分部类 什么情况下需要拆分类定义呢? 处理大型项目时,使一个类分布于多个独立文件中可以让多位程序员同时对该类进行处理. 当使用自动生成的源文

  • C++中的explicit关键字详解

    目录 前言 1. 抑制构造函数定义的隐式转换 2. 为转换显式地使用构造函数 3. 类型转换运算符可能产生意外结果 4. 显示的类型转换运算符 5. explicit练习 5.1 当不使用explict关键字时 5.2 使用explict关键字时 5.3 explicit 标识的构造函数中存在一个默认值 前言 最近在阅读android底层源码的时候,发现其中好多代码使用了explicit关键字,因此这里对explicit关键字进行了分析和介绍. 1. 抑制构造函数定义的隐式转换 在要求隐式转换的

  • Java中的final关键字详解及实例

    Java中的final关键字 1.修饰类的成员变量 这是final的主要用途之一,和C/C++的const,即该成员被修饰为常量,意味着不可修改. 上面的代码对age进行初始化后就不可再次赋值,否则编译时会报类似上图的错误. 如果修饰的是引用类型的变量,那么初始化后就不能让他指向另一个对象,如下图所示 2.修饰方法 用final关键字修饰的方法是不能被该类的子类override(重写),因此,如果在想明确禁止 该方法在子类中被覆盖的情况下才将方法设置为final的. 注:类的private方法会

  • C++ 中try finally关键字详解

    try-finally语句是Microsoft对C和C++语言的扩展,它能使32位的目标程序在异常出现时,有效保证一些资源能够被及时清除,这些资源的清除任务可以包括例如内存的释放,文件的关闭,文件句柄的释放等等.try-finally语句特别适合这样的情况下使用,例如一个例程(函数)中,有几个地方需要检测一个错误,并且在错误出现时,函数可能提前返回. #include <windows.h> #include <stdio.h> try-finally语句的语法与try-excep

  • PHP中的self关键字详解

    前言 PHP群里有人询问self关键字的用法,答案是比较明显的:静态成员函数内不能用this调用非成员函数,但可以用self调用静态成员函数/变量/常量:其他成员函数可以用self调用静态成员函数以及非静态成员函数.随着讨论的深入,发现self并没有那么简单.鉴于此,本文先对几个关键字做对比和区分,再总结self的用法. 与parent.static以及this的区别 要想将彻底搞懂self,要与parent.static以及this区分开.以下分别做对比. parent self与parent

  • C/C++中的static关键字详解

    目录 C/C++ 中的 static 1. 静态局部变量 2. 静态全局变量 3. static 修饰函数 C++的 static 成员 静态成员变量 静态成员函数 总结: static是 C/C++中的关键字之一,是常见的函数与变量(C++中还包括类)的修饰符,它常被用来控制变量的存储方式和作用范围. 在众多高级语言中都有其作为关键字或函数出现,所以这也是应当被程序员熟知其各种含义的一个单词 我们知道在函数内部定义的变量,当程序执行到它的定义处时,编译器为它在栈上分配空间,函数在栈上分配的空间

  • js中的this关键字详解

    this是Javascript语言的一个关键字. 它代表函数运行时,自动生成的一个内部对象,只能在函数内部使用.比如, 复制代码 代码如下: function test(){ this.x = 1; } 随着函数使用场合的不同,this的值会发生变化.但是有一个总的原则,那就是this指的是,调用函数的那个对象. 下面分四种情况,详细讨论this的用法. 情况一:纯粹的函数调用 这是函数的最通常用法,属于全局性调用,因此this就代表全局对象Global. 请看下面这段代码,它的运行结果是1.

  • C#中的yield关键字详解

    在"C#中,什么时候用yield return"中,我们了解到:使用yield return返回集合,不是一次性加载到内存中,而是客户端每调用一次就返回一个集合元素,是一种"按需供给".本篇来重温yield return的用法,探秘yield背后的故事并自定义一个能达到yield return相同效果的类,最后体验yield break的用法. 回顾yield return的用法 以下代码创建一个集合并遍历集合. class Program { static Ran

  • Java中final关键字详解

    谈到final关键字,想必很多人都不陌生,在使用匿名内部类的时候可能会经常用到final关键字.另外,Java中的String类就是一个final类,那么今天我们就来了解final这个关键字的用法. 主要介绍:一.final关键字的基本用法.二.深入理解final关键字 一.final关键字的基本用法 在Java中,final关键字可以用来修饰类.方法和变量(包括成员变量和局部变量).下面就从这三个方面来了解一下final关键字的基本用法. 1.修饰类 当用final修饰一个类时,表明这个类不能

  • Java中的instanceof关键字在Android中的用法实例详解

    在下面介绍Android中如何使用instanceof关键字开发更方便时,先来温习一下java中instanceof的概念. instanceof大部分的概念是这样定义的:instanceof是Java的一个二元操作符,和==,>,<是同一类东西.由于它是由字母组成的,所以也是Java的保留关键字.它的作用是测试它左边的对象是否是它右边的类的实例,返回boolean类型的数据.举个栗子: String s = "I AM an Object!"; boolean isObj

随机推荐