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

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

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

背景

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

相关推荐

win11怎么激活(win11怎么激活office)

目前,Windows11的永久激活方法还没有被公开或者确认。不过,你可以尝试以下几种方法来激活Windows11:使用数字许可证:如果你的电脑已经安装了Windows10并且已经激活,那么你可以...

笔记本电脑快捷键大全(笔记本电脑快捷键大全常用)
  • 笔记本电脑快捷键大全(笔记本电脑快捷键大全常用)
  • 笔记本电脑快捷键大全(笔记本电脑快捷键大全常用)
  • 笔记本电脑快捷键大全(笔记本电脑快捷键大全常用)
  • 笔记本电脑快捷键大全(笔记本电脑快捷键大全常用)
苹果恢复出厂设置(苹果恢复出厂设置还能恢复数据吗)

首先打开手机上面的“设置”功能,进入手机的系统设置。进入手机的设置后,选择“通用"。进入通用之后,往下滑动页面,在页面的最下方可以看到“还原”的选项,点击进入。进入还原之后,有多个还原选项,我...

路由器的配置步骤(路由器配置教学)

打开浏览器-输入192.168.1.1(一般路由器地址是这个或者查看路由器背面的登录信息)进路由-输入用户名,密码,(默认一般是admin)。2、在【设置向导】里,选择【PPOE拨号】(有些是ADS...

psp模拟器ios(psp模拟器ios推荐)

psp手机模拟器推荐PPSSPP,作为最流行的开源PSP模拟器,因为其强大的功能和兼容性广受玩家们喜爱。虽然提供了PC和安卓双平台的支持,但是有碍于安卓设备的硬件,移动端PPSSPP的功能并不完整。不...

台式机重装系统按f几(重装电脑系统按f几)

F8、F9、F10、F11、F12、F2、del。一般用到这几个。下面以联想电脑装WIN10系统为例:1、将制作好的U盘插入要重装系统的电脑,开机画面出现电脑品牌logo时,不停地按“f2键”进入“B...

win10激活错误代码0x8007007b

Win10激活出现0x8007007b解决方法如下1、找到计算机,右键点击属性,确认你的电脑系统是否是windows10。2、鼠标右击桌面,依次点击个性化-主题-桌面图标设置,勾选计算机后依次点击应用...

4000台式电脑最好的组装配置
4000台式电脑最好的组装配置

四千元价格组装电脑主机与五千元组装电脑主机的价格类似,因为电脑主机就几个大部件,电脑主机主板是多少代的产品?主板内存的插槽数?电脑处理器等如果是自己组装,都可以配置到十二代产品,电脑硬盘可以分为256G固态硬盘做系统盘,1T机械硬盘作为工作...

2025-11-06 20:05 liuian

linux是一种什么系统(linux属于什么系统)

Linux,全称GNU/Linux,是一种免费使用和自由传播的类UNIX操作系统,是一个基于POSIX的多用户、多任务、支持多线程和多CPU的操作系统。其内核由林纳斯·本纳第克特·托瓦兹于1991年1...

手机管理大师免费版(手机管理大师极速版)

使用手机“文件管理”打开文件夹时提示访问受限,需要前往“文件”应用查看1.进入手机设置——安全——应用权限——权限/应用2.在手机桌面找到手机管家——权限隐私——应用权限——权限/应用?当然,相对于被...

电脑能开机但是进不去桌面怎么办

打开任务管理器按Ctrl+Shift+Esc打开任务管理器。文件中运行新任务点击文件,运行新任务。输入指令重启桌面输入explorer.exe,点击确定,等待桌面重启完成就可以了。电脑已经是我们生活中...

怎样解除自动关机模式(怎样解除自动开关机)

1、打开手机主界面,找到系统自带的“时钟”应用,点击打开它。2、点击进入时钟后,点击右下角的“计时器”。3、进入到计时器后,点击“在计时结束启用雷达”这个选项。4、然后在这里,下拉到最下面,勾选“停...

电脑最高配置是什么配置2025

一,2023最新主流电脑装机配置如下。二,处理器可以使用十二代的i512400或者i512490f,内存16gb双通道,显卡rtx3060,主板可以使用b660m或者h610m。三,如果十三代酷睿...

MySQL慢查询优化:从explain到索引,DBA手把手教你提升10倍性能

数据库性能是应用系统的生命线,而慢查询就像隐藏在系统中的定时炸弹。某电商平台曾因一条未优化的SQL导致订单系统响应时间从200ms飙升至8秒,最终引发用户投诉和订单流失。今天我们就来系统学习MySQL...

一文读懂SQL五大操作类别(DDL/DML/DQL/DCL/TCL)的基础语法

在SQL中,DDL、DML、DQL、DCL、TCL是按操作类型划分的五大核心语言类别,缩写及简介如下:DDL(DataDefinitionLanguage,数据定义语言):用于定义和管理数据库结构...