The document discusses Assembly Definition (asmdef) files in Unity. It begins by explaining that asmdef files are used to define Assembly configurations in a project. It notes some key points about asmdef files, including that they allow defining assemblies that can be referenced from other parts of a project. It also discusses different ways asmdef files can be structured, such as having one per script folder, one per assembly, or splitting assemblies for editor/playmode tests. Overall, the document provides an overview of what asmdef files are used for and important considerations around their usage and configuration in Unity projects.

1. Assembly Definition
あれやこれ
中野 洋輔
@naninuneno_y
Gotanda.unity #16 sponsored by 株式会社Donuts

2. もくじ
1. `asmdef` is 何
2. 使うべきか/使わないべきか
3. 取り扱い注意な点
4. asmdefの構成について
5. 設定項⽬を⼀通り試してみた
触ったことない⼈の⼀歩を後押し
知ってる⼈にもさらに便利に使ってもらいたい
検証時の環境はUnity2020.2.0です

3. `asmdef` is 何
私は普段「あせんでふ」で読んでます
• プロジェクトのディレクトリに asmdef ファイルを作成する
ことで、配下のファイルの Assembly を設定することができる機能。
Unity Editorからポチポチするだけで
導⼊可能。楽！
• [参考記事] Assembly definitions (Unity公式)
• [参考記事] Unity Assembly Definition 完全に理解した

4. `asmdef` is 何
ADFが無難そう
• あせんぶり・でぃふぃにしょん・(ふぁいるず)
• えー・でぃー・えふ
• あせむ(ん)でふ
読み⽅

5. Q. Assembly Definition は
プロジェクトに導⼊すべきですか？

6. Q. Assembly Definition は
プロジェクトに導⼊すべきですか？
A. 使わないで済むなら
使わなくてよいです(※)
※ ライブラリ開発者はマストで導⼊してください(後述)

7. asmdef導⼊で注意すべき点
⾃⼒解決の⼿間や、詰みが発⽣する可能性があり得るのが
⼿放しではおススメはできない理由です
• 今まで当然のように参照できてたクラスにアクセスできなくなる
• UnityでのC#開発の経験しかない⼈だとUnityがこわれた状態になる
• asmdefがないライブラリを使⽤する場合、⾃⼒で設定する業を背負
わなくてはならなくなる
• １〜２個追加して済めばよいが、Editor拡張とかテストとかあると地獄をみる
ことになる
• staticクラス/partialクラスの使われ⽅によっては詰みが発⽣する場合も
[参考記事] Assembly Definition Files の地雷ポイントについて解説してみる

8. asmdefの構成(ノーガード)
プロジェクトが巨⼤になるとコンパイル時間が増⼤
EditModeテストは不可
Assets
├─MyProject
│ └─Scripts
│ └─いろいろ.cs
│
├─Library1
│ └─いろいろ.cs
│
└─Plugins
└─Library2
├─Library2.asmdef
└─いろいろ.cs
※ MyProjectからLibrary2は参照可(逆は不可)
全てが Assembly-CSharp に
属する平和な世界
• asmdefの困りごとと無縁
• asmdefの恩恵は受けられない

9. asmdefの構成(ノーガード)
わかり⾟いのはおそらく敢えてで、
Unityはasmdef導⼊を推奨しているのだと思います
Enable playmode test for all assemblies により、
asmdefなしでもPlayModeテストを導⼊可能
EditModeテストは諦めてください

10. asmdefの構成(オーソドックス)
Assets
├─MyProject
│ └─Scripts
│ ├─MyProject.asmdef
│ ├─いろいろ.cs
│ ├─Editor
│ │ └─MyProject.Editor.
│ └─Tests
│ ├─EditMode
│ │ └─MyProject.Tests.EditMode.asmdef
│ └─PlayMode
│ └─MyProject.Tests.PlayMode.asmdef
│
├─Library1
│ ├─いろいろ.cs
│ └─Library1.asmdef
│
└─Plugins
└─Library2
├─Library2.asmdef
└─いろいろ.cs
⾃プロジェクトにasmdefを1つ追加する
• Editor拡張のためにはplatform=Editorな
asmefが必要
• テストには専⽤のasmdefが必要
• EditModeテストのasmdefも
platform=Editorにすること
• MyProjectから特定のライブラリを参照
するには独⾃にasmdefを追加！

11. asmdefの構成(ライブラリ)
[参考]Package layout(Unity公式)<root>
├─package.json
├─README.md
├─CHANGELOG.md
├─LICENSE.md
├─Editor
│ ├─MyLibrary.Editor.asmdef
│ └─いろいろ.cs
├─Runtime
│ ├─MyLibrary.asmdef
│ └─いろいろ.cs
├─Tests
│ ├─Editor
│ │ ├── MyLibrary.Editor.Tests.asmdef
│ │ └── EditorExampleTest.cs
│ └─Runtime
│ ├── MyLibrary.Tests.asmdef
│ └── RuntimeExampleTest.cs
└─Documentation~
└──MyLibrary.md
upm経由で配布するにはasmdef必須
package.jsonだけあっても
インストール時に警告が出て使⽤不可
not be compiled because
it exists outside the Assets folder
and does not to belong to any assembly definition file.

12. asmdefの構成(ライブラリ)
<root>
├─package.json
├─README.md
├─CHANGELOG.md
├─LICENSE.md
├─Editor
│ ├─MyLibrary.Editor.asmdef
│ └─いろいろ.cs
├─Runtime
│ ├─MyLibrary.asmdef
│ └─いろいろ.cs
├─Tests
│ ├─Editor
│ │ ├── MyLibrary.Editor.Tests.asmdef
│ │ └── EditorExampleTest.cs
│ └─Runtime
│ ├── MyLibrary.Tests.asmdef
│ └── RuntimeExampleTest.cs
└─Documentation~
└──MyLibrary.md
[注意]
⼀度でもasmdefなしでライブラリをリ
リースした場合はasmdef追加には慎重
になったほうが良い
asmdefを独⾃に追加しちゃった⼈に
とって破壊的変更になる
• asmdef追加の告知/案内を出す
• asmdefだけのunitypackageを配布す
る

13. asmdefの構成(チャレンジ)
asmdefでレイヤ分割することで、コードの関係性も
整理できるし、ディレクトリ階層に意味を持たせられる
機能やレイヤ分割のためasmdefをどんどん
追加していく
• コードの参照関係をコントロールできる
• クラスAからBを呼び出せない
ようにしたいなど
• カオスにならないように注意
• [参考記事] CleanArchitectureでasmdefをガチった話(Unity)
• [去年のLT] clean architecture と asmdef

14. asmdefの構成(asmref)
Assets
├─Fuga
│ ├─Fuga.asmdef
│ ├─PiyoBehaviourScript.cs
│ └─Piyo
│ ├─Piyo.asmref ★Hoge.asmdefを参照
│ └─PiyoBehaviourScript.cs
│
└─Hoge
├─Hoge.asmdef
└─HogeBehaviourScript.cs
asmref にasmdefの参照を通すとディ
レクトリがそのAssemblyに属する
• 左の場合なら PiyoBehaviourScript
と HogeBehaviourScript は相互に参
照可能。
• 設定できるasmdefは⼀つだけ
フォルダ構成の束縛から抜けたい⼈向け

15. asmdefのプロパティ
いずれは nullable も設定できるようになるんですかね
• Allow ʻunsafeʼ Code
• amsdef配下のコードでunsafeの機能を許すかの項⽬
• PlayerSettings > Other Settingsから設定した場合は
プロジェクト全体でunsafe可能になるが、
asmdefでunsafe可能なレイヤを制御できる

16. asmdefのプロパティ
コンパイル時間の削減⽬的でasmdefを導⼊するなら要チェック
• Auto Referenced
• onだとasmdef配下がAssembly-Csharpから参照される
• offにするとAssembly-CSharpにしか属さないコードから
参照できなくなる。
• ⾃分で追加したasmdefに関してはoffでよさそう。
• ライブラリ開発者はonにしておくべき。
• (でないとノーガード戦法の⼈が困る)
• [参考記事] 「AssemblyDefinitionを分けるとコンパイルが⾼速になる」ってホント？検証してみた！
• [参考記事] なんだかこのUnityプロジェクト、エディタコンパイル時間が⻑いぞ、という時の対処

17. asmdefのプロパティ
• Auto Referenced
• Library.asmdefが auto referenced=true の場合は MyProject2/ 以下のコードから参照 できる
• Library.asmdefが auto referenced=false の場合は MyProject2/ 以下のコードから参照 できない
Assets
├─MyProject1
│ └─Scripts
│ ├─MyProject1.asmdef ★Library.asmdefを参照
│ └─いろいろ.cs
│
├─MyProject2
│ └─Scripts
│ └─いろいろ.cs
│
└─Plugins
└─Library
├─Library.asmdef
└─いろいろ.cs

18. asmdefのプロパティ
メリットのほどがわからないので導⼊は慎重に
(将来事故る可能性の⽅が⾼そう)
• No Engine References
• UnityEngineのAsssemblyに参照できなくするオプション
• MonoBehaviour はおろか、Quaternion、
MathfやDebug.Logにもアクセスできなくなる
• onにすることで、asmdef配下のコードは
Unityにすら依存しないことを明⽰できる

19. asmdefのプロパティ
asmdef切ってもdll内のクラスはどこからでも参照できちゃうんだよね。。
と思っていたが制御できた。
• Override References
• コンパイル済みdllの参照を上書きする
• Plugins/配下にあるdllはasmdef有無に関わらず、
プロジェクト全体から呼び出せるが、asmdef配下で
参照する/しないを制御する。

20. asmdefのプロパティ
毎回⼿癖でnamespaceをコピペしてた⼈には
ありがたい機能
• Root Namespace
• ここに設定した⽂字列が、Scriptを作成したときに
namespaceに⾃動で設定される。
• Unity2020.2で追加

21. asmdefのプロパティ
#if でコードが読み⾟くなるのを整理できるかも
• Define Constraints
• プロジェクト内でシンボルが有効な時に
asmdef配下のコードを有効にする
• 逆に⾔うとプロジェクト内でシンボルが無効な時は、
asmdef以下のコードにアクセスできなくなる
• ソースコード全体を #if UNITY_2020_2 とかで囲うのと同じ

22. asmdefのプロパティ
asmdefに限らないが、どのplatformでもコンパイルは
通るように保守しましょう
• Platforms
• Android/iOS/WebGLなど特定のプラットフォームで
asmdefを有効化する設定
• Define Constraintsと仕組みは⼀緒
• Editor拡張や、EditModeテストのコードは
PlatformがEditorだけのasmdefをつくること

23. asmdefのプロパティ
GitHub上でコードレビューする際にGUIDだと参照先が
⼈間に読めないのでAssembly名の⽅がよい場合もある
• Assembly Definition References
• ⽂字通り、asmdefから参照するasmdefの⼀覧を設定
・循環参照はできないので注意(⾃分を参照するのも不可能)
• Use GUIDs
• asmdefの参照をGUIDで⾏う設定(デフォルトon)
• offにするとAssembly名で参照する
• Nameを変えると参照が切れるのでGUIDを使う⽅が安全
• Unity2019辺りで追加
• asmdefパース⾃作勢はこの仕様に注意

24. asmdefのプロパティ
• Version Defines
• 特定のパッケージ(+バージョン)がプロジェクトに
存在するときのみ有効になるシンボルを設定可能。
• 別packageの拡張メソッドを⾃作ライブラリに実装
• UniTaskでの使⽤例
• これがなかったら、DOTweenのUniTask拡張は
別packageで配布になったと思われる

25. まとめ
• asmdefは混乱することもありますが、使いこなせば
開発者の不便利を解決してくれる、無⼆の存在だと思っています
asmdef Editor拡張紹介
• naninunenoy/AsmdefHelper
• asmdefでレイヤ分けても可視化できなければ意味ないねというモチベで作った
• その他便利だと思ったEditor拡張なども導⼊
• hananoki/AsmdefGraph
• 基本思想は同じなようだが、csファイルの⼀覧まで⾒られる
• ProjectBLUE-000/CleanArchitectureCodeGenerator
• CleanArchitectureに則ったasmdefやクラスを⽣成してくれる
• Dependencies Visualizer
• Asset StoreにあるEditor拡張
• 作者の名前でググればGitHubも⾒つかる
終
制作・著作
━━━━━
ⒶⒹⒻ