c# 干净代码：使用 Action 和 Func 的最佳实践
阅读：38
点赞：0
一、简介
C#提供了内置的委托类型如Action和Func，允许开发者创建更为简洁、类型安全且易读的代码。它们简化了方法引用而无需定义自定义的委托类型。在本文中，我们将专注于如何有效地在你的代码库中使用Action和Func。
二、什么是Action和Func？
ACTION
定义
Action代表一个可以接受最多16个输入参数但不返回任何值的委托。
示例
Action<int> 可以持有接收一个整数作为输入但不返回任何值的方法。
// 定义一个Action委托，用于打印一条消息
Action<string> logMessage = message => Console.WriteLine($"Log: {message}");
// 调用logMessage
logMessage("System started.");
FUNC
定义
Func代表一个可以接受最多16个输入参数并返回指定类型的值的委托。
示例
Func<int, int, int> 可以持有接收两个整数作为输入并返回一个整数的方法。
// 定义一个Func委托，用于计算两个整数的和
Func<int, int, int> add = (a, b) => a + b;
// 调用add
int result = add(3, 5); // 输出: 8
三、何时使用Action和Func？
ACTION
当你需要执行一个操作但不需要返回结果时使用Action。
如果方法的主要任务是执行某个动作，比如打印到控制台、记录日志或者更新一个值，那么Action是合适的。
// 使用Action来记录一条消息
Action<string> logMessage = message => Console.WriteLine($"Log: {message}");
// 调用logMessage
logMessage("System started.");
FUNC
当你需要返回一个值时使用Func。
Func适用于那些产生结果的方法，例如计算、数据转换或者获取信息。
// 使用Func来计算两个整数的和
Func<int, int, int> add = (a, b) => a + b;
// 调用add
int result = add(3, 5); // 输出: 8
四、使用Action和Func的指南
1. 优先考虑简洁性
用Action和Func替换自定义委托以减少代码复杂性。
示例
-
在定义一个简单的操作时，直接使用Action或Func而不是定义自定义委托。
// 之前
public delegate void MyDelegate(string input);
MyDelegate display = message => Console.WriteLine(message);
// 现在
Action<string> display = message => Console.WriteLine(message);
2. 使用描述性的名称
当使用Action和Func时，使用有意义的变量名来清晰地描述其用途。
示例
// 使用描述性的名称
Func<int, int, int> calculateSum = (x, y) => x + y;
Action<string> logError = error => Console.WriteLine($"Error: {error}");
3. 限制参数数量
虽然Action和Func可以接受最多16个参数，但为了保持可读性，应将参数数量保持在最小（理想情况下不超过3个）。
示例
// 限制参数数量
Func<int, int, string> compareNumbers = (a, b) => a > b ? "First is greater" : "Second is greater";
4. 对简短实现使用Lambda表达式
对于简单的逻辑，使用Lambda表达式可以让Action和Func的赋值更加简洁易读。
示例
// 使用Lambda表达式
Action<int> printSquare = num => Console.WriteLine(num * num);
printSquare(5); // 输出: 25
5. 在LINQ查询中使用Func
Func经常被用来在LINQ中进行过滤、投影和聚合。
示例
// 使用Func在LINQ中过滤偶数
var numbers = new List<int> { 1, 2, 3, 4, 5 };
Func<int, bool> isEven = x => x % 2 == 0;
var evenNumbers = numbers.Where(isEven).ToList(); // 输出: [2, 4]
6. 为可重用逻辑优先使用方法引用
当逻辑可以在不同上下文中重复使用时，使用方法引用与Action和Func。
示例
// 使用方法引用
void DisplayMessage(string message)
{
Console.WriteLine(message);
}
Action<string> action = DisplayMessage;
action("Hello World!");
7. 优雅地处理异常
当存在潜在异常时，在调用Action或Func委托时将其包装在try-catch块中，确保程序优雅地处理错误。
示例
// 使用try-catch处理除零异常
Func<int, int, int> divide = (x, y) =>
{
if (y == 0) throw new DivideByZeroException();
return x / y;
};
try
{
int result = divide(10, 0);
}
catch (DivideByZeroException)
{
Console.WriteLine("Cannot divide by zero.");
}
8. 保持委托逻辑简单
Action和Func内的逻辑应该简单明了。复杂的逻辑会使理解和维护变得更加困难。
示例
// 保持逻辑简单
Func<int, int> doubleNumber = x => x * 2; // 简单且清晰
五、结论
-
在C#中使用Action和Func可以极大地简化代码，使其更具可读性、可维护性和类型安全性。通过遵循这些指南，你可以有效地使用这些内置委托，并提高代码库的质量。 -
通过合理应用Action和Func，我们可以使得代码更加紧凑，同时保持良好的可读性和可维护性，这对于构建大型应用程序尤其重要。