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

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

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

背景

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

相关推荐

tplink说明书图片(tp-link路由器说明书步骤图)

第一步连接路由器WIFI在手机获取IP地址里找到路由器网关地址,第二步在浏览器地址栏输入路由器网关地址,之后会跳转到路由器管理员登录界面,输入账号密码就可以进入路由后台管理路由,如果提示路由器密码错误...

如何不安装flash玩4399(现在4399不提供flash如何玩游戏)

没有flash是玩不了的,需要开启flash才可以。1、首先打开浏览器,进入4399的游戏页面。2、进入游戏页面后,点击【已被屏蔽】文字。3、然后右上角会出现窗口,点击【管理】按钮。4、进入管理页面后...

chrome download apk(chromedownloadapk in english)

手机下载安装的第三方应用出现问题,无法正常使用,建议按照以下方法操作:1.关闭重新启动该应用。2.建议将此软件卸载重新安装尝试。3.更换其他版本尝试。4.更新下手机系统版本后安装尝试5.备份手机数据(...

qq空间官网手机登录网页版(qq空间官网登陆入口)
qq空间官网手机登录网页版(qq空间官网登陆入口)

z.qq.com可以通过以下方式登录手机QQ空间:1、使用手机登录手机腾讯网3g.qq.com,点击“空间”,根据提示QQ号码和QQ密码就可以登录;2、通过手机直接输入手机QQ空间网址z.qq.com,根据提示操作即可登录;3、下载手机Q...

2025-12-22 13:55 liuian

windows11我的电脑在哪里打开

1/6通过“开始”进入“设置”-“时间和语言”。2/6在“时间和语言”界面选择“区域”3/6这里我们将区域更改位“新加披”,退出。4/6打开微软自带的市场,搜索“你的手机”获取并下载。5/6安装完成后...

win10怎么取消开机自启动(win10如何关闭开机自动启动)

要关闭Windows10的开机自动启动程序,你可以按下Win+R键,输入"msconfig"并按回车键打开系统配置工具。在"启动"选项卡中,你可以看到所有开机自动...

手机cpu排名2025(手机cpu排名榜)

一、2022手机CPU性能综合排名前八名手机CPU:1、型号:苹果A16---综合分数:暂无2、型号:骁龙8gen1---综合分数:42333、联发科天玑9000---综合分数:38724、...

论坛系统(论坛系统数据流图)

BBS是电子布告栏系统的简称,一种网站系统,也是目前流行网络论坛的前身。它允许用户使用终端程序通过调制解调器拨接或者因特网来进行连接,BBS站台提供布告栏、分类讨论区、新闻阅读、软件下载与上传、游戏、...

hp1020plus打印机无法打印(惠普1020plus打印机突然不能打印了)

 删除惠普打印机驱动和软件:1.如果你的打印机已通过USB连接到电脑,断开USB连接;2.打开控制面板—程序和功能(卸载或更改应用程序);3.在软件列表中找到惠普打印机,将其卸载;4.重启电脑...

wifi密码破解器电脑版(wifi密码破解工具电脑版)

肯定不是万能钥匙这种“破解”wifi的东西。不是一两次见到把万能钥匙当做破解wifi用的人了,但实际上那玩意就是个分享wifi的软件。你连上一个wifi,密码就会被分享到云端(可以不分享),别...

手机临时文件夹在哪个位置(手机临时文件夹在哪个位置找)

1.手机文件临时文件是指在手机使用过程中产生的临时文件。2.手机应用程序在运行时需要产生一些临时文件,如缓存文件、日志文件、临时下载文件等,这些文件可以提高应用程序的运行效率和用户体验。但是,这些...

安卓10系统下载(安卓10 下载)

方法及步骤:  其实使用安卓车机下载歌曲的方法十分的简单,具体操作步骤和安卓手机一模一样。  首先我们需要在车机的应用商店上,下载一个音乐播放器,例如网易云音乐或者QQ音乐等。  下载完成后点击进入...

华硕人工客服24小时吗(华硕售后人工客服)

华硕服务中心广东省惠州市惠东县城平深路(创富斜对面)惠东同心电脑城1L11(1.3km)笔记本电脑,平板电脑华硕服务中心广东省惠州市惠东县平山镇同心电脑城1F26(1.3km)笔记本电脑,平...

电脑音量小喇叭不见了(电脑声音喇叭图标不见了怎么办)

如果您电脑上的小喇叭(扬声器)不见了,可以尝试以下方法找回:1.检查设备管理器:在Windows下,右键点击“我的电脑”(或此电脑)->点击“属性”->点击“设备管理器”,查看“声音、视...

腾达路由器手机设置教程(腾达路由器手机设置教程视频)

用手机设置腾达路由器的方法如下:1在手机上打开浏览器,输入路由器背面的管理IP和用户及对应的密码2一般第一次打开,默认会跳出设置向导,准备好宽带用户名和密码,3按向导提示输入相应内容4在无线设置的安全...