1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

.NET 11のFile-based Apps:C#をスクリプトのように直接実行できるように

1
Posted at

C#でプログラムを開発する場合、簡単なツールを作るだけでも、通常はまずプロジェクトを作成し、.csprojファイルを用意してから、dotnet runで実行する必要があります。正式なソフトウェアシステムであれば、この手順に問題はありません。しかし、数十行のコードでJSONファイルを処理したり、APIを一度呼び出したり、一時的なデータ変換ツールを作ったりするだけなら、プロジェクト一式を用意するのは少し面倒です。

.NET 10で導入された**File-based Apps(ファイルベースのアプリ)**は、この問題を解決するための仕組みです。.NET 11では機能がさらに強化され、C#のソースファイル1つだけで、Pythonのように直接実行できるだけでなく、NuGetパッケージの利用、ほかのコードファイルの参照、さらにはWeb APIの構築まで可能になりました。基本的な考え方はシンプルです。開発者はC#コードに集中し、プロジェクト設定とビルド処理は.NET SDKに任せます。

プロジェクトを作成せず、C#ファイル1つで実行できる

簡単なコマンドラインツールを書くとします。hello.csファイルを作成し、次のコードを記述するだけです。

var name = args.Length > 0 ? args[0] : "World";
Console.WriteLine($"Hello, {name}!");

.NET 10以降のSDKをインストールしていれば、ターミナルからそのままdotnet hello.csを実行できます。引数を渡す場合は、dotnet run --file hello.cs -- ZhangSanのようにします。--以降の内容は.NET CLIではなく、C#プログラムに渡されます。

さらに、C#コードは標準入力から実行することもできます。たとえばPowerShellで'Console.WriteLine("Hello");' | dotnet run -を実行すれば、コードをファイルに保存せず、その場で実行できます。この方法は、自動化スクリプトの作成、APIのテスト、ビジネスロジックのすばやい検証、開発支援ツールの作成などに適しています。

誤解しやすい点があります。File-based Appsは別のC#スクリプト言語ではなく、従来の.csxの仕組みでもありません。**実行されるのはあくまで標準のC#コードであり、内部では通常の.NETコンパイラーが使われます。**ただし、SDKがソースファイルを基に一時的な仮想プロジェクトを自動生成するため、開発者が.csprojを手動で管理する必要はありません。そのため、一般的な型定義や非同期プログラミング、LINQ、.NETクラスライブラリを通常どおり利用できます。また、Visual Studio CodeとC# Dev Kitを組み合わせれば、インテリセンスやコード検査などの開発支援機能も利用できます。

C#を直接実行しても、なぜ遅くならないのか?

C#はコンパイル型言語です。.csファイルを実行するたびにMSBuildによる完全なビルド処理を最初から実行するのであれば、スクリプトツールに求められる手軽さは失われてしまいます。この問題を解決するため、File-based Appsにはビルドキャッシュの仕組みが導入されています。

SDKは、ソースコード、ビルド指示、SDKのバージョンなどの情報を基に、どの処理を再実行する必要があるかを判断します。初回実行時には必要なコンパイルが行われます。通常のC#コードだけを変更した場合は、不要なプロジェクト設定やビルド処理を省略し、再コンパイルだけで済むのが一般的です。コードにも依存関係の設定にも変更がなければ、SDKは前回生成したアセンブリを再利用できるため、再コンパイルを避けられます。プロジェクト構造に影響する設定が変更された場合に限り、より完全なビルド処理が必要になります。

全体の流れは、次の図のように捉えることができます。

処理のフロー図

この仕組みにより、C#プログラムを実行するたびに完全なビルドを行う必要がなくなります。簡単なプログラムのテストでは、キャッシュがヒットすれば、起動時間を数百ミリ秒程度に抑えられます。ただし、実際の速度はマシンの性能、プログラムの内容、キャッシュの状態によって異なります。

注意点として、#:includeでワイルドカードを使って複数のファイルを一括で読み込むと、現時点では該当するビルドキャッシュの最適化が無効になります。そのため、頻繁に実行する小さなツールでは、依存ファイルを明示的に指定するほうが適しています。

.NET 11で、単一ファイルのアプリが本格的なプロジェクト機能を備える

File-based Appsの大きな価値は、.csprojファイルを省けることだけではありません。よく使うプロジェクト設定をC#ファイル内に直接記述できる点にもあります。

たとえば、#:packageでNuGet依存関係を宣言し、#:sdkで使用する.NET SDKを選択できます。#:propertyではMSBuildプロパティを設定し、#:projectでは従来のC#プロジェクトを参照できます。さらに、#:includeを使うと、ほかのC#ファイルを取り込めます。取り込んだファイルから、さらに別のファイルを参照することもできます。

こうして、最初は数十行のコードだけだった小さなツールも、複数のモジュールに発展した段階ですぐに従来のプロジェクトへ移行する必要はありません。

たとえば、C#ファイル1つでWeb APIを作成する場合は、web.csを作成して次のように記述します。

#:sdk Microsoft.NET.Sdk.Web

var app = WebApplication.Create(args);

app.MapGet("/", () => new
{
    Message = "Hello from .NET!"
});

app.Run();

dotnet run --file web.csを実行すると、本格的なASP.NET Core Webアプリケーションが起動します。ここでの#:sdk Microsoft.NET.Sdk.Webは、このファイルをWebプロジェクトとしてビルドするようSDKに指示しています。

ビジネスロジックが複雑になってきた場合は、#:includeを使ってデータモデルやヘルパークラスを別のファイルに分けたり、#:projectで既存のクラスライブラリを参照したり、#:packageでサードパーティーのコンポーネントを追加したりできます。開発者は引き続きASP.NET Coreのルーティング、依存性注入、構成の仕組みを利用できますが、完全なプロジェクトの作成から始める必要はありません。

コードファイルから、実際に配布できるアプリケーションへ

実行方法が簡単になっただけでなく、.NET 11ではFile-based Appsと.NET CLIの統合もさらに改善されました。dotnet buildでソースファイルをコンパイルし、dotnet formatでコードを整形できます。また、NuGetパッケージのバージョンやセキュリティ上の問題を確認したり、dotnet publishでデプロイ可能なプログラムを生成したりすることもできます。

File-based Appsは、既定でNative AOTによる発行に対応しています。そのため、アプリケーションを事前にネイティブ実行可能ファイルへコンパイルできます。従来のプロジェクト構造が必要になった場合は、dotnet project convertで変換できるため、コードを一から整理し直す必要はありません。

LinuxやmacOSの環境では、Shebang(たとえば#!/usr/bin/env -S dotnet --)と実行権限を設定することで、.csファイルをコマンドラインスクリプトのように直接実行することもできます。

もちろん、File-based Appsは従来の.csprojプロジェクトに取って代わるものではありません。大規模なエンタープライズアプリケーション、複数プロジェクトで構成されるソリューション、複雑なビルド設定が必要なシステムでは、従来のプロジェクトのほうが適しています。File-based Appsが大きく変えるのは、C#を使い始めるハードルです。これまではプロジェクトを作成してからコードを書き始めるのが一般的でしたが、これからはファイル1つから始め、機能が複雑になってきた段階で、完全なプロジェクト構成が必要かどうかを判断できます。

.NET 10から.NET 11にかけて、File-based AppsによってC#は、スクリプト言語の手軽さとコンパイル型言語としての開発能力を兼ね備えるようになりました。自動化スクリプトの作成、社内ツールの開発、技術案の検証、APIの迅速な構築を頻繁に行う開発者にとって、これは準備作業を減らし、すぐに問題解決に取りかかれることを意味します。

(Translated by GPT)

元のリンク:https://mp.weixin.qq.com/s/3N4t12BoF26LHgfPdT-8ew?wt.mc_id=MVP_325642

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?