クラスと構造体のプライマリコンストラクターを宣言する

C# 12 にはプライマリコンストラクターが導入されています。これにより、型の本体の任意の場所でパラメーターを使用できるコンストラクターを宣言するための簡潔な構文が提供されます。

この記事では、型でプライマリコンストラクターを宣言し、プライマリコンストラクターパラメーターを格納する場所を認識する方法について説明します。他のコンストラクターからプライマリコンストラクターを呼び出し、型のメンバーでプライマリコンストラクターパラメーターを使用できます。

前提条件

最新の .NET SDK
Visual Studio Codeエディター
C# DevKit

プライマリコンストラクターの規則を理解する

パラメーターを struct または class 宣言に追加して、 プライマリコンストラクターを作成できます。プライマリコンストラクターパラメーターは、クラス定義全体のスコープ内にあります。プライマリコンストラクターパラメーターは、クラス定義全体のスコープ内にある場合でも 、パラメーター として表示することが重要です。

いくつかの規則では、これらのコンストラクターがパラメーターであることを明確にしています。

プライマリコンストラクターパラメーターは、必要ない場合は格納されない可能性があります。
プライマリコンストラクターパラメーターは、クラスのメンバーではありません。たとえば、 param という名前のプライマリコンストラクターパラメーターには、 this.paramとしてアクセスできません。
プライマリコンストラクターパラメーターを割り当てることができます。
プライマリコンストラクターパラメーターは、レコード型を除き、プロパティになりません。

これらの規則は、他のコンストラクター宣言を含め、任意のメソッドのパラメーターに対して既に定義されているのと同じ規則です。

プライマリコンストラクターパラメーターの最も一般的な用途を次に示します。

base() コンストラクターの呼び出しに引数として渡す
メンバーフィールドまたはプロパティを初期化する
インスタンスメンバーのコンストラクターパラメーターを参照する

クラスの他のすべてのコンストラクターは、コンストラクターの呼び出しを通じて、直接または間接的にプライマリコンストラクターを呼び出すthis()。この規則により、プライマリコンストラクターパラメーターが型の本体内のあらゆる場所に確実に割り当てられます。

変更できないプロパティまたはフィールドを初期化する

次のコードは、プライマリコンストラクターパラメーターから計算される 2 つの読み取り (変更できない) プロパティを初期化します。

public readonly struct Distance(double dx, double dy)
{
    public readonly double Magnitude { get; } = Math.Sqrt(dx * dx + dy * dy);
    public readonly double Direction { get; } = Math.Atan2(dy, dx);
}

この例では、プライマリコンストラクターを使用して、計算された読み取り専用プロパティを初期化します。 MagnitudeプロパティとDirection プロパティのフィールド初期化子は、プライマリコンストラクターパラメーターを使用します。プライマリコンストラクターパラメーターは、構造体の他の場所では使用されません。このコードでは、次の方法で記述されたかのように構造体が作成されます。

public readonly struct Distance
{
    public readonly double Magnitude { get; }

    public readonly double Direction { get; }

    public Distance(double dx, double dy)
    {
        Magnitude = Math.Sqrt(dx * dx + dy * dy);
        Direction = Math.Atan2(dy, dx);
    }
}

この機能を使用すると、フィールドまたはプロパティを初期化するために引数が必要な場合に、フィールド初期化子を簡単に使用できます。

変更可能な状態を作成する

前の例では、プライマリコンストラクターパラメーターを使用して、読み取り専用プロパティを初期化します。読み取り専用ではないプロパティにプライマリコンストラクターを使用することもできます。

次のコードについて考えてみましょう。

public struct Distance(double dx, double dy)
{
    public readonly double Magnitude => Math.Sqrt(dx * dx + dy * dy);
    public readonly double Direction => Math.Atan2(dy, dx);

    public void Translate(double deltaX, double deltaY)
    {
        dx += deltaX;
        dy += deltaY;
    }

    public Distance() : this(0,0) { }
}

この例では、 Translate メソッドによって dx コンポーネントと dy コンポーネントが変更されます。これには、アクセス時に Magnitude プロパティと Direction プロパティを計算する必要があります。ラムダ演算子 (=>) は式形式の get アクセサーを指定しますが、等しい演算子 (=) は初期化子を指定します。

このバージョンのコードでは、パラメーターなしのコンストラクターが構造体に追加されます。パラメーターなしのコンストラクターは、プライマリコンストラクターを呼び出す必要があります。これにより、すべてのプライマリコンストラクターパラメーターが確実に初期化されます。プライマリコンストラクターのプロパティはメソッドでアクセスされ、コンパイラは各パラメーターを表す非表示フィールドを作成します。

次のコードは、コンパイラによって生成される内容の近似を示しています。実際のフィールド名は、有効な共通中間言語 (CIL) 識別子ですが、有効な C# 識別子ではありません。

public struct Distance
{
    private double __unspeakable_dx;
    private double __unspeakable_dy;

    public readonly double Magnitude => Math.Sqrt(__unspeakable_dx * __unspeakable_dx + __unspeakable_dy * __unspeakable_dy);
    public readonly double Direction => Math.Atan2(__unspeakable_dy, __unspeakable_dx);

    public void Translate(double deltaX, double deltaY)
    {
        __unspeakable_dx += deltaX;
        __unspeakable_dy += deltaY;
    }

    public Distance(double dx, double dy)
    {
        __unspeakable_dx = dx;
        __unspeakable_dy = dy;
    }
    public Distance() : this(0, 0) { }
}

コンパイラによって作成されたストレージ

このセクションの最初の例では、コンパイラはプライマリコンストラクターパラメーターの値を格納するフィールドを作成する必要はありませんでした。ただし、2 番目の例では、プライマリコンストラクターパラメーターがメソッド内で使用されるため、コンパイラはパラメーターのストレージを作成する必要があります。

コンパイラは、型のメンバーの本体でパラメーターにアクセスする場合にのみ、すべてのプライマリコンストラクターのストレージを作成します。それ以外の場合、プライマリコンストラクターパラメーターはオブジェクトに格納されません。

依存関係の挿入を使用する

プライマリコンストラクターのもう 1 つの一般的な用途は、依存関係挿入のパラメーターを指定することです。次のコードでは、その使用にサービスインターフェイスを必要とする単純なコントローラーを作成します。

public interface IService
{
    Distance GetDistance();
}

public class ExampleController(IService service) : ControllerBase
{
    [HttpGet]
    public ActionResult<Distance> Get()
    {
        return service.GetDistance();
    }
}

プライマリコンストラクターは、クラスで必要なパラメーターを明確に示します。クラス内の他の変数と同様に、プライマリコンストラクターパラメーターを使用します。

基本クラスを初期化する

基底クラスのプライマリコンストラクターは、派生クラスのプライマリコンストラクターから呼び出すことができます。この方法は、基底クラスでプライマリコンストラクターを呼び出す必要がある派生クラスを記述する最も簡単な方法です。異なる口座タイプを表すクラスの階層を銀行として考えてみましょう。次のコードは、基底クラスの外観を示しています。

public class BankAccount(string accountID, string owner)
{
    public string AccountID { get; } = accountID;
    public string Owner { get; } = owner;

    public override string ToString() => $"Account ID: {AccountID}, Owner: {Owner}";
}

種類に関係なく、すべての銀行口座には、口座番号と所有者のプロパティがあります。完成したアプリケーションでは、基本クラスに他の一般的な機能を追加できます。

多くの型では、コンストラクターパラメーターに対してより具体的な検証が必要です。たとえば、 BankAccount クラスには、 owner パラメーターと accountID パラメーターに固有の要件があります。 owner パラメーターはnullまたは空白にすることはできません。また、accountID パラメーターは 10 桁の文字列である必要があります。この検証は、対応するプロパティを割り当てるときに追加できます。

public class BankAccount(string accountID, string owner)
{
    public string AccountID { get; } = ValidAccountNumber(accountID) 
        ? accountID 
        : throw new ArgumentException("Invalid account number", nameof(accountID));

    public string Owner { get; } = string.IsNullOrWhiteSpace(owner) 
        ? throw new ArgumentException("Owner name cannot be empty", nameof(owner)) 
        : owner;

    public override string ToString() => $"Account ID: {AccountID}, Owner: {Owner}";

    public static bool ValidAccountNumber(string accountID) => 
    accountID?.Length == 10 && accountID.All(c => char.IsDigit(c));
}

この例では、コンストラクターパラメーターをプロパティに割り当てる前に検証する方法を示します。 String.IsNullOrWhiteSpace(String)などの組み込みメソッドや、独自の検証メソッド (ValidAccountNumber など) を使用できます。この例では、初期化子を呼び出すと、コンストラクターから例外がスローされます。コンストラクターパラメーターを使用してフィールドを割り当てない場合、コンストラクターパラメーターに最初にアクセスしたときに例外がスローされます。

1 つの派生クラスが当座預金アカウントを表す場合があります。

public class CheckingAccount(string accountID, string owner, decimal overdraftLimit = 0) : BankAccount(accountID, owner)
{
    public decimal CurrentBalance { get; private set; } = 0;

    public void Deposit(decimal amount)
    {
        if (amount < 0)
        {
            throw new ArgumentOutOfRangeException(nameof(amount), "Deposit amount must be positive");
        }
        CurrentBalance += amount;
    }

    public void Withdrawal(decimal amount)
    {
        if (amount < 0)
        {
            throw new ArgumentOutOfRangeException(nameof(amount), "Withdrawal amount must be positive");
        }
        if (CurrentBalance - amount < -overdraftLimit)
        {
            throw new InvalidOperationException("Insufficient funds for withdrawal");
        }
        CurrentBalance -= amount;
    }
    
    public override string ToString() => $"Account ID: {AccountID}, Owner: {Owner}, Balance: {CurrentBalance}";
}

派生 CheckingAccount クラスには、基底クラスで必要なすべてのパラメーターを受け取るプライマリコンストラクターと、既定値を持つ別のパラメーターがあります。プライマリコンストラクターは、 : BankAccount(accountID, owner) 構文を使用して基本コンストラクターを呼び出します。この式は、基底クラスの型と、プライマリコンストラクターの引数の両方を指定します。

派生クラスは、プライマリコンストラクターを使用する必要はありません。次の例に示すように、基底クラスのプライマリコンストラクターを呼び出すコンストラクターを派生クラスに作成できます。

public class LineOfCreditAccount : BankAccount
{
    private readonly decimal _creditLimit;
    public LineOfCreditAccount(string accountID, string owner, decimal creditLimit) : base(accountID, owner)
    {
        _creditLimit = creditLimit;
    }
    public decimal CurrentBalance { get; private set; } = 0;

    public void Deposit(decimal amount)
    {
        if (amount < 0)
        {
            throw new ArgumentOutOfRangeException(nameof(amount), "Deposit amount must be positive");
        }
        CurrentBalance += amount;
    }

    public void Withdrawal(decimal amount)
    {
        if (amount < 0)
        {
            throw new ArgumentOutOfRangeException(nameof(amount), "Withdrawal amount must be positive");
        }
        if (CurrentBalance - amount < -_creditLimit)
        {
            throw new InvalidOperationException("Insufficient funds for withdrawal");
        }
        CurrentBalance -= amount;
    }

    public override string ToString() => $"{base.ToString()}, Balance: {CurrentBalance}";
}

クラス階層とプライマリコンストラクターには、潜在的な懸念事項が 1 つあります。パラメーターは派生クラスと基底クラスの両方で使用されるため、プライマリコンストラクターパラメーターの複数のコピーを作成できます。次のコードでは、各 owner パラメーターと accountID パラメーターの 2 つのコピーが作成されます。

public class SavingsAccount(string accountID, string owner, decimal interestRate) : BankAccount(accountID, owner)
{
    public SavingsAccount() : this("default", "default", 0.01m) { }
    public decimal CurrentBalance { get; private set; } = 0;

    public void Deposit(decimal amount)
    {
        if (amount < 0)
        {
            throw new ArgumentOutOfRangeException(nameof(amount), "Deposit amount must be positive");
        }
        CurrentBalance += amount;
    }

    public void Withdrawal(decimal amount)
    {
        if (amount < 0)
        {
            throw new ArgumentOutOfRangeException(nameof(amount), "Withdrawal amount must be positive");
        }
        if (CurrentBalance - amount < 0)
        {
            throw new InvalidOperationException("Insufficient funds for withdrawal");
        }
        CurrentBalance -= amount;
    }

    public void ApplyInterest()
    {
        CurrentBalance *= 1 + interestRate;
    }

    public override string ToString() => $"Account ID: {accountID}, Owner: {owner}, Balance: {CurrentBalance}";
}

この例で強調表示されている行は、ToString メソッドが基底クラスのプロパティ (OwnerとAccountID) ではなく、プライマリコンストラクターパラメーター (ownerとaccountID) を使用していることを示しています。その結果、派生クラス SavingsAccountパラメーターコピーのストレージが作成されます。派生クラスのコピーは、基底クラスのプロパティとは異なります。基底クラスのプロパティを変更できる場合、派生クラスのインスタンスに変更は表示されません。コンパイラは、派生クラスで使用され、基底クラスのコンストラクターに渡されるプライマリコンストラクターパラメーターに対して警告を発行します。この場合、修正は基底クラスのプロパティを使用することです。

フィードバック

このページはお役に立ちましたか?

Last updated on 2025-04-02

次の方法で共有

クラスと構造体のプライマリ コンストラクターを宣言する