使用dropwizard(6)-国际化-easy-i18n

2024-05-03 09:58

本文主要是介绍使用dropwizard(6)-国际化-easy-i18n,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!


前言

Dropwizard官方文档并没有提供国际化的模块,所以只能自己加。Spring的MessageResource用的很顺手,所以copy过来。

作者:@Ryan-Miao
本文为作者原创,转载请注明出处:http://www.cnblogs.com/woshimrf/p/dropwizard-i18n.html

Easy i18n

在整合Dropwizard的时候,多语言貌似只能通过jdk自带的ResourceBundle拿数据。其实也就够了,但在开发过程中发现需要缓存,需要解析占位符等。代码越写越多,显然不是仅仅一个调用就完事的。写的差不多的时候突然觉得和spring context里的message source结构类似。于是,放弃维护已经开始变的复杂的逻辑,直接使用spring。

但选取dropwizard的时候就是摒弃了spring,再拿过来也不好玩了。干脆,抽取Spring context项目的MessageResource相关代码,重写封装了一个library: https://github.com/Ryan-Miao/easy-i18n, 欢迎star。

easy-i18n还是和在Spring项目中相同。

首先,引入依赖,由于github项目的library已经有仓库去维护了,就没费心思放到maven和jcenter了,直接从github上拉取。类库地址为:

<repositories><repository><id>jitpack.io</id><url>https://jitpack.io</url></repository>
</repositories>

引入

<dependency><groupId>com.github.Ryan-Miao</groupId><artifactId>easy-i18n</artifactId><version>1.0</version>
</dependency>

简单使用

#情形一 只有一个Resource Bundle

在resources下新建i18n/messages.properties以及i18n/messages_zh_CN.properties. demo位置:l4dropwizard

然后,调用方法如下:

@Test
public void testI18n(){ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();messageSource.addBasenames("i18n/messages");messageSource.setDefaultEncoding("UTF-8");String index = messageSource.getMessage("index", null, Locale.US);System.out.println(index);
}

#情形二 我有多个Resource Bundle

实际项目中,由于产品分类,有时候需要创建多个Resource Bundle,这时候也简单,只要创建多个ResourceBundleMessageSource来读取翻译即可。


public void testI18n2(){ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();messageSource.addBasenames("i18n/messages");messageSource.setDefaultEncoding("UTF-8");String index = messageSource.getMessage("index", null, Locale.US);System.out.println(index);ResourceBundleMessageSource messageSource2 = new ResourceBundleMessageSource();messageSource2.addBasenames("i18n/messages2");messageSource2.setDefaultEncoding("UTF-8");String second = messageSource2.getMessage("second", null, Locale.US);System.out.println(second);
}

#情形三 我有多个Resource Bundle但读取翻译的时候我想一起

有时候,想要读取翻译,可能翻译文件在不同的Resource Bundle,但我指向用一个接口去调用。这时候,做法时候在这几个Resource Bundle的里面添加命名空间,即key要在这几个Resource Bundle里唯一,而不仅仅是本文件唯一。

然后,


public void testI18n2(){ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();messageSource.addBasenames("i18n/messages", "i18n/messages2");messageSource.setDefaultEncoding("UTF-8");String index = messageSource.getMessage("index", null, Locale.US);System.out.println(index);
}

这种做法,会一次从两个Resource Bundle里寻找翻译,找到即返回。因此,如果有相同的key,将导致只有第一个生效。

#情形4

没有了,你翻译要那么复杂吗。

更多用法,参考测试类:ResourceBundleMessageSourceTest

Demo source

https://github.com/Ryan-Miao/l4dropwizard

本文是基于dropwizard入门之上的演进。

确保依赖都是最新的,或者自行解决版本冲突,比如jackson不同版本之间的类有所不同。

引入easy-i18n

repository url

<repositories><repository><id>jitpack.io</id><url>https://jitpack.io</url></repository>
</repositories>

引入

<dependency><groupId>com.github.Ryan-Miao</groupId><artifactId>easy-i18n</artifactId><version>1.0</version>
</dependency>

添加Resource Bundle

在resources下新增文件夹i18n, 依次添加几个Resource Bundle。具体做法是,在文件夹i18n右键 -> new -> Resource Bundle, 然后选择想要支持的语言。比如美国en_US,简体中文zh_CN

新建MessageService

创建一个Util来处理翻译功能。
com.test.domain.service.IMessageService

package com.test.domain.service;import java.text.MessageFormat;
import java.util.List;
import java.util.Locale;/*** The Message translation service* Created by Ryan Miao on 11/23/17.*/
public interface IMessageService {/*** Get translation by message key.** @param key The message key in the properties* @return the translated message*/String getMessage(String key, Locale locale);/*** Get translation by message key and compose it with variables.* Note that the variable would be injected by {@link MessageFormat}** @param key The message key in the properties* @param args The variables to inject into the message.* @return the translated message.*/String getMessage(String key, List<String> args, Locale locale);
}

实现类com.test.domain.service.impl.MessageService

package com.test.domain.service.impl;import com.miao.easyi18n.support.ResourceBundleMessageSource;
import com.test.domain.service.IMessageService;import javax.inject.Inject;
import javax.inject.Singleton;
import java.util.List;
import java.util.Locale;/*** Created by Ryan Miao on 11/23/17.*/
@Singleton
public class MessageService implements IMessageService{private final ResourceBundleMessageSource messageSource;@Injectpublic MessageService(ResourceBundleMessageSource messageSource) {this.messageSource = messageSource;}@Overridepublic String getMessage(String key, Locale locale) {return messageSource.getMessage(key, null, locale);}@Overridepublic String getMessage(String key, List<String> args, Locale locale) {return messageSource.getMessage(key, args.toArray(), locale);}
}

在IoC中提供ResourceBundleMessageSource

由于ResourceBundleMessageSource是公共组件,需要单独提取出来,并使用单例模式创建。关于IoC的配置,参阅dropwizard中添加DI

ConfigurationModule中:

package com.test.domain.ioc.module;import com.miao.easyi18n.support.ResourceBundleMessageSource;
import com.test.configuration.HelloWorldConfiguration;
import dagger.Module;
import dagger.Provides;import javax.inject.Singleton;/*** Created by Ryan Miao on 11/20/17.*/
@Module
public class ConfigurationModule {private final HelloWorldConfiguration configuration;public ConfigurationModule(HelloWorldConfiguration configuration) {this.configuration = configuration;}@Provides@SingletonHelloWorldConfiguration helloWorldConfiguration(){return configuration;}@Singleton@ProvidesResourceBundleMessageSource resourceBundleMessageSource(){ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();messageSource.addBasenames("i18n/messages", "i18n/messages2", "i18n/otherGroup");messageSource.setDefaultEncoding("UTF-8");return messageSource;}
}

这里,关于Resource Bundle的位置没有单独提出来,后面可以放到HelloWorldConfiguration,提到配置文件中。

测试

在dagger中,接口和实现类的绑定只能通过手动声明。因此,绑定IMessageService

@Singleton
@Provides
IMessageService messageService(MessageService messageService){return messageService;
}

创建测试Resource, com.test.domain.resource.LocalResource

package com.test.domain.resource;import com.codahale.metrics.annotation.Timed;
import com.google.common.collect.ImmutableMap;
import com.test.domain.entiry.GithubUser;
import com.test.domain.service.IMessageService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;import javax.inject.Inject;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.ws.rs.GET;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import java.util.Locale;
import java.util.Map;/*** Test localization* Created by Ryan Miao on 11/23/17.*/
@Api("/local")
@Path("/local")
@Produces(MediaType.APPLICATION_JSON)
public class LocalResource {private final IMessageService messageService;@Injectpublic LocalResource(IMessageService messageService) {this.messageService = messageService;}@GET@Timed@Path("/{key}")@ApiOperation(value = "Get github user profile.", notes = "There should be the note.")@ApiResponses({@ApiResponse(code = 401, message = "Valid credentials are required to access this resource."),@ApiResponse(code = 400, message = "Params not valid."),@ApiResponse(code = 500, message = "Something wrong from the server."),@ApiResponse(code = 200, message = "Success.", response = GithubUser.class)})public Map<String, String> getIndex(@PathParam("key") final String index,@HeaderParam("Accept-Language") @Valid@NotNull(message = "cannot be null.")@Pattern(regexp = "([a-z]{2}-[A-Z]{2})", message = "pattern should like zh-CN, en-US.")final String language) {final Locale locale = Locale.forLanguageTag(language);final String message = messageService.getMessage(index, locale);return ImmutableMap.of(index, message);}
}

结果

这篇关于使用dropwizard(6)-国际化-easy-i18n的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/956469

相关文章

Java学习手册之Filter和Listener使用方法

《Java学习手册之Filter和Listener使用方法》:本文主要介绍Java学习手册之Filter和Listener使用方法的相关资料,Filter是一种拦截器,可以在请求到达Servl... 目录一、Filter(过滤器)1. Filter 的工作原理2. Filter 的配置与使用二、Listen

Pandas使用AdaBoost进行分类的实现

《Pandas使用AdaBoost进行分类的实现》Pandas和AdaBoost分类算法,可以高效地进行数据预处理和分类任务,本文主要介绍了Pandas使用AdaBoost进行分类的实现,具有一定的参... 目录什么是 AdaBoost?使用 AdaBoost 的步骤安装必要的库步骤一:数据准备步骤二:模型

使用Pandas进行均值填充的实现

《使用Pandas进行均值填充的实现》缺失数据(NaN值)是一个常见的问题,我们可以通过多种方法来处理缺失数据,其中一种常用的方法是均值填充,本文主要介绍了使用Pandas进行均值填充的实现,感兴趣的... 目录什么是均值填充?为什么选择均值填充?均值填充的步骤实际代码示例总结在数据分析和处理过程中,缺失数

如何使用 Python 读取 Excel 数据

《如何使用Python读取Excel数据》:本文主要介绍使用Python读取Excel数据的详细教程,通过pandas和openpyxl,你可以轻松读取Excel文件,并进行各种数据处理操... 目录使用 python 读取 Excel 数据的详细教程1. 安装必要的依赖2. 读取 Excel 文件3. 读

解决Maven项目idea找不到本地仓库jar包问题以及使用mvn install:install-file

《解决Maven项目idea找不到本地仓库jar包问题以及使用mvninstall:install-file》:本文主要介绍解决Maven项目idea找不到本地仓库jar包问题以及使用mvnin... 目录Maven项目idea找不到本地仓库jar包以及使用mvn install:install-file基

Python使用getopt处理命令行参数示例解析(最佳实践)

《Python使用getopt处理命令行参数示例解析(最佳实践)》getopt模块是Python标准库中一个简单但强大的命令行参数处理工具,它特别适合那些需要快速实现基本命令行参数解析的场景,或者需要... 目录为什么需要处理命令行参数?getopt模块基础实际应用示例与其他参数处理方式的比较常见问http

C 语言中enum枚举的定义和使用小结

《C语言中enum枚举的定义和使用小结》在C语言里,enum(枚举)是一种用户自定义的数据类型,它能够让你创建一组具名的整数常量,下面我会从定义、使用、特性等方面详细介绍enum,感兴趣的朋友一起看... 目录1、引言2、基本定义3、定义枚举变量4、自定义枚举常量的值5、枚举与switch语句结合使用6、枚

使用Python从PPT文档中提取图片和图片信息(如坐标、宽度和高度等)

《使用Python从PPT文档中提取图片和图片信息(如坐标、宽度和高度等)》PPT是一种高效的信息展示工具,广泛应用于教育、商务和设计等多个领域,PPT文档中常常包含丰富的图片内容,这些图片不仅提升了... 目录一、引言二、环境与工具三、python 提取PPT背景图片3.1 提取幻灯片背景图片3.2 提取

使用Python实现图像LBP特征提取的操作方法

《使用Python实现图像LBP特征提取的操作方法》LBP特征叫做局部二值模式,常用于纹理特征提取,并在纹理分类中具有较强的区分能力,本文给大家介绍了如何使用Python实现图像LBP特征提取的操作方... 目录一、LBP特征介绍二、LBP特征描述三、一些改进版本的LBP1.圆形LBP算子2.旋转不变的LB

Maven的使用和配置国内源的保姆级教程

《Maven的使用和配置国内源的保姆级教程》Maven是⼀个项目管理工具,基于POM(ProjectObjectModel,项目对象模型)的概念,Maven可以通过一小段描述信息来管理项目的构建,报告... 目录1. 什么是Maven?2.创建⼀个Maven项目3.Maven 核心功能4.使用Maven H