如何使用Eclipse国际化OSGi应用程序?

时间:2019-05-02 09:51:23

标签: java eclipse localization internationalization osgi

我正在尝试使用“ OSGi方式” 将OSGi应用程序国际化,但是我没有取得任何进展。通过 OSGi方式,我的意思是使用框架提供的功能。我以前已经对Java应用程序进行了国际化,但是我想知道如何作为 OSGi 应用程序来实现它。

我已经创建了这个简单的演示 [GitHub repo] ,该演示旨在创建一个捆绑包,该捆绑包将在激活一条消息后记录该消息,而在禁用该消息后记录另一条消息。

项目结构:

src
   |- org.example.i18n
                     |- SimpleLoggingComponent   // where the actual strings are
                     |- SimpleLogService
                     |- SimpleLogServiceImpl
META-INF
   |- MANIFEST.MF
OSGI-INF
   |- org.example.i18n.SimpleLoggingComponent
   |- org.example.i18n.SimpleLogServiceImpl
build.properties

SimpleLoggingComponent source

@Component
public class SimpleLoggingComponent {

    private SimpleLogService simpleLogService;

    @Reference
    public void bindLogger(SimpleLogService logService) {
        this.simpleLogService = logService;
    }

    public void unbindLogger(SimpleLogService logService) {
        this.simpleLogService = null;
    }

    @Activate
    public void activate() {
        if (simpleLogService != null) {
            simpleLogService.log("Yee ha, I'm logging!"); // <-- need this message internationalized
        }
    }

    @Deactivate
    public void deactivate() {
        if (simpleLogService != null) {
            simpleLogService.log("Done, I'm finishing logging!"); // <-- need this message internationalized
        }
    }
}

现在,字符串已在代码中固定,我希望能够将它们国际化。假设支持英语和西班牙语。

稍后我计划通过 Fragment Bundles 添加对更多语言的支持,因此该解决方案应该可以通过这种方式扩展。


我已经阅读了所有这些内容,但没有发现任何对我有帮助的一致意见。

此外,OSGi Alliance Tutorial ArchiveOSGi enRoute均不包含任何内容。

环境:

PS:我确定这不是一个复杂的任务,只是我没有找到任何有用的(对我而言)有关的文档。

1 个答案:

答案 0 :(得分:1)

理论知识

本地化1

捆绑本地化条目共享一个通用的基本名称。为了找到潜在的本地化条目,添加了一个下划线('_'\ u005F)加上多个后缀,并用另一个下划线分隔,最后加上后缀.properties。后缀在java.util.Locale中定义。后缀的顺序必须为:

  • 语言

  • 国家/地区

  • 变体

例如,以下文件提供了英语,荷兰语(比利时和荷兰)和瑞典语的清单翻译。

OSGI-INF/l10n/bundle_en.properties
OSGI-INF/l10n/bundle_nl_BE.properties
OSGI-INF/l10n/bundle_nl_NL.properties
OSGI-INF/l10n/bundle_sv.properties

清单本地化2

本地化的值存储在捆绑软件中的属性资源中。包本地化属性文件的默认基本名称为OSGI-INF/l10n/bundle Bundle-Localization 清单标头可用于覆盖本地化文件的默认基本名称。此位置相对于包和包片段的根。

本地化条目包含用于本地化信息的键/值条目。包清单中的所有标头都可以本地化。但是,框架必须始终使用具有框架语义的标头的非本地化版本。

可以使用以下语法将本地化密钥指定为包清单清单头的值:

header-value ::= '%'text
text ::= < any value which is both a valid manifest headervalue
   and a valid property key name >

例如,考虑以下捆绑清单清单条目:

Bundle-Name: %acme bundle
Bundle-Vendor: %acme corporation
Bundle-Description: %acme description
Bundle-Activator: com.acme.bundle.Activator
Acme-Defined-Header: %acme special header

用户定义的标头也可以本地化。本地化键中的空格是明确允许的。

先前的清单清单示例可以由清单本地化条目OSGI-INF/l10n/bundle.properties中的以下条目进行本地化。

# bundle.properties
acme\ bundle=The ACME Bundle
acme\ corporation=The ACME Corporation
acme\ description=The ACME Bundle provides all of the ACME\ services
acme\ special\ header=user-defined Acme Data

实践中

1。。首先,创建捆绑文件,其中将包含键/值对。在这种情况下,英语(bundle.properties)将是默认值,而西班牙语(bundle_es.properties)将是默认值之一。

...
OSGI-INF
   |- l10n
        |- bundle.properties
        |- bunlde_es.properties
   |- ...

...,它将包含我们之前的硬编码字符串值。

#bundle.properties
startMessage = Yeah ha, I'm logging!
endMessage = Done, I'm finishing logging!

#bundle_es.properties
startMessage = Si, Estoy registrando logs!
endMessage = Terminado, He concluido de registrar logs!

2。。现在,我们创建一个实用程序组件,该组件将帮助我们根据语言环境获取与每个键关联的值。

src
   ...
   |- org.example.i18n.messages
                              |- MessageProvider
                              |- MessagesProviderImpl
   ...

有两个文件:接口和实际实现,其中包含获取键/值对的逻辑。

public interface MessageProvider {
    String get(String key);
}

@Component
public class MessagesProviderImpl implements MessageProvider {
    private BundleLocalization bundleLocalization;
    private LocaleProvider localeProvider;
    private ResourceBundle resourceBundle;

    @Reference
    public void bindBundleLocalization(BundleLocalization bundleLocalization) {
        this.bundleLocalization = bundleLocalization;
    }

    @Reference(cardinality = ReferenceCardinality.OPTIONAL, policy = ReferencePolicy.DYNAMIC)
    public void bindLocaleProvider(LocaleProvider localeProvider) {
        this.localeProvider = localeProvider;
        setResourceBundle()
    }

    /*unbind methods omitted*/

    @Activate
    public void activate() {
        setResourceBundle();
    }

    @Override
    public String get(String key) {
        return resourceBundle.getString(key);
    }

    private String getLocale() {
        return localeProvider != null ? localeProvider.getLocale().toString() : Locale.getDefault().toString();
    }

    private void setResourceBundle() {
        resourceBundle = bundleLocalization.getLocalization(FrameworkUtil.getBundle(getClass()), getLocale());
    }
}

3。。使用MessageProvider中的SimpleLoggingComponent组件。

@Component
public class SimpleLoggingComponent {

    /*previously code omitted for brevity*/

    private MessageProvider messages;

    @Reference
    public void bindMessageProvider(MessageProvider messageProvider) {
        messages = messageProvider;
    }

    /*unbind methods omitted*/

    @Activate
    public void activate() {
        simpleLogService.log(messages.get("startMessage")); // <- use now the key: startMessage
    }

    @Deactivate
    public void deactivate() {
        simpleLogService.log(messages.get("endMessage")); // <- use now the key: endMessage
    }
}

使用自定义语言启动应用程序

在“参数”选项卡上,为此使用运行时参数-nl,例如-nl en

Image of run configuration with parameter -nl set to English language: <code>-nl en</code>


参考

完整源代码