C#文法 リフレクション G05_CanWrite

CanWriteとは

PropertyInfoにはCanWriteというプロパティが用意されています。これは、対象のプロパティに値を書き込めるかどうかをチェックするためのものです。

たとえばStockEntityクラスにStockTextというプロパティを作り、getのみでsetを持たない状態にしておきます。

StockTextプロパティ（getのみ、setなし）

public string StockText { get; }

setのないプロパティにSetValueすると例外になる

このgetのみのStockTextに対してPropertyInfo.SetValueを呼び出すとどうなるかを確認します。CanWriteでのチェックを行わずにSetValueをそのまま呼び出すと、setが存在しないため例外が発生します。

PropertyInfo p = t.GetProperty("StockText");
p.SetValue(instance, "AAA");
var value2 = p.GetValue(instance);

setを持たないプロパティにSetValueすると「ユーザーが処理していない例外」が発生する

getだけのプロパティにはそもそもsetが存在しないため、SetValueで書き込もうとすると当然ながら例外になります。この例外を発生させずに事前にチェックしたい場合に使うのがCanWriteです。

CanWriteで書き込み可否をチェックする

PropertyInfoにはCanWriteのほかにCanReadもありますが、getが存在しないプロパティは基本的にないため、実務上チェックする機会が多いのはCanWriteの方です。読み取りは基本的に誰でもできる一方で、書き込みができるかどうかはsetの有無によって制御されることが多いためです。

IntelliSenseからCanWriteを選択する

if文でp.CanWriteを判定し、trueのときだけSetValueを呼び出すようにコードを変更します。

PropertyInfo p = t.GetProperty("StockText");
if (p.CanWrite)
{
p.SetValue(instance, "AAA");
var value2 = p.GetValue(instance);
}

この状態でStockTextはgetのみのプロパティなので、CanWriteはfalseを返します。そのためif文の中には入らず、SetValueは実行されずに処理が通り抜けます。

CanWriteがfalseのため、if文の中を通らずに処理が終わる

setを付けるとCanWriteはtrueになる

試しにStockTextプロパティにsetを付けてみます。ここではpublicなsetではなく、あえてprivate setを指定します。

public string StockText { get; private set; }

StockTextにprivate setを追加する

この状態で実行すると、今度はCanWriteがtrueとなり、if文の中に処理が進んでSetValueが実行されます。value2にはSetValueで書き込んだ”AAA”が正しく格納されます。

private setを追加したことでCanWriteがtrueになり、if文の中でSetValueが実行される

private setでも書き込めることに注意

ここで注意したいのは、setがprivateであってもCanWriteはtrueを返し、SetValueも例外にならず書き込めてしまうという点です。

通常のC#のコードでは、private setは外部のクラスからアクセスできません。しかしReflectionを使う場合は、アクセスレベルに関係なくメンバーにアクセスできてしまうという特有の性質があります。そのため、private setにしておいても、Reflection経由であれば書き込みが可能になってしまいます。

本当に外部から書き込まれたくないプロパティであれば、setそのものを持たせずgetのみにしておく必要があります。getのみにしておけばCanWriteはfalseとなり、SetValueを呼び出すと例外になります。

まとめ

・PropertyInfo.CanWriteを使うと、対象のプロパティがsetを持っているかどうか（書き込み可能かどうか）を例外を出さずに事前にチェックできる。

・getのみのプロパティに対してCanWriteを使わずにSetValueを呼び出すと例外になる。

・private setであってもCanWriteはtrueとなり、SetValueで書き込めてしまう点に注意が必要（Reflectionはアクセスレベルの制約を受けない）。

・書き込みを完全に禁止したい場合は、setを持たせずgetのみのプロパティにしておく。