レベル1

C#のコンパイラ警告 CS1690 について解説

2025-03-29更新日: 2025-03-29

C#のコンパイラ警告CS1690は、MarshalByRefObject由来のクラスの値型メンバーに直接アクセスすると、別のアプリケーションドメイン間で操作した際にランタイム例外が発生する可能性があるため表示されます。

対策として、値型メンバーは一度ローカル変数にコピーしてから操作する方法が推奨されています。

目次から探す

警告CS1690の基本情報
- 警告発生の背景
- MarshalByRefObjectの役割と性質
発生条件とコード例の解析
- CS1690が発生する状況
- サンプルコードの各部分の解説
警告回避の方法
- 値型メンバー操作の安全な手法
- 実装上の留意事項
まとめ

警告CS1690の基本情報

このセクションでは、CS1690警告の概要とその発生背景について説明します。

CS1690は、MarshalByRefObjectから派生するクラスの値型メンバーに対して、直接メソッドやプロパティ、インデクサーを呼び出すときに表示される警告です。

リモート環境やアプリケーションドメイン間でオブジェクトがマーシャリングされる際、値型メンバーに直接アクセスすると予期しない動作やランタイム例外を引き起こす恐れがあるため、警告が発生します。

警告発生の背景

CS1690警告は、リモート通信やアプリケーションドメインをまたいだオブジェクトのやりとりを行う際に出現します。

具体的には、MarshalByRefObjectを継承したクラスのインスタンスが、別のアプリケーションドメインから参照された場合、その値型メンバーに直接アクセスすると、アクセス先のオブジェクトの実体はコピーによって保持されるわけではなく、直接動作しようとするため、ランタイム例外が起こるリスクがあることに起因します。

MarshalByRefObjectの役割と性質

MarshalByRefObjectは、リモートオブジェクトとして動作させるための基本クラスです。

オブジェクトが異なるアプリケーションドメインやプロセス間で通信する場合、このクラスから派生したオブジェクトは、参照によるマーシャリングを利用して操作されます。

これにより、オブジェクトの実体を物理的に転送せず、リモート側の呼び出しが可能となるため、リソース管理やライフサイクルの統一がしやすくなります。

アプリケーションドメイン間のマーシャリングの仕組み

アプリケーションドメイン間でオブジェクトが使われるとき、MarshalByRefObjectを継承したクラスでは、インターフェースを介してリモート呼び出しが行われます。

アプリケーションドメインをまたぐとき、オブジェクトのプロキシが生成され、呼び出しはそのプロキシを通して実行される仕組みです。

値型はプロキシを介さず直接コピーされるため、この違いが警告の対象となる状況を生み出しています。

値型メンバー取り扱い時の注意点

値型メンバーは、コピーが行われる性質を持つため、リモートオブジェクトとしての一貫性が損なわれることがあります。

MarshalByRefObjectのインスタンスにおいて、値型のフィールドやプロパティに直接アクセスすると、アプリケーションドメインを越えた通信時に、正しくマーシャリングが行われず、不具合やランタイム例外の原因となる可能性があるため、アクセス方法には注意が必要です。

発生条件とコード例の解析

このセクションでは、実際にCS1690警告が発生する条件と、サンプルコードを用いた解説を行います。

具体例をもとに、どのような操作が警告につながるのかを見ていきます。

CS1690が発生する状況

CS1690は、MarshalByRefObjectを継承するクラスの値型メンバーに対して、直接メソッドやプロパティ、あるいはインデクサーを呼び出すときに発生する警告です。

例えば、別のアプリケーションドメインから取得したオブジェクトの値型メンバーに対し直接アクセスすると、この警告が表示されます。

直接アクセス時のリスクメカニズム

直接アクセスすることにより、リモートプロキシが経由せずに値型のメンバーにアクセスしようとするため、オブジェクトの状態が正しく反映されない場合があります。

また、期待されるマーシャリング手続きが無視されるため、リモート通信時に予期せぬ挙動や、最悪の場合はランタイム例外が発生するリスクが増大します。

InvalidOperationException発生の要因

値型メンバーに直接アクセスすることで、特定の条件下ではInvalidOperationExceptionが発生する可能性があります。

これは、リモートオブジェクトが持つ整合性や状態管理を保証するための設計上の制約によるものであり、不適切なアクセス方法を防ぐための仕組みの一環です。

サンプルコードの各部分の解説

以下のセクションでは、サンプルコードを例に、どの部分がCS1690警告の原因となっているのか、また動作原理について解説します。

問題箇所の特定と動作原理

次のサンプルコードは、CS1690警告が発生する典型例です。

リモートアプリケーションドメインで生成されたWarningCS1690クラスのインスタンスに対して、直接値型メンバーiにアクセスする部分が問題になっています。

using System;
class WarningCS1690 : MarshalByRefObject
{
    int i = 5; // 値型のフィールド
    public static void Main()
    {
        // 新たなアプリケーションドメインを作成
        AppDomain domain = AppDomain.CreateDomain("MyDomain");
        Type t = typeof(WarningCS1690);
        // リモートアプリケーションドメインでWarningCS1690のインスタンスを作成
        WarningCS1690 e = (WarningCS1690)domain.CreateInstanceAndUnwrap(t.Assembly.FullName, t.FullName);
        // ここでCS1690の警告が発生する
        e.i.ToString();
        // 以下は警告回避のためにローカル変数にコピー
        int localValue = e.i;
        localValue.ToString();
        e.i = localValue;
    }
}

// 出力は特にありません。プログラム実行中にCS1690警告が発生する可能性があります。

このコードでは、e.i.ToString()と直接呼び出す部分で、値型メンバーに直接アクセスしているため、リモートプロキシの事前処理を経ずにメソッドが呼び出されます。

そのため、CS1690警告が発生し、最終的に不具合が生じるリスクがあります。

警告回避の方法

このセクションでは、CS1690警告を回避するための方法について説明します。

正しい手法を用いることで、リモートアプリケーションドメイン間の通信で安全に値型メンバーを操作できます。

値型メンバー操作の安全な手法

CS1690警告の回避策として、値型メンバーを操作する際にローカル変数へコピーする方法が推奨されます。

これにより、リモートオブジェクトのプロキシを通さずに値型のコピーを利用するため、警告が発生せず、またリスクも低減されます。

ローカル変数へのコピー手順

ローカル変数にコピーする手順は以下のとおりです。

リモートオブジェクトの値型メンバーを一旦ローカル変数に格納する。
ローカル変数に対して、必要なメソッドやプロパティの呼び出しを行う。
必要であれば、ローカル変数の値を元のオブジェクトに再代入する。

以下のコードサンプルは、この手順を実践した例です。

using System;
class WarningCS1690Fixed : MarshalByRefObject
{
    int i = 5; // 値型のフィールド
    public static void Main()
    {
        // 新たなアプリケーションドメインを作成
        AppDomain domain = AppDomain.CreateDomain("MyDomain");
        Type t = typeof(WarningCS1690Fixed);
        // リモートアプリケーションドメインでインスタンスを作成
        WarningCS1690Fixed e = (WarningCS1690Fixed)domain.CreateInstanceAndUnwrap(t.Assembly.FullName, t.FullName);
        // ローカル変数にコピーしてから操作
        int localValue = e.i;
        // ローカル変数でメソッド呼び出しすることで、警告を回避
        string strValue = localValue.ToString();
        // 必要に応じて、ローカル変数の値を元のオブジェクトに再代入
        e.i = localValue;
        // 結果表示(デバッグ用)
        Console.WriteLine(strValue);
    }
}

// 出力例:
// 5

この方法により、直接値型メンバーにアクセスすることなく、安全にその値を操作することができます。

呼び出し前に確認すべきポイント

値型メンバーにアクセスする前に以下のポイントを確認することで、CS1690警告の回避と動作の安定性を確保できます。

・リモートオブジェクトが本当にローカルのコピーを必要としているか

・コピーした値を利用する処理において、値の整合性が保たれているか

・再代入が必要な場合、適切なタイミングで行われているか

これらの確認を徹底することで、リモートアプリケーションドメインとの通信において不具合を防止できます。

実装上の留意事項

実際に実装を行う際は、アプリケーションドメインの管理やリモートオブジェクトの操作に関して、いくつかの留意点があります。

以下のポイントを意識して実装することで、CS1690警告の回避とともに、コードの安定性を向上させることができます。

複数アプリケーションドメイン間の管理方法

複数のアプリケーションドメインを用いる場合は、以下の点に注意してください。

・各アプリケーションドメイン間で生成されるオブジェクトのライフサイクル管理を明確にする

・マーシャリングの仕組みを理解した上で、リモート呼び出しの際のデータの整合性に気を配る

・エラー発生時の例外処理を適切に実装する

これにより、異なるアプリケーションドメイン間での値のやりとりがスムーズに行われるようになります。

改修時の注意点とチェック項目

既存コードの改修時には、特に以下の項目をチェックしてください。

・リモートオブジェクトの値型メンバーに対する直接アクセスがないか

・ローカル変数を用いた安全なメンバー操作が実装されているか

・新たな機能追加によって、アプリケーションドメイン間のマーシャリングに悪影響がないか

必要な項目をチェックすることで、改修による不具合発生のリスクを最小限に抑えることができます。

まとめ

本記事では、MarshalByRefObjectから派生するクラスの値型メンバー操作に起因するCS1690警告について説明しています。

アプリケーションドメイン間のマーシャリングの仕組みや、直接アクセスによるリスクとInvalidOperationExceptionの発生要因、さらに、ローカル変数へのコピーを利用した安全なアクセス法と実装上の留意点が理解できる内容となっております。