Func<TResult> Delegat

Definicja

Hermetyzuje metodę, która nie ma parametrów i zwraca wartość typu określonego przez parametr TResult.Encapsulates a method that has no parameters and returns a value of the type specified by the TResult parameter.

generic <typename TResult>
public delegate TResult Func();
public delegate TResult Func<out TResult>();
public delegate TResult Func<TResult>();
type Func<'Result> = delegate of unit -> 'Result
Public Delegate Function Func(Of Out TResult)() As TResult 
Public Delegate Function Func(Of TResult)() As TResult 

Parametry typu

TResult

Typ wartości zwracanej przez ten delegata.The type of the return value of the method that this delegate encapsulates.

Ten parametr typu jest kowariantny. Oznacza to, że możesz użyć typu, który został przez Ciebie określony, lub dowolnego typu, który jest bardziej pochodny. Aby uzyskać więcej informacji o kowariancji i kontrawariancji, zobacz Kowariancja i kontrawariancja w typach ogólnych.

Wartość zwracana

TResult

Wartość zwracana metody, która jest hermetyzowana przez ten delegat.The return value of the method that this delegate encapsulates.

Dziedziczenie
Func<TResult>

Przykłady

W poniższym przykładzie pokazano, jak używać delegata, który nie przyjmuje żadnych parametrów.The following example demonstrates how to use a delegate that takes no parameters. Ten kod tworzy klasę generyczną o nazwie LazyValue, która ma pole typu Func<TResult>.This code creates a generic class named LazyValue that has a field of type Func<TResult>. To pole delegata może przechowywać odwołanie do dowolnej funkcji, która zwraca wartość typu, który odpowiada parametrowi typu obiektu LazyValue.This delegate field can store a reference to any function that returns a value of the type that corresponds to the type parameter of the LazyValue object. Typ LazyValue ma również właściwość Value, która wykonuje funkcję (jeśli nie została jeszcze wykonana) i zwraca wartość wynikową.The LazyValue type also has a Value property that executes the function (if it has not already been executed) and returns the resulting value.

W przykładzie są tworzone dwie metody i tworzone są dwa LazyValue obiekty z wyrażeniami lambda, które wywołują te metody.The example creates two methods and instantiates two LazyValue objects with lambda expressions that call these methods. Wyrażenia lambda nie pobierają parametrów, ponieważ tylko muszą wywołać metodę.The lambda expressions do not take parameters because they just need to call a method. Ponieważ dane wyjściowe są wyświetlane, dwie metody są wykonywane tylko wtedy, gdy zostanie pobrana wartość każdego obiektu LazyValue.As the output shows, the two methods are executed only when the value of each LazyValue object is retrieved.

using System;

static class Func1
{
   public static void Main()
   {
      // Note that each lambda expression has no parameters.
      LazyValue<int> lazyOne = new LazyValue<int>(() => ExpensiveOne());
      LazyValue<long> lazyTwo = new LazyValue<long>(() => ExpensiveTwo("apple"));

      Console.WriteLine("LazyValue objects have been created.");

      // Get the values of the LazyValue objects.
      Console.WriteLine(lazyOne.Value);
      Console.WriteLine(lazyTwo.Value);
   }
      
   static int ExpensiveOne()
   {
      Console.WriteLine("\nExpensiveOne() is executing.");
      return 1;
   }

   static long ExpensiveTwo(string input)
   {
      Console.WriteLine("\nExpensiveTwo() is executing.");
      return (long)input.Length;
   }
}

class LazyValue<T> where T : struct
{
   private Nullable<T> val;
   private Func<T> getValue;

   // Constructor.
   public LazyValue(Func<T> func)
   {
      val = null;
      getValue = func;
   }

   public T Value
   {
      get
      {
         if (val == null)
            // Execute the delegate.
            val = getValue();
         return (T)val;
      }
   }
}
/* The example produces the following output:

    LazyValue objects have been created.
    
    ExpensiveOne() is executing.
    1
    
    ExpensiveTwo() is executing.
    5
*/    
Public Module Func
   Public Sub Main()
      ' Note that each lambda expression has no parameters.
      Dim lazyOne As New LazyValue(Of Integer)(Function() ExpensiveOne())
      Dim lazyTwo As New LazyValue(Of Long)(Function() ExpensiveTwo("apple")) 

      Console.WriteLine("LazyValue objects have been created.")

      ' Get the values of the LazyValue objects.
      Console.WriteLine(lazyOne.Value)
      Console.WriteLine(lazyTwo.Value)
   End Sub

   Public Function ExpensiveOne() As Integer
      Console.WriteLine()
      Console.WriteLine("ExpensiveOne() is executing.")
      Return 1
   End Function

   Public Function ExpensiveTwo(input As String) As Long
      Console.WriteLine() 
      Console.WriteLine("ExpensiveTwo() is executing.")
      Return input.Length
   End Function
End Module

Public Class LazyValue(Of T As Structure)
   Private val As Nullable(Of T)
   Private getValue As Func(Of T)

   ' Constructor.
   Public Sub New(func As Func(Of T))
      Me.val = Nothing
      Me.getValue = func
   End Sub

   Public ReadOnly Property Value() As T
      Get
         If Me.val Is Nothing Then
            ' Execute the delegate.
            Me.val = Me.getValue()
         End If   
         Return CType(val, T)
      End Get
   End Property
End Class

Uwagi

Tego delegata można użyć do reprezentowania metody, którą można przekazać jako parametru bez jawnego deklarowania niestandardowego delegata.You can use this delegate to represent a method that can be passed as a parameter without explicitly declaring a custom delegate. Metoda hermetyzowana musi odpowiadać sygnaturze metody zdefiniowanej przez tego delegata.The encapsulated method must correspond to the method signature that is defined by this delegate. Oznacza to, że metoda hermetyzowana nie może mieć parametrów i musi zwracać wartość.This means that the encapsulated method must have no parameters and must return a value.

Uwaga

Aby odwołać się do metody, która nie ma parametrów i zwraca void (lub w Visual Basic, która jest zadeklarowana jako Sub a nie jako Function), należy zamiast tego użyć delegata Action.To reference a method that has no parameters and returns void (or in Visual Basic, that is declared as a Sub rather than as a Function), use the Action delegate instead.

W przypadku korzystania z delegata Func<TResult> nie trzeba jawnie definiować delegata, który hermetyzuje metodę bez parametrów.When you use the Func<TResult> delegate, you do not have to explicitly define a delegate that encapsulates a parameterless method. Na przykład poniższy kod jawnie deklaruje delegata o nazwie WriteMethod i przypisuje odwołanie do metody wystąpienia OutputTarget.SendToFile do jego wystąpienia delegata.For example, the following code explicitly declares a delegate named WriteMethod and assigns a reference to the OutputTarget.SendToFile instance method to its delegate instance.

using System;
using System.IO;

delegate bool WriteMethod();

public class TestDelegate
{
   public static void Main()
   {
      OutputTarget output = new OutputTarget();
      WriteMethod methodCall = output.SendToFile;
      if (methodCall())
         Console.WriteLine("Success!"); 
      else
         Console.WriteLine("File write operation failed.");
   }
}

public class OutputTarget
{
   public bool SendToFile()
   {
      try
      {
         string fn = Path.GetTempFileName();
         StreamWriter sw = new StreamWriter(fn);
         sw.WriteLine("Hello, World!");
         sw.Close();
         return true;
      }  
      catch
      {
         return false;
      }
   }
}
Imports System.IO

Delegate Function WriteMethod As Boolean

Module TestDelegate
   Public Sub Main()
      Dim output As New OutputTarget()
      Dim methodCall As WriteMethod = AddressOf output.SendToFile
      If methodCall() Then 
         Console.WriteLine("Success!")
      Else
         Console.WriteLine("File write operation failed.")
      End If      
   End Sub
End Module

Public Class OutputTarget
   Public Function SendToFile() As Boolean
      Try
         Dim fn As String = Path.GetTempFileName
         Dim sw As StreamWriter = New StreamWriter(fn)
         sw.WriteLine("Hello, World!")
         sw.Close      
         Return True
      Catch
         Return False
      End Try
   End Function
End Class

Poniższy przykład upraszcza ten kod, tworząc wystąpienie delegata Func<TResult>, zamiast jawnie definiując nowy delegat i przypisując nazwaną metodę.The following example simplifies this code by instantiating the Func<TResult> delegate instead of explicitly defining a new delegate and assigning a named method to it.

using System;
using System.IO;

public class TestDelegate
{
   public static void Main()
   {
      OutputTarget output = new OutputTarget();
      Func<bool> methodCall = output.SendToFile;
      if (methodCall())
         Console.WriteLine("Success!"); 
      else
         Console.WriteLine("File write operation failed.");
   }
}

public class OutputTarget
{
   public bool SendToFile()
   {
      try
      {
         string fn = Path.GetTempFileName();
         StreamWriter sw = new StreamWriter(fn);
         sw.WriteLine("Hello, World!");
         sw.Close();
         return true;
      }  
      catch
      {
         return false;
      }
   }
}
Imports System.IO

Module TestDelegate
   Public Sub Main()
      Dim output As New OutputTarget()
      Dim methodCall As Func(Of Boolean) = AddressOf output.SendToFile
      If methodCall() Then 
         Console.WriteLine("Success!")
      Else
         Console.WriteLine("File write operation failed.")
      End If      
   End Sub
End Module

Public Class OutputTarget
   Public Function SendToFile() As Boolean
      Try
         Dim fn As String = Path.GetTempFileName
         Dim sw As StreamWriter = New StreamWriter(fn)
         sw.WriteLine("Hello, World!")
         sw.Close      
         Return True
      Catch
         Return False
      End Try
   End Function
End Class

Można użyć delegata Func<TResult> z metodami anonimowymi C#w, jak pokazano w poniższym przykładzie.You can use the Func<TResult> delegate with anonymous methods in C#, as the following example illustrates. (Aby uzyskać wprowadzenie do metod anonimowych, zobacz metody anonimowe).(For an introduction to anonymous methods, see Anonymous Methods.)

using System;
using System.IO;

public class Anonymous
{
   public static void Main()
   {
      OutputTarget output = new OutputTarget();
      Func<bool> methodCall = delegate() { return output.SendToFile(); };
      if (methodCall())
         Console.WriteLine("Success!"); 
      else
         Console.WriteLine("File write operation failed.");
   }
}

public class OutputTarget
{
   public bool SendToFile()
   {
      try
      {
         string fn = Path.GetTempFileName();
         StreamWriter sw = new StreamWriter(fn);
         sw.WriteLine("Hello, World!");
         sw.Close();
         return true;
      }  
      catch
      {
         return false;
      }
   }
}

Można również przypisać wyrażenie lambda do delegata Func<T,TResult>, jak pokazano w poniższym przykładzie.You can also assign a lambda expression to a Func<T,TResult> delegate, as the following example illustrates. (Aby uzyskać wprowadzenie do wyrażeń lambda, zobacz wyrażenia lambda i wyrażenia lambda.)(For an introduction to lambda expressions, see Lambda Expressions and Lambda Expressions.)

using System;
using System.IO;

public class Anonymous
{
   public static void Main()
   {
      OutputTarget output = new OutputTarget();
      Func<bool> methodCall = () => output.SendToFile(); 
      if (methodCall())
         Console.WriteLine("Success!"); 
      else
         Console.WriteLine("File write operation failed.");
   }
}

public class OutputTarget
{
   public bool SendToFile()
   {
      try
      {
         string fn = Path.GetTempFileName();
         StreamWriter sw = new StreamWriter(fn);
         sw.WriteLine("Hello, World!");
         sw.Close();
         return true;
      }  
      catch
      {
         return false;
      }
   }
}
Imports System.IO

Module TestDelegate
   Public Sub Main()
      Dim output As New OutputTarget()
      Dim methodCall As Func(Of Boolean) = Function() output.SendToFile()
      If methodCall() Then 
         Console.WriteLine("Success!")
      Else
         Console.WriteLine("File write operation failed.")
      End If      
   End Sub
End Module

Public Class OutputTarget
   Public Function SendToFile() As Boolean
      Try
         Dim fn As String = Path.GetTempFileName
         Dim sw As StreamWriter = New StreamWriter(fn)
         sw.WriteLine("Hello, World!")
         sw.Close      
         Return True
      Catch
         Return False
      End Try
   End Function
End Class

Typ podstawowy wyrażenia lambda jest jednym z ogólnych delegatów Func.The underlying type of a lambda expression is one of the generic Func delegates. Dzięki temu można przekazać wyrażenie lambda jako parametr bez jawnego przypisywania go do delegata.This makes it possible to pass a lambda expression as a parameter without explicitly assigning it to a delegate. W szczególności, ponieważ wiele metod typów w przestrzeni nazw System.Linq ma Func parametrów, można przekazać te metody do wyrażenia lambda bez bezpośredniego tworzenia wystąpienia delegata Func.In particular, because many methods of types in the System.Linq namespace have Func parameters, you can pass these methods a lambda expression without explicitly instantiating a Func delegate.

Jeśli masz kosztowne obliczenie, które chcesz wykonać tylko wtedy, gdy wynik jest rzeczywiście potrzebny, można przypisać kosztowną funkcję do delegata Func<TResult>.If you have an expensive computation that you want to execute only if the result is actually needed, you can assign the expensive function to a Func<TResult> delegate. Wykonanie funkcji może następnie zostać opóźnione do momentu użycia właściwości, która uzyskuje dostęp do wartości w wyrażeniu.The execution of the function can then be delayed until a property that accesses the value is used in an expression. W przykładzie w następnej sekcji pokazano, jak to zrobić.The example in the next section demonstrates how to do this.

Metody rozszerzania

GetMethodInfo(Delegate)

Pobiera obiekt, który reprezentuje metodę reprezentowaną przez określony delegat.Gets an object that represents the method represented by the specified delegate.

Dotyczy

Zobacz też