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

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

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

背景

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

相关推荐

python入门到脱坑函数—定义函数_如何定义函数python

Python函数定义:从入门到精通一、函数的基本概念函数是组织好的、可重复使用的代码块,用于执行特定任务。在Python中,函数可以提高代码的模块性和重复利用率。二、定义函数的基本语法def函数名(...

javascript函数的call、apply和bind的原理及作用详解

javascript函数的call、apply和bind本质是用来实现继承的,专业点说法就是改变函数体内部this的指向,当一个对象没有某个功能时,就可以用这3个来从有相关功能的对象里借用过来...

JS中 call()、apply()、bind() 的用法

其实是一个很简单的东西,认真看十分钟就从一脸懵B到完全理解!先看明白下面:例1obj.objAge;//17obj.myFun()//小张年龄undefined例2shows(...

Pandas每日函数学习之apply函数_apply函数python

apply函数是Pandas中的一个非常强大的工具,它允许你对DataFrame或Series中的数据应用一个函数,可以是自定义的函数,也可以是内置的函数。apply可以作用于DataF...

Win10搜索不习惯 换个设定就好了_window10搜索用不了怎么办

Windows10的搜索功能是真的方便,这点用惯了Windows10的小伙伴应该都知道,不过它有个小问题,就是Windows10虽然会自动联网搜索,但默认使用微软自家的Bing搜索引擎和Edge...

面试秘籍:call、bind、apply的区别,面试官为什么总爱问这三位?

引言你有没有发现,每次JavaScript面试,面试官总爱问你call、bind和apply的区别?好像这三个方法成了通关密码,掌握了它们,就能顺利过关。其实不难理解,面试官问这些问题,不...

记住这8招,帮你掌握“追拍“摄影技法—摄影早自习第422日

杨海英同学提问:请问叶梓老师,我练习追拍时,总也不能把运动的人物拍清晰,速度一般掌握在1/40-1/60,请问您如何把追拍拍的清晰?这跟不同的运动形式有关系吗?请您给讲讲要点,谢谢您!摄影:Damia...

[Sony] 有点残酷的测试A7RII PK FS7

都是好机!手中利器!主要是最近天天研究fs5,想知道fs5与a7rii后期匹配问题,苦等朋友的fs5月底到货,于是先拿手里现有的fs7小测一下,十九八九也能看到fs5的影子,另外也了解一下fs5k标配...

AndroidStudio_Android使用OkHttp发起Http请求

这个okHttp的使用,其实网络上有很多的案例的,但是,如果以前没用过,copy别人的直接用的话,可以发现要么导包导不进来,要么,人家给的代码也不完整,这里自己整理一下.1.引入OkHttp的jar...

ESL-通过事件控制FreeSWITCH_es事务控制

通过事件提供的最底层控制机制,允许我们有效地利用工具箱,适时选择使用其中的单个工具。FreeSWITCH是一个核心交换与混合矩阵,它周围有几十个模块提供各种功能特性。我们完全控制了所有的即时信息,这些...

【调试】perf和火焰图_perf生成火焰图

简介perf是linux上的性能分析工具,perf可以对event进行统计得到event的发生次数,或者对event进行采样,得到每次event发生时的相关数据(cpu、进程id、运行栈等),利用这些...

文本检索控件也玩安卓?dtSearch Engine发布Android测试版

dtSearchEngineforLinux(原生64-bit/32-bitC++和JavaAPIs)和dtSearchEngineforWin&.NET(原生64-bi...

网站后台莫名增加N个管理员,记一次SQL注入攻击

网站没流量,但却经常被SQL注入光顾。最近,网站真的很奇怪,网站后台不光莫名多了很多“管理员”,所有的Wordpres插件还会被自动暂停,导致一些插件支持的页面,如WooCommerce无法正常访问、...

多元回归树分析Multivariate Regression Trees,MRT

多元回归树(MultivariateRegressionTrees,MRT)是单元回归树的拓展,是一种对一系列连续型变量递归划分成多个类群的聚类方法,是在决策树(decision-trees)基础...

JMETER性能测试_JMETER性能测试指标

jmeter为性能测试提供了一下特色:jmeter可以对测试静态资源(例如js、html等)以及动态资源(例如php、jsp、ajax等等)进行性能测试jmeter可以挖掘出系统最大能处...