Sparkdo.Localization 1.0.1

Sparkdo.Localization

Sparkdo 本地化模块，提供完整的本地化功能实现。

功能特性

• 多语言支持
• 资源文件管理
• 枚举本地化
• 动态本地化贡献者
• 与 Sparkdo 框架无缝集成

安装

<PackageReference Include="Sparkdo.Localization" Version="x.x.x" />

核心组件

本地化资源

• LocalizationResource: 基于类型的本地化资源
• NonTypedLocalizationResource: 非类型化本地化资源
• LocalizationResourceBase: 本地化资源基类

本地化器

• ISparkdoStringLocalizer: Sparkdo字符串本地化器接口
• SparkdoDictionaryBasedStringLocalizer: 基于字典的字符串本地化器
• SparkdoStringLocalizerFactory: 字符串本地化器工厂

枚举本地化

• IEnumLocalizer: 枚举本地化器接口
• DefaultEnumLocalizer: 默认枚举本地化器实现

语言管理

• ILanguageProvider: 语言提供者接口
• DefaultLanguageProvider: 默认语言提供者实现
• ILanguageInfo: 语言信息接口
• LanguageInfo: 语言信息实现

资源贡献者

• ILocalizationResourceContributor: 本地化资源贡献者接口
• LocalizationResourceContributorList: 本地化资源贡献者列表

使用方法

基本本地化配置

// 在模块配置中添加本地化资源
public override void Configure(IConfigureContext context)
{
    context.Services.Configure<SparkdoLocalizationOptions>(options =>
    {
        options
            .Resources
            .Add<MyResource>("zh-Hans")
            .AddVirtualJson("/Localization/Resources/MyResource");
    });
}

使用本地化器

// 注入字符串本地化器
public class MyService
{
    private readonly IStringLocalizer _localizer;
    
    public MyService(IStringLocalizer<MyResource> localizer)
    {
        _localizer = localizer;
    }
    
    public string GetLocalizedMessage()
    {
        return _localizer["MyKey"];
    }
}

枚举本地化

// 使用枚举本地化器
public class MyService
{
    private readonly IEnumLocalizer _enumLocalizer;
    
    public MyService(IEnumLocalizer enumLocalizer)
    {
        _enumLocalizer = enumLocalizer;
    }
    
    public string GetLocalizedEnumValue(MyEnum enumValue)
    {
        return _enumLocalizer.GetString(typeof(MyEnum), enumValue);
    }
}

扩展性

该库提供了完整的本地化功能实现，可以通过以下方式扩展：

1. 实现自定义的 ILocalizationResourceContributor 来提供特定的本地化资源贡献者
2. 实现自定义的 ILanguageProvider 来提供特定的语言列表
3. 实现自定义的 IEnumLocalizer 来提供特定的枚举本地化逻辑
4. 实现自定义的本地化资源管理逻辑

代码结构说明

本项目包含以下主要组件：

本地化核心

• SparkdoStringLocalizerFactory: 字符串本地化器工厂，负责创建和管理本地化器实例
• SparkdoDictionaryBasedStringLocalizer: 基于字典的字符串本地化器，提供核心本地化功能
• LocalizationResource: 本地化资源，表示一个具体的本地化资源
• LocalizationResourceBase: 本地化资源基类，定义资源的基本结构

枚举本地化

• IEnumLocalizer: 枚举本地化器接口，定义枚举本地化的方法
• DefaultEnumLocalizer: 默认枚举本地化器实现，提供基本的枚举本地化功能

语言管理

• ILanguageProvider: 语言提供者接口，定义获取语言列表的方法
• DefaultLanguageProvider: 默认语言提供者实现
• ILanguageInfo: 语言信息接口，定义语言的基本信息
• LanguageInfo: 语言信息实现

资源贡献者

• ILocalizationResourceContributor: 本地化资源贡献者接口，定义贡献者的功能
• LocalizationResourceContributorList: 本地化资源贡献者列表，管理多个贡献者

配置选项

• SparkdoLocalizationOptions: 本地化选项，配置本地化功能的各种选项
• SparkdoLocalizationOptionsExtensions: 本地化选项扩展方法

所有公共接口和类都添加了详细的 XML 文档注释，便于开发者理解和使用。