generated from mingliqiye/lib-tem
minglipro
972ed6d338
All checks were successful
Gitea Actions Build / Build (push) Successful in 1m3s
在多个文件中调整了导入语句的顺序，并移除了重复的导入语句。 - `AutoConfiguration.java` 中调整了导入语句的顺序。 - `DateTimeToStringConverter.java` 和 `StringToDateTimeConverter.java` 中调整了静态导入的位置。- `JsonStringConverter.java` 中移除了多余的空行。 - `UUIDBinaryTypeHandler.java` 和 `UUIDStringTypeHandler.java` 中调整了导入语句的顺序。 feat(json): 添加新的 GsonJsonApi 类和 JsonApiAutoConfiguration 配置类 - 新增 `GsonJsonApi` 类，实现了 `JsonApi` 接口，提供了 JSON 处理功能。 - 新增 `JsonApiAutoConfiguration` 类，自动配置 `JsonApi` bean，支持 Jackson 和 Gson。 - 更新 `gradle.properties` 文件中的版本号从 3.1.2 到 3.1.3
391 lines
11 KiB
Java
391 lines
11 KiB
Java
/*
|
||
* Copyright 2025 mingliqiye
|
||
*
|
||
* 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
|
||
*
|
||
* 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.
|
||
*
|
||
* ProjectName mingli-utils
|
||
* ModuleName mingli-utils.main
|
||
* CurrentFile JsonApi.java
|
||
* LastUpdate 2025-09-09 09:22:02
|
||
* UpdateUser MingLiPro
|
||
*/
|
||
|
||
package com.mingliqiye.utils.json;
|
||
|
||
import java.io.*;
|
||
import java.nio.file.Files;
|
||
import java.nio.file.Path;
|
||
import java.nio.file.Paths;
|
||
import java.util.List;
|
||
import java.util.Map;
|
||
|
||
/**
|
||
* JSON处理接口，提供JSON字符串与Java对象之间的相互转换功能
|
||
*/
|
||
public interface JsonApi {
|
||
/**
|
||
* 将JSON字符串解析为指定类型的对象
|
||
*
|
||
* @param json 待解析的JSON字符串
|
||
* @param clazz 目标对象的Class类型
|
||
* @param <T> 泛型参数，表示目标对象的类型
|
||
* @return 解析后的对象实例
|
||
*/
|
||
<T> T parse(String json, Class<T> clazz);
|
||
|
||
/**
|
||
* 将JSON字符串解析为指定泛型类型对象
|
||
*
|
||
* @param json 待解析的JSON字符串
|
||
* @param type 目标对象的Type类型（支持泛型）
|
||
* @param <T> 泛型参数，表示目标对象的类型
|
||
* @return 解析后的对象实例
|
||
*/
|
||
<T> T parse(String json, JsonTypeReference<T> type);
|
||
|
||
/**
|
||
* 将对象格式化为JSON字符串
|
||
*
|
||
* @param object 待格式化的对象
|
||
* @return 格式化后的JSON字符串
|
||
*/
|
||
String format(Object object);
|
||
|
||
String formatUnicode(Object object);
|
||
|
||
default <T> T parseFrom(String path, Class<T> clazz) throws IOException {
|
||
return parseFrom(Paths.get(path), clazz);
|
||
}
|
||
|
||
default <T> T parseFrom(Path path, Class<T> clazz) throws IOException {
|
||
return parseFrom(path.toFile(), clazz);
|
||
}
|
||
|
||
default <T> T parseFrom(File file, Class<T> clazz) throws IOException {
|
||
try (InputStream inputStream = Files.newInputStream(file.toPath())) {
|
||
return parseFrom(inputStream, clazz);
|
||
}
|
||
}
|
||
|
||
default <T> T parseFrom(InputStream inputStream, Class<T> clazz)
|
||
throws IOException {
|
||
if (inputStream == null) {
|
||
throw new IllegalArgumentException("inputStream cannot be null");
|
||
}
|
||
if (clazz == null) {
|
||
throw new IllegalArgumentException("clazz cannot be null");
|
||
}
|
||
byte[] bytes = new byte[1024];
|
||
try (ByteArrayOutputStream bos = new ByteArrayOutputStream()) {
|
||
int readlength;
|
||
while ((readlength = inputStream.read(bytes)) != -1) {
|
||
bos.write(bytes, 0, readlength);
|
||
}
|
||
return parse(bos.toByteArray(), clazz);
|
||
}
|
||
}
|
||
|
||
default <T> T parseFrom(String path, JsonTypeReference<T> type)
|
||
throws IOException {
|
||
return parseFrom(Paths.get(path), type);
|
||
}
|
||
|
||
default <T> T parseFrom(Path path, JsonTypeReference<T> type)
|
||
throws IOException {
|
||
return parseFrom(path.toFile(), type);
|
||
}
|
||
|
||
default <T> T parseFrom(File file, JsonTypeReference<T> type)
|
||
throws IOException {
|
||
try (InputStream inputStream = Files.newInputStream(file.toPath())) {
|
||
return parseFrom(inputStream, type);
|
||
}
|
||
}
|
||
|
||
default <T> T parseFrom(InputStream inputStream, JsonTypeReference<T> type)
|
||
throws IOException {
|
||
if (inputStream == null) {
|
||
throw new IllegalArgumentException("inputStream cannot be null");
|
||
}
|
||
if (type == null) {
|
||
throw new IllegalArgumentException("type cannot be null");
|
||
}
|
||
byte[] bytes = new byte[1024];
|
||
try (ByteArrayOutputStream bos = new ByteArrayOutputStream()) {
|
||
int readlength;
|
||
while ((readlength = inputStream.read(bytes)) != -1) {
|
||
bos.write(bytes, 0, readlength);
|
||
}
|
||
return parse(bos.toByteArray(), type);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* 将字节数组形式的JSON解析为指定类型的对象
|
||
*
|
||
* @param json 待解析的JSON字节数组
|
||
* @param clazz 目标对象的Class类型
|
||
* @param <T> 泛型参数，表示目标对象的类型
|
||
* @return 解析后的对象实例
|
||
*/
|
||
default <T> T parse(byte[] json, Class<T> clazz) {
|
||
return parse(new String(json), clazz);
|
||
}
|
||
|
||
/**
|
||
* 将字节数组形式的JSON解析为指定泛型类型对象
|
||
*
|
||
* @param json 待解析的JSON字节数组
|
||
* @param type 目标对象的Type类型（支持泛型）
|
||
* @param <T> 泛型参数，表示目标对象的类型
|
||
* @return 解析后的对象实例
|
||
*/
|
||
default <T> T parse(byte[] json, JsonTypeReference<T> type) {
|
||
return parse(new String(json), type);
|
||
}
|
||
|
||
/**
|
||
* 将JSON字符串解析为指定类型的对象，解析失败时返回默认值
|
||
*
|
||
* @param json 待解析的JSON字符串
|
||
* @param clazz 目标对象的Class类型
|
||
* @param defaultValue 解析失败时返回的默认值
|
||
* @param <T> 泛型参数，表示目标对象的类型
|
||
* @return 解析后的对象实例或默认值
|
||
*/
|
||
default <T> T parse(String json, Class<T> clazz, T defaultValue) {
|
||
try {
|
||
return parse(json, clazz);
|
||
} catch (Exception e) {
|
||
return defaultValue;
|
||
}
|
||
}
|
||
|
||
/**
|
||
* 将JSON字符串解析为指定泛型类型对象，解析失败时返回默认值
|
||
*
|
||
* @param json 待解析的JSON字符串
|
||
* @param type 目标对象的Type类型（支持泛型）
|
||
* @param defaultValue 解析失败时返回的默认值
|
||
* @param <T> 泛型参数，表示目标对象的类型
|
||
* @return 解析后的对象实例或默认值
|
||
*/
|
||
default <T> T parse(
|
||
String json,
|
||
JsonTypeReference<T> type,
|
||
T defaultValue
|
||
) {
|
||
try {
|
||
return parse(json, type);
|
||
} catch (Exception e) {
|
||
return defaultValue;
|
||
}
|
||
}
|
||
|
||
/**
|
||
* 将对象格式化为美化格式的JSON字符串（带缩进和换行）
|
||
*
|
||
* @param object 待格式化的对象
|
||
* @return 格式化后的美化JSON字符串
|
||
*/
|
||
String formatPretty(Object object);
|
||
|
||
default byte[] formatPrettyBytes(Object object) {
|
||
return formatPretty(object).getBytes();
|
||
}
|
||
|
||
String formatPrettyUnicode(Object object);
|
||
|
||
default byte[] formatPrettyUnicodeBytes(Object object) {
|
||
return formatPrettyUnicode(object).getBytes();
|
||
}
|
||
|
||
default void formatPretty(Object object, String file) throws IOException {
|
||
formatPretty(object, Paths.get(file));
|
||
}
|
||
|
||
default void formatPretty(Object object, Path file) throws IOException {
|
||
formatPretty(object, file.toFile());
|
||
}
|
||
|
||
default void formatPretty(Object object, File file) throws IOException {
|
||
try (FileOutputStream fos = new FileOutputStream(file)) {
|
||
formatPretty(object, fos);
|
||
}
|
||
}
|
||
|
||
default void formatPretty(Object object, OutputStream stream)
|
||
throws IOException {
|
||
stream.write(formatPrettyBytes(object));
|
||
}
|
||
|
||
default void formatPrettyUnicode(Object object, String file)
|
||
throws IOException {
|
||
formatPrettyUnicode(object, Paths.get(file));
|
||
}
|
||
|
||
default void formatPrettyUnicode(Object object, Path file)
|
||
throws IOException {
|
||
formatPrettyUnicode(object, file.toFile());
|
||
}
|
||
|
||
default void formatPrettyUnicode(Object object, File file)
|
||
throws IOException {
|
||
try (FileOutputStream fos = new FileOutputStream(file)) {
|
||
formatPrettyUnicode(object, fos);
|
||
}
|
||
}
|
||
|
||
default void formatPrettyUnicode(Object object, OutputStream stream)
|
||
throws IOException {
|
||
stream.write(formatPrettyUnicodeBytes(object));
|
||
}
|
||
|
||
default byte[] formatBytes(Object object) {
|
||
return format(object).getBytes();
|
||
}
|
||
|
||
default byte[] formatUnicodeBytes(Object object) {
|
||
return formatUnicode(object).getBytes();
|
||
}
|
||
|
||
default void format(Object object, String file) throws IOException {
|
||
format(object, Paths.get(file));
|
||
}
|
||
|
||
default void format(Object object, Path file) throws IOException {
|
||
format(object, file.toFile());
|
||
}
|
||
|
||
default void format(Object object, File file) throws IOException {
|
||
try (FileOutputStream fos = new FileOutputStream(file)) {
|
||
format(object, fos);
|
||
}
|
||
}
|
||
|
||
default void format(Object object, OutputStream stream) throws IOException {
|
||
stream.write(formatPrettyBytes(object));
|
||
}
|
||
|
||
default void formatUnicode(Object object, String file) throws IOException {
|
||
formatUnicode(object, Paths.get(file));
|
||
}
|
||
|
||
default void formatUnicode(Object object, Path file) throws IOException {
|
||
formatUnicode(object, file.toFile());
|
||
}
|
||
|
||
default void formatUnicode(Object object, File file) throws IOException {
|
||
try (FileOutputStream fos = new FileOutputStream(file)) {
|
||
formatUnicode(object, fos);
|
||
}
|
||
}
|
||
|
||
default void formatUnicode(Object object, OutputStream stream)
|
||
throws IOException {
|
||
stream.write(formatPrettyUnicodeBytes(object));
|
||
}
|
||
|
||
/**
|
||
* 将JSON字符串解析为指定元素类型的List集合
|
||
*
|
||
* @param json 待解析的JSON字符串
|
||
* @param elementType List中元素的类型
|
||
* @param <T> 泛型参数，表示List中元素的类型
|
||
* @return 解析后的List集合
|
||
*/
|
||
default <T> List<T> parseList(String json, Class<T> elementType) {
|
||
return parse(json, JsonTypeUtils.listType(elementType));
|
||
}
|
||
|
||
/**
|
||
* 将JSON字符串解析为指定键值类型的Map集合
|
||
*
|
||
* @param json 待解析的JSON字符串
|
||
* @param keyType Map中键的类型
|
||
* @param valueType Map中值的类型
|
||
* @param <K> 泛型参数，表示Map中键的类型
|
||
* @param <V> 泛型参数，表示Map中值的类型
|
||
* @return 解析后的Map集合
|
||
*/
|
||
default <K, V> Map<K, V> parseMap(
|
||
String json,
|
||
Class<K> keyType,
|
||
Class<V> valueType
|
||
) {
|
||
JsonTypeReference<Map<K, V>> mapType = new JsonTypeReference<
|
||
Map<K, V>
|
||
>() {};
|
||
return parse(json, mapType);
|
||
}
|
||
|
||
/**
|
||
* 验证字符串是否为有效的JSON格式
|
||
*
|
||
* @param json 待验证的字符串
|
||
* @return 如果是有效的JSON格式返回true，否则返回false
|
||
*/
|
||
boolean isValidJson(String json);
|
||
|
||
/**
|
||
* 将对象转换为JSON字节数组
|
||
*
|
||
* @param object 待转换的对象
|
||
* @return 转换后的JSON字节数组
|
||
*/
|
||
default byte[] toBytes(Object object) {
|
||
return format(object).getBytes();
|
||
}
|
||
|
||
/**
|
||
* 将对象转换为美化格式的JSON字节数组
|
||
*
|
||
* @param object 待转换的对象
|
||
* @return 转换后的美化格式JSON字节数组
|
||
*/
|
||
default byte[] toBytesPretty(Object object) {
|
||
return formatPretty(object).getBytes();
|
||
}
|
||
|
||
/**
|
||
* 合并多个JSON字符串为一个JSON对象
|
||
*
|
||
* @param jsons 待合并的JSON字符串数组
|
||
* @return 合并后的JSON字符串
|
||
*/
|
||
String merge(String... jsons);
|
||
|
||
/**
|
||
* 获取JSON字符串中指定路径节点的值
|
||
*
|
||
* @param json JSON字符串
|
||
* @param path 节点路径（如："user.name"）
|
||
* @return 节点值的字符串表示
|
||
*/
|
||
String getNodeValue(String json, String path);
|
||
|
||
/**
|
||
* 更新JSON字符串中指定路径节点的值
|
||
*
|
||
* @param json 原始JSON字符串
|
||
* @param path 节点路径（如："user.name"）
|
||
* @param newValue 新的节点值
|
||
* @return 更新后的JSON字符串
|
||
*/
|
||
String updateNodeValue(String json, String path, Object newValue);
|
||
|
||
<T, D> D convert(T source, Class<D> destinationClass);
|
||
|
||
<T, D> D convert(T source, JsonTypeReference<D> destinationType);
|
||
}
|