定义扩展方法
使用 this 修饰符编写静态方法。
定义扩展方法 是 CoddyKit 上的免费 C# Academy 课时。 这是第 1 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 C# Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 C# Academy 课程共包含 4 节课。
什么是扩展方法
扩展方法可以在不修改现有类型、也不创建派生类型的情况下,为其添加新方法。您可以像调用实例方法一样调用它,但它实际上是一个特殊的 static 方法。
当您不拥有某个类型(如 string 或 int)的源代码,却希望为它添加方便的新行为时,扩展方法非常适合。
三个要求
要声明扩展方法,您需要:一个静态类、一个静态方法,以及一个使用 this 关键字标记的第一个参数。this 参数指定您要扩展的类型。
using System;
public static class StringExtensions
{
public static int WordCount(this string text)
{
if (string.IsNullOrWhiteSpace(text)) return 0;
return text.Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries).Length;
}
}
public class Program
{
public static void Main()
{
string sentence = "the quick brown fox";
Console.WriteLine(sentence.WordCount());
}
}像调用实例方法一样调用
虽然 WordCount 是静态的,但您可以将其调用为 sentence.WordCount()。编译器会在幕后将该调用改写为 StringExtensions.WordCount(sentence)。
using System;
using System.Linq;
public static class StringExtensions
{
public static string Repeat(this string text, int times)
{
return string.Concat(Enumerable.Repeat(text, times));
}
}
public class Program
{
public static void Main()
{
// These two lines do exactly the same thing
Console.WriteLine("ab".Repeat(3));
Console.WriteLine(StringExtensions.Repeat("ab", 3));
}
}this 参数接收实例
点号左侧的值会成为 this 参数。您可以在它后面添加更多参数,调用方会像平常一样传入这些参数。
using System;
public static class IntExtensions
{
public static bool IsBetween(this int value, int low, int high)
{
return value >= low && value <= high;
}
}
public class Program
{
public static void Main()
{
int age = 25;
Console.WriteLine(age.IsBetween(18, 65));
Console.WriteLine(10.IsBetween(1, 5));
}
}扩展您自己的类型
扩展方法不只适用于库类型。您也可以扩展自己的类,这有助于保持核心类型简洁,同时在其他位置添加辅助行为。
using System;
public class Money
{
public decimal Amount { get; }
public Money(decimal amount) { Amount = amount; }
}
public static class MoneyExtensions
{
public static string ToUsd(this Money m) => "$" + m.Amount.ToString("0.00");
}
public class Program
{
public static void Main()
{
var price = new Money(19.5m);
Console.WriteLine(price.ToUsd());
}
}扩展方法无法访问私有成员
扩展方法只是另一个类中的静态方法,因此它只能使用该类型的公共接口(如果位于同一程序集,也可以使用内部接口)。它无法访问私有字段。
using System;
public class Counter
{
private int _count;
public int Value => _count;
public void Increment() => _count++;
}
public static class CounterExtensions
{
// Can only use public members like Value and Increment
public static bool IsZero(this Counter c) => c.Value == 0;
}
public class Program
{
public static void Main()
{
var c = new Counter();
Console.WriteLine(c.IsZero());
c.Increment();
Console.WriteLine(c.IsZero());
}
}链接扩展方法
由于每个扩展方法都会返回一个值,因此您可以将它们链接成流式处理链。这种写法自上而下阅读,也是 LINQ 使用的风格。
using System;
public static class TextExtensions
{
public static string Shout(this string s) => s.ToUpper();
public static string Bang(this string s) => s + "!";
}
public class Program
{
public static void Main()
{
string result = "hello".Shout().Bang();
Console.WriteLine(result);
}
}空值与扩展方法
与真正的实例调用不同,即使接收对象为 null,扩展方法也可以运行,因为在您的代码访问它之前,并不会进行解引用。这使您能够编写安全处理空值的辅助方法。
using System;
public static class StringExtensions
{
public static bool IsBlank(this string text)
{
// text may be null here, and that is fine
return string.IsNullOrWhiteSpace(text);
}
}
public class Program
{
public static void Main()
{
string nothing = null;
Console.WriteLine(nothing.IsBlank());
Console.WriteLine("x".IsBlank());
}
}实例方法优先于扩展方法
如果存在签名匹配的真正实例方法,编译器总是优先使用它,而不是扩展方法。扩展方法只会填补类型尚未覆盖的功能空缺。
using System;
public static class Ext
{
// This will be ignored because string already has ToString()
public static string ToString(this string s, int n) => s + n;
}
public class Program
{
public static void Main()
{
// Resolves to the built-in instance ToString(), not the extension
Console.WriteLine("value: " + "abc".ToString());
}
}实用的辅助库
将相关的扩展方法集中在一个静态类中,可以创建整洁的工具库。下面是一个您可以在项目中重复使用的小型数值辅助类。
using System;
public static class NumberExtensions
{
public static bool IsEven(this int n) => n % 2 == 0;
public static int Squared(this int n) => n * n;
public static double Percent(this int n) => n / 100.0;
}
public class Program
{
public static void Main()
{
Console.WriteLine(4.IsEven());
Console.WriteLine(5.Squared());
Console.WriteLine(50.Percent());
}
}亲自尝试
综合运用您学到的知识:创建一个包含多个专用扩展方法的静态类,并以流畅的方式调用它们。日常使用的辅助库正是这样构建的。
using System;
public static class StringExtensions
{
public static string Capitalize(this string s)
=> string.IsNullOrEmpty(s) ? s : char.ToUpper(s[0]) + s.Substring(1);
public static string Surround(this string s, char c) => c + s + c;
}
public class Program
{
public static void Main()
{
Console.WriteLine("hello".Capitalize().Surround('*'));
}
}快速检查
测试您对扩展方法声明的理解。
复习
您已经了解到,扩展方法是位于 static 类中的 static 方法,其第一个参数使用 this。它使用实例语法调用,但编译后会变成普通的静态调用。
- 三个要求:静态类、静态方法、以
this作为第一个参数。 - 只能访问公共成员。
- 实例方法始终具有优先权。
- 扩展方法可以链接,甚至可以在接收对象为
null时运行。
常见问题解答
「定义扩展方法」课时是免费的吗?
是的 — 「定义扩展方法」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 C# Academy 课程的其余内容,请升级到 CoddyKit PRO。 C# Academy 课程共包含 4 节课。
「定义扩展方法」这节课中我会学到什么?
使用 this 修饰符编写静态方法。 你通过在浏览器中直接运行的动手代码来练习 C# Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 C# Academy 需要有经验吗?
无需任何先前经验。CoddyKit 上的 C# Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 1 节课,共 4 节。
「定义扩展方法」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 C# Academy 课中编写并运行代码吗?
能。每节 C# Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。