feat(I18n): Support I18N

Author: zhenlei520

src/BuildingBlocks/Data/Masa.BuildingBlocks.Data/Constants/ErrorCode.cs

@@ -236,7 +236,7 @@ static ErrorCode()
         {
             var errorMessage = AttributeUtils.GetDescriptionByField(field);
 
-            _errorCodeMessageDictionary.Add(field.GetRawConstantValue()!.ToString(), errorMessage);
+            _errorCodeMessageDictionary.Add(field.GetRawConstantValue()!.ToString()!, errorMessage);
         }
     }
 

src/BuildingBlocks/Globalization/Masa.BuildingBlocks.Globalization.I18N/CultureModel.cs

@@ -7,11 +7,11 @@ public class CultureModel
 {
     public string Culture { get; set; }
 
-    public string DisplayName { get; set; }
+    public string? DisplayName { get; set; }
 
     public string Icon { get; set; }
 
-    public CultureModel(string culture, string displayName, string? icon = null)
+    public CultureModel(string culture, string? displayName = null, string? icon = null)
     {
         Culture = culture;
         DisplayName = displayName;

src/BuildingBlocks/Globalization/Masa.BuildingBlocks.Globalization.I18N/DefaultLanguageProvider.cs

@@ -8,6 +8,12 @@ public class DefaultLanguageProvider : ILanguageProvider
     private readonly II18N<MasaLanguageResource> _i18N;
     private readonly IOptions<CultureSettings> _options;
 
+    private static Dictionary<string, string> _languages = new()
+    {
+        { "en-US", "English (United States)" },
+        { "zh-CN", "中文 (简体)" }
+    };
+
     public DefaultLanguageProvider(II18N<MasaLanguageResource> i18N, IOptions<CultureSettings> options)
     {
         _i18N = i18N;
@@ -24,7 +30,7 @@ public IReadOnlyList<LanguageInfo> GetLanguages()
                 nameof(LanguageInfo.UIDisplayName) :
                 $"{culture.Culture}\\.{nameof(LanguageInfo.UIDisplayName)}";
             var uiDisplayName = _i18N.T(key);
-            var languageInfo = new LanguageInfo(culture.Culture, culture.DisplayName, culture.Icon)
+            var languageInfo = new LanguageInfo(culture.Culture, culture.DisplayName ?? GetDisplayName(cultureName), culture.Icon)
             {
                 UIDisplayName = uiDisplayName
             };
@@ -33,4 +39,12 @@ public IReadOnlyList<LanguageInfo> GetLanguages()
         });
         return list;
     }
+
+    private static string GetDisplayName(string cultureName)
+    {
+        if (_languages.TryGetValue(cultureName, out string? displayName))
+            return displayName;
+
+        return string.Empty;
+    }
 }

src/BuildingBlocks/Globalization/Masa.BuildingBlocks.Globalization.I18N/I18N.cs

@@ -7,9 +7,12 @@ public static class I18N
 {
     private static readonly IServiceProvider _serviceProvider = MasaApp.RootServiceProvider;
     private static readonly II18N _i18N = InitI18N();
+    private static readonly ILanguageProvider _languageProvider = InitLanguage();
 
     static II18N InitI18N() => _serviceProvider.GetRequiredService<II18N>();
 
+    static ILanguageProvider InitLanguage() => _serviceProvider.GetRequiredService<ILanguageProvider>();
+
     /// <summary>
     /// Gets the string resource with the given name.
     /// </summary>
@@ -77,4 +80,6 @@ public static class I18N
     /// </summary>
     /// <param name="culture"></param>
     public static void SetUiCulture(CultureInfo culture) => _i18N.SetUiCulture(culture);
+
+    public static IReadOnlyList<LanguageInfo> GetLanguages() => _languageProvider.GetLanguages();
 }

src/BuildingBlocks/Globalization/Masa.BuildingBlocks.Globalization.I18N/I18NResource.cs

@@ -9,15 +9,15 @@ public class I18NResource
 
     public Type ResourceType { get; }
 
-    public IEnumerable<Type> BaseResourceTypes { get; }
+    public List<Type> BaseResourceTypes { get; private set; }
 
     public IEnumerable<Assembly> Assemblies { get; set; } = new List<Assembly>();
 
     public I18NResource(Type resourceType, IEnumerable<Type> baseResourceTypes)
     {
         _dictionary = new(StringComparer.OrdinalIgnoreCase);
         ResourceType = resourceType;
-        BaseResourceTypes = baseResourceTypes;
+        BaseResourceTypes = baseResourceTypes.ToList();
     }
 
     public void AddContributor(string cultureName, II18NResourceContributor localizationResourceContributor)
@@ -37,4 +37,16 @@ public void AddContributor(string cultureName, II18NResourceContributor localiza
 
         return null;
     }
+
+    public void TryAddBaseResourceTypes<TBaseResourceType>() where TBaseResourceType : class
+        => TryAddBaseResourceTypes(typeof(TBaseResourceType));
+
+    public void TryAddBaseResourceTypes(params Type[] resourceTypes)
+    {
+        foreach (var type in resourceTypes)
+        {
+            if (!BaseResourceTypes.Contains(type))
+                BaseResourceTypes.Add(type);
+        }
+    }
 }

src/Contrib/Dispatcher/Masa.Contrib.Dispatcher.Events.FluentValidation/Middleware/ValidatorMiddleware.cs

@@ -8,10 +8,10 @@ namespace Masa.Contrib.Dispatcher.Events;
 public class ValidatorMiddleware<TEvent> : Middleware<TEvent>
     where TEvent : IEvent
 {
-    private readonly ILogger<ValidatorMiddleware<TEvent>> _logger;
+    private readonly ILogger<ValidatorMiddleware<TEvent>>? _logger;
     private readonly IEnumerable<IValidator<TEvent>> _validators;
 
-    public ValidatorMiddleware(IEnumerable<IValidator<TEvent>> validators, ILogger<ValidatorMiddleware<TEvent>> logger)
+    public ValidatorMiddleware(IEnumerable<IValidator<TEvent>> validators, ILogger<ValidatorMiddleware<TEvent>>? logger = null)
     {
         _validators = validators;
         _logger = logger;
@@ -21,7 +21,7 @@ public override async Task HandleAsync(TEvent @event, EventHandlerDelegate next)
     {
         var typeName = @event.GetType().FullName;
 
-        _logger.LogDebug("----- Validating command {CommandType}", typeName);
+        _logger?.LogDebug("----- Validating command {CommandType}", typeName);
 
         var failures = _validators
             .Select(v => v.Validate(@event))
@@ -31,7 +31,7 @@ public override async Task HandleAsync(TEvent @event, EventHandlerDelegate next)
 
         if (failures.Any())
         {
-            _logger.LogError("Validation errors - {CommandType} - Event: {@Command} - Errors: {@ValidationErrors}",
+            _logger?.LogError("Validation errors - {CommandType} - Event: {@Command} - Errors: {@ValidationErrors}",
                 typeName,
                 @event,
                 failures);

src/Contrib/Exception/Masa.Contrib.Exceptions/Extensions/ApplicationBuilderExtensions.cs

@@ -5,6 +5,7 @@
 
 namespace Microsoft.AspNetCore.Builder;
 
+[ExcludeFromCodeCoverage]
 public static class ApplicationBuilderExtensions
 {
     /// <summary>

src/Contrib/Exception/Masa.Contrib.Exceptions/Extensions/MvcBuilderExtensions.cs

@@ -5,6 +5,7 @@
 
 namespace Microsoft.Extensions.DependencyInjection;
 
+[ExcludeFromCodeCoverage]
 public static class MvcBuilderExtensions
 {
     public static IMvcBuilder AddMasaExceptionHandler(this IMvcBuilder builder)

src/Contrib/Exception/Masa.Contrib.Exceptions/Handlers/ExceptionHandlerMiddleware.cs

@@ -5,6 +5,7 @@
 
 namespace Microsoft.AspNetCore.Builder;
 
+[ExcludeFromCodeCoverage]
 public class ExceptionHandlerMiddleware
 {
     private readonly RequestDelegate _next;

src/Contrib/Exception/Masa.Contrib.Exceptions/Handlers/MvcGlobalExceptionFilter.cs

@@ -8,6 +8,7 @@ namespace Microsoft.AspNetCore.Mvc.Filters;
 /// <summary>
 /// Mvc pipeline exception filter to catch global exception
 /// </summary>
+[ExcludeFromCodeCoverage]
 public class MvcGlobalExceptionFilter : IExceptionFilter
 {
     private readonly IServiceProvider _serviceProvider;

src/Contrib/Exception/Masa.Contrib.Exceptions/Internal/Constant.cs

@@ -6,6 +6,4 @@ namespace Masa.Contrib.Exceptions.Internal;
 internal static class Constant
 {
     public const string DEFAULT_HTTP_CONTENT_TYPE = "text/plain; charset=utf-8";
-
-    // public const string DEFAULT_EXCEPTION_MESSAGE = "An error occur in masa framework.";
 }

src/Contrib/Exception/Masa.Contrib.Exceptions/Internal/ExceptionExtensions.cs

@@ -3,6 +3,7 @@
 
 namespace Masa.Contrib.Exceptions.Internal;
 
+[ExcludeFromCodeCoverage]
 internal static class ExceptionExtensions
 {
     public static int GetHttpStatusCode(this Exception exception)

src/Contrib/Exception/Masa.Contrib.Exceptions/Internal/HttpResponseExtensions.cs

@@ -3,6 +3,7 @@
 
 namespace Masa.Contrib.Exceptions.Internal;
 
+[ExcludeFromCodeCoverage]
 internal static class HttpResponseExtensions
 {
     /// <summary>

src/Contrib/Exception/Masa.Contrib.Exceptions/Internal/LoggerExtensions.cs

@@ -5,6 +5,7 @@
 
 namespace System;
 
+[ExcludeFromCodeCoverage]
 internal static class LoggerExtensions
 {
     public static void WriteLog(

src/Contrib/Exception/Masa.Contrib.Exceptions/Internal/ServiceProviderExtensions.cs

@@ -3,6 +3,7 @@
 
 namespace Masa.Contrib.Exceptions.Internal;
 
+[ExcludeFromCodeCoverage]
 internal static class ServiceProviderExtensions
 {
     public static IMasaExceptionHandler? GetMasaExceptionHandler(this IServiceProvider serviceProvider, Type? masaExceptionHandlerType)

src/Contrib/Exception/Masa.Contrib.Exceptions/MasaExceptionContext.cs

@@ -5,6 +5,7 @@
 
 namespace System;
 
+[ExcludeFromCodeCoverage]
 public class MasaExceptionContext
 {
     public IServiceProvider ServiceProvider { get; set; }

src/Contrib/Exception/Masa.Contrib.Exceptions/Options/MasaExceptionHandlerOptions.cs

@@ -5,6 +5,7 @@
 
 namespace System;
 
+[ExcludeFromCodeCoverage]
 public class MasaExceptionHandlerOptions
 {
     public bool CatchAllException { get; set; } = true;

src/Contrib/Exception/Masa.Contrib.Exceptions/Options/MasaExceptionLogRelationOptions.cs

@@ -5,9 +5,10 @@
 
 namespace System;
 
+[ExcludeFromCodeCoverage]
 public class MasaExceptionLogRelationOptions
 {
-    internal Dictionary<Type, LogLevel> Mappings { get; } = new();
+    private Dictionary<Type, LogLevel> Mappings { get; } = new();
 
     public MasaExceptionLogRelationOptions MapLogLevel<TException>(LogLevel logLevel) where TException : Exception
     {

src/Contrib/Exception/Masa.Contrib.Exceptions/Results/DefaultExceptionResult.cs

@@ -5,6 +5,7 @@
 
 namespace Microsoft.AspNetCore.Mvc;
 
+[ExcludeFromCodeCoverage]
 public class DefaultExceptionResult : IActionResult
 {
     public string Message { get; set; }

src/Contrib/Exception/Masa.Contrib.Exceptions/Results/InternalServerErrorObjectResult.cs

@@ -5,6 +5,7 @@
 
 namespace Microsoft.AspNetCore.Mvc;
 
+[ExcludeFromCodeCoverage]
 public class InternalServerErrorObjectResult : ObjectResult
 {
     public InternalServerErrorObjectResult(object obj)

src/Contrib/Exception/Masa.Contrib.Exceptions/Results/UserFriendlyExceptionResult.cs

@@ -5,6 +5,7 @@
 
 namespace Microsoft.AspNetCore.Mvc;
 
+[ExcludeFromCodeCoverage]
 public class UserFriendlyExceptionResult : IActionResult
 {
     public string Message { get; set; }

src/Contrib/Exception/Masa.Contrib.Exceptions/_Imports.cs

@@ -10,6 +10,7 @@
 global using Microsoft.Extensions.DependencyInjection;
 global using Microsoft.Extensions.Logging;
 global using Microsoft.Extensions.Options;
+global using System.Diagnostics.CodeAnalysis;
 global using System.Net;
 global using System.Reflection;
 global using System.Text;

src/Contrib/Globalization/Masa.Contrib.Globalization.I18N.AspNetCore/Extensions/ApplicationBuilderExtensions.cs

@@ -5,6 +5,7 @@
 
 namespace Microsoft.AspNetCore.Builder;
 
+[ExcludeFromCodeCoverage]
 public static class ApplicationBuilderExtensions
 {
     private static bool _isInitialize;

src/Contrib/Globalization/Masa.Contrib.Globalization.I18N.AspNetCore/README.md

@@ -0,0 +1,98 @@
+[中](README.zh-CN.md) | EN
+
+Provides the ability to parse and obtain Culture, and use it with [I18N](../Masa.Contrib.Globalization.I18N/README.md). Currently, there are three ways to switch languages:
+
+* URL parameter method: ?culture=en-US, this method has the highest priority, the format is: culture=region code
+* Cookies method: call L.SetCulture (region code) method to switch
+* Client browser language automatic matching: If neither of the previous two methods are set, it supports automatic matching according to the client browser language.
+
+## Masa.Contrib.Globalization.I18N.AspNetCore
+
+Example:
+
+``` powershell
+Install-Package Masa.Contrib.Globalization.I18N.AspNetCore
+```
+
+### getting Started
+
+1. Default resource folder structure
+
+``` structure
+- Resources
+  - I18n
+    - en-US.json
+    - zh-CN.json
+    - supportedCultures.json
+```
+
+* en-US.json
+
+``` en-US.json
+{
+    "Home":"Home",
+    "Docs":"Docs",
+    "Blog":"Blog",
+    "Team":"Team",
+    "Search":"Search"
+    "User":{
+        "Name":"Name"
+    }
+}
+```
+
+* zh-CN.json
+
+``` zh-CN.json
+{
+    "Home":"Home",
+    "Docs":"Documents",
+    "Blog":"Blog",
+    "Team":"Team",
+    "Search":"Search",
+    "User":{
+        "Name":"Name"
+    }
+}
+```
+
+* supportedCultures.json
+
+``` supportedCultures.json
+[
+    {
+        "Culture":"zh-CN",
+        "DisplayName":"Simplified Chinese",
+        "Icon": "{Replace-Your-Icon}"
+    },
+    {
+        "Culture":"en-US",
+        "DisplayName":"English (United States)",
+        "Icon": "{Replace-Your-Icon}"
+    }
+]
+```
+
+2. Register to use I18N, modify `Program.cs`
+
+``` C#
+services.AddI18N();
+```
+
+3. Use `Masa.Contrib.Globalization.I18N.AspNetCore` to provide the ability to parse Culture
+
+``` C#
+app.UseI18N();
+```
+
+4. How to use I18N
+
+* Get `II18N` from DI (**II18N** is the interface, supports getting from DI)
+* Use `I18N` (**I18N** is a static class)
+
+Take `I18N` as an example:
+
+```` C#
+var home = I18N.T("Home"); //Get the value of the language corresponding to the key value Home, this method call will return "Home";
+var name = I18N.T("User.Name");//Output: name (support nesting)
+````