Spring Mvc Long型別精度丟失

諸葛小亮發表於2021-06-07
SpringMVC型別

背景

在使用Spring Boot Mvc的專案中，使用Long型別作為id的型別，但是當前端使用Number型別接收Long型別資料時，由於前端精度問題，會導致Long型別資料轉換為Number型別時的後兩位變為0

Spring Boot Controller

以下程式碼提供一個Controller，返回一個Dto, Dto的id是Long型別的，其中id的返回資料是1234567890102349123
@CrossOrigin 註解表示可以跨域訪問


@RestController()
@RequestMapping
public class LongDemoController {

    @GetMapping("getLongValue")
    @CrossOrigin(origins = "*")
    public GetLongValueDto getLongValue(){
        GetLongValueDto result = new GetLongValueDto();
        result.setId(1234567890102349123L);
        return result;
    }

    @Data
    public static class GetLongValueDto{
        private Long id;
    }

}

前端呼叫

現在使用jquery呼叫後端地址，模擬前端呼叫

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>spring boot mvc long</title>
</head>
<body>
<p>Long:<span id='resId'></span></p>
<p>Id型別:<span id='idType'></span></p>
 
<script src="https://cdn.bootcdn.net/ajax/libs/jquery/3.6.0/jquery.js"></script>
<script type="text/javascript">
$(document).ready(function(){
	console.log('init');
	$.ajax({url:"http://localhost:8080/getLongValue"})
		.then(res=>{
			console.log({
				'getLongValue':res
			});
			$('#resId').text(res.id);
			$('#idType').text(typeof res.id);
		})
});
</script>
</body>
</html>

執行結果

通過輸出結果和檢視網路的內容，發現實際上id返回的結果是1234567890102349000，最後幾位都變成了00, 這是因為，javascript的Number型別最大長度是17位，而後端返回的Long型別有19位，導致js的Number不能解析。

方案

既然不能使用js的Number接收，那麼前端如何Long型別的資料呢，答案是js使用string型別接收

方案一 @JsonSerialize 註解

修改Dto的id欄位，使用@JsonSerialize註解指定型別為string。
這個方案有一個問題，就是需要程式設計師明確指定@JsonSerialize， 在實際的使用過程中，程式設計師會很少注意到Long型別的問題，只有和前端聯調的時候發現不對。


    @Data
    public static class GetLongValueDto{
        @JsonSerialize(using= ToStringSerializer.class)
        private Long id;
    }

方案二 全域性處理器

新增Configuration， 處理 HttpMessageConverter


@Configuration
public class WebConfiguration implements WebMvcConfigurer {
    /**
     * 序列化json時,將所有的long變成string
     * 因為js中得數字型別不能包含所有的java long值
     */
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        MappingJackson2HttpMessageConverter jackson2HttpMessageConverter = new MappingJackson2HttpMessageConverter();
        ObjectMapper objectMapper = new ObjectMapper();
        SimpleModule simpleModule=new SimpleModule();
        simpleModule.addSerializer(Long.class, ToStringSerializer.instance);
        simpleModule.addSerializer(Long.TYPE, ToStringSerializer.instance);
        objectMapper.registerModule(simpleModule);
        jackson2HttpMessageConverter.setObjectMapper(objectMapper);
        converters.add(0,jackson2HttpMessageConverter);
    }
}


    @Data
    public static class GetLongValueDto{
        private Long id;
    }

發現沒有@JsonSerialize註解的資訊，前端接收到的資料，也是string型別了。

與swagger整合

上面只是解決了傳輸時的long型別轉string，但是當整合了swagger時，swagger文件描述的型別仍然是number型別的，這樣在根據swagger文件生成時，會出現型別不匹配的問題

swagger 文件整合

pom或gradle

implementation group: 'io.springfox', name: 'springfox-boot-starter', version: '3.0.0'

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

檢視文件, 發現 GetLongValueDto 描述的id型別是 integer($int64)

swagger long型別描述為string

需要修改swagger的配置, 修改 Docket 的配置

.directModelSubstitute(Long.class, String.class)
                .directModelSubstitute(long.class, String.class)


@Configuration
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())//api的配置路徑
                .paths(PathSelectors.any())//掃描路徑選擇
                .build()
                .directModelSubstitute(Long.class, String.class)
                .directModelSubstitute(long.class, String.class)
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("title") //文件標題
                .description("description")//介面概述
                .version("1.0") //版本號
                .termsOfServiceUrl(String.format("url"))//服務的域名
                //.license("LICENSE")//證照
                //.licenseUrl("http://www.guangxu.com")//證照的url
                .build();
    }

}

檢視swagger文件 , 可以看到 文件中型別已經是 string了

總結

  1. long型別傳輸到前端的兩種方案：註解、修改HttpMessageConverter
  2. 使用directModelSubstitute解決swagger文件中型別描述，避免生成程式碼器中描述的型別錯誤

關注我的公總號，一起探索新知識新技術

相關文章