com.github.joekerouac.common.tools.codec.Codec Maven / Gradle / Ivy
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;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.reflect.Type;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import javax.validation.constraints.NotNull;
import com.github.joekerouac.common.tools.codec.exception.SerializeException;
import com.github.joekerouac.common.tools.reflect.type.AbstractTypeReference;
/**
* 序列化接口
*
* @since 1.0.0
* @author JoeKerouac
* @date 2022-10-14 14:37:00
*/
public interface Codec {
/**
* 读取数据
*
* @param data
* 数据
* @param type
* 数据类型Class
* @param
* 数据实际类型
* @return 读取到的数据
* @throws SerializeException
* 序列化失败应该抛出SerializeException而不是其他异常
*/
@Deprecated
default T read(byte[] data, @NotNull Class type) throws SerializeException {
return read(data, StandardCharsets.UTF_8, type);
}
/**
* 读取数据
*
* @param data
* 数据
* @param charset
* 数据对应的字符集，传null时默认使用utf8
* @param type
* 数据类型Class
* @param
* 数据实际类型
* @return 读取到的数据
* @throws SerializeException
* 序列化失败应该抛出SerializeException而不是其他异常
*/
default T read(byte[] data, Charset charset, @NotNull Class type) throws SerializeException {
return read(data, charset, new AbstractTypeReference() {
@Override
public Type getType() {
return type;
}
});
}
/**
* 读取数据
*
* @param data
* 数据
* @param typeReference
* 数据类型引用
* @param
* 数据实际类型
* @return 读取到的数据
* @throws SerializeException
* 序列化失败应该抛出SerializeException而不是其他异常
*/
@Deprecated
default T read(byte[] data, @NotNull AbstractTypeReference typeReference) throws SerializeException {
return read(data, StandardCharsets.UTF_8, typeReference);
}
/**
* 读取数据
*
* @param data
* 数据
* @param charset
* 数据对应的数据集，传null时默认使用utf8
* @param typeReference
* 数据类型引用
* @param
* 数据实际类型
* @return 读取到的数据
* @throws SerializeException
* 序列化失败应该抛出SerializeException而不是其他异常
*/
default T read(byte[] data, Charset charset, @NotNull AbstractTypeReference typeReference)
throws SerializeException {
if (data == null || data.length == 0 || typeReference == null) {
return null;
}
return read(new ByteArrayInputStream(data), charset, typeReference);
}
/**
* 读取数据
*
* @param inputStream
* 数据输入流
* @param type
* 数据类型
* @param
* 数据实际类型
* @return 读取到的数据
* @throws SerializeException
* 序列化失败应该抛出SerializeException而不是其他异常
*/
default T read(InputStream inputStream, @NotNull Class type) throws SerializeException {
return read(inputStream, StandardCharsets.UTF_8, new AbstractTypeReference() {
@Override
public Type getType() {
return type;
}
});
}
/**
* 读取数据
*
* @param inputStream
* 数据输入流
* @param typeReference
* 数据类型引用
* @param
* 数据实际类型
* @return 读取到的数据
* @throws SerializeException
* 序列化失败应该抛出SerializeException而不是其他异常
*/
default T read(InputStream inputStream, @NotNull AbstractTypeReference typeReference)
throws SerializeException {
return read(inputStream, StandardCharsets.UTF_8, typeReference);
}
/**
* 读取数据
*
* @param inputStream
* 数据输入流
* @param charset
* 数据对应的数据集，传null时默认使用utf8
* @param type
* 数据类型
* @param
* 数据实际类型
* @return 读取到的数据
* @throws SerializeException
* 序列化失败应该抛出SerializeException而不是其他异常
*/
default T read(InputStream inputStream, Charset charset, @NotNull Class type) throws SerializeException {
return read(inputStream, charset, new AbstractTypeReference() {
@Override
public Type getType() {
return type;
}
});
}
/**
* 读取数据
*
* @param inputStream
* 数据输入流
* @param charset
* 数据对应的数据集，传null时默认使用utf8
* @param typeReference
* 数据类型引用
* @param
* 数据实际类型
* @return 读取到的数据
* @throws SerializeException
* 序列化失败应该抛出SerializeException而不是其他异常
*/
T read(InputStream inputStream, Charset charset, @NotNull AbstractTypeReference typeReference)
throws SerializeException;
/**
* 写出数据
*
* @param data
* 数据
* @return 序列化后的数据
*/
@Deprecated
default byte[] write(Object data) {
return write(data, StandardCharsets.UTF_8);
}
/**
* 写出数据
*
* @param data
* 数据
* @param resultCharset
* 结果字符集，如果为空则使用utf8字符集
* @return 序列化后的数据
*/
default byte[] write(Object data, Charset resultCharset) {
if (data == null) {
return new byte[0];
}
ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
write(data, resultCharset, outputStream);
return outputStream.toByteArray();
}
/**
* 写出数据到输出流
*
* @param data
* 数据
* @param outputStream
* 写出流
*/
default void write(Object data, OutputStream outputStream) {
write(data, StandardCharsets.UTF_8, outputStream);
}
/**
* 写出数据到输出流
*
* @param data
* 数据
* @param resultCharset
* 结果字符集，如果为空则使用utf8字符集
* @param outputStream
* 写出流
*/
void write(Object data, Charset resultCharset, OutputStream outputStream);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy