mirror of https://github.com/abpframework/abp.git
maliming
2 years ago
455 changed files with 6489 additions and 2349 deletions
|
Before Width: | Height: | Size: 280 KiB After Width: | Height: | Size: 212 KiB |
|
Before Width: | Height: | Size: 72 KiB After Width: | Height: | Size: 54 KiB |
|
After Width: | Height: | Size: 189 KiB |
|
After Width: | Height: | Size: 525 KiB |
@ -0,0 +1,93 @@ |
|||
# ABP.IO Platform 9.0 Has Been Released Based on .NET 9.0 |
|||
|
|||
 |
|||
|
|||
Today, [ABP](https://abp.io/) 9.0 stable version has been released based on [.NET 9.0](https://dotnet.microsoft.com/en-us/download/dotnet/9.0). You can create solutions with ABP 9.0 starting from ABP Studio v0.9.11 or by using the ABP CLI as explained in the following sections. |
|||
|
|||
## What's New With Version 9.0? |
|||
|
|||
All the new features were explained in detail in the [9.0 RC Announcement Post](https://abp.io/blog/announcing-abp-9-0-release-candidate), so there is no need to review them again. You can check it out for more details. |
|||
|
|||
## Getting Started with 9.0 |
|||
|
|||
### Creating New Solutions |
|||
|
|||
You can check the [Get Started page](https://abp.io/get-started) to see how to get started with ABP. You can either download [ABP Studio](https://abp.io/get-started#abp-studio-tab) (**recommended**, if you prefer a user-friendly GUI application - desktop application) or use the [ABP CLI](https://abp.io/docs/latest/cli) to create new solutions. |
|||
|
|||
By default, ABP Studio uses stable versions to create solutions. Therefore, it will be creating the solution with the latest stable version, which is v9.0 for now, so you don't need to specify the version. **You can create solutions with ABP 9.0 starting from v0.9.11.** |
|||
|
|||
### How to Upgrade an Existing Solution |
|||
|
|||
You can upgrade your existing solutions with either ABP Studio or ABP CLI. In the following sections, both approaches are explained: |
|||
|
|||
### Upgrading via ABP Studio |
|||
|
|||
If you are already using the ABP Studio, you can upgrade it to the latest version to align it with ABP v9.0. ABP Studio periodically checks for updates in the background, and when a new version of ABP Studio is available, you will be notified through a modal. Then, you can update it by confirming the opened modal. See [the documentation](https://abp.io/docs/latest/studio/installation#upgrading) for more info. |
|||
|
|||
After upgrading the ABP Studio, then you can open your solution in the application, and simply click the **Switch to stable** action button to instantly upgrade your solution: |
|||
|
|||
 |
|||
|
|||
> Please note that ABP CLI & ABP Studio only upgrade the related ABP packages, so you need to upgrade the other packages for .NET 9.0 manually. |
|||
|
|||
### Upgrading via ABP CLI |
|||
|
|||
Alternatively, you can upgrade your existing solution via ABP CLI. First, you need to install the ABP CLI or upgrade it to the latest version. |
|||
|
|||
If you haven't installed it yet, you can run the following command: |
|||
|
|||
```bash |
|||
dotnet tool install -g Volo.Abp.Studio.Cli |
|||
``` |
|||
|
|||
Or to update the existing CLI, you can run the following command: |
|||
|
|||
```bash |
|||
dotnet tool update -g Volo.Abp.Studio.Cli |
|||
``` |
|||
|
|||
After installing/updating the ABP CLI, you can use the [`update` command](https://abp.io/docs/latest/CLI#update) to update all the ABP related NuGet and NPM packages in your solution as follows: |
|||
|
|||
```bash |
|||
abp update |
|||
``` |
|||
|
|||
You can run this command in the root folder of your solution to update all ABP related packages. |
|||
|
|||
> Please note that ABP CLI & ABP Studio only upgrade the related ABP packages, so you need to upgrade the other packages for .NET 9.0 manually. |
|||
|
|||
## Migration Guides |
|||
|
|||
There are a few breaking changes in this version that may affect your application. Please read the migration guide carefully, if you are upgrading from v8.x: [ABP Version 9.0 Migration Guide](https://abp.io/docs/9.0/release-info/migration-guides/abp-9-0) |
|||
|
|||
## Community News |
|||
|
|||
### Highlights from .NET 9.0 |
|||
|
|||
Our team has closely followed the ASP.NET Core and Entity Framework Core 9.0 releases, read Microsoft's guides and documentation, and adapted the changes to our ABP.IO Platform. We are proud to say that we've shipped the ABP 9.0 based on .NET 9.0 just after Microsoft's .NET 9.0 release. |
|||
|
|||
In addition to the ABP's .NET 9.0 upgrade, our team has created many great articles to highlight the important features coming with ASP.NET Core 9.0 and Entity Framework Core 9.0. |
|||
|
|||
> You can read [this post](https://volosoft.com/blog/Highlights-for-ASP-NET-Entity-Framework-Core-NET-9-0) to see the list of all articles. |
|||
|
|||
### New ABP Community Articles |
|||
|
|||
In addition to [the articles to highlight .NET 9.0 features written by our team](https://volosoft.com/blog/Highlights-for-ASP-NET-Entity-Framework-Core-NET-9-0), here are some of the recent posts added to the [ABP Community](https://abp.io/community): |
|||
|
|||
* [Video: Building Modular Monolith Applications with ASP.NET Core & ABP Studio](https://abp.io/community/videos/building-modular-monolith-applications-with-asp.net-core-abp-studio-66znukvf) by [Halil İbrahim Kalkan](https://x.com/hibrahimkalkan) |
|||
* [How to create your Own AI Bot on WhatsApp Using an ABP.io Template](https://abp.io/community/articles/how-to-create-your-own-ai-bot-on-whatsapp-using-the-abp-framework-c6jgvt9c) by [Michael Kokula](https://abp.io/community/members/Michal_Kokula) |
|||
* [ABP Now Supports .NET 9](https://abp.io/community/articles/abp-now-supports-.net-9-zpkznc4f) by [Alper Ebiçoğlu](https://x.com/alperebicoglu) |
|||
|
|||
Thanks to the ABP Community for all the content they have published. You can also [post your ABP related (text or video) content](https://abp.io/community/posts/submit) to the ABP Community. |
|||
|
|||
### ABP Community Talks 2024.7: What’s New with .NET 9 & ABP 9? |
|||
|
|||
 |
|||
|
|||
In this episode of ABP Community Talks, 2024.7; we will dive into the features that came with .NET 9.0 with [Alper Ebicoglu](https://github.com/ebicoglu), [Engincan Veske](https://github.com/EngincanV), [Berkan Sasmaz](https://github.com/berkansasmaz) and [Ahmet Faruk Ulu](https://github.com/ahmetfarukulu). |
|||
|
|||
## Conclusion |
|||
|
|||
This version comes with some new features and a lot of enhancements to the existing features. You can see the [Road Map](https://docs.abp.io/en/abp/9.0/Road-Map) documentation to learn about the release schedule and planned features for the next releases. Please try ABP v9.0 and provide feedback to help us release more stable versions. |
|||
|
|||
Thanks for being a part of this community! |
|||
|
After Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 541 KiB After Width: | Height: | Size: 524 KiB |
|
Before Width: | Height: | Size: 110 KiB After Width: | Height: | Size: 106 KiB |
|
Before Width: | Height: | Size: 441 KiB After Width: | Height: | Size: 432 KiB |
|
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 23 KiB |
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 155 KiB After Width: | Height: | Size: 108 KiB |
|
Before Width: | Height: | Size: 121 KiB After Width: | Height: | Size: 71 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 840 KiB After Width: | Height: | Size: 93 KiB |
|
Before Width: | Height: | Size: 528 KiB After Width: | Height: | Size: 46 KiB |
@ -0,0 +1,125 @@ |
|||
# Hybrid Cache in .NET 9 |
|||
|
|||
.NET 9 introduces an exciting feature: **HybridCache**, an advanced caching mechanism that seamlessly combines multiple caching strategies to maximize performance and scalability. |
|||
|
|||
It offers a flexible caching solution that combines the best aspects of local and distributed caching. **HybridCache** is particularly useful in scenarios where quick, in-memory access is desirable but data consistency across multiple application instances is also a requirement. |
|||
|
|||
In this article, we’ll explore **HybridCache** in .NET 9 and how it integrates with ABP Framework using `AbpHybridCache`. This new feature offers a robust solution for applications that need to scale while maintaining efficient caching strategies. |
|||
|
|||
## What is HybridCache? |
|||
|
|||
**HybridCache** is designed to merge different caching layers, commonly including an in-memory cache (for high-speed access) and a distributed cache (for scalability across multiple instances). This hybrid approach allows for: |
|||
|
|||
* **Improved Performance**: Frequently accessed data is stored in-memory, reducing latency. |
|||
* **Increased Scalability**: Cached data can still be shared across distributed environments, essential for load-balanced applications. |
|||
* **Automatic Synchronization**: Changes in distributed cache automatically update the in-memory cache, ensuring data consistency. |
|||
|
|||
## Using HybridCache with ABP |
|||
|
|||
> For more information about the implementation in the ABP side, you can refer to the pull request [here](https://github.com/abpframework/abp/pull/20859). |
|||
|
|||
ABP's support for **HybridCache** is available starting from version 9.0 through the [`AbpHybridCache`](https://github.com/abpframework/abp/blob/dev/framework/src/Volo.Abp.Caching/Volo/Abp/Caching/Hybrid/AbpHybridCache.cs) implementation. By leveraging this feature, developers using ABP can implement hybrid caching in a way that aligns with ABP’s modular and extensible architecture. |
|||
|
|||
To demonstrate how to use **HybridCache** in ABP, let's start with a simple example. |
|||
|
|||
> You can create an ABP-based application with v9.0+, and then follow the next steps for using hybrid caching in your application. |
|||
|
|||
### Configuring the `AbpHybridCacheOptions` (Optional) |
|||
|
|||
First, you can configure the hybrid cache options in your module class as below (it's optional): |
|||
|
|||
```csharp |
|||
using Microsoft.Extensions.Caching.Hybrid; |
|||
using Volo.Abp.Caching.Hybrid; |
|||
|
|||
public class YourModule : AbpModule |
|||
{ |
|||
public override void ConfigureServices(ServiceConfigurationContext context) |
|||
{ |
|||
//... |
|||
|
|||
Configure<AbpHybridCacheOptions>(options => |
|||
{ |
|||
//configuring the global hybrid cache options |
|||
options.GlobalHybridCacheEntryOptions = new HybridCacheEntryOptions() |
|||
{ |
|||
Expiration = TimeSpan.FromMinutes(20), |
|||
LocalCacheExpiration = TimeSpan.FromMinutes(10) |
|||
}; |
|||
}); |
|||
} |
|||
} |
|||
``` |
|||
|
|||
* You can configure the `AbpHybridCacheOptions` to set *keyPrefix* for your cache keys, throw or hide exceptions for the distributed cache (by default *it hides errors*), or configure cache for specific cache item keys and more... |
|||
* By setting the `GlobalHybridCacheEntryOptions`, you specify the caching options globally in your application. Thanks to that, you don't need to manually pass the related options whenever you use the `IHybridCache` service. |
|||
|
|||
### Using the `IHybridCache` Service |
|||
|
|||
After the configuration, now you can inject the `IHybridCache` and use it to set and retrieve cache values: |
|||
|
|||
```csharp |
|||
using Volo.Abp.Caching.Hybrid; |
|||
|
|||
public class BookAppService : ApplicationService, IBookAppService |
|||
{ |
|||
private readonly IHybridCache<BookCacheItem> _hybridCache; |
|||
|
|||
public BookAppService(IHybridCache<BookCacheItem> hybridCache) |
|||
{ |
|||
_hybridCache = hybridCache; |
|||
} |
|||
|
|||
public async Task<BookCacheItem> GetBookWithPageCountAsync(string name) |
|||
{ |
|||
var cacheKey = "cacheKey:book-" + name; |
|||
|
|||
// Retrieve data from hybrid cache |
|||
return await _hybridCache.GetOrCreateAsync(cacheKey, async () => |
|||
{ |
|||
// Simulating getting and returning the data if not exist in the cache |
|||
return new BookCacheItem |
|||
{ |
|||
Name = name, |
|||
PageCount = 100 |
|||
}; |
|||
}); |
|||
} |
|||
} |
|||
|
|||
public class BookCacheItem |
|||
{ |
|||
public string Name { get; set; } |
|||
|
|||
public int PageCount { get; set; } |
|||
} |
|||
``` |
|||
|
|||
* You can use the `IHybridCache<TCacheItem>` or `IHybridCache<TCacheItem, TCacheKey>` service to leverage the hybrid caching. If you use `IHybridCache<TCacheItem>`as the service, then you should pass the cache key as *string* like in the example above. |
|||
* In this example, you used the `GetOrCreateAsync` method, which first tries to get the cache item with the provided cache key, if there is no cache with the specified key, then it runs the factory method and add the returned data to the cache. |
|||
* Alternatively, you can use the `SetAsync` method to set the cache item. |
|||
|
|||
### Debugging the `IHybridCache` Service (deep-dive) |
|||
|
|||
When you debug the `IHybridCache` service, you'll notice the L1 and L2 cache stores. (L1 is in-memory cache store and L2 is the distributed cache store): |
|||
|
|||
 |
|||
|
|||
As you can see from the figure, it only set the cache item to the **LocalCache** (`MemoryCache`) and did not set the **BackendCache** (`DistributedCache`) because I did not configure the distributed cache and not running my application in multiple instances. But as you can notice, even without an `IDistributedCache` configuration, the `HybridCache` service will still provide in-process caching. |
|||
|
|||
**Note:** If you configure distributed caching options, `HybridCache` service uses the distributed cache and sets the **BackendCache**. |
|||
|
|||
## Conclusion |
|||
|
|||
The **HybridCache** library in .NET 9 provides a powerful tool for applications needing both high-speed caching and consistency in distributed environments. |
|||
|
|||
With ABP Framework’s `AbpHybridCache` support, integrating this feature into an ABP-based application becomes straightforward. This setup helps ensure that cached data remains synchronized across instances, bringing a new level of flexibility to caching in .NET 9 applications. |
|||
|
|||
> For more information, you can refer to the [Microsoft's official document](https://learn.microsoft.com/en-us/aspnet/core/release-notes/aspnetcore-9.0?view=aspnetcore-9.0#new-hybridcache-library). |
|||
|
|||
## References |
|||
|
|||
- https://learn.microsoft.com/en-us/aspnet/core/release-notes/aspnetcore-9.0?view=aspnetcore-9.0#new-hybridcache-library |
|||
- https://www.youtube.com/watch?v=TDyZc11cJfA |
|||
- https://github.com/abpframework/abp/pull/20803 |
|||
- https://github.com/abpframework/abp/pull/20859 |
|||
|
After Width: | Height: | Size: 483 KiB |
|
After Width: | Height: | Size: 144 KiB |
@ -0,0 +1,86 @@ |
|||
# EF Core 9 Read-only Primitive Collections |
|||
|
|||
In this article, we will explore the new features introduced in EF Core 9, specifically focusing on Read-only Primitive Collections. EF Core 8 introduced support for mapping arrays and mutable lists of primitive types, and you can read more about it [here](https://abp.io/community/articles/ef-core-8-primitive-collections-ttn5b6xp). This has been expanded in EF Core 9 to include read-only collections/lists. Specifically, EF Core 9 supports collections typed as `IReadOnlyList`, `IReadOnlyCollection`, or `ReadOnlyCollection`. |
|||
|
|||
## Introduction to EF Core 9 Read-only Primitive Collections |
|||
|
|||
Entity Framework Core 9 introduces several enhancements, one of which is the support for Read-only Primitive Collections. This feature aims to provide better support for scenarios where collections of primitive types, such as `int`, `string`, or `bool`, need to be used in a read-only manner in your entity classes. Previously, developers had to use complex workarounds to ensure collections couldn't be modified, but EF Core 9 now provides a simpler, built-in solution to handle this more effectively. |
|||
|
|||
### Why Read-only Primitive Collections Matter |
|||
|
|||
Read-only Primitive Collections are particularly useful when you need to guarantee the integrity of certain data within your entities. For example, imagine you have a `Car` entity that has a collection of `Colors`, represented as a set of enums. You might not want these colors to be modified after they're initially set, ensuring that any business logic reliant on these values remains consistent. |
|||
|
|||
EF Core 9 introduces a convenient way to define these collections as read-only, helping developers maintain stricter control over their data. |
|||
|
|||
### How It Works |
|||
|
|||
Defining a read-only primitive collection is quite straightforward in EF Core 9. You can use the `IReadOnlyList<T>`, `IReadOnlyCollection<T>`, or `ReadOnlyCollection<T>` types to declare your properties, ensuring a consistent read-only behavior. This helps maintain data integrity by preventing modifications after the collection is set. Below is an example that includes a `Car` class and a `Color` enum. The `Car` class has a `Colors` property that holds a read-only list of available colors, ensuring that these values cannot be modified after being initially set: |
|||
|
|||
```csharp |
|||
public enum Color |
|||
{ |
|||
Black, |
|||
White, |
|||
Red, |
|||
Blue |
|||
} |
|||
|
|||
public class Car |
|||
{ |
|||
public int Id { get; set; } |
|||
public string Brand { get; set; } |
|||
public string Model { get; set; } |
|||
public IReadOnlyList<Color> Colors { get; private set; } = new List<Color> { Color.Black, Color.White }.AsReadOnly(); |
|||
|
|||
protected Car() |
|||
{ |
|||
/* This constructor is for deserialization / ORM purpose */ |
|||
} |
|||
|
|||
public Car(string brand, string model, IEnumerable<Color> colors) |
|||
{ |
|||
Brand = brand; |
|||
Model = model; |
|||
Colors = colors.ToList().AsReadOnly(); |
|||
} |
|||
} |
|||
``` |
|||
|
|||
In the example above, `Colors` is defined as a read-only list, preventing any accidental modifications once it is set. This ensures that data integrity is maintained without the need for manual validation. |
|||
|
|||
To query cars with specific colors, you can use the following example: |
|||
|
|||
```csharp |
|||
var colors = new List<Color> { Color.Black, Color.White }; |
|||
var cars = await context.Cars |
|||
.Where(c => c.Colors.Intersect(colors).Any()) |
|||
.ToListAsync(); |
|||
``` |
|||
|
|||
The query selects all cars that have any of the specified colors in their `Colors` collection. |
|||
|
|||
The SQL result looks like this; as you can see, it sends colors as parameters instead of adding them inline. It also uses the `json_each` function to deserialize on the database side: |
|||
|
|||
```sql |
|||
SELECT "c"."id", |
|||
"c"."brand", |
|||
"c"."colors", |
|||
"c"."model" |
|||
FROM "cars" AS "c" |
|||
WHERE EXISTS (SELECT 1 |
|||
FROM (SELECT "c0"."value" |
|||
FROM Json_each("c"."colors") AS "c0" |
|||
INTERSECT |
|||
SELECT "c1"."value" |
|||
FROM Json_each(@__colors_0) AS "c1") AS "i") |
|||
``` |
|||
|
|||
### Conclusion |
|||
|
|||
Read-only primitive collections make it easier to enforce data integrity by preventing changes to your collection data. This feature helps simplify your code while ensuring that critical parts of your data remain consistent. |
|||
|
|||
## References |
|||
|
|||
- https://learn.microsoft.com/en-us/ef/core/what-is-new/ef-core-9.0/whatsnew#read-only-primitive-collections |
|||
- https://learn.microsoft.com/en-us/ef/core/what-is-new/ef-core-8.0/whatsnew#primitive-collections |
|||
- https://abp.io/community/articles/ef-core-8-primitive-collections-ttn5b6xp |
|||
@ -0,0 +1,54 @@ |
|||
# .NET Aspire 9.0 Features |
|||
|
|||
.NET Aspire 9.0 is the next major release, supporting both .NET 8 and .NET 9. This version includes new features and improvements. |
|||
|
|||
## Upgrade to .NET Aspire |
|||
|
|||
Now, you don't need workloads to develop .NET Aspire applications. In your project, you can add an SDK reference to `Aspire.AppHost.Sdk`. |
|||
For more information, you can check out [https://learn.microsoft.com/en-us/dotnet/aspire/whats-new/dotnet-aspire-9?tabs=windows#upgrade-to-net-aspire-9](https://learn.microsoft.com/en-us/dotnet/aspire/whats-new/dotnet-aspire-9?tabs=windows#upgrade-to-net-aspire-9) which explains upgrading an existing project in details. |
|||
|
|||
## Dashboard |
|||
|
|||
.NET Aspire offers a nice dashboard for developers to observe the performance and behavior of their applications. In this version, there are some enhancements; |
|||
|
|||
* **Manage resource lifecycle**: You can stop, start, and restart resources. |
|||
* **Mobile and responsive support**: The .NET Aspire dashboard is now mobile-friendly. |
|||
* **Sensitive properties**: Properties can be marked as sensitive, automatically masking them in the dashboard UI. |
|||
* **Volumes**: Configured container volumes are listed in resource details. |
|||
* **Health checks**: .NET Aspire 9 adds support for health checks. |
|||
|
|||
 |
|||
|
|||
## Telemetry |
|||
|
|||
.NET Aspire 9 comes with many new features to the Telemetry service. |
|||
|
|||
* **Improve telemetry filtering**: Telemetry data can now be filtered by attribute values. |
|||
* **Combine telemetry from multiple resources**: If a resource has multiple replicas, you can now filter telemetry data to view from all instances. |
|||
* **Browser telemetry support**: The dashboard now supports OpenTelemetry Protocol (OTLP) over HTTP and cross-origin resource sharing (CORS). |
|||
|
|||
 |
|||
|
|||
## Orchestration |
|||
|
|||
The .NET App Host is a core component of the .NET runtime that helps launch and execute .NET applications. |
|||
.NET Aspire 9 introduces many new features to the app host. Let's take a look; |
|||
|
|||
* **Waiting for dependencies**: You can configure a resource to wait for another resource to start before starting. |
|||
* **Resource health checks**: The `Waiting for dependencies` feature uses health checks to determine if a resource is ready. |
|||
|
|||
## Integrations |
|||
|
|||
.NET Aspire has integrations with some services and tools that make it easy to get started. New integrations are coming with .NET Aspire 9. |
|||
|
|||
* Redis Insight |
|||
* OpenAI (Preview) |
|||
* MongoDB |
|||
* Azure |
|||
|
|||
For Azure part, it is better to check the official documentation here [https://learn.microsoft.com/en-us/dotnet/aspire/whats-new/dotnet-aspire-9-release-candidate-1?tabs=windows&pivots=visual-studio#azure](https://learn.microsoft.com/en-us/dotnet/aspire/whats-new/dotnet-aspire-9-release-candidate-1?tabs=windows&pivots=visual-studio#azure) because it has a very detailed explanation. |
|||
|
|||
## ABP Studio |
|||
|
|||
.NET Aspire and [ABP Studio](https://abp.io/studio) are tools for different purposes with different scopes, and they have different approaches to solving problems; many developers may still be confused since they also have some similar functionalities and solve some common problems. You can check the comparison of .NET Aspire and ABP Studio in this [article](https://abp.io/community/articles/.net-aspire-vs-abp-studio-side-by-side-t1c73d1l). |
|||
|
|||
|
After Width: | Height: | Size: 51 KiB |
|
After Width: | Height: | Size: 55 KiB |
@ -0,0 +1,113 @@ |
|||
# SignalR supports trimming and Native AOT |
|||
|
|||
## What is SignalR? |
|||
|
|||
SignalR is a library that allows you to add real-time web functionality to your applications. It provides a simple API for creating server-to-client remote procedure calls (RPC) that can be called from the server and client. Now SignalR supports trimming and Native AOT in .NET 8.0 and .NET 9.0. You can learn more about [SignalR new features](https://abp.io/community/articles/asp.net-core-signalr-new-features-summary-kcydtdgq) in this article. |
|||
|
|||
## What is trimming and Native AOT? |
|||
|
|||
AOT (Ahead-of-Time) compilation is a feature that allows you to compile your application into native code before running it. This can help improve performance and reduce startup times. Trimming is a feature that allows you to remove unused code from your application, reducing its size and improving performance. You can learn more about [Native AOT Compilation](https://abp.io/community/articles/native-aot-compilation-in-.net-8-oq7qtwov) in this article. |
|||
|
|||
## How to use SignalR with trimming and Native AOT? |
|||
|
|||
You can create ASP.NET Core AOT application with using the following command: |
|||
|
|||
```bash |
|||
dotnet new webapiaot -n Acme.Sample |
|||
``` |
|||
|
|||
The created application uses `CreateSlimBuilder` method to create minimal builder for the application. You can use `CreateBuilder` method to create a builder with all the services registered. However, deploying an application with `CreateSlimBuilder` method is more convenient because it reduces the size of the application. You can learn more about [CreateSlimBuilder vs CreateBuilder](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/native-aot#createslimbuilder-vs-createbuilder). |
|||
|
|||
Replace the `Program.cs` file with the following code: |
|||
|
|||
```csharp |
|||
using Microsoft.AspNetCore.SignalR; |
|||
using System.Text.Json.Serialization; |
|||
|
|||
var builder = WebApplication.CreateSlimBuilder(args); |
|||
|
|||
builder.Services.AddSignalR(); |
|||
builder.Services.Configure<JsonHubProtocolOptions>(o => |
|||
{ |
|||
o.PayloadSerializerOptions.TypeInfoResolverChain.Insert(0, AppJsonSerializerContext.Default); |
|||
}); |
|||
|
|||
var app = builder.Build(); |
|||
|
|||
app.MapHub<ChatHub>("/chatHub"); |
|||
app.MapGet("/", () => Results.Content(""" |
|||
<!DOCTYPE html> |
|||
<html> |
|||
<head> |
|||
<title>SignalR Chat</title> |
|||
</head> |
|||
<body> |
|||
<input id="userInput" placeholder="Enter your name" /> |
|||
<input id="messageInput" placeholder="Type a message" /> |
|||
<button onclick="sendMessage()">Send</button> |
|||
<ul id="messages"></ul> |
|||
|
|||
<script src="https://cdnjs.cloudflare.com/ajax/libs/microsoft-signalr/8.0.7/signalr.min.js"></script> |
|||
<script> |
|||
const connection = new signalR.HubConnectionBuilder() |
|||
.withUrl("/chatHub") |
|||
.build(); |
|||
|
|||
connection.on("ReceiveMessage", (user, message) => { |
|||
const li = document.createElement("li"); |
|||
li.textContent = `${user}: ${message}`; |
|||
document.getElementById("messages").appendChild(li); |
|||
}); |
|||
|
|||
async function sendMessage() { |
|||
const user = document.getElementById("userInput").value; |
|||
const message = document.getElementById("messageInput").value; |
|||
await connection.invoke("SendMessage", user, message); |
|||
} |
|||
|
|||
connection.start().catch(err => console.error(err)); |
|||
</script> |
|||
</body> |
|||
</html> |
|||
""", "text/html")); |
|||
|
|||
app.Run(); |
|||
|
|||
[JsonSerializable(typeof(string))] |
|||
internal partial class AppJsonSerializerContext : JsonSerializerContext { } |
|||
|
|||
public class ChatHub : Hub |
|||
{ |
|||
public async Task SendMessage(string user, string message) |
|||
{ |
|||
await Clients.All.SendAsync("ReceiveMessage", user, message); |
|||
} |
|||
} |
|||
``` |
|||
|
|||
It is a simple chat application that uses SignalR to send and receive messages. |
|||
|
|||
 |
|||
|
|||
Before deploying the application, ensure that **Desktop development with C++** is installed on your machine if you're using Windows OS. For more details, you can check the [pre-requisites](https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot#prerequisites). |
|||
|
|||
You can deploy the application with the following command: |
|||
|
|||
```bash |
|||
dotnet publish -c Release |
|||
``` |
|||
|
|||
### Limitations |
|||
|
|||
Since we are using Native AOT, there are some limitations that you should be aware of: |
|||
|
|||
- **Only the JSON protocol is supported**: For the payload serialization in SignalR, only the JSON protocol is supported. You need to configure the `JsonHubProtocolOptions` to use the `AppJsonSerializerContext` for serialization/deserialization. |
|||
- **Reflection**: Native AOT does not support reflection. You need to use the `JsonSerializable` attribute to specify the types that should be serialized/deserialized. In this example, we have used the `JsonSerializable` attribute for the `string` type in the `AppJsonSerializerContext` class. |
|||
|
|||
For more details, you can check the [limitations](https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot#limitations-of-native-aot-deployment) of Native AOT. |
|||
|
|||
## Conclusion |
|||
|
|||
In this article, we learned how to use SignalR with trimming and Native AOT in .NET 8.0 and .NET 9.0. We created a simple chat application that uses SignalR to send and receive messages. We also discussed the limitations of using Native AOT and how to overcome them. |
|||
|
|||
For more information, you can refer to the [Microsoft's official document](https://learn.microsoft.com/en-us/aspnet/core/release-notes/aspnetcore-9.0?view=aspnetcore-9.0#signalr-supports-trimming-and-native-aot). |
|||
|
After Width: | Height: | Size: 31 KiB |
@ -0,0 +1,58 @@ |
|||
# Middleware Now Supports Keyed Dependency Injection in .NET 9 |
|||
|
|||
This article explores a new feature in .NET 9 that enables keyed dependency injection in middleware. Previously, .NET 8 introduced keyed services, which allowed developers to register multiple instances of the same service type with distinct keys. Now, .NET 9 extends this feature to middleware, making it easier to inject specific services within the middleware based on defined keys. For more details, see this [overview on the .NET blog](https://github.com/dotnet/core/blob/main/release-notes/9.0/preview/rc1/aspnetcore.md#keyed-di-in-middleware). |
|||
|
|||
## What is Keyed Dependency Injection? |
|||
|
|||
Keyed dependency injection is a technique for registering multiple service versions with unique identifiers, or “keys.” This approach is especially helpful when multiple implementations of the same service are required in different contexts. For example, you may have various logging services but want to inject a specific logger based on the application’s current needs. By using keys, developers can ensure that the appropriate service version is injected precisely where it’s needed. |
|||
|
|||
## Using Keyed Dependency Injection in Middleware |
|||
|
|||
In .NET 9, developers can now use keyed dependency injection directly in middleware. Keyed services can be injected through the middleware constructor or via the `Invoke`/`InvokeAsync` methods, allowing for straightforward and flexible control of service instances in middleware components. Here’s an example of how to configure and use keyed dependency injection in middleware: |
|||
|
|||
```csharp |
|||
var builder = WebApplication.CreateBuilder(args); |
|||
|
|||
// Register services with unique keys |
|||
builder.Services.AddKeyedSingleton<MySingletonClass>("test"); |
|||
builder.Services.AddKeyedScoped<MyScopedClass>("test2"); |
|||
|
|||
var app = builder.Build(); |
|||
app.UseMiddleware<MyMiddleware>(); |
|||
app.Run(); |
|||
|
|||
internal class MyMiddleware |
|||
{ |
|||
private readonly RequestDelegate _next; |
|||
private readonly MySingletonClass _singletonService; |
|||
|
|||
// Constructor injection with key |
|||
public MyMiddleware(RequestDelegate next, [FromKeyedServices("test")] MySingletonClass singletonService) |
|||
{ |
|||
_next = next; |
|||
_singletonService = singletonService; |
|||
} |
|||
|
|||
// Invoke method with additional scoped service injection using key |
|||
public Task Invoke(HttpContext context, [FromKeyedServices("test2")] MyScopedClass scopedService) |
|||
{ |
|||
// Middleware logic here |
|||
return _next(context); |
|||
} |
|||
} |
|||
``` |
|||
|
|||
In this example: |
|||
- `MySingletonClass` and `MyScopedClass` are registered with unique keys (`"test"` and `"test2"`). |
|||
- These services are injected into the middleware through both the constructor and `Invoke` method, based on their respective keys. |
|||
|
|||
This approach allows developers to manage which service instances are available within middleware precisely. |
|||
|
|||
## Conclusion |
|||
|
|||
Keyed dependency injection in middleware is a significant addition in .NET 9. It provides developers with more control over which services are injected based on specific keys. This enhancement enables selective service injection in middleware scenarios, allowing for more modular and maintainable applications. |
|||
|
|||
## References |
|||
|
|||
- [.NET 9 Release Notes](https://github.com/dotnet/core/blob/main/release-notes/9.0/preview/rc1/aspnetcore.md#keyed-di-in-middleware) |
|||
- [Dependency Injection and Keyed Services](https://learn.microsoft.com/aspnet/core/fundamentals/dependency-injection#keyed-services) |
|||
@ -0,0 +1,108 @@ |
|||
# Optimizing Static Asset Delivery feature in ASP.NET Core 9.0 |
|||
|
|||
Delivering static assets efficiently is a key factor in building performant web applications. By optimizing how assets like CSS, JavaScript, and images are served to the browser, you can reduce load times, decrease network traffic, and improve the overall user experience. |
|||
|
|||
One powerful tool to help achieve this is **MapStaticAssets**, a feature in ASP.NET Core that significantly optimizes the delivery of static resources. Whether you're working with Blazor, Razor Pages, MVC, or other UI frameworks, **MapStaticAssets** streamlines asset management and ensures that your web app delivers resources in the most efficient way possible. |
|||
|
|||
## Why Optimizing Static Assets Matters |
|||
|
|||
Serving static assets without optimization can lead to several performance bottlenecks: |
|||
|
|||
- **Excessive network requests**: The browser may need to request the same resources multiple times, even if they haven’t changed. |
|||
- **Unnecessary data transfer**: Larger files are sent over the network, consuming bandwidth and slowing down page loads. |
|||
- **Outdated assets**: Without proper cache management, users may receive stale versions of files after an app update. |
|||
|
|||
Optimizing static assets involves compressing files, managing caching headers, and ensuring that only the necessary resources are sent to the client. **MapStaticAssets** takes care of all these issues in a seamless, automated way. |
|||
|
|||
## What is MapStaticAssets? |
|||
|
|||
**MapStaticAssets** is designed to enhance the default static asset serving mechanism in ASP.NET Core. It can replace `UseStaticFiles` in most scenarios and comes with several built-in optimizations. These optimizations are executed at both build and publish time, ensuring that static resources are served in the most efficient way possible when your app is running. |
|||
|
|||
Here's how you can implement **MapStaticAssets** in your app: |
|||
|
|||
```csharp |
|||
var builder = WebApplication.CreateBuilder(args); |
|||
|
|||
builder.Services.AddRazorPages(); |
|||
|
|||
var app = builder.Build(); |
|||
|
|||
if (!app.Environment.IsDevelopment()) |
|||
{ |
|||
app.UseExceptionHandler("/Error"); |
|||
app.UseHsts(); |
|||
} |
|||
|
|||
app.UseHttpsRedirection(); |
|||
|
|||
app.UseRouting(); |
|||
|
|||
app.UseAuthorization(); |
|||
|
|||
// Replacing UseStaticFiles with MapStaticAssets |
|||
app.MapStaticAssets(); |
|||
app.MapRazorPages(); |
|||
|
|||
app.Run(); |
|||
``` |
|||
|
|||
## Key Features of MapStaticAssets |
|||
|
|||
1. **Build-time Compression**: |
|||
**MapStaticAssets** automatically compresses all static assets during the build process. It uses **gzip** compression during development and **gzip + brotli** compression when publishing. This reduces the file size significantly, ensuring faster download times. |
|||
|
|||
For example, in a default Razor Pages template, assets like `bootstrap.min.css` and `jquery.js` are compressed by over 80%, resulting in significantly reduced file sizes: |
|||
|
|||
| File | Original Size | Compressed Size | Compression Reduction | |
|||
|----------------------|---------------|-----------------|-----------------------| |
|||
| `bootstrap.min.css` | 163 KB | 17.5 KB | 89.26% | |
|||
| `jquery.js` | 89.6 KB | 28 KB | 68.75% | |
|||
| `bootstrap.min.js` | 78.5 KB | 20 KB | 74.52% | |
|||
| **Total** | 331.1 KB | 65.5 KB | 80.20% | |
|||
|
|||
2. **Content-based ETags**: |
|||
**MapStaticAssets** generates **ETags** based on the SHA-256 hash of the file content, encoded in Base64. This ensures that the browser only re-downloads a resource if its content has changed. This eliminates unnecessary network requests, improving page load speeds. |
|||
|
|||
3. **Smaller File Sizes for Libraries**: |
|||
Popular component libraries, such as **Fluent UI Blazor** and **MudBlazor**, benefit from similar compression optimizations. For example, the size of the **MudBlazor** library is reduced by over 90%, from 588 KB to just 46.7 KB after compression. |
|||
|
|||
| File | Original Size | Compressed Size | Compression Reduction | |
|||
|----------------------|---------------|-----------------|-----------------------| |
|||
| `MudBlazor.min.css` | 541 KB | 37.5 KB | 93.07% | |
|||
| `MudBlazor.min.js` | 47.4 KB | 9.2 KB | 80.59% | |
|||
| **Total** | 588.4 KB | 46.7 KB | 92.07% | |
|||
|
|||
4. **Automatic Optimization**: |
|||
As libraries or components are added or updated, **MapStaticAssets** automatically optimizes the assets as part of the build process. This includes minimizing the size of JavaScript and CSS files, reducing the impact of mobile or low-bandwidth environments. |
|||
|
|||
5. **Serving Assets with a CDN**: |
|||
Although **MapStaticAssets** is focused on server-side optimizations, integrating a **CDN (Content Delivery Network)** can further boost performance by serving static assets from servers geographically closer to the user, reducing latency. |
|||
|
|||
## Comparing MapStaticAssets to IIS Dynamic Compression |
|||
|
|||
**MapStaticAssets** provides several advantages over traditional dynamic compression techniques, such as IIS **gzip** compression: |
|||
|
|||
- **Simplicity**: There is no need for server-specific configuration, making **MapStaticAssets** easy to implement. |
|||
- **Performance**: By compressing assets at build time, the app doesn't need to perform compression during every request, which improves server performance. |
|||
- **Optimization**: Developers can focus on ensuring that assets are compressed to the smallest possible size during the build process. |
|||
|
|||
For example, using **MapStaticAssets**, a file like `MudBlazor.min.css` is compressed down to 37.5 KB, whereas IIS dynamic compression might result in a size of 90 KB. This represents a **59%** reduction in size. |
|||
|
|||
## About MapAbpStaticAssets |
|||
|
|||
The ABP framework is 100% compatible with this new feature. |
|||
|
|||
However, some JavaScript, CSS, and image files exist in the [Virtual File System](https://abp.io/docs/latest/framework/infrastructure/virtual-file-system), which ASP.NET Core's **MapStaticAssets** can't handle. For these files, additional **StaticFileMiddleware** is needed to serve them, which is where **MapAbpStaticAssets** comes in. |
|||
|
|||
**MapAbpStaticAssets** adds the necessary **StaticFileMiddleware** to ensure that virtual files are correctly served. This middleware setup ensures seamless delivery of virtual resources alongside static assets. |
|||
|
|||
You can view the source code of **MapAbpStaticAssets** on [GitHub](https://github.com/abpframework/abp/blob/dev/framework/src/Volo.Abp.AspNetCore/Microsoft/AspNetCore/Builder/AbpApplicationBuilderExtensions.cs#L129-L198). |
|||
|
|||
## Conclusion |
|||
|
|||
Optimizing static asset delivery is essential for building fast, efficient web applications. **MapStaticAssets** simplifies and automates the optimization of static files by providing build-time compression, caching headers, and content-based ETags. This ensures that your app's static assets are always delivered in the most efficient way, whether users are on fast broadband or slower mobile connections. By using **MapStaticAssets**, you can deliver a faster, more reliable experience for your users with minimal effort. |
|||
|
|||
## References |
|||
|
|||
* [Static files in ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/static-files?view=aspnetcore-9.0) |
|||
* [What's new in ASP.NET Core 9.0](https://learn.microsoft.com/en-us/aspnet/core/release-notes/aspnetcore-9.0?view=aspnetcore-8.0#optimize-static-web-asset-delivery) |
|||
|
After Width: | Height: | Size: 445 KiB |
|
After Width: | Height: | Size: 174 KiB |
|
After Width: | Height: | Size: 175 KiB |
|
After Width: | Height: | Size: 271 KiB |
|
After Width: | Height: | Size: 116 KiB |
|
After Width: | Height: | Size: 106 KiB |
@ -0,0 +1,164 @@ |
|||
Built-in OpenAPI Document Generation with .NET 9 — No more SwaggerUI! 👋 |
|||
======================================================================== |
|||
|
|||
 |
|||
|
|||
What’s Swagger UI? |
|||
------------------ |
|||
|
|||
[Swagger UI](https://swagger.io/) is an open-source tool that automatically generates an interactive, web-based documentation interface for WebAPIs. |
|||
It supports OpenAPI standards. It was very popular tool among the ASP.NET Core developers from 2020 to 2024. |
|||
Because it was a built-in tool comes with ASP.NET Core default templates. |
|||
We liked this tool because it was the first tool that allows us to make WebAPI calls for testing. |
|||
Now it provides paid services as well as free ones. |
|||
|
|||
> Previously, Swagger was included by default from **.NET 5** to **.NET 8** in .NET web templates. |
|||
|
|||
--- |
|||
|
|||
|
|||
|
|||
What’s OpenAPI? |
|||
--------------- |
|||
|
|||
OpenAPI is a standard specification for defining REST APIs. |
|||
The official website is [https://www.openapis.org/](https://www.openapis.org/). |
|||
Microsoft is now using OpenAPI and here is the official documentation 👉 [https://aka.ms/aspnet/openapi](https://aka.ms/aspnet/openapi) |
|||
|
|||
--- |
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Replacement of Swagger UI with OpenAPI |
|||
---------------------------------------------------------------------------- |
|||
|
|||
Swagger UI is no longer integrated into NET 9, as Microsoft wants a solution with first-class support, better control, and enhanced security. As you see in the below screenshot, Microsoft declares that it's already removed. |
|||
|
|||
 |
|||
|
|||
--- |
|||
|
|||
|
|||
|
|||
|
|||
|
|||
## Why is Swagger Removed from .NET 9? |
|||
|
|||
In March 2024, the ASP.NET Core team announced that they are removing the `Swashbuckle.AspNetCore` dependency from web templates from .NET 9 release. |
|||
|
|||
|
|||
|
|||
> This decision was influenced by the project's lack of active maintenance and the absence of an official release for .NET 8. |
|||
|
|||
|
|||
|
|||
Microsoft team created a new package `Microsoft.AspNetCore.OpenApi`. It provides built-in OpenAPI document generation just like Swagger. So Microsoft doesn't depend on external tools. Because in every .NET release, they need to ask the owners of the external tool libraries to align with their new version. And sometimes these library owners cannot update their code-base according to the recent .NET changes. And it is becoming harder for Microsoft to support the 3rd party libraries under these circumstances. Basically reducing 3rd party dependencies will help Microsoft fast release cycles. |
|||
|
|||
I read Reddit, GitHub discussions and YouTube reviews about this topic. As I see community members expressed concerns about the inactivity of Swashbuckle and they are discussing alternatives like contributing to or forking the project. The Microsoft team also contacted the owners of Swashbuckle and NSwag to explore potential collaborations and ensure a smooth transition for developers. |
|||
|
|||
In the below GitHub issue, you can see the details of this decision: |
|||
|
|||
* [github.com/dotnet/aspnetcore/issues/54599](https://github.com/dotnet/aspnetcore/issues/54599) |
|||
|
|||
|
|||
|
|||
**Jeremy** -Product Manager- at Microsoft, answers why they took this decision in [this post](https://github.com/dotnet/aspnetcore/issues/54599#issuecomment-2004975574). |
|||
|
|||
 |
|||
|
|||
As a summary; |
|||
|
|||
**The change is due to a lack of maintenance of the Swagger library**, although it has seen some recent updates. This aims to reduce dependency on external tools and provide a streamlined, out-of-the-box experience for generating OpenAPI documentation for ASP.NET Core Web APIs. |
|||
|
|||
--- |
|||
|
|||
|
|||
|
|||
|
|||
|
|||
What are the Benefits of the New OpenAI Package? |
|||
--------------------------------------------------------------- |
|||
|
|||
### Native Support and Reduced Dependency |
|||
|
|||
The new `Microsoft.AspNetCore.OpenApi` package provides first-class citizen support for OpenAPI. It reduces reliance on external tools like Swashbuckle or NSwag for basic documentation needs. The native implementation leverages source generators to reduce runtime overhead. |
|||
|
|||
### Simplified Configuration |
|||
|
|||
No need extra setup or 3rd party integrations. Just by defining controllers and endpoints, ASP.NET Core automatically generates OpenAPI specifications. |
|||
|
|||
### Well Integration with Minimal APIs |
|||
|
|||
[Minimal APIs](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/minimal-apis) introduced in .NET 6. There's an optimized built-in support for Minimal APIs. It automatically adds metadata for routes, request parameters, and responses. |
|||
|
|||
### Compatibility with Existing Tools |
|||
|
|||
You can still use the output of OpenAPI with Swagger or NSwag... So it doesn't mean that in this case you have only one option when you use OpenAPI. |
|||
|
|||
--- |
|||
|
|||
|
|||
|
|||
How to Use the New OpenAPI in .NET9? |
|||
------------------------------------ |
|||
|
|||
When you create a new ASP.NET Core project, you can see the below checkbox to add OpenAPI. |
|||
|
|||
 |
|||
|
|||
I created a new .NET 9 web project, I saw that OpenAPI had already been added. |
|||
|
|||
 |
|||
|
|||
## Add OpenAPI Support For Your Existing Project |
|||
|
|||
Upgrade your project to .NET 9 and add the required NuGet package [Microsoft.AspNetCore.OpenApi](https://www.nuget.org/packages/Microsoft.AspNetCore.OpenApi) |
|||
|
|||
``` |
|||
dotnet add package Microsoft.AspNetCore.OpenApi |
|||
``` |
|||
|
|||
### |
|||
|
|||
Add the following services and middleware in `Program.cs` |
|||
|
|||
``` |
|||
var builder = WebApplication.CreateBuilder(); |
|||
builder.Services.AddOpenApi(); //<<----- |
|||
var app = builder.Build(); |
|||
app.MapOpenApi(); //<<----- |
|||
app.MapGet("/", () => "Test"); |
|||
app.Run(); |
|||
``` |
|||
|
|||
Your OpenAPI document URL is [_https://localhost:7077/openapi/v1.json_](https://localhost:7077/openapi/v1.json) |
|||
|
|||
Change the port to your active port. This is how it looks like: |
|||
|
|||
 |
|||
|
|||
--- |
|||
|
|||
|
|||
|
|||
Alternative 3rd Party Tool: Scalar |
|||
================================== |
|||
|
|||
**Scalar** is an open-source API platform for RestAPI documentation. Also, it provides an interface for interacting with RESTful API. Generates interactive and user-friendly API documentation. Supports OpenAPI and Swagger specifications. It’s open-source with **7K stars** on GitHub. |
|||
|
|||
See the repo 👉 [https://github.com/scalar/scalar](https://github.com/scalar/scalar). |
|||
|
|||
|
|||
|
|||
That's all from the replacement of Swagger in .NET 9. |
|||
Happy coding 👨💻 |
|||
|
|||
|
|||
|
|||
**References** |
|||
|
|||
* [https://learn.microsoft.com/en-us/aspnet/core/release-notes/aspnetcore-9.0?view=aspnetcore-8.0#openapi](https://learn.microsoft.com/en-us/aspnet/core/release-notes/aspnetcore-9.0?view=aspnetcore-8.0#openapi) |
|||
|
|||
|
|||
@ -0,0 +1,202 @@ |
|||
# C# 13 Features |
|||
|
|||
C# 13 is the latest version of C# and it comes with a lot of new features. In this article, we will discuss some of the new features of C# 13. |
|||
|
|||
## `params` collections |
|||
|
|||
With the C# 13, method parameter with `params` keyword isn't limited to be an array. You can now use any collection type that implements `IEnumerable<T>` interface. |
|||
|
|||
Let's see how it can help us in our code. |
|||
|
|||
```csharp |
|||
public IEnumerable<int> GetOdds(params IEnumerable<int> numbers) |
|||
{ |
|||
foreach (var number in numbers) |
|||
{ |
|||
if (number % 2 != 0) |
|||
{ |
|||
Console.WriteLine(number); |
|||
} |
|||
} |
|||
} |
|||
``` |
|||
|
|||
## New lock object |
|||
|
|||
I'm sure you have used `lock` statement in your code to synchronize access to a shared resource. With C# 13, you can now use a new lock object that is more efficient than the traditional lock object. |
|||
The new `Lock` type provides better thread synchronization through its API. When `Lock.EnterScope()` method is called, it returns a struct named `Scope` that contains a `Dispose` method. The `Dispose` method is called when the `Scope` object goes out of scope, which releases the lock. C# `using` statement recognizes the `Dispose` method and calls it automatically like it does with other `IDisposable` objects. |
|||
|
|||
It was something similar before: |
|||
```csharp |
|||
private object _lock = new(); |
|||
|
|||
public void DoSomething() |
|||
{ |
|||
lock (_lock) |
|||
{ |
|||
// Do something |
|||
} |
|||
} |
|||
``` |
|||
|
|||
Now, you can use the new lock object like this: |
|||
```csharp |
|||
System.Threading.Lock x = new System.Threading.Lock(); |
|||
public void DoSomething() |
|||
{ |
|||
using (x.EnterScope()) |
|||
{ |
|||
// Do something |
|||
} |
|||
} |
|||
``` |
|||
|
|||
## New escape sequence |
|||
In C# 13, a new escape sequence `\e` has been introduced to represent the `ESCAPE` character, Unicode `U+001B`. Previously, you had to use `\u001b` or `\x1b` to represent this character. The new `\e` escape sequence simplifies this process and avoids potential issues with hexadecimal digits following `\x1b`. |
|||
|
|||
> You can check [here](https://en.wikipedia.org/wiki/ANSI_escape_code#C0_control_codes) for ANSI escape codes. |
|||
|
|||
## Implicit index access |
|||
|
|||
The implicit "from the end" index operator, `^`, is now allowed in an object initializer expression. |
|||
|
|||
It was not possible before, but now you can do this: |
|||
|
|||
```csharp |
|||
var countdown = new TimerRemaining() |
|||
{ |
|||
buffer = |
|||
{ |
|||
[^1] = 0, |
|||
[^2] = 1, |
|||
[^3] = 2, |
|||
[^4] = 3, |
|||
[^5] = 4, |
|||
[^6] = 5, |
|||
[^7] = 6, |
|||
[^8] = 7, |
|||
[^9] = 8, |
|||
[^10] = 9 |
|||
} |
|||
}; |
|||
``` |
|||
|
|||
It's a great feature that makes the code more readable and maintainable. Still not a big deal, but it's nice to have it. |
|||
|
|||
## `ref` and `unsafe` in iterators and async methods |
|||
|
|||
In C# 13, the restrictions on using `ref` and `unsafe` constructs in iterators and async methods have been relaxed. Previously, you couldn't declare local `ref` variables or use unsafe contexts in these methods. Now, you can declare ref local variables and use unsafe contexts in async methods and iterators, provided they are not accessed across `await` or `yield` boundaries |
|||
|
|||
|
|||
This change allows for more expressive and efficient code, especially when working with types like `System.Span<T>` and `System.ReadOnlySpan<T>`. The compiler ensures that these constructs are used safely, and it will notify you if any safety rules are violated. |
|||
|
|||
You can read more about this feature on the [Microsoft Learn page](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/proposals/csharp-13.0/ref-unsafe-in-iterators-async). |
|||
|
|||
|
|||
|
|||
## More partial members |
|||
|
|||
In C# 13, the concept of partial members has been expanded to include partial properties and partial indexers. Previously, only methods could be defined as partial members. This means you can now split the definition of properties and indexers across multiple files, just like you could with methods. |
|||
|
|||
For example, you can declare a partial property in one part of your class and implement it in another part. Here's a simple illustration: |
|||
|
|||
```csharp |
|||
public partial class MyClass |
|||
{ |
|||
// Declaring declaration |
|||
public partial string MyProperty { get; set; } |
|||
} |
|||
|
|||
public partial class MyClass |
|||
{ |
|||
// Implementing declaration |
|||
private string _myProperty; |
|||
public partial string MyProperty |
|||
{ |
|||
get => _myProperty; |
|||
set => _myProperty = value; |
|||
} |
|||
} |
|||
``` |
|||
|
|||
This feature allows for better organization and modularization of your code, especially in large projects where different parts of a class might be implemented by different team members. |
|||
|
|||
## Overload resolution priority |
|||
|
|||
What does "Overload resolution priority" section mean in this page? |
|||
In C# 13, the OverloadResolutionPriority attribute allows library authors to specify which method overload should be preferred by the compiler when multiple overloads are available. This attribute helps avoid ambiguity and ensures that the most appropriate overload is chosen, even if it might not be the most obvious choice based on traditional overload resolution rules. |
|||
|
|||
This may be useful in scenarios where you have multiple overloads that are equally valid, but you want to prioritize one over the others. The attribute can be applied to a method or constructor to indicate its priority in the overload resolution process. It can prevent unexpected behavior and make your code more predictable and maintainable. |
|||
|
|||
|
|||
Let me show with an example: |
|||
```csharp |
|||
public class Example |
|||
{ |
|||
// Existing method |
|||
public void Display(string message = "Hello!") |
|||
{ |
|||
Console.WriteLine("Message: " + message); |
|||
} |
|||
|
|||
// New, more efficient method with higher priority |
|||
[OverloadResolutionPriority(1)] |
|||
public void Display(string message = "Hello!", int repeatCount = 3) |
|||
{ |
|||
for (int i = 0; i < repeatCount; i++) |
|||
{ |
|||
Console.WriteLine("Message: " + message); |
|||
} |
|||
} |
|||
} |
|||
|
|||
class Program |
|||
{ |
|||
static void Main() |
|||
{ |
|||
Example example = new Example(); |
|||
|
|||
// Normally, you can't compile this code because of ambiguity: |
|||
example.Display(); |
|||
} |
|||
} |
|||
``` |
|||
|
|||
Output: |
|||
``` |
|||
Message: Hello! |
|||
Message: Hello! |
|||
Message: Hello! |
|||
``` |
|||
|
|||
## The `field` keyword |
|||
|
|||
n C# 13, the `field` keyword is introduced as a preview feature to simplify property accessors. This keyword allows you to reference the compiler-generated backing `field` directly within a property accessor, eliminating the need to declare an explicit backing `field` in your type declaration. |
|||
|
|||
For example, instead of writing: |
|||
|
|||
```csharp |
|||
private int _value; |
|||
public int Value |
|||
{ |
|||
get => _value; |
|||
set => _value = value; |
|||
} |
|||
``` |
|||
|
|||
You can now write: |
|||
|
|||
```csharp |
|||
public int Value |
|||
{ |
|||
get => field; |
|||
set => field = value; |
|||
} |
|||
``` |
|||
|
|||
This makes your code cleaner and more concise. However, be cautious if you have a `field` named `field` in your class, as it could cause confusion. You can disambiguate by using `@field` or `this.field`. |
|||
|
|||
Make sure you're using the latest `LangVersion` in your `.csproj` project file to enable this feature. |
|||
```xml |
|||
<LangVersion>preview</LangVersion> |
|||
``` |
|||
@ -0,0 +1,165 @@ |
|||
# EF Core 9 LINQ & SQL translation |
|||
|
|||
EF Core improves the translation of LINQ queries to SQL with every release. EF Core 9 is no exception. This article will show you some of the improvements in EF Core 9. |
|||
|
|||
EF Core 9 includes a lot of improvements in LINQ to SQL translation. we don't cover all of them in this article. You can find more information in the [official release notes](https://learn.microsoft.com/en-us/ef/core/what-is-new/ef-core-9.0/whatsnew#linq-and-sql-translation). |
|||
|
|||
## Support for complex types |
|||
|
|||
### GroupBy |
|||
|
|||
EF Core now supports grouping by complex type instance. For example: |
|||
|
|||
```csharp |
|||
var groupedAddress = await context.Customers |
|||
.GroupBy(c => new { c.Address }) |
|||
.Select(g => new { g.Key, Count = g.Count() }) |
|||
.ToListAsync(); |
|||
``` |
|||
|
|||
Address is a complex type as a value object here. |
|||
|
|||
### ExecuteUpdate |
|||
|
|||
EF Core now supports updating a complex type. For example: |
|||
|
|||
```csharp |
|||
var newAddress = new Address("New Street", "New City", "New Country"); |
|||
|
|||
await context.Customers |
|||
.Where(e => e.Region == "Turkey") |
|||
.ExecuteUpdateAsync(s => s.SetProperty(b => b.Address, newAddress)); |
|||
``` |
|||
|
|||
EF Core updates each column of the complex type. |
|||
|
|||
## Prune unneeded elements from SQL |
|||
|
|||
Ef Core now translates LINQ queries to SQL more efficiently. It will remove unneeded elements from the SQL query and bring better performance. |
|||
|
|||
### Table pruning |
|||
|
|||
When you use table-per-hierarchy (TPH) inheritance, previously EF Core generated SQL queries that included JIONs to tables that were not needed. |
|||
|
|||
For example: |
|||
|
|||
```csharp |
|||
public class Order |
|||
{ |
|||
public int Id { get; set; } |
|||
... |
|||
|
|||
public Customer Customer { get; set; } |
|||
} |
|||
|
|||
public class DiscountedOrder : Order |
|||
{ |
|||
public double Discount { get; set; } |
|||
} |
|||
|
|||
public class Customer |
|||
{ |
|||
public int Id { get; set; } |
|||
... |
|||
|
|||
public List<Order> Orders { get; set; } |
|||
} |
|||
|
|||
public class AppContext : DbContext |
|||
{ |
|||
... |
|||
|
|||
protected override void OnModelCreating(ModelBuilder modelBuilder) |
|||
{ |
|||
modelBuilder.Entity<Order>().UseTptMappingStrategy(); |
|||
} |
|||
} |
|||
``` |
|||
|
|||
Consider the following query to get all customers with at least one order: |
|||
|
|||
```csharp |
|||
var customers = await context.Customers.Where(o => o.Orders.Any()).ToListAsync(); |
|||
``` |
|||
|
|||
Previously, EF Core generated the following SQL query: |
|||
|
|||
```sql |
|||
SELECT [c].[Id], [c].[Name] |
|||
FROM [Customers] AS [c] |
|||
WHERE EXISTS ( |
|||
SELECT 1 |
|||
FROM [Orders] AS [o] |
|||
LEFT JOIN [DiscountedOrders] AS [d] ON [o].[Id] = [d].[Id] |
|||
WHERE [c].[Id] = [o].[CustomerId]) |
|||
``` |
|||
|
|||
It included a JOIN to the `DiscountedOrders` table, which was not needed. In EF Core 9, the generated SQL query is: |
|||
|
|||
```sql |
|||
SELECT [c].[Id], [c].[Name] |
|||
FROM [Customers] AS [c] |
|||
WHERE EXISTS ( |
|||
SELECT 1 |
|||
FROM [Orders] AS [o] |
|||
WHERE [c].[Id] = [o].[CustomerId]) |
|||
``` |
|||
|
|||
## EF Core in ABP |
|||
|
|||
ABP Framework is built on top of the latest technologies. It will support EF Core 9 as soon as it is released. You can use the latest features of EF Core in your ABP applications. |
|||
|
|||
For example, you can use the `ExecuteUpdateAsync` method in your ABP application: |
|||
|
|||
```csharp |
|||
public class Book : FullAuditedAggregateRoot<Guid> |
|||
{ |
|||
public string Name { get; set; } |
|||
|
|||
public float Price { get; set; } |
|||
|
|||
public string Author { get; set; } |
|||
} |
|||
|
|||
public class AppContext : AbpDbContext<AppContext> |
|||
{ |
|||
public DbSet<Book> Books { get; set; } |
|||
|
|||
protected override void OnModelCreating(ModelBuilder modelBuilder) |
|||
{ |
|||
base.OnModelCreating(builder); |
|||
|
|||
builder.Entity<Book>(b => |
|||
{ |
|||
b.ToTable("Books"); |
|||
b.ConfigureByConvention(); |
|||
b.Property(x => x.Name).IsRequired().HasMaxLength(128); |
|||
b.Property(x => x.Author).IsRequired().HasMaxLength(64); |
|||
}); |
|||
} |
|||
} |
|||
|
|||
public class BookRepository : EfCoreRepository<AppContext, Book, Guid>, IBookRepository |
|||
{ |
|||
public BookRepository(IDbContextProvider<AppContext> dbContextProvider) |
|||
: base(dbContextProvider) |
|||
{ |
|||
} |
|||
|
|||
public async Task UpdatePriceByAuthorAsync(string author, float price) |
|||
{ |
|||
await (await GetDbSetAsync()) |
|||
.Where(b => b.Author == author) |
|||
.ExecuteUpdateAsync(b => b.SetProperty(x => x.Price, price)); |
|||
} |
|||
} |
|||
``` |
|||
|
|||
* `FullAuditedAggregateRoot` is an aggregate root base class with auditing properties provided by ABP Framework. |
|||
* `IRepository` is a generic repository interface provided by ABP Framework that provides CRUD operations and you can use EF Core's API in your entity repository implementation. |
|||
|
|||
## References |
|||
|
|||
* [LINQ and SQL translation](https://learn.microsoft.com/en-us/ef/core/what-is-new/ef-core-9.0/whatsnew#linq-and-sql-translation) |
|||
* [ABP Entity Framework Core Integration](https://abp.io/docs/latest/framework/data/entity-framework-core) |
|||
* [ABP Entities](https://abp.io/docs/latest/framework/architecture/domain-driven-design/entities) |
|||
@ -0,0 +1,84 @@ |
|||
# Forwarded Headers |
|||
|
|||
Reverse proxies and load balancers play a crucial role in modern web application architectures. When an application is deployed behind these proxies and load balancers, several specific issues can arise. This document will discuss these issues in detail, explain how ASP.NET Core's forwarded headers middleware can address them, and provide a code example for configuring forwarded headers in an ABP application. |
|||
|
|||
## Possible problem in a Reverse Proxy Environment |
|||
|
|||
When requests pass through a reverse proxy or load balancer, the following common issues can occur: |
|||
|
|||
### 1. Loss of Original Request Information |
|||
|
|||
A reverse proxy or load balancer typically modifies the original HTTP request headers. For example, the proxy may replace the client's `X-Forwarded-For` header, or the `Host` header might be set to the proxy's address. This can result in the backend application being unable to directly access the client's IP address, the true hostname, and the protocol used. |
|||
|
|||
### 2. HTTPS vs HTTP Protocol Confusion |
|||
|
|||
When a request is forwarded by a proxy server, it is often upgraded to HTTPS to ensure secure transmission. The proxy server will send a header like `X-Forwarded-Proto` to indicate whether the original request was HTTP or HTTPS. If the backend application does not correctly handle this header, it may generate URLs with the wrong protocol. |
|||
|
|||
### 3. Path Handling Issues |
|||
|
|||
Since load balancers and proxies might modify or map the request URL paths differently, the backend application could encounter path inconsistencies. For example, a reverse proxy might forward a request from `/api` to `/myapp/api`. If the backend application is not correctly configured, path parsing errors may occur. |
|||
|
|||
### 4. IP Address and Security |
|||
|
|||
Reverse proxies might replace the original client IP address with their own, which can affect logging, authentication, and access control mechanisms. To retrieve the actual client IP address, the `X-Forwarded-For` header must be correctly parsed and trusted. |
|||
|
|||
### 5. Load Balancer Impact |
|||
|
|||
Load balancers might distribute requests to different backend servers using different algorithms. This can create session affinity problems. If session data is stored on a single server and the load balancer directs subsequent requests to different servers, session loss or inconsistency may occur. |
|||
|
|||
## Forwarded Headers Middleware in ABP web application |
|||
|
|||
To resolve the above issues, ASP.NET Core provides a built-in middleware, `ForwardedHeadersMiddleware`, which processes the headers forwarded by reverse proxies. This middleware helps the application recover the correct original request information, such as the client’s IP address, protocol, and host. |
|||
|
|||
### Configuring `ForwardedHeadersMiddleware` |
|||
|
|||
ASP.NET Core’s `ForwardedHeadersMiddleware` supports several HTTP headers: |
|||
|
|||
- **X-Forwarded-For**: Contains the original client’s IP address. |
|||
- **X-Forwarded-Proto**: Indicates whether the original request was HTTP or HTTPS. |
|||
- **X-Forwarded-Host**: Contains the original host requested by the client. |
|||
- **X-Forwarded-Port**: Indicates the original port of the request. |
|||
|
|||
To configure this middleware: |
|||
|
|||
1. In the `ConfigureServices` method of your module, configure the `ForwardedHeadersOptions`: |
|||
|
|||
```csharp |
|||
public override void ConfigureServices(ServiceConfigurationContext context) |
|||
{ |
|||
context.Services.Configure<ForwardedHeadersOptions>(options => |
|||
{ |
|||
options.ForwardedHeaders = ForwardedHeaders.XForwardedFor | ForwardedHeaders.XForwardedProto; |
|||
}); |
|||
} |
|||
``` |
|||
|
|||
2. In the `OnApplicationInitialization` method of your module, add the middleware: |
|||
|
|||
> Forwarded Headers Middleware should run before other middleware. This ordering ensures that the middleware relying on forwarded headers information can consume the header values for processing. Forwarded Headers Middleware can run after diagnostics and error handling, but it must be run before calling UseHsts: |
|||
|
|||
```csharp |
|||
public override void OnApplicationInitialization(ApplicationInitializationContext context) |
|||
{ |
|||
var app = context.GetApplicationBuilder(); |
|||
var env = context.GetEnvironment(); |
|||
|
|||
if (env.IsDevelopment()) |
|||
{ |
|||
app.UseDeveloperExceptionPage(); |
|||
app.UseForwardedHeaders(); |
|||
} |
|||
else |
|||
{ |
|||
app.UseErrorPage(); |
|||
app.UseForwardedHeaders(); |
|||
app.UseHsts(); |
|||
} |
|||
|
|||
// Other middleware configurations... |
|||
} |
|||
``` |
|||
|
|||
## References |
|||
|
|||
- [ASP.NET Core Proxy and Load Balancer Configuration](https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/proxy-load-balancer?view=aspnetcore-9.0) |
|||
|
Before Width: | Height: | Size: 8.5 KiB |
@ -0,0 +1,184 @@ |
|||
# Solution Templates: A Guide to Select the Right One For You |
|||
|
|||
ABP provides several [startup templates](index.md) to you. It is important to start with the right startup template that is suitable for your **project** and **team**. This guide aims to lead you to select the most proper startup template for your requirements. |
|||
|
|||
The following **architectures** will be discussed based on ABP startup templates: |
|||
|
|||
* **Single-Layer** (non-layered) application |
|||
* **N-Layered** application |
|||
* **Modular** application |
|||
* **Microservice** solution |
|||
|
|||
## What is a Startup Template? |
|||
|
|||
In the following section, you will understand what a startup template is and what it provides. |
|||
|
|||
### Pre-Architected Solution Structure |
|||
|
|||
A startup solution template is a **pre-architected** structure. For example, the [layered startup template](layered-web-application/index.md) is a great starting point if you want to build a layered application code-base based on [Domain-Driven Design](../framework/architecture/domain-driven-design/index.md) principles and patterns. |
|||
|
|||
However, starting with any startup template **doesn't limit you** on adding or removing projects, layers, integration packages, and creating other applications/services. You can even start with a [single-layer application template]() and convert it to a microservice solution. However, if you want to build a microservice solution, starting with the [microservice startup template](microservice/index.md) is the best. |
|||
|
|||
So, it is **best to start with the most suitable startup template** for your purpose and then modify the solution to fit your custom requirements. |
|||
|
|||
### Well-Structured Code Organization |
|||
|
|||
Besides the overall solution structure, the internals of each project in a solution template are well-structured. It is clear where will you place your [entities](../framework/architecture/domain-driven-design/entities.md), [repositories](../framework/architecture/domain-driven-design/repositories.md), [data access code](../framework/data/index.md), [application services](../framework/architecture/domain-driven-design/application-services.md), [API controllers](../framework/api-development/index.md), [UI elements](../framework/ui/index.md), etc. You don't spend time thinking about how to **organize your codebase** in every new project. If you prefer to build automated tests for your application, the test projects are also included and pre-configured. |
|||
|
|||
### Library Integrations & Configurations |
|||
|
|||
When you use ABP startup solution templates to create a new solution, some **fundamental library installations** ([Serilog](https://serilog.net/), [Autofac](https://autofac.org/), [AutoMapper](https://automapper.org/), [Swagger](https://swagger.io/), [HealthCheck](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks) and others..) and their fine-tuned configurations are already prepared for you. Also, required **[ABP packages](https://abp.io/packages)** are just installed based on your preferences and configured for **development and production environments**. |
|||
|
|||
### Development Ready |
|||
|
|||
When you create a new solution, or when a new teammate starts to work on your existing solution, it is pretty **easy to understand** the solution structure, design decisions and the development flow by the help of [solution structure documents](index.md) and [development tutorials](../tutorials/index.md). |
|||
|
|||
### Production Ready |
|||
|
|||
ABP's startup templates are ready for production out of the box. You can just create a new solution and **deploy it** to your production environment. It is not only about **technical readiness**, but also about **functional readiness**. |
|||
|
|||
When you create a new ABP solution, **fundamental modules are already installed**. Your application has a robust [account module](../modules/account.md) (user registration, login, social logins, 2-factor authentication, user lockout, password complexity control...), an advanced [identity module](../modules/identity.md) (user, role and permission management), and many other production-ready [pre-built application modules](../modules/index.md) are just working as a part your application in the first day. |
|||
|
|||
## The Startup Solution Templates |
|||
|
|||
Up to this point, it is explained what a startup template is and the features it offers. In the following section, you will see the types of startup solution templates and **which one is best for you**. |
|||
|
|||
### Single-Layer Application Solution Template |
|||
|
|||
The [single-layer solution template](single-layer-web-application/index.md) is the simplest. It provides a **minimal solution architecture** while starting a new project. Your .NET solution typically contains a **single, or a few .NET projects** depending on your UI and other preferences while creating your solution. |
|||
|
|||
The following figure shows a single-project web application that has [MVC (Razor Pages) UI](../framework/ui/mvc-razor-pages/overall.md) and [Entity Framework Core](../framework/data/entity-framework-core/index.md) database provider with the default configuration: |
|||
|
|||
 |
|||
|
|||
As you see in the preceding figure, all the application code (entities, data access, services, UI pages, etc.) are located in a **single .NET project**. |
|||
|
|||
#### When Should You Start a Single-Layer Solution Template? |
|||
|
|||
In the following conditions, you may consider to use the single-layer solution template: |
|||
|
|||
* If **your project is small** and you don't expect that it will grow by the time. But remember that many projects are thought of as small in the beginning. |
|||
* If your project is a **temporary project** and it will be trash in a short time. It can be a POC project or a temporary application for a demo or advertisement campaign. |
|||
* If you are a **single developer** or there are only 2-3 developers working on your solution, and these developers are not experienced and are not willing to understand the structure and benefits of a layered application. |
|||
|
|||
If the preceding conditions are met with your case, you can consider starting with this solution template. |
|||
However, keep in mind that your solution can quickly become a **[big ball of mud](https://thedomaindrivendesign.io/big-ball-of-mud/)**. |
|||
We think that only a **very small portion of applications** are suitable for that kind of solution structure. |
|||
|
|||
Note that the single-layer solution template doesn't provide the following options/features: |
|||
|
|||
* Mobile application integration |
|||
* Public website (a second web application for landing page of your product) |
|||
* Tiered architecture (for MVC applications, separates UI and service layers) |
|||
* Separate tenant schema (for multi-tenant applications) |
|||
* Kubernetes / Helm configuration |
|||
* Automated (unit/integration) test projects |
|||
|
|||
These options are not implemented to keep the solution structure as simple as possible. If you need some of these, please feel free to use the layered solution template. |
|||
|
|||
### Layered Solution Template |
|||
|
|||
The [layered application startup template](layered-web-application/index.md) is a .NET solution that consists of several projects. |
|||
Each project represents a layer of the application or has a specific functionality for the solution. |
|||
|
|||
The exact project count in your solution depends on the options you have selected. |
|||
The following figure shows a solution with [MVC (Razor Pages) UI](../framework/ui/mvc-razor-pages/overall.md) and [Entity Framework Core](../framework/data/entity-framework-core/index.md) database provider with the default configuration: |
|||
|
|||
 |
|||
|
|||
The solution is layered based on Domain-Driven Design principles and extended based on real-world business application requirements. It includes test projects for each layer. Layering the solution has great benefits: |
|||
|
|||
* It makes your business code (domain & application layers) independent from infrastructure (UI and database) that makes it more **maintainable and long-living**. |
|||
* Different developers can **focus on different layers**. It is valuable when multiple developers (with different roles) touching to the same solution. |
|||
* It **separate concerns**, so you can focus on a single concern at a time. You can optimize your data access code without touching other layers, you can change your UI code without breaking your business logic. |
|||
* It provides **maximum code reusability**. If you have multiple applications (e.g. one back office application, one end-user application, and a mobile application), it is easy to separate these application's codebases (simply create new application & UI layers for each application type) while they can share the same domain and data access layers. |
|||
* Separating **UI layer** gives an opportunity to **replace/modify** it in the future without affecting other parts of your solution. You know, UI is the fastest changing technology in software industry. |
|||
|
|||
While it may seem a little complicated at the beginning, once you **complete the [Book Store tutorial](../tutorials/book-store/index.md)**, you will easily understand the purpose and usage of each project. |
|||
|
|||
#### When Should You Start a Layered Solution Template? |
|||
|
|||
In the following conditions, you may consider to use the layered solution template: |
|||
|
|||
* If your project **code-base** is relatively **larger**. |
|||
* If your project is **relatively complex** and involves multiple business domains or complex workflows. |
|||
* If your project is a **long-term** project and you want to design it as **maintainable** for long years. |
|||
* If you are **a team of developers** working on your solution. When multiple teams or developers work on different parts of the system. |
|||
* If your solution will have **multiple** web, mobile or other type of **applications** that need to **share** the same business logic. |
|||
* If your project needs **scalability**, solutions that may need to scale in functionality or user load over time. |
|||
* If your project needs **extensibility**, which requires the addition of new features or integration with third-party services. |
|||
|
|||
### Modular Monolith Applications |
|||
|
|||
ABP does not provide a specific modular monolith application startup template. However, it is not needed. Let us explain why. |
|||
|
|||
The ABP Framework and [ABP Studio](../studio/index.md) are already designed to support modular application development from their beginning. ABP framework provides all the **necessary infrastructure** for [modularity](../framework/architecture/modularity/basics.md) and all other framework features are **compatible with modular solutions**. |
|||
|
|||
On the other hand, the main purpose of ABP Studio's [Solution Explorer panel](../studio/solution-explorer.md) is to **architect and build modular and complex software solutions**. You can easily create new modules, arrange dependencies between the modules and import/install these modules into a monolith application. While you can do all these manually yourself, ABP Studio makes it extremely easy to do and understand it. |
|||
|
|||
#### How to Build a Modular Monolith Application? |
|||
|
|||
A **modular monolith** application consists of a **single host** application and **multiple sub-modules**. Typically, each module has its own .NET solution that contains the code related to that module. So, the general structure is shown in the following figure: |
|||
|
|||
 |
|||
|
|||
In this example, `MyCrm.Host` is an almost-empty host application that has package references to other modules. Every module consists of two packages: implementation and contract packages. |
|||
|
|||
You can follow the steps below to create such a modular solution with ABP Studio: |
|||
|
|||
* **Create a new application** using either [single-layer](single-layer-web-application/index.md) or [layered](layered-web-application/index.md) application startup template. That application will be the **host application** of your solution. |
|||
* **Create new modules** (right-click to the solution root, select the *Add* -> *New Module* -> ... command). |
|||
* **Import & Install** these **modules** to the host application. |
|||
|
|||
> You can follow the **[Modular Monolith Application Development Tutorial](../tutorials/modular-crm/index.md)** to learn how to build a modular application step by step. |
|||
|
|||
#### Which Startup Template should be used for a Modular Application? |
|||
|
|||
So, both [single-layer](single-layer-web-application/index.md) and [layered](layered-web-application/index.md) application startup templates are inherently modular. Just use one of them and start your modular solution. You may wonder which one to start: |
|||
|
|||
* Use the **[single-layer startup template](single-layer-web-application/index.md)** for the host application of your modular monolith if you will leave the host application as empty. It will contain some configuration code of course, but it won't contain any actual application code. **This is the suggested approach.** |
|||
* Use the **[layered application startup template](layered-web-application/index.md)** if you will write some application code into the hosting application. You may want to write some code that makes multiple module operations that are not easy to implement in a particular module. In that case, a layered hosting application will be a better way to organize your codebase. However, this approach can quickly move your solution away from a modular system. So, take your own risk. |
|||
|
|||
#### When Should You Start a Modular Monolith Application? |
|||
|
|||
In the following conditions, you may consider to build a modular software solution: |
|||
|
|||
* If your **domain is too complex** to develop and maintain in a single monolith codebase. |
|||
* If your business domain has clear functional boundaries and is possible to **split into sub-domains**. |
|||
* If you have **multiple teams** that will work on the solution. |
|||
* When you need to **reduce complexity** early on. And if you are considering migrating your application to a **microservice system**. |
|||
|
|||
While all these are also suitable for microservice solutions (which will be discussed in the next section), a modular solution is more suitable than microservices for most of the projects. |
|||
Especially if you don't need to have technology diversity, deploy and scale services independently and serve too many users concurrently with a fault-tolerant system, a modular monolith application would be a better choice to not deal with the complexity of a microservice system. Also, it is better to start with a thin architecture when you have a small team that can focus on building features without spending time managing distributed architecture complexities. Another advantage is that the modular monoliths avoid the network latency and communication overhead inherent in microservices, so debugging and monitoring are easier as all modules run within a single application. In summary, if you anticipate that your application may grow to require a microservices architecture in the future, a modular monolith is a great starting point. |
|||
|
|||
> Build for Now, Scale for Tomorrow |
|||
|
|||
Even if you are considering building a microservice architecture, it is usually advised to [start with a monolith modular first](https://martinfowler.com/bliki/MonolithFirst.html), then migrate to microservices later once your business and module boundaries are more stable. |
|||
|
|||
### Microservice Solution Template |
|||
|
|||
ABP's [microservice startup template](microservice/index.md) includes multiple services, API gateways and applications that are well integrated into each other and ready to be a great **base solution for your microservice system**. |
|||
In the following picture, you can see an overall diagram that shows the main components of the solution (they vary based on the options while you are creating your solution): |
|||
|
|||
 |
|||
|
|||
#### When Should You Start a Microservice Solution Template? |
|||
|
|||
In the following conditions, you may consider to build a microservice system: |
|||
|
|||
* If your **domain is too complex** to develop and maintain in a single monolith codebase. |
|||
* If your business domain is possible to **split into sub-domains**. |
|||
* If you have **multiple teams** that will work on the solution in parallel. |
|||
* If you need to **develop**, **test**, **deploy** and **scale services** independently. |
|||
* If you need to use **multiple technology stacks** so, some services can be built with .NET, and others can be built with Java, Python, etc... |
|||
* If you need to serve **too many users** concurrently with a **high available** and **fault tolerant** system. |
|||
* If you have **DevOps** knowledge and culture in your company. If you can deal with **complex** development, build, test, deployment and production environments. |
|||
|
|||
**Use Case Examples** |
|||
* **E-Commerce Platforms**: Separate services for cart, checkout, inventory, and shipping. |
|||
* **Streaming Services**: Modules for content delivery, user preferences, and recommendations. |
|||
* **SaaS Platforms**: Independent services for billing, user accounts, and analytics. |
|||
|
|||
## Conclusion |
|||
|
|||
In summary, the ABP Platform offers a variety of solution templates tailored to different architectural needs, including layered applications, microservices, and modular development. These templates provide a great foundation for building robust applications by implementing best practices and providing essential features. By selecting the right template, you can streamline the development process, ensuring scalability and maintainability in your project. |
|||
|
After Width: | Height: | Size: 159 KiB |
|
After Width: | Height: | Size: 7.7 KiB |
|
After Width: | Height: | Size: 12 KiB |
@ -1,12 +1,21 @@ |
|||
# Solution Templates |
|||
|
|||
ABP provides pre-architected and production-ready templates to jump start a new solution. The following solution templates are provided out of the box: |
|||
ABP provides pre-architected and production-ready templates to jump start a new solution. |
|||
|
|||
* **[Single-Layer Solution](single-layer-web-application)**: A single-project solution. Recommended for building an application with a **simpler and easy to understand** architecture. |
|||
* **[Layered Solution](layered-web-application)**: A fully layered (multiple projects) solution based on [Domain Driven Design](../framework/architecture/domain-driven-design) practices. Recommended for long-term projects that need a **maintainable and extensible** codebase. |
|||
* **[Microservice Solution](microservice)**: A **distributed solution** to build **microservice systems**. It includes pre-built services, API gateways, web and mobile applications, Kubernetes and Helm configuration, and everything you need to start your large-scale microservice solution. |
|||
* **[Application Module](application-module)**: A template that can be used to create a **reusable [application module](../modules)** based on the [module development best practices & conventions](../framework/architecture/best-practices). It is also suitable for creating **services** (with or without UI). |
|||
> **You can see the [Solution Template Selection Guide](guide.md) if you are not sure which solution template is suitable for you.** |
|||
|
|||
The following solution templates are provided out of the box: |
|||
|
|||
* **[Single-Layer Solution](single-layer-web-application/index.md)**: A single-project solution. Recommended for building an application with a **simpler and easy to understand** architecture. |
|||
* **[Layered Solution](layered-web-application/index.md)**: A fully layered (multiple projects) solution based on [Domain Driven Design](../framework/architecture/domain-driven-design) practices. Recommended for long-term projects that need a **maintainable and extensible** codebase. |
|||
* **[Microservice Solution](microservice/index.md)**: A **distributed solution** to build **microservice systems**. It includes pre-built services, API gateways, web and mobile applications, Kubernetes and Helm configuration, and everything you need to start your large-scale microservice solution. |
|||
* **[Application Module](application-module/index.md)**: A template that can be used to create a **reusable [application module](../modules/index.md)** based on the [module development best practices & conventions](../framework/architecture/best-practices/index.md). It is also suitable for creating **services** (with or without UI). |
|||
* **Others** |
|||
- [MAUI Application](../get-started/maui.md) |
|||
- [WPF Application](../get-started/wpf.md) |
|||
- [Console Application](../get-started/console.md) |
|||
- [Console Application](../get-started/console.md) |
|||
|
|||
## See Also |
|||
|
|||
* [Solution Template Selection Guide](guide.md) |
|||
* [Get Started with ABP Platform](../get-started/index.md) |
|||
|
After Width: | Height: | Size: 66 KiB |
|
After Width: | Height: | Size: 27 KiB |
@ -1,19 +0,0 @@ |
|||
# ABP Studio and ABP Solution Templates Version Compatibility |
|||
|
|||
This document provides an overview of the compatibility between various versions of ABP Studio and [ABP Solution Templates](../solution-templates/index.md). Use this reference to ensure that you are using the correct versions of ABP Studio and ABP for your projects. |
|||
|
|||
| **ABP Studio Version** | **ABP Version** | |
|||
|------------------------|---------------------------| |
|||
| 0.9.2 | 8.3.2 | |
|||
| 0.8.4 - 0.9.1 | 8.3.1 | |
|||
| 0.8.1 to 0.8.3 | 8.3.0 | |
|||
| 0.8.0 | 8.2.3 | |
|||
| 0.7.8 - 0.7.9 | 8.2.2 | |
|||
| 0.7.4 to 0.7.7 | 8.2.1 | |
|||
| 0.7.0 to 0.7.3 | 8.2.0 | |
|||
| 0.6.8 - 0.6.9 | 8.1.3 | |
|||
| 0.6.7 | 8.1.1 | |
|||
|
|||
By default, ABP Studio uses stable versions to create solutions. Therefore, if you want to create a solution with a preview version, first you need to create a solution and then switch your solution to the preview version from the ABP Studio UI: |
|||
|
|||
 |
|||
@ -0,0 +1,24 @@ |
|||
# ABP Studio and ABP Startup Template Version Mappings |
|||
|
|||
This document provides a general overview of the relationship between various versions of ABP Studio and the ABP version of the [ABP Solution Templates](../solution-templates/index.md) used when generating a new solution. Each version of ABP Studio is configured to create solutions with a specific ABP version. However, once a solution is created, you can easily update it to the latest version of ABP via ABP Studio or [ABP CLI](../cli/index.md#update). |
|||
|
|||
| **ABP Studio Version** | **ABP Version of Startup Template** | |
|||
|------------------------|---------------------------| |
|||
| 0.9.9 to 0.9.13 | 9.0.0 | |
|||
| 0.9.8 | 8.3.4 | |
|||
| 0.9.5 to 0.9.7 | 8.3.3 | |
|||
| 0.9.2 to 0.9.4 | 8.3.2 | |
|||
| 0.8.4 - 0.9.1 | 8.3.1 | |
|||
| 0.8.1 to 0.8.3 | 8.3.0 | |
|||
| 0.8.0 | 8.2.3 | |
|||
| 0.7.8 - 0.7.9 | 8.2.2 | |
|||
| 0.7.4 to 0.7.7 | 8.2.1 | |
|||
| 0.7.0 to 0.7.3 | 8.2.0 | |
|||
| 0.6.8 - 0.6.9 | 8.1.3 | |
|||
| 0.6.7 | 8.1.1 | |
|||
|
|||
# Working with ABP's Preview Versions |
|||
|
|||
By default, ABP Studio uses stable versions to create solutions. Therefore, if you want to create a solution with a preview version, first you need to create a solution and then switch your solution to the preview version from the ABP Studio UI: |
|||
|
|||
 |
|||
|
After Width: | Height: | Size: 144 KiB |
|
After Width: | Height: | Size: 57 KiB |
|
After Width: | Height: | Size: 33 KiB |
|
After Width: | Height: | Size: 48 KiB |
|
After Width: | Height: | Size: 29 KiB |
|
After Width: | Height: | Size: 21 KiB |
|
After Width: | Height: | Size: 24 KiB |
|
After Width: | Height: | Size: 117 KiB |
|
After Width: | Height: | Size: 29 KiB |
|
After Width: | Height: | Size: 93 KiB |
|
After Width: | Height: | Size: 26 KiB |
|
After Width: | Height: | Size: 81 KiB |
|
After Width: | Height: | Size: 178 KiB |
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue