com.github.joekerouac.common.tools.codec.json.JacksonJsonCodec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common-tools Show documentation
各种常用工具
The newest version!
/*
 * 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 com.github.joekerouac.common.tools.codec.json;

import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.lang.reflect.Type;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.function.Consumer;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.github.joekerouac.common.tools.codec.Codec;
import com.github.joekerouac.common.tools.codec.exception.SerializeException;
import com.github.joekerouac.common.tools.codec.json.databind.DateDeserializer;
import com.github.joekerouac.common.tools.codec.json.databind.DateSerializer;
import com.github.joekerouac.common.tools.codec.json.databind.InMemoryFileDeserializer;
import com.github.joekerouac.common.tools.codec.json.databind.InMemoryFileSerializer;
import com.github.joekerouac.common.tools.codec.json.databind.LocalDateTimeDeserializer;
import com.github.joekerouac.common.tools.codec.json.databind.LocalDateTimeSerializer;
import com.github.joekerouac.common.tools.codec.json.databind.ResourceDeserializer;
import com.github.joekerouac.common.tools.codec.json.databind.ResourceSerializer;
import com.github.joekerouac.common.tools.codec.json.databind.SerializeRegister;
import com.github.joekerouac.common.tools.collection.CollectionUtil;
import com.github.joekerouac.common.tools.enums.ErrorCodeEnum;
import com.github.joekerouac.common.tools.reflect.type.AbstractTypeReference;

/**
 * jackson实现的json序列化器
 * 
 * @since 1.0.0
 * @author JoeKerouac
 * @date 2022-10-14 14:37:00
 */
public class JacksonJsonCodec implements Codec {

    private static final Charset JSON_DEFAULT_CHARSET = StandardCharsets.UTF_8;

    /**
     * 当前系统默认序列化注册器
     */
    public static final List DEFAULT_SERIALIZE_REGISTERS;

    static {
        List serializeRegisters = new ArrayList<>();
        serializeRegisters.add(new ResourceDeserializer<>());
        serializeRegisters.add(new ResourceSerializer());
        serializeRegisters.add(new LocalDateTimeSerializer());
        serializeRegisters.add(new LocalDateTimeDeserializer());
        serializeRegisters.add(new DateSerializer());
        serializeRegisters.add(new DateDeserializer());
        serializeRegisters.add(new InMemoryFileSerializer());
        serializeRegisters.add(new InMemoryFileDeserializer());
        DEFAULT_SERIALIZE_REGISTERS = Collections.unmodifiableList(serializeRegisters);
    }

    protected final ObjectMapper mapper;

    public JacksonJsonCodec() {
        this(null);
    }

    /**
     * 构造器
     * 
     * @param visitor
     *            ObjectMapper访问器，给外部提供自定义ObjectMapper的可能，允许为null
     */
    public JacksonJsonCodec(Consumer visitor) {
        this(visitor, DEFAULT_SERIALIZE_REGISTERS);
    }

    public JacksonJsonCodec(Consumer visitor, List serializeRegisters) {
        this.mapper = new ObjectMapper();
        mapper.setSerializationInclusion(JsonInclude.Include.ALWAYS);
        if (CollectionUtil.isNotEmpty(serializeRegisters)) {
            SimpleModule module = new SimpleModule();
            serializeRegisters.forEach(serializeRegister -> serializeRegister.register(module));
            mapper.registerModule(module);
        }

        mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        if (visitor != null) {
            visitor.accept(mapper);
        }
    }

    @Override
    public  T read(InputStream inputStream, Charset charset, AbstractTypeReference typeReference)
        throws SerializeException {
        try {
            if (inputStream == null) {
                return null;
            }

            InputStreamReader reader =
                new InputStreamReader(inputStream, charset == null ? JSON_DEFAULT_CHARSET : charset);
            return mapper.readValue(reader, new com.fasterxml.jackson.core.type.TypeReference() {
                @Override
                public Type getType() {
                    return typeReference.getType();
                }
            });
        } catch (Throwable e) {
            String msg = String.format("解析数据[%s]失败,类型：[%s]", inputStream, typeReference.getType().getTypeName());
            throw new SerializeException(ErrorCodeEnum.SERIAL_EXCEPTION, msg, e);
        }
    }

    @Override
    public void write(Object data, Charset charset, OutputStream outputStream) {
        if (data != null) {
            try {
                OutputStreamWriter outputStreamWriter =
                    new OutputStreamWriter(outputStream, charset == null ? JSON_DEFAULT_CHARSET : charset);
                mapper.writeValue(outputStreamWriter, data);
            } catch (Throwable e) {
                throw new SerializeException(ErrorCodeEnum.SERIAL_EXCEPTION, e);
            }
        }
    }

}