forked from spring-projects/spring-framework
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add web support for Yaml via Jackson
This commit adds support for application/yaml in MediaType and leverages jackson-dataformat-yaml in order to support Yaml in RestTemplate, RestClient and Spring MVC. See spring-projectsgh-32345
- Loading branch information
Showing
11 changed files
with
177 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
76 changes: 76 additions & 0 deletions
76
...java/org/springframework/http/converter/yaml/MappingJackson2YamlHttpMessageConverter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
/* | ||
* Copyright 2002-2024 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.http.converter.yaml; | ||
|
||
import com.fasterxml.jackson.databind.ObjectMapper; | ||
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory; | ||
|
||
import org.springframework.http.MediaType; | ||
import org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter; | ||
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder; | ||
import org.springframework.util.Assert; | ||
|
||
/** | ||
* Implementation of {@link org.springframework.http.converter.HttpMessageConverter | ||
* HttpMessageConverter} that can read and write the <a href="https://yaml.io/">YAML</a> | ||
* data format using <a href="https://github.com/FasterXML/jackson-dataformat-yaml/tree/master"> | ||
* the dedicated Jackson 2.x extension</a>. | ||
* | ||
* <p>By default, this converter supports the {@link MediaType#APPLICATION_YAML_VALE} | ||
* media type. This can be overridden by setting the {@link #setSupportedMediaTypes | ||
* supportedMediaTypes} property. | ||
* | ||
* <p>The default constructor uses the default configuration provided by | ||
* {@link Jackson2ObjectMapperBuilder}. | ||
* | ||
* @author Hyoungjune Kim | ||
* @since 6.2 | ||
*/ | ||
public class MappingJackson2YamlHttpMessageConverter extends AbstractJackson2HttpMessageConverter { | ||
|
||
/** | ||
* Construct a new {@code MappingJackson2YamlHttpMessageConverter} using the | ||
* default configuration provided by {@code Jackson2ObjectMapperBuilder}. | ||
*/ | ||
public MappingJackson2YamlHttpMessageConverter() { | ||
this(Jackson2ObjectMapperBuilder.yaml().build()); | ||
} | ||
|
||
/** | ||
* Construct a new {@code MappingJackson2YamlHttpMessageConverter} with a | ||
* custom {@link ObjectMapper} (must be configured with a {@code YAMLFactory} | ||
* instance). | ||
* <p>You can use {@link Jackson2ObjectMapperBuilder} to build it easily. | ||
* @see Jackson2ObjectMapperBuilder#yaml() | ||
*/ | ||
public MappingJackson2YamlHttpMessageConverter(ObjectMapper objectMapper) { | ||
super(objectMapper, MediaType.APPLICATION_YAML); | ||
Assert.isInstanceOf(YAMLFactory.class, objectMapper.getFactory(), "YAMLFactory required"); | ||
} | ||
|
||
|
||
/** | ||
* {@inheritDoc} | ||
* The {@code ObjectMapper} must be configured with a {@code YAMLFactory} instance. | ||
*/ | ||
@Override | ||
public void setObjectMapper(ObjectMapper objectMapper) { | ||
Assert.isInstanceOf(YAMLFactory.class, objectMapper.getFactory(), "YAMLFactory required"); | ||
super.setObjectMapper(objectMapper); | ||
} | ||
|
||
} |
9 changes: 9 additions & 0 deletions
9
spring-web/src/main/java/org/springframework/http/converter/yaml/package-info.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
/** | ||
* Provides an HttpMessageConverter for the Yaml data format. | ||
*/ | ||
@NonNullApi | ||
@NonNullFields | ||
package org.springframework.http.converter.yaml; | ||
|
||
import org.springframework.lang.NonNullApi; | ||
import org.springframework.lang.NonNullFields; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.