Erklärung des Begriffs: File-based App

Zur Stichwortliste unseres Lexikons

Was ist File-based App ?

Seit .NET 10.0 können Entwicklerinnen und Entwickler einzelne C#-Dateien direkt übersetzen und starten – ohne dass es eine Projektdatei geben muss.

Microsoft nennt das Feature File-based Apps. Voraussetzung ist, dass das .NET Software Development Kit (SDK) www.dotnet-lexikon.de/NETSoftware_Development_Kit/lex/285 Version 10.0 oder höher installiert ist. Eine Installation der .NET Runtime www.dotnet-lexikon.de/NETRuntime/lex/444 reicht dafür nicht!
Damit kann C# nun auch als Skriptsprache zum Einsatz kommen, z.B. für Skripte im Rahmen von Entwicklungsprojekten, wo man bisher PowerShell oder bash eingesetzt hat. Es gab dafür aber schon vorher Ansätze außerhalb von Microsoft: C#-Scripting im .NET 10.0 SDK ist möglich mit dem .NET SDK CLI-Befehl dotnet run:
dotnet run .\Dateiname.cs
Alternativ ist die direkte Ausführung einer C#-Datei auch ohne Angabe des Wortes "run" möglich:
dotnet .\Dateiname.cs

Starten einzelner C#-Dateien unter Linux und macOS

Auf Linux und macOS kann man eine einzelne C#-Datei als File-based App direkt starten, auch ohne Voranstellung von "dotnet".
Dazu verwendet man eine sogenannte Hash-Bang-Zeile (oder Shebang-Zeile) am Anfang der C#-Datei:
#!/usr/bin/env dotnet
Dann macht man diese Datei ausführbar mit diesem Kommandozeilenbefehl:
chmod +x Dateiname.cs
Ein Start ist dann ohne Erwähnung von dotnet möglich:
./Dateiname.cs
Es ist nicht einmal notwendig, dass die Datei auf .cs endet (siehe nächste Abbildung).
Ein solch direkter Start einer einzelnen C#-Datei – ohne „dotnet“ davor zu schreiben – ist unter Windows jedoch nicht möglich.

Klasse Program und Main()-Methode in File-based Apps

Eine File-based App kann Top-Level-Statements oder einen klassischen .NET-Einsprungpunkt besitzen.

Eine File-based App kann die in C# 9.0 (im Rahmen von .NET 5.0) eingeführten Top-Level-Statements www.dotnet-lexikon.de/lex/12051 besitzen. Das wird der Regelfall sein, d.h. die Ausführung der Datei beginnt bei der ersten Zeile.

Console.WriteLine(System.Runtime.InteropServices.RuntimeInformation.FrameworkDescription);
Console.WriteLine($"Kompilierungsmodus: {(System.Runtime.CompilerServices.RuntimeFeature.IsDynamicCodeSupported ? "JIT" : "AOT")}");

Neben der Verwendung von Top-Level-Statements ist auch der klassische Stil mit class Program und Main()-Methode in den File-based Apps möglich:
class Program
{
static void Main(string[] args)
{
Console.WriteLine(System.Runtime.InteropServices.RuntimeInformation.FrameworkDescription);
Console.WriteLine($"Kompilierungsmodus: {(System.Runtime.CompilerServices.RuntimeFeature.IsDynamicCodeSupported ? "JIT" : "AOT")}");
}
}

Übergabe von Parametern in File-based Apps

File-based Apps können auch Kommandozeilenparameter empfangen.
Die Verwendung von Parametern ist sowohl in Verbindung mit class Program und Main()-Methode möglich als auch bei der Verwendung von Top-Level-Statements, da auch dort die Variable args durch den Compiler zur Verfügung gestellt wird.

Listing: Erweitertes Hello-World-Beispiel mit Parametern
using System; // nicht notwendig, Standardnamensräume sind immer dabei, da <ImplicitUsings>enable</ImplicitUsings> gesetzt ist

var conf = args.FirstOrDefault() ?? "diesem Vortrag";
Console.WriteLine(System.Runtime.InteropServices.RuntimeInformation.FrameworkDescription);
Console.WriteLine($"Hallo liebe Teilnehmerinnen und Teilnehmer bei \e[4;33;5m{conf}\e[0m!");
Console.WriteLine($"Kompilierungsmodus: {(System.Runtime.CompilerServices.RuntimeFeature.IsDynamicCodeSupported ? "JIT" : "AOT")}");

NuGet-Pakete und Einstellungen für File-based Apps

Informationen, die bei normalen .NET-Projekten in der Projektdatei (.csproj) liegen, setzt man in File-based Apps mit einer Präprozessor-Direktive.
Für Informationen, die üblicherweise in der .csproj-Projektdatei liegen, hat Microsoft für File-based Apps eine eigene Syntax beginnend mit der Raute # (Präprozessor-Direktiven) gefolgt von einem Doppelpunkt (dies ist aus der Sicht des C#-Compilers eine zu ignorierende Direktive) eingeführt:
 Festlegung des SDKs: #:sdk Microsoft.NET.Sdk.Web. Bei der Angabe des SDKs kann man ab Preview 6 auch die Versionsnummer nach @ angeben, z.B. #:sdk Aspire.AppHost.Sdk@9.3.1
  • Referenz auf ein NuGet-Paket: #:package Spectre.Console@0.48.*
  • Referenz auf Projekte: #:project ./ClassLib/ClassLib.csproj
  • Build-Eigenschaften, z.B. Versionsnummer: #:property Version=1.1.2 (vor Preview 6 noch ohne Gleichheitszeichen, sondern mit Leerzeichen als Trennung)
  • File-based Apps verwenden im Standard den NativeAOT-Compiler. Dies kann man mit #:property PublishAot=false ausschalten. Dann wird der Just-in-Time-Compiler verwendet.

Weitere Features von Files-based Apps

  • Man kann unter Dateiname.settings.json im gleichen Ordner eine Settings-Datei für die File-based App anlegen.
  • Man kann unter Dateiname.run.json im gleichen Ordner ein Launch-Profile für die File-based App anlegen.
  • Man kann dotnet build Dateiname.cs oder dotnet restore Dateiname.cs ausführen.
  • Man kann solche File-based Apps mit dotnet publish Dateiname.cs zu einer ausführbaren Datei (.EXE) übersetzen
  • Innerhalb einer File-based App können Entwicklerinnen und Entwickler seit Preview 6 den Standort der Datei mit AppContext.GetData("EntryPointFileDirectoryPath") und den ganzen Pfad zur ausgeführten C#-Datei mit AppContext.GetData("EntryPointFilePath") bestimmen. Das funktioniert allerdings nur mit File-based Apps, nicht in normalen, projektbasierten C#-Anwendungen.
  • Es gibt aber in .NET 10.0 noch keine Möglichkeit, in einer File-based App eine andere .cs-Datei direkt einzubinden. Das ist geplant für .NET 11.0.

Beispiel einer File-based App

Das Listing zeigt ein Beispiel einer File-based App mit zwei referenzierten NuGet-Paketen.

#!/usr/bin/env dotnet
#region Einstellungen für File-based App
// www.nuget.org/packages/humanizer/
#:package Humanizer@2.14.1
// www.nuget.org/packages/Spectre.Console/
#:package Spectre.Console@0.*
#:property LangVersion=preview
#:property Version=1.2.0
#:project ./ClassLibrary/ClassLibrary.csproj
#endregion
using Spectre.Console;
using Humanizer;

var title = "C# Script v" + System.Reflection.Assembly.GetExecutingAssembly().GetName().Version +
" mit " + System.Runtime.InteropServices.RuntimeInformation.FrameworkDescription + "\n" +
AppContext.GetData("EntryPointFilePath");

// Header
AnsiConsole.Write(
new Panel(title)
.Header("[yellow]File-based App[/]", Justify.Center)
.Border(BoxBorder.Rounded)
.BorderStyle(new Style(foreground: Color.Green))
.Padding(1, 1, 1, 1)
);

// Parameter auflisten
foreach (var arg in args)
{
Console.WriteLine($"Argument: {arg}");
}

Console.WriteLine();

// Daten
(Data net80, Data net90, Data net10) = GetData();

// Textausgabe in Wochen
var dotNet8Released = DateTimeOffset.Parse(net80.Release);
TimeSpan dotNet8Since = DateTimeOffset.Now - dotNet8Released;
Console.WriteLine($"It has been {dotNet8Since.Humanize()} since .NET {net80.Version} was released.");

var dotNet9Released = DateTimeOffset.Parse(net90.Release);
TimeSpan dotNet9Since = DateTimeOffset.Now - dotNet9Released;
Console.WriteLine($"It has been {dotNet9Since.Humanize()} since .NET {net90.Version} was released.");

var dotNet10Released = DateTimeOffset.Parse(net10.Release);
TimeSpan dotNet10Since = DateTimeOffset.Now - dotNet10Released;
Console.WriteLine($"{dotNet10Since.Humanize()} since .NET {net10.Version} release.");

Console.WriteLine();

// Zeichne Balken für die Anzahl der Tage seit der Veröffentlichung
var bar = new BarChart()
.Width(100)
.AddItem("Days since .NET 8.0 release", dotNet8Since.TotalDays, Color.Red)
.AddItem("Days since .NET 9.0 release", dotNet9Since.TotalDays, Color.Blue)
.AddItem("Days since .NET 10.0 release", dotNet10Since.TotalDays, Color.Purple);
AnsiConsole.Write(bar);

Console.WriteLine();

// Lokale Funktion
static (Data, Data, Data) GetData()
{
var net80 = new Data
{
Version = "8.0",
Release = "2023-11-14"
};
var net90 = new Data
{
Version = "9.0",
Release = "2024-11-12"
};
var net10 = new Data
{
Version = "10.0",
Release = "2025-11-11"
};
return (net80, net90, net10);
}

// Datenklasse
class Data
{
public required string Version { get; set; }
public string Release { get; set; }
}

Beratung & Support

Schulungen

Anfrage für eine individuelle Schulung zum Thema FILE-BASED APP Gesamter Schulungsthemenkatalog

Fachbücher

Alle unsere aktuellen Fachbücher E-Book-Abo für ab 99 Euro im Jahr