百度360必应搜狗淘宝本站头条
当前位置:网站首页 > IT知识 > 正文

基于SpringCloud的enum枚举值国际化处理实践

liuian 2025-02-26 12:45 46 浏览

背景

选用SpringCloud框架搭建微服务做业务后台应用时,会涉及到大量的业务状态值定义,一般常规做法是:

  • 持久层(数据库)存储int类型的值
  • 后台系统里用阅读性好一点儿的常量将int类型的值做一层映射
  • 前端(app或浏览器)同样定义一套常量去映射这些关系
  • 前端调用后台系统的接口时,使用常量定义的int类型进行提交

源于持久层存储的优化规则,int类型要比varchar类型效率高很多,这套做法也是大家接受度非常高的。

只是这里有一个不是很方便的地方:状态值映射的常量定义涉及前端和后台两部分,沟通的成本是一方面,另外如果状态值有变化,需要两组人员同时修改。

预期目标

在保证持久层的int类型存储状态值的前提下,主要是考虑业务状态的可阅读性问题和多处修改的问题,可阅读性问题一部分可以通过前后端人员定义常量来解决,但接口调试时还是直接使用int类型,这部分的可阅读性问题还是存在,多处修改的问题需要重点解决。

本篇推荐的方案:

  • 持久层(数据库)存储没用原先的int类型值,这点保持不变
  • 后台系统使用enum定义业务状态,不同的业务状态集可以由多个enum来实现,enum支持国际化
  • 前端展示enum国际化的文本内容
  • 前端调用后台系统接口时,使用enum国际化的文本内容进行提交
  • 后台接收enum国际化的文本内容转换成int类型值,存储在数据库

方案的优点:

  • 持久层原有的设计,效率性问题不受影响
  • 业务状态的定义、映射全部内聚到后台系统,后续有状态值变化时,只需后台做相应修改即可
  • 前端展示的内容,接口传输的内容均为阅读性更好的文本,并且支持国际化

方案的缺点:

  • 后台系统存储、读取状态值时,需要用enum进行转换
  • 通信传输的内容报文比原有的int类型大一点点

方案实践

实践原理

此实践方案主要包含三部分:

  1. Enum类使用Jackson进行JSON序列化和反序列化
  2. Enum枚举项的messages国际化处理
  3. Enum的定义

Enum自定义序列化和反序列化

先定义Enum国际化类,自定义Enum的序列化和反序列化类,并使用注解@JsonSerialize、@JsonDeserialize注册到Spring的ObjectMapper中

@JsonDeserialize(using?=?DescEnumDeserializer.class)
@JsonSerialize(using?=?DescEnumSerializer.class)
public?interface?I18NEnum?{

????/**
?????*?获取枚举描述
?????*
?????*?@return
?????*/
????String?getDesc();
}

参考一下自定义的序列化实现:

/**
?*?@author?huangying
?*/
public?class?DescEnumSerializer?extends?JsonSerializer?{

????@Override
????public?void?serialize(I18NEnum?value,?JsonGenerator?gen,?SerializerProvider?serializers)?throws?IOException?{
????????//?按类名+枚举值名称拼接配置文件key,全部大写处理
????????String?key?=?value.getClass().getSimpleName()?+?"."?+?StringUtils.upperCase(value.toString());
????????//?I18NUtil为国际化处理工具类
????????String?data?=?I18NUtil.get(key,?value.getDesc());
????????gen.writeString(data);
????}
}

自定义的反序列化实现:

/**
?*?@author?huangying
?*/
public?class?DescEnumDeserializer?extends?JsonDeserializer?{

????@Override
????public?I18NEnum?deserialize(JsonParser?p,?DeserializationContext?ctx)?throws?IOException?{
????????JsonNode?node?=?p.getCodec().readTree(p);
????????Class?enumCls?=?BeanUtils.findPropertyType(p.currentName(),?p.getCurrentValue().getClass());
????????List?enumFields?=?EnumUtils.getEnumList(enumCls);
????????String?keyPrefix?=?enumCls.getSimpleName()?+?".";
????????for?(Object?enumField?:?enumFields)?{
????????????I18NEnum?i18NEnum?=?(I18NEnum)?enumField;
????????????//?I18NUtil为国际化处理工具类
????????????String?data?=?I18NUtil.get(keyPrefix?+?StringUtils.upperCase(i18NEnum.toString()),?i18NEnum.getDesc());
????????????if?(node.asText().equals(data))?{
????????????????return?i18NEnum;
????????????}
????????}
????????throw?new?I18NEnumException("enum:未知的枚举类型");
????}
}

自定义一个专用异常,这样看起来更加高大上:

/**
?*?@author?huangying
?*/
public?class?I18NEnumException?extends?RuntimeException?{

????public?I18NEnumException(String?message)?{
????????super(message);
????}
}

国际化处理工具类

这个国际化处理的工具类是通用的,读取项目工程里的messages.properties\messages_zh_CN.properties\messages_en.properties等配置文件的MessageSource信息,并根据具体的语言,返回信息来完成国际化显示,代码如下:

/**
?*?@author?huangying
?*/
@Component
public?class?I18NUtil?{

????private?static?MessageSource?messageSource;

????public?I18NUtil(MessageSource?messageSource)?{
????????I18NUtil.messageSource?=?messageSource;
????}

????public?static?String?get(String?key)?{
????????return?messageSource.getMessage(key,?null,?LocaleContextHolder.getLocale());
????}

????public?static?String?get(String?key,?Object?arg)?{
????????return?messageSource.getMessage(key,?new?Object[]{arg},?LocaleContextHolder.getLocale());
????}
}

Enum定义示例

我们举一个enum定义的示例,有SUCCESS和FAIL两个枚举值,存储在数据库中的int值分别是1和2:

public?enum?OperateEnum?implements?I18NEnum?{

?/**
??*?个人日常消费
??*/
?SUCCESS(1,?"SUCCESS"),
?/**
??*?装修
??*/
?FAIL(2,"FAIL");

?private?int?index;
?private?String?desc;

?OperateEnum(int?index,?String?desc)?{
??this.index?=?index;
??this.desc?=?desc;
?}

?@Override
?public?String?getDesc()?{
??return?desc;
?}

?public?int?getIndex()?{
??return?index;
?}
}

配置文件的写法:

#?messages.properties内容
#?枚举类
OperateEnum.SUCCESS=success
OperateEnum.FAIL=fail

#?messages_zh_CN.properties内容
#?枚举类
OperateEnum.SUCCESS=操作成功
OperateEnum.FAIL=操作失败

方案应用

在SpringCloud环境下,添加对国际化语言的处理,我们统一将国际语言标识放在request header的lang里面:

/**
?*?@author?huangying
?*/
public?class?I18NLocalResolver?implements?LocaleResolver?{

????@Override
????public?Locale?resolveLocale(HttpServletRequest?request)?{
????????String?lang?=?request.getHeader("lang");
????????//获取jvm默认locale
????????Locale?locale?=?Locale.getDefault();
????????if?(lang?!=?null)?{
????????????locale?=?new?Locale(lang);
????????}
????????return?locale;
????}

????@Override
????public?void?setLocale(HttpServletRequest?request,?HttpServletResponse?response,?Locale?locale)?{

????}
}

自定义enum的序列化方法触发

在接口里只需要将enum类返回,在@ResponseBody进行处理时即可触发enum国际化的序列化方法,示例接口如下:

@ApiOperation(value?=?"枚举值国际化示例")
@ApiImplicitParams({
??@ApiImplicitParam(name?=?"uid",?value?=?"操作人员ID",?paramType?=?"header",?dataType?=?"Long")})
@RequestMapping(value?=?"/test/enums",?method?=?RequestMethod.GET)
public?Result?get(
??@RequestHeader(value?=?"lang")?String?lang)?{
?return?Result.success(EnumUtils.getEnumList(OperateEnum.class));
}

自定义enum的反序列化方法触发


MappingJackson2HttpMessageConverter转换器默认将@RequestBody的内容做反序列化处理,如果enum的国际化值传递给了客户端,若需要正确处理客户端提交的枚举值国际化内容,最简单的办法是将enum定义在@RequestBody的对象中,就能自动触发enum的自定义反序列化方法,并得到期望的结果。

若在@RequestParam修饰的参数上定义enum对象,请求中的String转换成enum是通过
org.springframework.core.convert.support.StringToEnumConverterFactory 来实现的,该类实现了接口 ConverterFactory ,通过调用 Enum.valueOf(Class, String) 实现了这个功能,而不会触发enum枚举值的反序列化。因此只能处理与枚举值相同的字面值(name),enum枚举值国际化处理后,可能与字面值不相同,直接使用@RequestParam来转换,会报错。

如果要让@RequestParam能够触发enum枚举值的反序列化操作,可以尝试重写springmvc的参数转换器,此处略。

小结

enum枚举值的国际化处理,是个非常有意思的改进,既可能解决阅读性的问题,又提高了业务定义的内聚性,此方案的应用取决于前后端的编码习惯,如果是在项目初期,前后端童鞋沟通确认后可以尝试此方案,希望对你有帮助。

相关推荐

驱动网卡(怎么从新驱动网卡)
驱动网卡(怎么从新驱动网卡)

网卡一般是指为电脑主机提供有线无线网络功能的适配器。而网卡驱动指的就是电脑连接识别这些网卡型号的桥梁。网卡只有打上了网卡驱动才能正常使用。并不是说所有的网卡一插到电脑上面就能进行数据传输了,他都需要里面芯片组的驱动文件才能支持他进行数据传输...

2026-01-30 00:37 liuian

win10更新助手装系统(微软win10更新助手)

1、点击首页“系统升级”的按钮,给出弹框,告诉用户需要上传IMEI码才能使用升级服务。同时给出同意和取消按钮。华为手机助手2、点击同意,则进入到“系统升级”功能华为手机助手华为手机助手3、在检测界面,...

windows11专业版密钥最新(windows11专业版激活码永久)

 Windows11专业版的正版密钥,我们是对windows的激活所必备的工具。该密钥我们可以通过微软商城或者通过计算机的硬件供应商去购买获得。获得了windows11专业版的正版密钥后,我...

手机删过的软件恢复(手机删除过的软件怎么恢复)
手机删过的软件恢复(手机删除过的软件怎么恢复)

操作步骤:1、首先,我们需要先打开手机。然后在许多图标中找到带有[文件管理]文本的图标,然后单击“文件管理”进入页面。2、进入页面后,我们将在顶部看到一行文本:手机,最新信息,文档,视频,图片,音乐,收藏,最后是我们正在寻找的[更多],单击...

2026-01-29 23:55 liuian

一键ghost手动备份系统步骤(一键ghost 备份)

  步骤1、首先把装有一键GHOST装系统的U盘插在电脑上,然后打开电脑马上按F2或DEL键入BIOS界面,然后就选择BOOT打USDHDD模式选择好,然后按F10键保存,电脑就会马上重启。  步骤...

怎么创建局域网(怎么创建局域网打游戏)

  1、购买路由器一台。进入路由器把dhcp功能打开  2、购买一台交换机。从路由器lan端口拉出一条网线查到交换机的任意一个端口上。  3、两台以上电脑。从交换机任意端口拉出网线插到电脑上(电脑设置...

精灵驱动器官方下载(精灵驱动手机版下载)

是的。驱动精灵是一款集驱动管理和硬件检测于一体的、专业级的驱动管理和维护工具。驱动精灵为用户提供驱动备份、恢复、安装、删除、在线更新等实用功能。1、全新驱动精灵2012引擎,大幅提升硬件和驱动辨识能力...

一键还原系统步骤(一键还原系统有哪些)

1、首先需要下载安装一下Windows一键还原程序,在安装程序窗口中,点击“下一步”,弹出“用户许可协议”窗口,选择“我同意该许可协议的条款”,并点击“下一步”。  2、在弹出的“准备安装”窗口中,可...

电脑加速器哪个好(电脑加速器哪款好)

我认为pp加速器最好用,飞速土豆太懒,急速酷六根本不工作。pp加速器什么网页都加速,太任劳任怨了!以上是个人观点,具体性能请自己试。ps:我家电脑性能很好。迅游加速盒子是可以加速电脑的。因为有过之...

任何u盘都可以做启动盘吗(u盘必须做成启动盘才能装系统吗)

是的,需要注意,U盘的大小要在4G以上,最好是8G以上,因为启动盘里面需要装系统,内存小的话,不能用来安装系统。内存卡或者U盘或者移动硬盘都可以用来做启动盘安装系统。普通的U盘就可以,不过最好U盘...

u盘怎么恢复文件(u盘文件恢复的方法)

开360安全卫士,点击上面的“功能大全”。点击文件恢复然后点击“数据”下的“文件恢复”功能。选择驱动接着选择需要恢复的驱动,选择接入的U盘。点击开始扫描选好就点击中间的“开始扫描”,开始扫描U盘数据。...

系统虚拟内存太低怎么办(系统虚拟内存占用过高什么原因)

1.检查系统虚拟内存使用情况,如果发现有大量的空闲内存,可以尝试释放一些不必要的进程,以释放内存空间。2.如果系统虚拟内存使用率较高,可以尝试增加系统虚拟内存的大小,以便更多的应用程序可以使用更多...

剪贴板权限设置方法(剪贴板访问权限)
剪贴板权限设置方法(剪贴板访问权限)

1、首先打开iphone手机,触碰并按住单词或图像直到显示选择选项。2、其次,然后选取“拷贝”或“剪贴板”。3、勾选需要的“权限”,最后选择开启,即可完成苹果剪贴板权限设置。仅参考1.打开苹果手机设置按钮,点击【通用】。2.点击【键盘】,再...

2026-01-29 21:37 liuian

平板系统重装大师(平板重装win系统)

如果你的平板开不了机,但可以连接上电脑,那就能好办,楼主下载安装个平板刷机王到你的个人电脑上,然后连接你的平板,平板刷机王会自动识别你的平板,平板刷机王上有你平板的我刷机包,楼主点击下载一个,下载完成...

联想官网售后服务网点(联想官网售后服务热线)

联想3c服务中心是联想旗下的官方售后,是基于互联网O2O模式开发的全新服务平台。可以为终端用户提供多品牌手机、电脑以及其他3C类产品的维修、保养和保险服务。根据客户需求层次,联想服务针对个人及家庭客户...