2020/06/29

C# 9.0

C# 9.0 in Visual Studio 16.7 preview 3

先週の話にはなってしまうんですが、Visual Studio 16.7 が Preview 3.1 になっています。 .NET 5 も Preview 6 に。

で、今回も C# 9.0 の新機能がいくつか入っています。

Records
Top-level statements
Function pointers

昨日、このネタでライブ配信してたりするんですが、今回、ついに配信時間が3時間の大台に…

配信時間が長くなっているのはチャット欄での応答が盛り上がりすぎたというのが原因です。 (「新機能が多くて長引いた」みたいなのではなく。) 特に Function pointers の話とか、そもそも付いてくる人がいると思っていなかったので、 Function pointers だけで相当な時間しゃべることになったのがだいぶ意外…

インタラクションが欲しくて始めたライブ配信だし、タイムキーピングを気にしなくていいのも楽なので、うれしい悲鳴なんですけども、

!is 問題

最初に取り上げるのは C# 9.0 でもなんでもないんですけども。

VS 16.7 p3 のリリースノートを見ていて、null 抑制演算子の ! に対するリファクタリングが入っていてなんとも言えない気持ちになったという話。

以下のコード、解釈の仕方を間違う人があまりにも多いらしく。

if (x !is 0) { }

!x が「x の否定」、not x の意味なせいで、それで勘違いしちゃう人がいたりします。上記のコードは正しくは (x!) is 0 の意味で、この ! は後置きの x!。否定の意味の ! ではなくて、C# 8.0 の null 許容参照型がらみの機能で、効果としては単なる null 警告の抑止です。

挙句の果てに、is 0 と書いた時点で「null ではないことが確定」なので、null 警告の抑止をする意味すらないという。

つまるところ、!is を not is と勘違いして使ってしまうと、真逆の挙動になるというひどいバグを生む原因です。なのでしょうがないので…

リファクタリング1: 意味がないので ! を消す

if (x is 0) { }

リファクタリング2: “ちゃんと”真逆に直す

if (x is not 0) { }

is not T x

not パターン自体は先月の時点で入っていたんですが、微妙に今回の 16.7 Preview 3 リリースで入った修正もあります。以下のようなコードが有効になりました。

static void M(object x)
{
    // not パターンでも変数宣言できる
    if (x is not string s)
    {
        // ちなみに、ここで s の中身を読もうとすると「未初期化」エラー
 
        s = "";
 
        // s を読めるのはこの行以降
    }
 
    // ここは絶対 s が初期化されている保証あり
    Console.WriteLine(s);
}

Top-level statements

Program.Main が要らなくなります。 C# スクリプトモードじゃなくても以下のように、Top-level (クラスとか名前空間の外)にコードが書けます。

using System;
 
Console.WriteLine("Hellow World!");

ちなみに、「C# スクリプトモード」とはまたちょっと挙動が違ったりします。

Top-level の場合

あくまで Main メソッドの自動生成
- 変数やメソッドを書くと、ローカル変数、ローカル関数の意味になる
- args (暗黙的変数)でコマンドライン引数を受け取れるし、return で終了コードを返せる
#r や #load などのスクリプト専用機能は使えない

スクリプトの場合

ラッパークラスが作られる
- 変数はフィールドに、メソッドはインスタンスメソッドになる
逆に、return とか namespace とか「通常モード」専用の構文は使えない

ちなみに、Top-level に普通に await も書けます。 await があれば async Task Main、なければ void Main みたいな扱いです。

Top-level ステートメントを書いた上で、さらにどこかのクラスに Main メソッドを書いてしまった場合、 Top-level ステートメントの方が優先されます(書いてしまった Main は呼ばれない)。警告だけは出ます。

また、複数のファイルに Top-level ステートメントを書いたり、名前空間やクラスよりも後ろに書いた場合はコンパイルエラーになります。あくまで、1ファイルの先頭にだけ Top-level ステートメントを書けます。

Function pointer

関数ポインターを C# 上で書けるようになりました。

まあ、正直、大多数の人にとって直接触れる機能ではないです。実質的には P/Invoke 専用機能になると思います(どうひねり出そうと思っても他の用途が思いつかない)。

以下のように、delegate* で「関数ポインター型」を作って、 & でメソッドのアドレスを取得できる機能です。

using System;
 
class Program
{
    unsafe static void Main()
    {
        delegate*<int, void> f = &M;
        f(1);
    }
 
    static void M(int x) => Console.WriteLine(x);
}

.NET の仕様上は上記コードに相当する命令(ldftn, calli)が元々あったりします。ただ、C# からこれらの命令を使う手段が全くなくて、これまでは IL アセンブラーや Reflection.Emit を使う必要がありました。

今、iOS や WebAssembly 対応のために、 Reflection.Emit による実行時コード生成を、 Source Generator によるコンパイル時コード生成に置き換えたいという話もあったりします。 P/Invoke の類も、 .NET Runtime の中で特殊対応するよりも、事前にソースコード生成したいみたいな話もあって、そのために必要になる機能です。

「ないと困るから入れた」という類であって、「便利に使いたい、簡単に使いたい」という動機はないので、構文的に結構複雑だったりします。

ただ、関数ポインターで <void> を認めてくれるんなら、普通のデリゲートでも同じように書きたい… (書けないし、今後もたぶんずっと無理)

using System;
 
class Program
{
    static void Main()
    {
        Func<int, void> f = M; // こう書きたい(無理)
        Action<int> a = M; // 戻り値が void かどうかで型が違う
    }
 
    static void M(int x) => Console.WriteLine(x);
}

Records

待望(？)の Records。概ね、6月9日にブログに書いた状態で実装されていそうな感じ。

一番シンプルな書き方をすると以下のようになります。プライマリコンストラクター構文。引数の順序(position, 位置)に意味があるので positional record と言ったりもします。

using System;
 
// 一番シンプルな書き方はこうなる
record Point(int X, int Y);
 
class Program
{
    static void Main()
    {
        var p = new Point(1, 2);
        Console.WriteLine(p.X);
    }
}

class や struct と並んで、record という型定義用のキーワードが増えます。

ちなみに上記コードは以下のコードとほぼ同じ意味になります。

// プライマリ コンストラクターの展開結果
record Point
{
    public int X { get; init; }
    public int Y { get; init; }
 
    public Point(int X, int Y)
    {
        this.X = X;
        this.Y = Y;
    }
}

残念ながら、今のところ(というか、おそらく C# 9.0 リリース時点では)、プライマリコンストラクターを書けるのは record だけになりそうです。

一方、init は class や struct でも使えます。例えば、以下のようなコードは有効な C# 9.0 コードになります。

// init に関しては çlass でも struct でも使える
class Point
{
    public int X { get; init; }
    public int Y { get; init; }
 
    public Point(int X, int Y)
    {
        this.X = X;
        this.Y = Y;
    }
}

ということで、Records の説明をする上での本質は以下の2点からなります。

じゃあ、 class と record は何が違うか
プロパティの init は何か

補足: IsExternalInit 属性

init プロパティを表現するために IsExternalInit という名前の属性を使っているんですが、これは、

現時点では .NET 5 にも入っていない
リリース時点では .NET 5 には入る予定
古い .NET ランタイムに対するポーティングとかは提供せず「C# 9.0 をフルにサポートするのは .NET 5 のみ」という扱いにしたい

ということになっています。ただ、以下のコードを自前で用意すれば、現時点の .NET 5 Preview や古い .NET ランタイムでも record や init を使えます。

namespace System.Runtime.CompilerServices
{
    internal class IsExternalInit { }
}

ちなみにこの型、中身空っぽでマーカー的に用意された型ですが、実際の使われ方は modreq になります。

後述する init が、古い C# コンパイラーから触られるとまずい機能なので、触れなくするために modreq を使っています。

record と class

現状だと、プライマリコンストラクターを書けるのは record だけなんですが、 class や struct に対しても後々追加される可能性は結構高いです。

で、前述の通り、init プロパティを使うのであれば、class、struct、record でほぼ同じ書き方ができます。じゃあ、class、struct と record の何が違うかと言うと…

struct みたいな、全フィールドの memberwise 比較を元にした Equals、GetHashCode、Clone がコンパイラー生成される
record は参照型

みたいな感じです。要するに、struct 的な「値セマンティクス」を持つ参照型が record。

これだけ書いてしまうと大したことをしていないように聞こえますけども、 immutable なデータ構造を簡単に書けるようにするという意義があります。

参照型の「値比較」(memberwise に Equals、GetHashCode 実装)は immutable に作らないとまずいです。一方で、immutable なクラスを真面目に書くのはすさまじく大変で、その負担を減らしてくれるのが record です。

あと、派生が絡んだ時の Equals 実装も意外とめんどくさくて、そこも record からのコード生成が頑張ってくれています。

with 式

immutable なクラスの部分書き換えをする場合、基本的には Clone してから所望のメンバーだけを上書きと言う処理が必要になります。

それをやってくれるのが with 式で、record に対して以下のような書き方ができます。

using System;
 
record Point(int X, int Y);
 
class Program
{
    static void Main()
    {
        var p = new Point(1, 2);
 
        // p を部分書き換え(この場合 X だけ書き換え)
        var p1 = p with { X = 3 };
 
        Console.WriteLine((p.X, p.Y));   // (1, 2)。元の p は不変
        Console.WriteLine((p1.X, p1.Y)); // (3, 2)。p を Clone した上で X だけ書き換えてる
    }
}

これと同じことを class の手書きでやろうとすると、以下のように、Clone 後の書き換えで immutable であることが破たんします。

using System;
 
class Point
{
    // 本当は set できるとまずいけど、Clone 後の書き換えのために必須になってしまう。
    // これを回避するために init アクセサー(後述)がある。
    public int X { get; set; }
    public int Y { get; set; }
    public Point(int x, int y) => (X, Y) = (x, y);
    public Point Clone() => new Point(X, Y);
}
 
class Program
{
    static void Main()
    {
        var p = new Point(1, 2);
 
        // p を部分書き換え(この場合 X だけ書き換え)
        var p1 = p.Clone();
 
        // Clone 後の書き換えのためにやむを得ず public set。
        // init とか with とか、新構文が必要になる理由。
        p1.X = 3;
 
        Console.WriteLine((p.X, p.Y));   // (1, 2)。元の p は不変
        Console.WriteLine((p1.X, p1.Y)); // (3, 2)。p を Clone した上で X だけ書き換えてる
    }
}

(もっと複雑で、実行時コストも高い方法でよければもうちょっとやり様はあるんですが。後述する init プロパティで一応、実行時コストは掛けずにこの問題を解決できるので、それを採用することになりました。)

ちなみに、原理的には with 式は init プロパティを持つ class や struct に対しても使えるはずなんですが、 C# 9.0 時点では record 専用構文になりそうです。 (スケジュールの問題。あとで class や struct に対する wth 式追加が検討される。)

init アクセサー

プロパティのアクセサーに、set の代わりに init を使うことで、初期化子や with 式でだけ書き換え可能なプロパティができます。

class InitOnly
{
    public int X { get; init; }
}
 
class Program
{
    static void Main()
    {
        var p = new InitOnly
        {
            X = 1, // 初期化子を使える
        };
 
        p.X = 2; // これはコンパイル エラー
 
        // with 式での書き換え(Clone 後の書き換え)もできる
        var p1 = p with { X = 3 };
    }
}

init アクセサーは以下の場所からだけ呼び出せる制限付きの set みたいなものです。

そのクラスのコンストラクター内
オブジェクト初期化子
with 式
他の init アクセサー内

1だけでよければ get-only プロパティでも実現できるんですが、残りの3つのために init アクセサーが新設されました。

ちなみに、set と init を同時に書くことはできません。というか、init アクセサーは内部的には「特殊な属性を付けた set アクセサー」として実現されています。

C# 9.0 in Visual Studio 16.7 preview 3

!is 問題

is not T x

Top-level statements

Function pointer

Records

補足: IsExternalInit 属性

record と class

with 式

init アクセサー

最近の投稿

ref/ref struct 変数を非同期メソッド中で使えるように

Lock クラス

Extensions (拡張型)

C# 13 でのコレクション式 - ディクショナリ式

C# 13 でのコレクション式 - 制限の緩和の話

アーカイブ