祝 Unity 2021.2 C# 9 対応！

2021.2リリース

公式のPushが弱いのか、あんまり話題になっていない気がしますが、こっそりC#9に対応しました。😎

リリースノート

Scripting: Updated C# language version to 9.0 for compilation and IDE's

マニュアル

C# language version
C# 9.0

内部的には、Roslynのバージョンが、2.1.0.0->3.9.0.0にアプデートされました。

使える機能

言語バージョンは上がりましたが、ランタイムのバージョンが上がったわけではないので、すべての機能が使えるわけではありません。

• パターンマッチの強化
  • 不等式
  • and/or式
  • is not式
• 関数ポインタ
  • Delegateを作らない、Marshalingしない分だけ早い
• new X()のクラスXの推論
  • List<Hoge> dic = new(0)
• ラムダ式にstaticつけられる
  • staticラムダはDelegateがキャッシュされるのでアロケートが起こらない
• cond ? a : bとしたとき、a,bの共通の祖先の型を推論
• 拡張メソッドGetEnumeratorを持っているものもforeach可能に
• ラムダ式の引数を破棄可能に（_）
• ローカル関数に属性がつけられる
• partialなメソッド
• nint/nuint

使えない機能

コンパイラ君の頑張りではどうにもならないシリーズ

• [SkipLocalsInit]によるスタックメモリの0初期化の回避
• 戻り値型の共変
• Module初期化メソッド（[ModuleInitilizer）
• Stdcall以外の呼出し規約の関数ポインタの利用
• トップレベルステートメント

ひと手間加えると使えるもの

IAsyncEnumeratorとかが入った時もそうでしたが…
コンパイラが必要とするクラスが含まれていないので、適当に追加してやれば動きます。
（最初から入れておいてくれればいいのに…）

• recordクラス/initプロパティ
  • どこかにIsExternalInit っを書いておけばOK

SourceGeneratorは使えそうで使えない？

コンパイラのバージョンが上がったということで、Roslynのバージョンが上がりました。3.9.0.0になったわけですが、SourceGeneratorは3.8.0.0からです。つまり使える！！！

…かと思ったのですが、残念ながら動きませんでした。
Unityはcsprojではなく、cscに直接ソースファイル群を渡してコンパイルしているっぽいのですがSourceGeneratorはcscより上のレイヤーで処理してるんじゃないかなとか
この辺の実装が2021.2で大幅に変更されていました。今のところ、本当にcscを直接叩いているのかもよくわかってないです。

またIDE側についてですが、そもそもcsprojが存在しないのでそれっぽいcsprojをcom.unity.ide.vscodeなどが生成してIDEに読ませています。そしてこのでっち上げられたcsprojがSDK形式ではなく、.NETFramework時代の古い形式となっています。おそらくSouceGeneratorはSDK形式のcsprojじゃないと動かないんじゃないかと考えています。

ちなみに、SourceGeneratorもAnalyzerと同じ手順で導入して試しました。

一応、動いたゾって言ってる人いるけど…🤔
https://forum.unity.com/threads/source-generators-via-roslyn-analyzers-in-2020-2.1003386/

SourceGeneratorのうま味半減…というか、これなら自前のGeneratorでも変わらないですが、<CompilerGeneratedFilesOutputPath>を使って別でやるという手もあります。
非Unityと共有するGeneratorや将来のUnityに期待を込めてSouceGenerator化しておくのはありだとは思います。
（「not found command "dotnet"って出たんだけど😡」っていう苦情が非エンジニアから飛んでくると思うので、SDKを同梱するとか運用上の工夫は必要かもしれません）
https://github.com/Cysharp/UnitGenerator#use-for-unity

CodeAnalyzerも微妙？

CodeAnalyzerは2020で入ったものですが、Roslynつながりで。
しかし、これも完全に動いたとは言い難いところです。

導入したAnalyzerはマニュアルに例示されているものErrorProne.NET.CoreAnalyzers/0.1.2です。

まずUnity側ですが、コンパイルが走るとちゃんと警告が出てくれます。

しかし、その状態でcom.unity.ide.vscodeによって吐かせたcsprojをVSCodeに読ませたところ、警告が出ませんでした。
一方、ここに書かれているMicrosoft.CodeAnalysis.NetAnalyzers/5.0.3はVSCodeでも反応するので謎です。
TargetFrameworkが原因の可能性もあるので、Standerd2.0のErrorProne.NET.CoreAnalyzers/0.4.0-beta.1でも試しましたが同様でした。

以前のバージョンでも使いたい

C#9,8をポーティングしてくれるライブラリが存在します。
ちなみに2021.2では、EditorCompilationInterface.DirtyAllScriptsなどがなくなった影響で動作しません。まぁ、コンパイラ変わってますし仕方ないね。

ざっくりとした仕組み

UnityEditorのC#コンパイルのProcessStartInfoを、リフレクションで上書きすることで実現しています。

1. [InitializeOnLoadMethod] Coffee.CSharpCompilerSettings.Core.Initialize
2. CompilationPipeline.assemblyCompilationStarted += OnAssemblyCompilationStarted
3. OnAssemblyCompilationStarted(string name)
4. DLLのパスを取得
5. ChangeCompilerProcess
6. CompleのProcessStartInfoを取得
7. ProcessStartInfoを、カスタムコンパイラを使うように書き換え
8. ProcessStartInfoを実行
9. UnityはカスタムコンパイラでコンパイルされたDLLをロードする

カスタムコンパイラは、GUIから指定できます。

「コンパイラのバージョンだけを下げる方法」の逆です。
MSBuildを使っている場合、参照に追加するだけでコンパイラが切り替わってくれるとこのことですが、Unityはcscを直接叩いてコンパイルをしているため、上記のようにコンパイルのProcessStartInfoを上書きする必要があるものと思われます。

このライブラリを使えば、.NET5 SDKでビルド（TargetFrameworkはStanderd2.0）できるんじゃないかと思いましたが、Microsoft.Net.Compilers.Toolsetはv4.7まででした…。ただ、「StartProcessInfoを上書きする」ところまで改造を入れれば、dotnet build ...とすることも出来そうな気がします。