-
Notifications
You must be signed in to change notification settings - Fork 8.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
HADOOP-19231. Add JacksonUtil to manage Jackson classes (#6953)
New class org.apache.hadoop.util.JacksonUtil centralizes construction of Jackson ObjectMappers and JsonFactories. Contributed by PJ Fanning
- Loading branch information
Showing
71 changed files
with
392 additions
and
296 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
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
123 changes: 123 additions & 0 deletions
123
hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/JacksonUtil.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,123 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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 | ||
| * | ||
| * http://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.apache.hadoop.util; | ||
|
|
||
| import com.fasterxml.jackson.core.JsonFactory; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import com.fasterxml.jackson.databind.ObjectReader; | ||
| import com.fasterxml.jackson.databind.ObjectWriter; | ||
| import com.fasterxml.jackson.databind.json.JsonMapper; | ||
|
|
||
| import org.apache.hadoop.classification.InterfaceAudience.Private; | ||
|
|
||
| /** | ||
| * Utility for sharing code related to Jackson usage in Hadoop. | ||
| */ | ||
| @Private | ||
| public final class JacksonUtil { | ||
|
|
||
| private static final ObjectMapper SHARED_BASIC_OBJECT_MAPPER = createBasicObjectMapper(); | ||
| private static final ObjectReader SHARED_BASIC_OBJECT_READER = | ||
| SHARED_BASIC_OBJECT_MAPPER.reader(); | ||
| private static final ObjectWriter SHARED_BASIC_OBJECT_WRITER = | ||
| SHARED_BASIC_OBJECT_MAPPER.writer(); | ||
| private static final ObjectWriter SHARED_BASIC_OBJECT_WRITER_PRETTY = | ||
| SHARED_BASIC_OBJECT_MAPPER.writerWithDefaultPrettyPrinter(); | ||
|
|
||
| /** | ||
| * Creates a new {@link JsonFactory} instance with basic configuration. | ||
| * | ||
| * @return an {@link JsonFactory} with basic configuration | ||
| */ | ||
| public static JsonFactory createBasicJsonFactory() { | ||
| // deliberately return a new instance instead of sharing one because we can't trust | ||
| // that users won't modify this instance | ||
| return new JsonFactory(); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new {@link ObjectMapper} instance with basic configuration. | ||
| * | ||
| * @return an {@link ObjectMapper} with basic configuration | ||
| */ | ||
| public static ObjectMapper createBasicObjectMapper() { | ||
| // deliberately return a new instance instead of sharing one because we can't trust | ||
| // that users won't modify this instance | ||
| return JsonMapper.builder(createBasicJsonFactory()).build(); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new {@link ObjectMapper} instance based on the configuration | ||
| * in the input {@link JsonFactory}. | ||
| * | ||
| * @param jsonFactory a pre-configured {@link JsonFactory} | ||
| * @return an {@link ObjectMapper} with configuration set by the input {@link JsonFactory}. | ||
| */ | ||
| public static ObjectMapper createObjectMapper(final JsonFactory jsonFactory) { | ||
| return JsonMapper.builder(jsonFactory).build(); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a shared {@link ObjectReader} instance with basic configuration. | ||
| * | ||
| * @return a shared {@link ObjectReader} instance with basic configuration | ||
| */ | ||
| public static ObjectReader getSharedReader() { | ||
| return SHARED_BASIC_OBJECT_READER; | ||
| } | ||
|
|
||
| /** | ||
| * Returns an {@link ObjectReader} for the given type instance with basic configuration. | ||
| * | ||
| * @param type the class that the reader has to support | ||
| * @return an {@link ObjectReader} instance with basic configuration | ||
| */ | ||
| public static ObjectReader createBasicReaderFor(Class<?> type) { | ||
| return SHARED_BASIC_OBJECT_MAPPER.readerFor(type); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a shared {@link ObjectWriter} instance with basic configuration. | ||
| * | ||
| * @return a shared {@link ObjectWriter} instance with basic configuration | ||
| */ | ||
| public static ObjectWriter getSharedWriter() { | ||
| return SHARED_BASIC_OBJECT_WRITER; | ||
| } | ||
|
|
||
| /** | ||
| * Returns a shared {@link ObjectWriter} instance with pretty print and basic configuration. | ||
| * | ||
| * @return a shared {@link ObjectWriter} instance with pretty print and basic configuration | ||
| */ | ||
| public static ObjectWriter getSharedWriterWithPrettyPrint() { | ||
| return SHARED_BASIC_OBJECT_WRITER_PRETTY; | ||
| } | ||
|
|
||
| /** | ||
| * Returns an {@link ObjectWriter} for the given type instance with basic configuration. | ||
| * | ||
| * @param type the class that the writer has to support | ||
| * @return an {@link ObjectWriter} instance with basic configuration | ||
| */ | ||
| public static ObjectWriter createBasicWriterFor(Class<?> type) { | ||
| return SHARED_BASIC_OBJECT_MAPPER.writerFor(type); | ||
| } | ||
|
|
||
| private JacksonUtil() {} | ||
| } |
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.