使用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

相关文章

Python使用Tenacity一行代码实现自动重试详解

《Python使用Tenacity一行代码实现自动重试详解》tenacity是一个专为Python设计的通用重试库,它的核心理念就是用简单、清晰的方式,为任何可能失败的操作添加重试能力,下面我们就来看... 目录一切始于一个简单的 API 调用Tenacity 入门:一行代码实现优雅重试精细控制:让重试按我

MySQL中EXISTS与IN用法使用与对比分析

《MySQL中EXISTS与IN用法使用与对比分析》在MySQL中,EXISTS和IN都用于子查询中根据另一个查询的结果来过滤主查询的记录,本文将基于工作原理、效率和应用场景进行全面对比... 目录一、基本用法详解1. IN 运算符2. EXISTS 运算符二、EXISTS 与 IN 的选择策略三、性能对比

使用Python构建智能BAT文件生成器的完美解决方案

《使用Python构建智能BAT文件生成器的完美解决方案》这篇文章主要为大家详细介绍了如何使用wxPython构建一个智能的BAT文件生成器,它不仅能够为Python脚本生成启动脚本,还提供了完整的文... 目录引言运行效果图项目背景与需求分析核心需求技术选型核心功能实现1. 数据库设计2. 界面布局设计3

使用IDEA部署Docker应用指南分享

《使用IDEA部署Docker应用指南分享》本文介绍了使用IDEA部署Docker应用的四步流程:创建Dockerfile、配置IDEADocker连接、设置运行调试环境、构建运行镜像,并强调需准备本... 目录一、创建 dockerfile 配置文件二、配置 IDEA 的 Docker 连接三、配置 Do

Android Paging 分页加载库使用实践

《AndroidPaging分页加载库使用实践》AndroidPaging库是Jetpack组件的一部分,它提供了一套完整的解决方案来处理大型数据集的分页加载,本文将深入探讨Paging库... 目录前言一、Paging 库概述二、Paging 3 核心组件1. PagingSource2. Pager3.

python使用try函数详解

《python使用try函数详解》Pythontry语句用于异常处理,支持捕获特定/多种异常、else/final子句确保资源释放,结合with语句自动清理,可自定义异常及嵌套结构,灵活应对错误场景... 目录try 函数的基本语法捕获特定异常捕获多个异常使用 else 子句使用 finally 子句捕获所

C++11右值引用与Lambda表达式的使用

《C++11右值引用与Lambda表达式的使用》C++11引入右值引用,实现移动语义提升性能,支持资源转移与完美转发;同时引入Lambda表达式,简化匿名函数定义,通过捕获列表和参数列表灵活处理变量... 目录C++11新特性右值引用和移动语义左值 / 右值常见的左值和右值移动语义移动构造函数移动复制运算符

Python对接支付宝支付之使用AliPay实现的详细操作指南

《Python对接支付宝支付之使用AliPay实现的详细操作指南》支付宝没有提供PythonSDK,但是强大的github就有提供python-alipay-sdk,封装里很多复杂操作,使用这个我们就... 目录一、引言二、准备工作2.1 支付宝开放平台入驻与应用创建2.2 密钥生成与配置2.3 安装ali

C#中lock关键字的使用小结

《C#中lock关键字的使用小结》在C#中,lock关键字用于确保当一个线程位于给定实例的代码块中时,其他线程无法访问同一实例的该代码块,下面就来介绍一下lock关键字的使用... 目录使用方式工作原理注意事项示例代码为什么不能lock值类型在C#中,lock关键字用于确保当一个线程位于给定实例的代码块中时

MySQL 强制使用特定索引的操作

《MySQL强制使用特定索引的操作》MySQL可通过FORCEINDEX、USEINDEX等语法强制查询使用特定索引,但优化器可能不采纳,需结合EXPLAIN分析执行计划,避免性能下降,注意版本差异... 目录1. 使用FORCE INDEX语法2. 使用USE INDEX语法3. 使用IGNORE IND