확장명 메서드(C# 프로그래밍 가이드)
확장명 메서드를 사용하면 새 파생 형식을 만들거나 다시 컴파일하거나 원래 형식을 수정하지 않고도 기존 형식에 메서드를 "추가"할 수 있습니다. 확장 메서드는 정적 메서드이지만 확장 형식의 인스턴스 메서드인 것처럼 호출됩니다. C#, F# 및 Visual Basic에서 작성된 클라이언트 코드의 경우 확장명 메서드를 호출하는 것과 형식에 정의된 메서드를 호출하는 데는 명백한 차이가 없습니다.
가장 일반적인 확장명 메서드는 쿼리 기능을 기존 System.Collections.IEnumerable 및 System.Collections.Generic.IEnumerable<T> 형식에 추가하는 LINQ 표준 쿼리 연산자입니다. 표준 쿼리 연산자를 사용하려면 using System.Linq 지시문을 사용해서 먼저 범위를 지정합니다. 그러면 IEnumerable<T>을 구현하는 모든 형식에 GroupBy, OrderBy, Average 등의 인스턴스 메서드가 있는 것처럼 나타납니다. List<T> 또는 Array와 같은 IEnumerable<T> 형식의 인스턴스 뒤에 "dot"를 입력하면 IntelliSense 문 완성에서 이러한 추가 메서드를 볼 수 있습니다.
OrderBy 예제
다음 예제에서는 정수 배열에서 표준 쿼리 연산자 OrderBy를 호출하는 방법을 보여 줍니다. 괄호 안의 식은 람다 식입니다. 많은 표준 쿼리 연산자가 람다 식을 매개 변수로 사용하지만 확장명 메서드에 대한 요구 사항은 아닙니다. 자세한 내용은 람다 식을 참조하세요.
class ExtensionMethods2
{
static void Main()
{
int[] ints = [10, 45, 15, 39, 21, 26];
var result = ints.OrderBy(g => g);
foreach (var i in result)
{
System.Console.Write(i + " ");
}
}
}
//Output: 10 15 21 26 39 45
확장명 메서드는 정적 메서드로 정의되지만 인스턴스 메서드 구문을 사용하여 호출됩니다. 첫 번째 매개 변수는 메서드가 작동하는 형식을 지정합니다. 매개 변수는 이 한정자를 따릅니다. 확장 메서드는 using 지시문을 사용하여 명시적으로 네임스페이스를 소스 코드로 가져오는 경우에만 범위에 있습니다.
다음 예제에서는 System.String 클래스에 대해 정의된 확장 메서드를 보여 줍니다. 이 확장 메서드는 제네릭이 아닌 비중첩 정적 클래스 내부에서 정의됩니다.
namespace ExtensionMethods
{
public static class MyExtensions
{
public static int WordCount(this string str)
{
return str.Split(new char[] { ' ', '.', '?' },
StringSplitOptions.RemoveEmptyEntries).Length;
}
}
}
WordCount 지시문을 사용하여 using 확장 메서드를 범위로 가져올 수 있습니다.
using ExtensionMethods;
또한 다음 구문을 사용하여 애플리케이션에서 확장 메서드를 호출할 수 있습니다.
string s = "Hello Extension Methods";
int i = s.WordCount();
코드에서 인스턴스 메서드 구문을 사용하여 확장 메서드를 호출합니다. 컴파일러에서 생성된 IL(중간 언어)이 코드를 정적 메서드 호출로 변환합니다. 캡슐화의 원칙은 실제로 위반되지 않습니다. 확장 메서드는 확장 중인 형식의 프라이빗 변수에 액세스할 수 없습니다.
MyExtensions 클래스와 static 메서드는 모두 static이며, 다른 모든 WordCount 멤버에 액세스하듯 액세스할 수 있습니다. WordCount 메서드는 다음과 같이 다른 static 메서드를 호출하듯 호출할 수 있습니다.
string s = "Hello Extension Methods";
int i = MyExtensions.WordCount(s);
위의 C# 코드에서:
- 값이
"Hello Extension Methods"인s라는 새string을 선언하고 할당합니다. - 지정된 인수를 호출
MyExtensions.WordCount합니다s.
자세한 내용은 사용자 지정 확장 메서드를 구현 및 호출하는 방법을 참조하세요.
일반적으로 확장명 메서드를 직접 구현하는 것보다 호출하는 경우가 훨씬 많습니다. 확장 메서드는 인스턴스 메서드 구문을 사용하여 호출되므로 특별한 지식이 없어도 클라이언트 코드에서 확장 메서드를 사용할 수 있습니다. 특정 형식의 확장 메서드를 사용하려면 해당 메서드가 정의된 네임스페이스에 대해 using 지시문을 추가합니다. 예를 들어 표준 쿼리 연산자를 사용하려면 다음 using 지시문을 코드에 추가합니다.
using System.Linq;
System.Core.dll에 대한 참조를 추가해야 할 수도 있습니다. 이제 표준 쿼리 연산자가 대부분의 IEnumerable<T> 형식에 사용할 수 있는 추가 메서드로 IntelliSense에 표시됩니다.
컴파일 타임에 확장 메서드 바인딩
확장 메서드를 사용하여 클래스 또는 인터페이스를 확장할 수 있지만 재정의할 수는 없습니다. 이름과 시그니처가 인터페이스 또는 클래스 메서드와 동일한 확장 메서드는 호출되지 않습니다. 컴파일 시간에 확장 메서드는 항상 형식 자체에서 정의된 인스턴스 메서드보다 우선 순위가 낮습니다. 즉, 형식에 Process(int i)라는 메서드가 있고 동일한 시그니처를 가진 확장 메서드가 있는 경우 컴파일러는 항상 인스턴스 메서드에 바인딩합니다. 컴파일러는 메서드 호출을 발견할 경우 먼저 형식의 인스턴스 메서드에서 일치 항목을 찾습니다. 일치하는 항목이 없으면 형식에 대해 정의된 확장 메서드를 검색하고 찾은 첫 번째 확장 메서드에 바인딩합니다.
예시
다음 예제에서는 C# 컴파일러가 메서드 호출을 형식의 인스턴스 메서드 또는 확장명 메서드에 바인딩할 것인지 결정할 때 따르는 규칙을 보여 줍니다. 정적 클래스 Extensions는 IMyInterface를 구현하는 모든 형식에 대해 정의된 확장 메서드를 포함합니다. A, B 및 C 클래스는 모두 인터페이스를 구현합니다.
MethodB 확장 메서드는 이름과 시그니처가 클래스에서 이미 구현된 메서드와 정확하게 일치하므로 호출되지 않습니다.
일치하는 시그니처를 가진 인스턴스 메서드를 찾을 수 없으면 컴파일러는 일치하는 확장명 메서드(있는 경우)에 바인딩합니다.
// Define an interface named IMyInterface.
namespace DefineIMyInterface
{
public interface IMyInterface
{
// Any class that implements IMyInterface must define a method
// that matches the following signature.
void MethodB();
}
}
// Define extension methods for IMyInterface.
namespace Extensions
{
using System;
using DefineIMyInterface;
// The following extension methods can be accessed by instances of any
// class that implements IMyInterface.
public static class Extension
{
public static void MethodA(this IMyInterface myInterface, int i)
{
Console.WriteLine
("Extension.MethodA(this IMyInterface myInterface, int i)");
}
public static void MethodA(this IMyInterface myInterface, string s)
{
Console.WriteLine
("Extension.MethodA(this IMyInterface myInterface, string s)");
}
// This method is never called in ExtensionMethodsDemo1, because each
// of the three classes A, B, and C implements a method named MethodB
// that has a matching signature.
public static void MethodB(this IMyInterface myInterface)
{
Console.WriteLine
("Extension.MethodB(this IMyInterface myInterface)");
}
}
}
// Define three classes that implement IMyInterface, and then use them to test
// the extension methods.
namespace ExtensionMethodsDemo1
{
using System;
using Extensions;
using DefineIMyInterface;
class A : IMyInterface
{
public void MethodB() { Console.WriteLine("A.MethodB()"); }
}
class B : IMyInterface
{
public void MethodB() { Console.WriteLine("B.MethodB()"); }
public void MethodA(int i) { Console.WriteLine("B.MethodA(int i)"); }
}
class C : IMyInterface
{
public void MethodB() { Console.WriteLine("C.MethodB()"); }
public void MethodA(object obj)
{
Console.WriteLine("C.MethodA(object obj)");
}
}
class ExtMethodDemo
{
static void Main(string[] args)
{
// Declare an instance of class A, class B, and class C.
A a = new A();
B b = new B();
C c = new C();
// For a, b, and c, call the following methods:
// -- MethodA with an int argument
// -- MethodA with a string argument
// -- MethodB with no argument.
// A contains no MethodA, so each call to MethodA resolves to
// the extension method that has a matching signature.
a.MethodA(1); // Extension.MethodA(IMyInterface, int)
a.MethodA("hello"); // Extension.MethodA(IMyInterface, string)
// A has a method that matches the signature of the following call
// to MethodB.
a.MethodB(); // A.MethodB()
// B has methods that match the signatures of the following
// method calls.
b.MethodA(1); // B.MethodA(int)
b.MethodB(); // B.MethodB()
// B has no matching method for the following call, but
// class Extension does.
b.MethodA("hello"); // Extension.MethodA(IMyInterface, string)
// C contains an instance method that matches each of the following
// method calls.
c.MethodA(1); // C.MethodA(object)
c.MethodA("hello"); // C.MethodA(object)
c.MethodB(); // C.MethodB()
}
}
}
/* Output:
Extension.MethodA(this IMyInterface myInterface, int i)
Extension.MethodA(this IMyInterface myInterface, string s)
A.MethodB()
B.MethodA(int i)
B.MethodB()
Extension.MethodA(this IMyInterface myInterface, string s)
C.MethodA(object obj)
C.MethodA(object obj)
C.MethodB()
*/
일반적인 사용 패턴
컬렉션 기능
과거에는 지정된 형식에 대한 System.Collections.Generic.IEnumerable<T> 인터페이스를 구현하고 해당 형식의 컬렉션에 작동하는 기능을 포함하는 "컬렉션 클래스"를 만드는 것이 일반적이었습니다. 이 형식의 컬렉션 개체를 만들어도 아무런 문제가 없지만 System.Collections.Generic.IEnumerable<T> 확장을 사용하여 동일한 기능을 구현할 수 있습니다. 확장은 해당 형식에 대한 System.Collections.Generic.IEnumerable<T>를 구현하는 System.Array 또는 System.Collections.Generic.List<T> 같은 모든 컬렉션에서 기능을 호출할 수 있다는 장점이 있습니다. Int32 배열을 사용하는 해당 예제는 이 문서의 앞부분에 있습니다.
레이어 관련 기능
양파형 아키텍처 또는 다른 계층화된 애플리케이션 디자인을 사용하는 경우 애플리케이션 경계에서 통신하는 데 사용할 수 있는 도메인 엔터티 또는 데이터 전송 개체의 집합을 사용하는 것이 일반적입니다. 이러한 개체는 일반적으로 아무 기능이 없거나 애플리케이션의 모든 레이어에 적용되는 기능만 포함합니다. 확장 메서드를 사용하여 다른 레이어에서 필요하지 않은 메서드를 사용하여 개체를 로드하지 않고 각 애플리케이션 레이어와 관련된 기능을 추가할 수 있습니다.
public class DomainEntity
{
public int Id { get; set; }
public string FirstName { get; set; }
public string LastName { get; set; }
}
static class DomainEntityExtensions
{
static string FullName(this DomainEntity value)
=> $"{value.FirstName} {value.LastName}";
}
미리 정의된 형식 확장
재사용 가능한 기능을 만들어야 할 때 새 개체를 만드는 대신 기존 형식(예: .NET 또는 CLR 형식)을 확장하는 경우가 많습니다. 예를 들어 확장 메서드를 사용하지 않는 경우 SQL Server에 대해 쿼리를 실행하는 작업을 수행하기 위해 코드의 여러 위치에서 호출될 수 있는 Engine 또는 Query 클래스를 만들 수 있습니다. 그러나 대신 확장 메서드를 사용하여 System.Data.SqlClient.SqlConnection 클래스를 확장하면 SQL Server에 연결된 모든 위치에서 해당 쿼리를 수행할 수 있습니다. 다른 예로는 System.String 클래스에 공통 기능 추가, System.IO.Stream 개체의 데이터 처리 기능 확장, 특정 오류 처리 기능을 위한 System.Exception 개체를 들 수 있습니다. 이러한 사용 사례 유형은 상상력과 판단력에 의해서만 제한됩니다.
미리 정의된 형식의 확장은 메서드에 값으로 전달되는 struct 형식에는 사용하기 어려울 수 있습니다. 구조체의 모든 변경 내용이 구조체의 복사본에 적용되기 때문입니다. 이러한 변경 내용은 확장 메서드가 만들어진 이후에는 표시되지 않습니다. 첫 번째 인수에 ref 한정자를 추가하여 ref 확장 메서드로 만들 수 있습니다. ref 키워드는 의미 체계상의 차이 없이 this 키워드 앞이나 뒤에 나타날 수 있습니다. ref 한정자를 추가하면 첫 번째 인수가 참조로 전달됨을 나타냅니다. 이렇게 하면 확장 중인 구조체의 상태를 변경하는 확장 메서드를 작성할 수 있습니다(프라이빗 멤버에 액세스할 수 없음). 구조체로 제한된 값 형식 또는 제네릭 형식(자세한 내용은 struct 제약 조건 참조)만 ref 확장 메서드의 첫 번째 매개 변수로 허용됩니다. 다음 예에서는 결과를 다시 할당하거나 ref 키워드가 있는 함수를 통해 전달할 필요 없이 ref 확장 메서드를 사용하여 기본 제공 형식을 직접 수정하는 방법을 보여 줍니다.
public static class IntExtensions
{
public static void Increment(this int number)
=> number++;
// Take note of the extra ref keyword here
public static void RefIncrement(this ref int number)
=> number++;
}
public static class IntProgram
{
public static void Test()
{
int x = 1;
// Takes x by value leading to the extension method
// Increment modifying its own copy, leaving x unchanged
x.Increment();
Console.WriteLine($"x is now {x}"); // x is now 1
// Takes x by reference leading to the extension method
// RefIncrement changing the value of x directly
x.RefIncrement();
Console.WriteLine($"x is now {x}"); // x is now 2
}
}
다음 예에서는 사용자 정의 구조체 형식에 대한 ref 확장 메서드를 보여 줍니다.
public struct Account
{
public uint id;
public float balance;
private int secret;
}
public static class AccountExtensions
{
// ref keyword can also appear before the this keyword
public static void Deposit(ref this Account account, float amount)
{
account.balance += amount;
// The following line results in an error as an extension
// method is not allowed to access private members
// account.secret = 1; // CS0122
}
}
public static class AccountProgram
{
public static void Test()
{
Account account = new()
{
id = 1,
balance = 100f
};
Console.WriteLine($"I have ${account.balance}"); // I have $100
account.Deposit(50f);
Console.WriteLine($"I have ${account.balance}"); // I have $150
}
}
일반 지침
개체의 코드를 수정하거나 적절하고 가능할 때마다 새 형식을 파생하는 것을 여전히 선호할 수 있지만 확장 메서드는 .NET 에코시스템 전체에서 재사용 가능한 기능을 만들기 위한 중요한 옵션이 됩니다. 사용자가 원래 소스를 제어하지 않는 경우, 파생 개체가 부적절하거나 불가능한 경우 또는 기능을 적용 가능한 범위 이상으로 노출하지 않아야 하는 경우에는 확장 메서드를 선택하는 것이 좋습니다.
파생 형식에 대한 자세한 내용은 상속을 참조하세요.
기존 메서드를 사용하여 소스 코드를 제어할 수 없는 형식을 확장하는 경우 형식의 구현이 변경되어 확장명 메서드가 손상될 수도 있습니다.
지정된 형식에 대해 확장 메서드를 구현하는 경우 다음 사항에 유의하세요.
- 형식에 정의된 메서드와 동일한 시그니처가 있는 경우 확장 메서드가 호출되지 않습니다.
- 확장 메서드는 네임스페이스 수준에서 범위로 가져옵니다. 예를 들어
Extensions라는 단일 네임스페이스에 확장 메서드를 포함하는 여러 개의 정적 클래스가 있는 경우using Extensions;지시문을 통해 모두 범위로 가져옵니다.
구현된 클래스 라이브러리의 경우 어셈블리의 버전 번호가 증가되는 것을 방지하기 위해 확장 메서드를 사용해서는 안 됩니다. 소스 코드를 소유하고 있는 라이브러리에 중요 기능을 추가하려는 경우 어셈블리 버전 관리를 위한 .NET 지침을 따르세요. 자세한 내용은 어셈블리 버전 관리를 참조하세요.
참고 항목
.NET
피드백
출시 예정: 2024년 내내 콘텐츠에 대한 피드백 메커니즘으로 GitHub 문제를 단계적으로 폐지하고 이를 새로운 피드백 시스템으로 바꿀 예정입니다. 자세한 내용은 다음을 참조하세요. https://aka.ms/ContentUserFeedback
다음에 대한 사용자 의견 제출 및 보기