Deprecate MediaType.APPLICATION_JSON_UTF8 in favor of APPLICATION_JSON #22788

reschke · 2019-04-12T05:30:43Z

In spring-framework/spring-web/src/main/java/org/springframework/http/MediaType.java:

 * <p>This {@link MediaType#APPLICATION_JSON} variant should be used to set JSON
 * content type because while
 * <a href="https://tools.ietf.org/html/rfc7159#section-11">RFC7159</a>
 * clearly states that "no charset parameter is defined for this registration", some
 * browsers require it for interpreting correctly UTF-8 special characters

RFC 7159 has been obsoleted by RFC 8259
That states "No "charset" parameter is defined for this registration. Adding one really has no effect on compliant recipients." (at the end of Section 11)
...and browsers have indeed fixed their code.

So it would be best to clarify the text and deprecate the constant.

The text was updated successfully, but these errors were encountered:

sdeleuze · 2019-04-25T08:21:18Z

Indeed, the related Chrome bug discussed in #18178 is fixed since September 2017, and I have been able to validate that UTF-8 characters are now rendered correctly with Content-Type: application/json, so I am ok to switch back to MediaType.APPLICATION_JSON, deprecate MediaType.APPLICATION_JSON_UTF8 and update the documentation accordingly in Spring Framework 5.2.

This commit deprecates MediaType.APPLICATION_JSON_UTF8 and MediaType.APPLICATION_PROBLEM_JSON_UTF8 in favor of MediaType.APPLICATION_JSON and MediaType.APPLICATION_PROBLEM_JSON since UTF-8 encoding is now handled correctly by most browsers (related bug has been fixed in Chrome since September 2017). Closes spring-projectsgh-22788

sdeleuze · 2019-04-29T15:27:33Z

It is a shame, but Safari still has this bug so we should decide what to do ...

sdeleuze · 2019-04-29T16:20:43Z

I have created https://bugs.webkit.org/show_bug.cgi?id=197369 on Safari bugtracker, let's see what is their feedback.

sdeleuze · 2019-04-29T19:27:27Z

The Safari bug is only impacting the display in the main frame, not via XMLHttpRequest, so I think we can move forward and merge that in master.

reschke · 2019-04-30T17:08:42Z

The Safari bug is only impacting the display in the main frame, not via XMLHttpRequest, ...

FWIW, I believe the same way true for the matching bugs in Chromium and Firefox.

This change is a follow-up to the ones done as part of spring-projectsgh-22788. Closes spring-projectsgh-22954

Follow spring-projects/spring-framework#22788

Solve test error by removing the charset in the content type validation as the default value has been changed in Spring Boot 2.2. See gh-22788 (spring-projects/spring-framework#22788)

In the newest versions of Spring Framework, after a change[1] to align it with the RFC8259[2], the character encoding is no longer set to UTF-8 for responses with `application/json` content-type. Tomcat's `Response#getCharacterEncoding()` returns ISO-8895-1 if it is not set explicitly. This fix makes a `JsonResponseWrapper` use UTF-8 by default, instead of getting charset from the wrapped `Response` instance which could have been not set. [1]: spring-projects/spring-framework#22788 [2]: https://tools.ietf.org/html/rfc8259#section-11

In the newest versions of Spring Framework, after a change[1] to align it with the RFC8259[2], the character encoding is no longer set to UTF-8 for responses with `application/json` content-type. This fix makes a `JsonResponseWrapper` use UTF-8 by default, instead of getting charset from the wrapped `Response` instance which could have been not set and so it returns default ISO-8895-1. [1]: spring-projects/spring-framework#22788 [2]: https://tools.ietf.org/html/rfc8259#section-11

spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Apr 12, 2019

jhoeller modified the milestones: 5.1.7, 5.2 M2 Apr 12, 2019

sdeleuze self-assigned this Apr 12, 2019

sdeleuze added type: documentation A documentation task type: task A general task and removed status: waiting-for-triage An issue we've not yet triaged or decided on type: documentation A documentation task labels Apr 12, 2019

sdeleuze changed the title ~~Misleading doc for MediaType.APPLICATION_JSON_UTF8~~ Deprecate MediaType.APPLICATION_JSON_UTF8 in favor of APPLICATION_JSON Apr 25, 2019

sdeleuze closed this as completed in 89454e6 Apr 30, 2019

gregturn mentioned this issue Apr 30, 2019

Deprecate _UTF8 media type variants spring-projects/spring-hateoas#987

Closed

sdeleuze mentioned this issue May 13, 2019

Remove charset parameter from Spring MVC JSON content type #22954

Closed

sdeleuze added a commit to sdeleuze/spring-framework that referenced this issue May 27, 2019

Remove charset parameter from Spring MVC JSON content type

bc205e0

This change is a follow-up to the ones done as part of spring-projectsgh-22788. Closes spring-projectsgh-22954

wilkinsona mentioned this issue May 28, 2019

Align with Framework dropping the charset attribute from JSON content type headers spring-projects/spring-boot#16979

Closed

rj-hwang added a commit to simter/simter-operation that referenced this issue Jun 5, 2019

Remove charset from JSON content type

7b807b0

Follow spring-projects/spring-framework#22788

rj-hwang added a commit to simter/simter-kv that referenced this issue Jun 6, 2019

Remove charset from JSON content type

3b51bac

Follow spring-projects/spring-framework#22788

sbrannen mentioned this issue Jul 1, 2019

MockMvc no longer handles UTF-8 characters #23219

Closed

sdeleuze mentioned this issue Jul 11, 2019

Support application/json;charset=UTF-8 for ProtobufHttpMessageConverter #23271

Closed

jzheaux mentioned this issue Aug 8, 2019

Remove Usage of MediaType.HAL_JSON_UTF8 spring-attic/spring-security-oauth2-boot#153

Closed

sainaen mentioned this issue Jan 29, 2020

Use UTF-8 for captured responses if charset is not set explicitly alexeytokar/rainbow-rest#39

Merged

This was referenced Jan 31, 2020

RDM-7457 - SpringBoot to latest 2.2.4 hmcts/ccd-definition-store-api#528

Merged

Spring boot upgrade 2.2.4.RELEASE hmcts/ccd-user-profile-api#246

Merged

rstoyanchev mentioned this issue Feb 4, 2020

Regression issue with response encoding between Spring Boot 2.1.x and 2.2.x #24477

Closed

rstoyanchev mentioned this issue Mar 3, 2020

Remove UTF-8 charset parameter from Content-Type in SseEmitter #24632

Closed

tdonohue mentioned this issue Mar 23, 2020

Upgrade backend to Spring Boot v2.2.6, Spring v5.2.5, Spring HATEOAS v1.0.3 DSpace/DSpace#2720

Merged

OmarHawk mentioned this issue Mar 30, 2020

RestController returning JSON String producing incorrect Content-Type charset #24813

Closed

rhengeveld mentioned this issue Apr 29, 2020

Diakrieten komen niet goed over in natuurlijke persoon kadaster/BRK-bevragen#448

Closed

bclozel mentioned this issue Jun 23, 2020

MappingJackson2HttpMessageConverter default character set issue #25304

Closed

pbetkier mentioned this issue Jun 29, 2020

RestTemplate reads JSON body as ISO-8859-1 instead of UTF-8 when +json suffix content-type #25328

Closed

This was referenced Jul 16, 2020

Content Type being append with charset=ISO-8859-1 spring-cloud/spring-cloud-contract#1428

Closed

Fix content type name before charset recognition rest-assured/rest-assured#1341

Merged

rob-valor mentioned this issue Oct 19, 2020

HttpEncodingAutoConfiguration is not added to the WebMvcTest slice spring-projects/spring-boot#23749

Closed

sohtsuka mentioned this issue Nov 23, 2020

The log contains Chinese, which is not displayed correctly. zalando/logbook#870

Closed

rstoyanchev mentioned this issue Nov 30, 2020

Spring default characterEncoding #26171

Closed

marcingrzejszczak mentioned this issue Dec 10, 2020

Misaligned spans exception when used with spring-data-mongodb-reactive and spring-cloud-stream spring-cloud/spring-cloud-sleuth#1770

Closed

metacubed mentioned this issue Jan 18, 2021

UAA returns JSON error responses with incorrect media type. cloudfoundry/uaa#1498

Closed

vikrama mentioned this issue Jan 18, 2021

Content-Type: "application/json; charset=utf-8" causes HTTP 422 Unprocessable Entity in graphql-java-spring apollographql/apollo-kotlin#2882

Closed

pedrodovale mentioned this issue Jan 19, 2021

NimbusOpaqueTokenIntrospector uses deprecated MediaType.APPLICATION_JSON_UTF8 spring-projects/spring-security#9353

Closed

boris-bc mentioned this issue Apr 15, 2021

Remove deprecated use of MediaType.APPLICATION_JSON_UTF8_VALUE zowe/api-layer#1369

Merged

14 tasks

rstoyanchev mentioned this issue Jan 10, 2022

Use UTF-8 for application/json in MockHttpServletResponse #27846

Closed

rstoyanchev mentioned this issue Feb 8, 2022

Content Negotiation with media type parameters: Method producing exact match of Accept content type is not called. #27999

Closed

bclozel mentioned this issue Jul 22, 2022

Improve documentation about deprecation for APPLICATION_JSON[-VALUE] but for programmatic clients #28859

Closed

melsk-r mentioned this issue Jul 1, 2024

Diakrieten komen niet goed over in natuurlijke persoon VNG-Realisatie/Haal-Centraal-BRK-bevragen-issues#361

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate MediaType.APPLICATION_JSON_UTF8 in favor of APPLICATION_JSON #22788

Deprecate MediaType.APPLICATION_JSON_UTF8 in favor of APPLICATION_JSON #22788

reschke commented Apr 12, 2019

sdeleuze commented Apr 25, 2019

sdeleuze commented Apr 29, 2019

sdeleuze commented Apr 29, 2019

sdeleuze commented Apr 29, 2019

reschke commented Apr 30, 2019

Deprecate MediaType.APPLICATION_JSON_UTF8 in favor of APPLICATION_JSON #22788

Deprecate MediaType.APPLICATION_JSON_UTF8 in favor of APPLICATION_JSON #22788

Comments

reschke commented Apr 12, 2019

sdeleuze commented Apr 25, 2019

sdeleuze commented Apr 29, 2019

sdeleuze commented Apr 29, 2019

sdeleuze commented Apr 29, 2019

reschke commented Apr 30, 2019