From 58227186f8bda6f663ce1acd2ed201c31bf5cefa Mon Sep 17 00:00:00 2001
From: maliming <malimings@gmail.com>
Date: Mon, 18 Apr 2022 17:27:36 +0800
Subject: [PATCH] Add `Bootstrap-Modules.md`

---
 docs/en/Bootstrap-Modules.md                  | 128 ++++++++++++++++++
 .../Getting-Started-AspNetCore-Application.md |  22 ++-
 docs/en/docs-nav.json                         |   4 +
 3 files changed, 140 insertions(+), 14 deletions(-)
 create mode 100644 docs/en/Bootstrap-Modules.md

diff --git a/docs/en/Bootstrap-Modules.md b/docs/en/Bootstrap-Modules.md
new file mode 100644
index 0000000000..904197e4e3
--- /dev/null
+++ b/docs/en/Bootstrap-Modules.md
@@ -0,0 +1,128 @@
+# Bootstrap Modules
+
+ABP framework can be bootstrapped in various applications. like ASP NET Core or Console, WPF, etc.
+
+Modules can be started sync or async, Corresponds to various event methods in the module. We recommend using **async**, Especially if you want to make async calls in the module's methods.
+
+The `PreConfigureServices`, `ConfigureServices`, `PostConfigureServices`, `OnPreApplicationInitialization`, `OnApplicationInitialization`, `OnPostApplicationInitialization` methods of module have the Async version. 
+
+> Async methods automatically call sync methods by default.
+
+If you use async methods in your module, please keep the same sync methods for compatibility.
+
+````csharp
+public async override Task OnApplicationInitializationAsync(ApplicationInitializationContext context)
+{
+    await AsyncMethod();
+}
+
+public override void OnApplicationInitialization(ApplicationInitializationContext context)
+{
+    AsyncHelper.RunSync(() => OnApplicationInitializationAsync(context));
+}
+````
+
+## ASP NET Core
+
+Bootstrap ABP by using [WebApplication](https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builder.webapplication?view=aspnetcore-6.0) 
+
+````csharp
+var builder = WebApplication.CreateBuilder(args);
+builder.Host.AddAppSettingsSecretsJson()
+    .UseAutofac();
+
+await builder.Services.AddApplicationAsync<MyProjectNameWebModule>();
+var app = builder.Build();
+
+await app.InitializeApplicationAsync();
+await app.RunAsync();
+````
+
+## Console
+
+Bootstrap ABP in Console App.
+
+````csharp
+var abpApplication = await AbpApplicationFactory.CreateAsync<MyProjectNameModule>(options =>
+{
+    options.UseAutofac();
+});
+
+await _abpApplication.InitializeAsync();
+
+var helloWorldService = _abpApplication.ServiceProvider.GetRequiredService<HelloWorldService>();
+
+await helloWorldService.SayHelloAsync();
+````
+
+Bootstrap ABP by using [HostedService](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/host/hosted-services?view=aspnetcore-6.0&tabs=visual-studio#ihostedservice-interface) 
+
+````csharp
+public class MyHostedService : IHostedService
+{
+    private IAbpApplicationWithInternalServiceProvider _abpApplication;
+
+    private readonly IConfiguration _configuration;
+    private readonly IHostEnvironment _hostEnvironment;
+
+    public MyHostedService(IConfiguration configuration, IHostEnvironment hostEnvironment)
+    {
+        _configuration = configuration;
+        _hostEnvironment = hostEnvironment;
+    }
+
+    public async Task StartAsync(CancellationToken cancellationToken)
+    {
+        _abpApplication = await AbpApplicationFactory.CreateAsync<MyProjectNameModule>(options =>
+        {
+            options.Services.ReplaceConfiguration(_configuration);
+            options.Services.AddSingleton(_hostEnvironment);
+
+            options.UseAutofac();
+            options.Services.AddLogging(loggingBuilder => loggingBuilder.AddSerilog());
+        });
+
+        await _abpApplication.InitializeAsync();
+
+        var helloWorldService = _abpApplication.ServiceProvider.GetRequiredService<HelloWorldService>();
+
+        await helloWorldService.SayHelloAsync();
+    }
+
+    public async Task StopAsync(CancellationToken cancellationToken)
+    {
+        await _abpApplication.ShutdownAsync();
+    }
+}
+````
+
+## WPF
+
+Bootstrap ABP on [OnStartup](https://docs.microsoft.com/en-us/dotnet/api/system.windows.application.onstartup?view=windowsdesktop-6.0) method.
+
+````csharp
+public partial class App : Application
+{
+    private IAbpApplicationWithInternalServiceProvider _abpApplication;
+
+    protected async override void OnStartup(StartupEventArgs e)
+    {
+        _abpApplication =  await AbpApplicationFactory.CreateAsync<MyProjectNameModule>(options =>
+        {
+            options.UseAutofac();
+            options.Services.AddLogging(loggingBuilder => loggingBuilder.AddSerilog(dispose: true));
+        });
+
+        await _abpApplication.InitializeAsync();
+
+        _abpApplication.Services.GetRequiredService<MainWindow>()?.Show();
+    }
+
+    protected async override void OnExit(ExitEventArgs e)
+    {
+        await _abpApplication.ShutdownAsync();
+    }
+}
+
+````
+
diff --git a/docs/en/Getting-Started-AspNetCore-Application.md b/docs/en/Getting-Started-AspNetCore-Application.md
index c5b72a6c1d..ef14fd0c54 100644
--- a/docs/en/Getting-Started-AspNetCore-Application.md
+++ b/docs/en/Getting-Started-AspNetCore-Application.md
@@ -77,20 +77,17 @@ using BasicAspNetCoreApplication;
 
 var builder = WebApplication.CreateBuilder(args);
 
-builder.Services.ReplaceConfiguration(builder.Configuration);
-
-builder.Services.AddApplication<AppModule>();
+await builder.Services.AddApplicationAsync<AppModule>();
 
 var app = builder.Build();
 
-app.InitializeApplication();
-
-app.Run();
+await app.InitializeApplicationAsync();
+await app.RunAsync();
 ````
 
-``builder.Services.AddApplication<AppModule>();`` adds all services defined in all modules starting from the ``AppModule``.
+``builder.Services.AddApplicationAsync<AppModule>();`` adds all services defined in all modules starting from the ``AppModule``.
 
-``app.InitializeApplication()`` initializes and starts the application.
+``app.InitializeApplicationAsync()`` initializes and starts the application.
 
 ## Run the Application!
 
@@ -128,15 +125,12 @@ var builder = WebApplication.CreateBuilder(args);
 
 builder.Host.UseAutofac();  //Add this line
 
-builder.Services.ReplaceConfiguration(builder.Configuration);
-
-builder.Services.AddApplication<AppModule>();
+await builder.Services.AddApplicationAsync<AppModule>();
 
 var app = builder.Build();
 
-app.InitializeApplication();
-
-app.Run();
+await app.InitializeApplicationAsync();
+await app.RunAsync();
 
 ````
 
diff --git a/docs/en/docs-nav.json b/docs/en/docs-nav.json
index 8c08724b62..f553cad14a 100644
--- a/docs/en/docs-nav.json
+++ b/docs/en/docs-nav.json
@@ -426,6 +426,10 @@
               "text": "Basics",
               "path": "Module-Development-Basics.md"
             },
+            {
+              "text": "Bootstrap",
+              "path": "Bootstrap-Modules.md"
+            },
             {
               "text": "Plug-In Modules",
               "path": "PlugIn-Modules.md"