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

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

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

背景

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

相关推荐

2023年最新微信小程序抓包教程(微信小程序 抓包)

声明:本公众号大部分文章来自作者日常学习笔记,部分文章经作者授权及其他公众号白名单转载。未经授权严禁转载。如需转载,请联系开百。请不要利用文章中的相关技术从事非法测试。由此产生的任何不良后果与文...

测试人员必看的软件测试面试文档(软件测试面试怎么说)

前言又到了毕业季,我们将会迎来许多需要面试的小伙伴,在这里呢笔者给从事软件测试的小伙伴准备了一份顶级的面试文档。1、什么是bug?bug由哪些字段(要素)组成?1)将在电脑系统或程序中,隐藏着的...

复活,视频号一键下载,有手就会,长期更新(2023-12-21)

视频号下载的话题,也算是流量密码了。但也是比较麻烦的问题,频频失效不说,使用方法也难以入手。今天,奶酪就来讲讲视频号下载的新方案,更关键的是,它们有手就会有用,最后一个方法万能。实测2023-12-...

新款HTTP代理抓包工具Proxyman(界面美观、功能强大)

不论是普通的前后端开发人员,还是做爬虫、逆向的爬虫工程师和安全逆向工程,必不可少会使用的一种工具就是HTTP抓包工具。说到抓包工具,脱口而出的肯定是浏览器F12开发者调试界面、Charles(青花瓷)...

使用Charles工具对手机进行HTTPS抓包

本次用到的工具:Charles、雷电模拟器。比较常用的抓包工具有fiddler和Charles,今天讲Charles如何对手机端的HTTS包进行抓包。fiddler抓包工具不做讲解,网上有很多fidd...

苹果手机下载 TikTok 旧版本安装包教程

目前苹果手机能在国内免拔卡使用的TikTok版本只有21.1.0版本,而AppStore是高于21.1.0版本,本次教程就是解决如何下载TikTok旧版本安装包。前期准备准备美区...

【0基础学爬虫】爬虫基础之抓包工具的使用

大数据时代,各行各业对数据采集的需求日益增多,网络爬虫的运用也更为广泛,越来越多的人开始学习网络爬虫这项技术,K哥爬虫此前已经推出不少爬虫进阶、逆向相关文章,为实现从易到难全方位覆盖,特设【0基础学爬...

防止应用调试分析IP被扫描加固实战教程

防止应用调试分析IP被扫描加固实战教程一、概述在当今数字化时代,应用程序的安全性已成为开发者关注的焦点。特别是在应用调试过程中,保护应用的网络安全显得尤为重要。为了防止应用调试过程中IP被扫描和潜在的...

一文了解 Telerik Test Studio 测试神器

1.简介TelerikTestStudio(以下称TestStudio)是一个易于使用的自动化测试工具,可用于Web、WPF应用的界面功能测试,也可以用于API测试,以及负载和性能测试。Te...

HLS实战之Wireshark抓包分析(wireshark抓包总结)

0.引言Wireshark(前称Ethereal)是一个网络封包分析软件。网络封包分析软件的功能是撷取网络封包,并尽可能显示出最为详细的网络封包资料。Wireshark使用WinPCAP作为接口,直接...

信息安全之HTTPS协议详解(加密方式、证书原理、中间人攻击 )

HTTPS协议详解(加密方式、证书原理、中间人攻击)HTTPS协议的加密方式有哪些?HTTPS证书的原理是什么?如何防止中间人攻击?一:HTTPS基本介绍:1.HTTPS是什么:HTTPS也是一个...

Fiddler 怎么抓取手机APP:抖音、小程序、小红书数据接口

使用Fiddler抓取移动应用程序(APP)的数据接口需要进行以下步骤:首先,确保手机与计算机连接在同一网络下。在计算机上安装Fiddler工具,并打开它。将手机的代理设置为Fiddler代理。具体方...

python爬虫教程:教你通过 Fiddler 进行手机抓包

今天要说说怎么在我们的手机抓包有时候我们想对请求的数据或者响应的数据进行篡改怎么做呢?我们经常在用的手机手机里面的数据怎么对它抓包呢?那么...接下来就是学习python的正确姿势我们要用到一款强...

Fiddler入门教程全家桶,建议收藏

学习Fiddler工具之前,我们先了解一下Fiddler工具的特点,Fiddler能做什么?如何使用Fidder捕获数据包、修改请求、模拟客户端向服务端发送请求、实施越权的安全性测试等相关知识。本章节...

fiddler如何抓取https请求实现手机抓包(100%成功解决)

一、HTTP协议和HTTPS协议。(1)HTTPS协议=HTTP协议+SSL协议,默认端口:443(2)HTTP协议(HyperTextTransferProtocol):超文本传输协议。默认...