C#のアクセス修飾子とUnityでの扱いを知っておくとグッド

アクセス修飾子の話はUnityでコーディングをする上でよく出てくる話です。

C#ではアクセス修飾子と呼ばれるキーワードを使って、対象のフィールドやメソッドに対してどこからアクセスできるかを決めています。

これは「アクセシビリティレベル」と呼ばれていて、アクセス修飾子単体または組み合わせて6段階のレベルを決めることができます。「アクセシビリティ」は近づきやすさ、利用しやすさといった意味の言葉で、どれだけ利用できるかのレベルを表しています。

どこからでも利用できたり、あるいはそのクラスでしか使えなかったりと、利用範囲に応じてアクセシビリティレベルを使い分けるのが鉄則。C#はオブジェクト指向のプログラミング言語なので、カプセル化や隠蔽の考え方に沿って、基本はそのクラスだけで使えるようにしたいところです。

ただし、Unityではインスペクターウィンドウから値を変更・調整できるようにすることでゲームのチューニングが容易になるので、こうした面からも適切なアクセス修飾子を選択できるようになるとグッド。

という訳でこのページではアクセス修飾子の種類を紹介し、Unityのインスペクターウィンドウで使うときにどれを選択すべきかも紹介していきます。

アクセス修飾子の種類

アクセス修飾子は

• public
• protected
• private
• internal

の4つがあります。

ざっくりと説明すると、publicはどこからでもアクセスできて、protectedは派生クラス(継承したクラス)で使えます。

privateはそのクラス内でしかアクセスできません。internalは同じアセンブリ内ならアクセスできます。

これらを単体で使う場合に加えて、組み合わせて使う「protected internal」や「private protected」もあります。こちらは名前の紹介だけにとどめますので、興味があれば調べてみてください。

internalとDLLの話

ちなみにinternalで出てきたアセンブリというのは.exeとか.dllといったアプリケーションの構成要素のことです。Unityではデフォルトだとユーザーが書いたコードはAssembly-CSharp.dllのファイルにまとまっているのでひとつのアセンブリ内でコーディングしています。dllとはDynamic Link Libraryの略で、プログラムを動かすときに使われる部品を表しています。

.dllファイルはプロジェクトフォルダの中にあるLibrary/ScriptAssembliesを見ると確認できます。アセットをインポートすると増えていたりするかもしれません。また、TextMeshProや2D Tilemap Editorなど、Unityのパッケージマネージャからインポートしたパッケージについてもdllファイルが作成されていたりします。

ユーザーが書いたコードについてもdllを分けたりできます。これによってコンパイルにかかる時間が短縮できるので、慣れてきたらこちらも検討するとグッド。この点についてはテラシュールブログさんのところで詳しく解説されているのでこちらもぜひ。

テラシュールブログ

 

33 Users

70 Pockets

【Unity】Assembly Definition Filesという神機能 - テラシュールブログ

http://tsubakit1.hateblo.jp/entry/2018/01/18/212834

今回は地味ですが神機能なAssembly Definition Filesについて紹介します。この機能は地味ですが、Unity開発の上で発生してる問題を（意図せず）かなり解決してくれるので、Unity 2017.3以降を使う人は是非覚えておいた方が良いかもしれません。 物自体は、C#のコードが出力するアセンブリを複数のアセンブリに分割する機能です。 ただし、使い方によってはコンパイル時間の削減によるイテレーションの高速化やビルドサイズ、アセットストアでの不満など様々な要素を解決する可能性がある機能です。 目次 Assembly Definition Filesとい...

基本はprivate

コーディングを行う際は、基本的にはprivateを使います。これは他のクラスからフィールドの値を変えられるといつ値が変わったか把握するのが大変になったりするためです。

オブジェクト指向の考え方だと、オブジェクトの振る舞いはオブジェクトの中で完結して結果だけ返すような組み方が良いんですよね。

例えば上司が部下に対して、

「PC立ち上げて」

「Excel開いて」

「テストケースのファイルを開いて」

「C24のセルにこの値を入れて」

「ファイルを保存して」

「私(上司)にメールで送って」

と逐一指示していたら、ふたりの時間がもったいないですよね。仕様が変わったらまた上司の指示内容が細かく変わったりするので、上司、部下のどちらの立場も大変です。

この場合だったら、上司から

「必要なデータは渡すからテストケースにまとめた後、私にメールで送ってください」

と部下にお願いすれば部下はちゃんと作ってくれるはずです。仕様が変わったとしても、部下側で調整すればいいので、上司は完成したテストケースのファイルを受けとるだけでOKです。

こんな感じで別のオブジェクトに対して逐一指示するするのではなく、「これやって」とお願いして、「できたよー」と結果が返ってくる関係が理想的。なので、わざわざpublicにして公開せずとも内部だけで値を持っていればいいこともあります。外からわーわー言われることで値が変わって逆に効率が落ちたり意図しない結果になってしまったりするので、必要がないときにはprivateにしておきたいところです。

また、アクセスレベルを指定しない場合はprivateとして扱われます。意図せず広いアクセスレベルになっていた！　なんてことがないので安心ですね。

明示的にprivateをつけるべきかは好みによるところですが、public, protected, privateと全部pで始まるので紛らわしいなーと思い、自分でコードを書くときはつけていません。一緒にやっている人が「privateつけるよ派」だったら合わせる感じです。

継承するならprotected

継承したクラスでフィールドやメソッドを使いたい場合も多々あります。そうした時はprotectedを使って継承しましょう。

スクリプトを作成したときには以下のように「MonoBehaviour」のクラスを継承しています。

なので、私たちが処理を書かなくても「gameObject」と指定すればアタッチしたゲームオブジェクトの情報を使うことができたり、あるいはGetComponentでコンポーネントへの参照を取得できたりするんです。

継承やオーバーライドについては以下の記事で紹介しているのでこちらもよかったらどうぞ。

エクスプラボ

 

2 Pockets

【Unity/C#】継承やオーバーライドも使えると便利なのでぜひ

https://ekulabo.com/c-sharp-inheritance-override

Unityで使っているC#はオブジェクト指向のプログラミング言語で、継承やオーバーライドの機能を上手く使えると効率よくコーディングできます。この記事では本当に導入レベルの話をしていて、キーワードの紹介に近いので他のページも一緒に参照するといいかもしれません。

Unityでのpublic

Unityではpublicなフィールドの扱いが特殊で、MonoBehaviourを継承したクラスについてはpublicなフィールドの値をインスペクターウィンドウから変更できます。

「インスペクターウィンドウから値を変えたい時はpublicだ！」

とたくさんのフィールドがpublicになることもありますが、publicにすることでインスペクターウィンドウだけではなく他のクラスからも値を変更できてしまう点には注意が必要です。

インスペクターウィンドウから値を変えたい、でもなるべくフィールドを公開したくない、という場合はprivateなフィールドに[SerializeField]のアトリビュート(属性)をつけることでもインスペクターウィンドウから値を変えられます。

ひとりで開発するならpublicが楽かもしれませんが、他の人と一緒に開発するならなるべくprivateのままにしておきたいところです。

この辺りはアクセシビリティレベルを意識してうまく使い分けられると安全なコードを書けると思います。

Attributeについては以下の記事で紹介しているのでよかったらこちらもご覧くださいな。

エクスプラボ

 

3 Pockets

【Unity】Inspectorウィンドウでの表示に関わるAttributeのまとめ

https://ekulabo.com/attributes-for-inspector

Inspectorウィンドウへの表示に関係するUnityのAttributeをまとめています。このブログではこれらのAttributeについて詳細記事を作成しているので、使い方を掴むのにも使えます。

エクスプラボ

 

1 Pocket

【Unity】Inspectorで値を変える時、publicとSerializeFieldどっち使う?

https://ekulabo.com/public-or-serializefield

スクリプトを書く時に悩む、Inspectorに表示したいフィールドの公開方法。publicなら簡単だけど他のスクリプトからアクセスできちゃうし、でInspectorに表示するのが無難かなーなんて思いつつ、2つの方法の使い分けを記載。

まとめ

C#でアクセシビリティレベルを表現するために使うアクセス修飾子を紹介しました。このうちpublicについてはUnityで特別な位置付けにあるので、C#での扱いとUnityでの扱いの両方を加味して選択するとグッド。