C#中的扩展方法---Extension

news2025/1/13 13:17:51

C#中扩展方法是C# 3.0/.NET 3.x 新增特性，能够实现向现有类型中“添加”方法，以下主要介绍C#中扩展方法的声明及使用。

1、扩展方法的声明

扩展方法使能够向现有类型“添加”方法，而无需创建新的派生类型、重新编译或以其他方式修改原始类型。这里的“添加”之所以使用引号，是因为并没有真正地向指定类型添加方法。扩展方法是一种特殊的静态方法，但可以像扩展类型上的实例方法一样进行调用。

1）.NET FrameWork中的扩展方法

VS中可以看扩展方法，如下图：

2）自定义扩展方法

定义扩展方法需要定义一个静态类，它的成员方法全是静态方法，而且每个方法的大部分第一参数都是以this开头。扩展方法的三个要素是：静态类、静态方法以及this关键字。

声明class类：

public class People
{
    public People(int id, string name, int age)
    {
        this.Id = id;
        this.Name = name;
        this.Age = age;
    }
    public int Id
    {
        get;
        set;
    }
    public string Name
    {
        get;
        set;
    }
    public int Age
    {
        get;
        set;
    }
}

声明扩展方法：

public static class PersonExtension
{
    public static string FormatOutput(this Person p)
    {
        return string.Format("ID:{0},Name:{1},Age:{2}",
            p.ID, p.Name, p.Age);
    }
}

2、扩展方法的使用

对指定的类型声明扩展方法，可以通该类型的实例直接调用，

例如，

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            Person p = new Person(5,"CJavaPY",1);
            Console.WriteLine(p.FormatOutput());   //可以直接调用扩展方法
            Console.ReadKey();
        }
    }
    public class Person
    {
        public Person(int id, string name, int age)
        {
            this.ID = id;
            this.Name = name;
            this.Age = age;
        }
        public int ID
        {
            get;
            set;
        }
        public string Name
        {
            get;
            set;
        }
        public int Age
        {
            get;
            set;
        }
    }
    //声明扩展方法
    public static class PersonExtension
    {
        public static string FormatOutput(this Person p)
        {
            return string.Format("ID:{0},Name:{1},Age:{2}",
                p.ID, p.Name, p.Age);
        }
    }
}

注意：如果要扩展的类中本来就有和扩展方法的名称一样的方法，编译器默认认为一个表达式是要使用一个实例方法，但如果没有找到，就会检查导入的命名空间和当前命名空间里所有的扩展方法，并匹配到适合的方法。