MockMvc nie obsługuje już znaków UTF-8 w Spring Boot 2.2.0

Po aktualizacji do nowo wydanej 2.2.0.RELEASEwersji Spring Boot niektóre z moich testów zakończyły się niepowodzeniem. Wygląda na to, że MediaType.APPLICATION_JSON_UTF8został on uznany za przestarzały i nie jest już zwracany jako domyślny typ zawartości z metod kontrolera, które nie określają jawnie typu zawartości.

Kod testowy jak

String content = mockMvc.perform(get("/some-api")
            .contentType(MediaType.APPLICATION_JSON))
            .andExpect(status().isOk())
            .andExpect(content().contentType(MediaType.APPLICATION_JSON_UTF8))
            .andReturn()
            .getResponse()
            .getContentAsString();

nagle przestał działać, ponieważ typ zawartości był niezgodny, jak pokazano poniżej

java.lang.AssertionError: Content type 
Expected :application/json;charset=UTF-8
Actual   :application/json

Na razie zmieniam kod, aby .andExpect(content().contentType(MediaType.APPLICATION_JSON))rozwiązać problem.

Ale teraz w porównaniu contentz oczekiwanym serializowanym obiektem nadal występuje niedopasowanie, jeśli w obiekcie znajdują się jakieś znaki specjalne. Wygląda na to, że .getContentAsString()metoda nie wykorzystuje domyślnie kodowania znaków UTF-8 (więcej).

java.lang.AssertionError: Response content expected:<[{"description":"Er hörte leise Schritte hinter sich."}]> but was:<[{"description":"Er hörte leise Schritte hinter sich."}]>
Expected :[{"description":"Er hörte leise Schritte hinter sich."}]
Actual   :[{"description":"Er hörte leise Schritte hinter sich."}]

Jak mogę uzyskać contentkodowanie UTF-8?

Tak. Jest to problem z wersji wiosennej 2.2.0. Ustawiają wycofanie dla domyślnego kodowania zestawu znaków.

.getContentAsString(StandardCharsets.UTF_8) - dobrze, ale w każdej odpowiedzi domyślnie zostanie wypełniona ISO 8859-1.

W moim projekcie zaktualizowałem aktualnie utworzony konwerter:

@Configuration
public class SpringConfig implements WebMvcConfigurer {

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.stream()
            .filter(converter -> converter instanceof MappingJackson2HttpMessageConverter)
            .findFirst()
            .ifPresent(converter -> ((MappingJackson2HttpMessageConverter) converter).setDefaultCharset(UTF_8));
    }
...

Używanie .getContentAsString(StandardCharsets.UTF_8)zamiast .getContentAsString()rozwiązywać problem.

Domyślny znak kodowania nie jest już UTF-8 od wersji wiosennej 5.2.0.

Aby kontynuować korzystanie z UTF-8, musisz ustawić go w odpowiedzi ServletRock wyniku MockMvc. Aby ustawić domyślne kodowanie znaków na UTF-8, wykonaj coś takiego w metodzie konfiguracji:

@Before
public void setUp() {
   mockMvc = webAppContextSetup(wac).addFilter(((request, response, chain) -> {
                response.setCharacterEncoding("UTF-8");
                chain.doFilter(request, response);
            })).build();
}

Następnie możesz użyć instancji mockMvc, aby wykonać żądanie.

Mam nadzieję, że to pomoże.

Zgodnie z tym żądaniem ściągania od deweloperów wiosennych nagłówek UTF-8 nie jest już wymagany i dlatego jest przestarzały. Jeśli używasz nagłówka UTF-8 w swojej aplikacji, możesz spróbować usunąć go z aplikacji zamiast próbować naprawić test. Upewnij się tylko, że używasz nagłówka Content-Type: application / json i wszystko powinno być w porządku.

Używam Spring Boot 1.5.15. RELEASE i napotkałem ten sam problem podczas pisania testów.

Pierwszym rozwiązaniem, które pomogło mi, było dodanie .characterEncoding („UTF-8”)) w następujący sposób:

String content = mockMvc.perform(get("/some-api")
            .contentType(MediaType.APPLICATION_JSON)
            .characterEncoding("UTF-8"))
            .andExpect(status().isOk())
            .andExpect(content().contentType(MediaType.APPLICATION_JSON_UTF8))
            .andReturn()
            .getResponse()
            .getContentAsString();

Używam StandaloneMockMvcBuilder w mojej klasie testowej, więc drugim rozwiązaniem, które pomogło mi, było utworzenie filtra, np .:

private static class Utf8Filter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
        throws ServletException, IOException {
        response.setCharacterEncoding(StandardCharsets.UTF_8.toString());
        filterChain.doFilter(request, response);
    }
}

a później dodaj go do metody standaloneSetup w mojej klasie testowej w następujący sposób:

@Before
public void setup() {
    MockitoAnnotations.initMocks(this);
    final SomeResource someResource = new SomeResource(someService);
    this.restLankMockMvc = MockMvcBuilders.standaloneSetup(someResource)
        .setCustomArgumentResolvers(pageableArgumentResolver)
        .setControllerAdvice(exceptionTranslator)
        .setConversionService(createFormattingConversionService())
        .setMessageConverters(jacksonMessageConverter)
        .addFilter(new Utf8Filter())
        .build();
}

Dodatkowe ustawienie MockMvc .accept(MediaType.APPLICATION_JSON_UTF8_VALUE):

    String content = mockMvc.perform(get("/some-api")
        .contentType(MediaType.APPLICATION_JSON)
        .accept(MediaType.APPLICATION_JSON_UTF8_VALUE))
        .andExpect(status().isOk())
        .andExpect(content().contentType(MediaType.APPLICATION_JSON))
        .andReturn()
        .getResponse()
        .getContentAsString();

Ten problem nie dotyczy Spring Boot, ale chyba konkretny MockMvc. Tak więc obejście musi być zastosowane tylko do MockMvc. ( JSON musi być zakodowany przy użyciu UTF-8 .)

powiązany problem: niewłaściwa obsługa UTF-8 w MockMvc dla odpowiedzi JSON · Problem # 23622 · wiosenne projekty / wiosenne ramy