Module guide
Fast.NET consists of 17 independently published NuGet packages. The primary modules target .NET 8, .NET 9, and .NET 10; Fast.IaaS targets .NET Standard 2.1.
Choose a module below for package-specific installation, contracts and consumer examples. Source declarations are documented in the Chinese member references; their full semantic translation remains pending.
| Package | Purpose | Main entry point | Default configuration / external dependency |
|---|---|---|---|
Fast.Runtime | Shared ASP.NET Core context, configuration, and MVC extensions | AddConfigurableOptions<T>(), AddMvcFilter() | Usually referenced transitively |
Fast.IaaS | Encoding, validation, masking, retry, tree, and general utilities | MaskingUtil, RetryUtil, and related APIs | No web host dependency |
Fast.NET.Core | Application initialization, configuration scanning, CORS, compression, and buffering | builder.Initialize(), AddCorsAccessor(), AddGzipCompression() | CorsAccessorSettings |
Fast.Cache | CSRedisCore cache wrapper | services.AddCache() | RedisSettings; requires Redis |
Fast.Consul | Service registration, health checks, and KV | services.AddFastConsul() | ConsulSettings; requires Consul |
Fast.DependencyInjection | Marker-based convention registration | services.AddDependencyInjection() | ITransientDependency, IScopedDependency, ISingletonDependency |
Fast.DynamicApplication | Dynamic API discovery for application services | services.AddDynamicApplication() | Call AddControllers() first |
Fast.EventBus | Bounded in-process channel, publishing, subscription, and background handling | services.AddEventBus() | Default capacity 3000; not distributed or durable |
Fast.JwtBearer | JWT Bearer authentication, authorization, and token helpers | services.AddJwtBearer() | JWTSettings |
Fast.Logging | Console and file logging extensions | services.AddLoggingService() | Logging:Fast; file path must be writable |
Fast.Mapster | Mapster registration and mapping | services.AddMapster() | Mapster 10 |
Fast.OpenApi | OpenAPI DTO and JavaScript/TypeScript client generation | services.AddOpenApi() | OpenApiSettings |
Fast.Serialization.System.Text.Json | Shared System.Text.Json options, converters, and masking | services.AddSerialization() | Usually choose one serialization module |
Fast.Serialization.Newtonsoft.Json | Shared Newtonsoft.Json options, converters, and masking | services.AddSerialization() and MVC extension | Usually choose one serialization module |
Fast.SqlSugar | SqlSugar integration, multi-database settings, repositories, and paging | services.AddSqlSugar(), AddSnowflake() | ConnectionSettings, SnowflakeSettings; requires a database |
Fast.Swagger | Swagger documents, grouping, security definitions, and UI | AddSwaggerDocuments(), UseSwaggerDocuments() | SwaggerSettings |
Fast.UnifyResult | Unified responses, model validation, and friendly exceptions | services.AddUnifyResult() | Designed for MVC/controller applications |
Fast.OpenApi generates TypeScript clients with separate import type declarations and explicit Promise<T> return types. Actions returning non-generic Task or ValueTask use Promise<void>. Download and Export actions retain their response: Web clients use AxiosResponse<Blob>, while mobile clients allow AxiosResponse<Blob | ArrayBuffer | string> for browser blobs, binary buffers, or native temporary file paths. Their autoDownloadFile parameter defaults to true; set it to false to receive the file response without requesting automatic saving. Other values without a concrete schema remain unknown. The output is compatible with verbatimModuleSyntax and the current Fast ESLint Config rules. Generated Web and mobile multipart upload methods also expose an optional Axios onUploadProgress callback.
Fast.IaaS 3.5.27 formats exact TimeSpan boundaries correctly through ToDescription(): one minute is 01分00秒, one hour is 01时00分00秒, and one day is 01天00时00分00秒.
Fast.Runtime 3.5.30 safely handles an unavailable HttpContext outside the request lifecycle. LocalIpv4() and LocalIpv6() return the server endpoint, while RemoteIpv4() and RemoteIpv6() return Connection.RemoteIpAddress after trusted UseForwardedHeaders processing. The misleading LanIpv4() and LanIpv6() methods have been removed. Fast.NET.Core 3.5.38 returns HttpRequestMethodEnum.Unknown when no request context exists, and Fast.SqlSugar 3.5.65 leaves unavailable request audit fields empty.
Recommended registration order
builder.Initialize();
builder.Services.AddSerialization();
builder.Services.AddControllers();
builder.Services.AddDependencyInjection();
builder.Services.AddEventBus();
builder.Services.AddUnifyResult();
builder.Services.AddDynamicApplication();
builder.Services.AddSwaggerDocuments(builder.Configuration);Order matters only where modules have an actual dependency. The explicit requirement is that AddDynamicApplication() runs after MVC controller registration.
Console output
Starting with Fast.Runtime 3.5.29, use MAppContext.ConsoleWrite to write text with colors applied to individual segments:
MAppContext.ConsoleWrite(e =>
{
e.ForegroundColor = ConsoleColor.Blue;
e.WriteLine();
e.WriteLine("Fast.NET");
});The callback receives a Fast.Runtime.ConsoleWriter with ForegroundColor, BackgroundColor, Write, WriteLine, and ResetColor(). The writer captures both colors on entry and restores them in finally; ResetColor() restores the same colors within the callback. Callbacks sharing an output stream execute serially and support nesting. Callbacks must complete synchronously, and callback or write exceptions propagate to the caller. When Console.IsOutputRedirected is true, color assignments are ignored and only text is written, without generated ANSI color codes.
Startup banners in Fast.NET.Core and direct diagnostics in Runtime, OpenApi, and SqlSugar use this entry point for Windows CMD, PowerShell, Windows Terminal, and Linux terminals. Fast.IaaS 3.5.27 remains a standalone netstandard2.1 package and uses its internal writer in src/IaaS/Internals/ConsoleWriter.cs without a Runtime dependency.
In the current Fast.NET.Core 3.5.38 source, builder.Initialize() prints application and host information before the ASCII logo. Application names and assembly versions come from the entry assembly; framework assembly versions come from the Core assembly. The implementation does not also print informational versions; unavailable names or versions use Unknown. The environment name comes from builder.Environment, and the startup timestamp is the local time when the banner is written (yyyy-MM-dd HH:mm:ss).
| Output | Color |
|---|---|
| Information labels | DarkGray |
| Application name, host name, operating system, OS platform/architecture, process architecture | Gray |
| .NET runtime description and Fast.NET framework versions | Cyan |
| Application versions | Cyan |
| ASCII logo | Green |
| Environment name | Green for Production, Yellow for Development, Magenta otherwise |
| Startup time | White |
| Gitee address | Red |
| Usage reminder | Yellow |
| Learning messages | Cyan |
| Framework description and PR invitation | Magenta |
The banner also updates indentation and spacing and adds a lawful-use reminder and learning messages. Redirected output contains the same text without generated color codes; the writer restores the original colors after output.
Fast.Logging continues to write through the TextWriter supplied to its ConsoleFormatter. ConsoleLoggerProvider handles terminal adaptation, ANSI parsing where needed, and queued console writes. The formatter does not change Console.ForegroundColor; LoggerColorBehavior.Default suppresses generated colors for redirected output, while ANSI support is handled by the provider rather than inferred solely from redirection.
Dependency injection conventions
AddDependencyInjection() scans non-abstract classes that implement ITransientDependency, IScopedDependency, or ISingletonDependency. Services that expose business interfaces are registered against those interfaces; services that only implement a lifetime marker are registered by their concrete type and can be injected directly.
Infrastructure notes
Fast.Cache,Fast.Consul, andFast.SqlSugarrequire real external services. Use an isolated environment for validation and never point repository checks at production data.Fast.EventBusis in-process. Pending events are not recovered after application restart. Use a dedicated message broker when you need cross-process, durable, or at-least-once delivery.- Both serialization packages use the
Fast.Serializationnamespace and similar extension names. Select and configure one deliberately. - File logging requires a writable directory. In containers, map it to a writable volume or prefer standard output.
Configuration source of truth
Option types participate in the repository post-configuration convention. The corresponding *SettingsOptions type and XML API documentation are authoritative for supported fields. Never include real tokens, connection strings, or passwords in documentation, samples, or issues.