為什么阿里巴巴Java開(kāi)發(fā)手冊(cè)中強(qiáng)制要求超大整數(shù)禁止使用Long類型返回?
本文轉(zhuǎn)載自微信公眾號(hào)「武培軒」,作者武培軒 。轉(zhuǎn)載本文請(qǐng)聯(lián)系武培軒公眾號(hào)。
在閱讀《阿里巴巴Java開(kāi)發(fā)手冊(cè)》時(shí),發(fā)現(xiàn)有一條關(guān)于前后端超大整數(shù)返回的規(guī)約,具體內(nèi)容如下:
這個(gè)問(wèn)題在之前和前端聯(lián)調(diào)的時(shí)候發(fā)生過(guò),發(fā)現(xiàn)根據(jù)腳本 id 去審批的時(shí)候,狀態(tài)沒(méi)有變化,后來(lái)和前端溝通后,才知道這是 JavaScript 的一個(gè)坑,下面來(lái)復(fù)現(xiàn)下這個(gè)錯(cuò)誤:
錯(cuò)誤演示
創(chuàng)建一個(gè) Spring Boot 項(xiàng)目,然后在新建一個(gè)接口,可以返回 DbScript 對(duì)象,其中 id 是由 mybatis-plus 的 IdWorker.getId(基于 Snowflake 算法)生成的 19 位 long 類型的數(shù)值。
- @RestController
- @RequestMapping("/dbScrip")
- public class DbScriptController {
- Logger logger = LoggerFactory.getLogger(DbScriptController.class);
- @RequestMapping("/info")
- public DbScript getDbScript() {
- DbScript dbScript = new DbScript();
- // 賦予一個(gè)大整數(shù) long 型腳本 id
- long id = IdWorker.getId();
- dbScript.setId(id);
- logger.info("id:{}", id);
- return dbScript;
- }
- }
接著啟動(dòng)服務(wù),在瀏覽器上訪問(wèn)該接口,結(jié)果如下所示:
通過(guò)日志可以看到后端傳給前端的 id 為 1304270071757017088,但是前端拿到的卻為 1304270071757017000,其中發(fā)生了精度損失。
為什么會(huì)發(fā)生這樣的情況呢?
通過(guò)開(kāi)發(fā)手冊(cè),我們可以知道如果返回的數(shù)值超過(guò) 2 的 53 次方,就會(huì)轉(zhuǎn)換成 JS 的 Number,此時(shí)有些數(shù)值就有可能發(fā)生精度損失。
解決方法
那如果遇到了這種情況,該如何解決呢?
不要慌,可以采取以下幾種方法:
如果這個(gè)對(duì)象只在這個(gè)方法中用到了,可以將該屬性直接從 Long 類型改為 String 類型。
如果這個(gè)對(duì)象在很多地方都用到了,可以在序列化的時(shí)候,將 Long 類型轉(zhuǎn)換成 String 類型。
還可以添加一個(gè)新的 String 類型的屬性,專門用來(lái)在前后端傳輸這種大整數(shù)。
第一種方法
第一種方法比較簡(jiǎn)單,直接將 Long id; 改為 String id;,這種只適用于這個(gè)對(duì)象只在這個(gè)方法中使用了,比較局限。
第二種方法
第二種方法可以在屬性上增加注解,如果使用的Jackson,可以添加 @JsonFormat(shape = JsonFormat.Shape.STRING) 或者 @JsonSerialize(using = ToStringSerializer.class) 注解。
如果這種需要修改的情況比較多,那么逐個(gè)添加還是有點(diǎn)費(fèi)事,那么還有什么好辦法嗎?
如果使用的是Jackson,它有個(gè)配置參數(shù) WRITE_NUMBERS_AS_STRINGS,可以強(qiáng)制將所有數(shù)字全部轉(zhuǎn)成字符串輸出,使用方法很簡(jiǎn)單,只需要配置參數(shù)即可:spring.jackson.generator.write_numbers_as_strings=true,這種方式的優(yōu)點(diǎn)是使用方便,不需要調(diào)整代碼;缺點(diǎn)是顆粒度太大,所有的數(shù)字都被轉(zhuǎn)成字符串輸出了,包括按照 timestamp 格式輸出的時(shí)間也是如此。
那么還有什么方法能夠只對(duì) Long 類型進(jìn)行處理轉(zhuǎn)換成 String 類型呢?
Jackson 提供了這種支持,可以對(duì) ObjectMapper 進(jìn)行定制,具體代碼如下所示:
- public class JacksonConfiguration {
- @Bean
- public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
- return jacksonObjectMapperBuilder -> jacksonObjectMapperBuilder
- .serializerByType(Long.class, ToStringSerializer.instance)
- .serializerByType(Long.TYPE, ToStringSerializer.instance);
- }
- }
通過(guò)定義 Jackson2ObjectMapperBuilderCustomizer,對(duì) Jackson2ObjectMapperBuilder 對(duì)象進(jìn)行定制,對(duì) Long 型數(shù)據(jù)進(jìn)行了定制,使用ToStringSerializer來(lái)進(jìn)行序列化。
第三種方法
第三種方法就需要多一個(gè)屬性,比如使用String dbScripId,用來(lái)代替之前的 id。
總結(jié)
本文針對(duì)《阿里巴巴Java開(kāi)發(fā)手冊(cè)》中的對(duì)于需要使用超大整數(shù)的場(chǎng)景,服務(wù)端一律使用 String 字符串類型返回,禁止使用Long 類型出發(fā),提出了幾種解決方法,大家可以根據(jù)自己的需求去選擇方法,有其他解決方法的也歡迎留言討論。