org.dromara.hutool.setting.yaml.YamlUtil Maven / Gradle / Ivy
/*
* Copyright (c) 2013-2024 Hutool Team and hutool.cn
*
* 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.
*/
package org.dromara.hutool.setting.yaml;
import org.dromara.hutool.core.io.IoUtil;
import org.dromara.hutool.core.io.resource.ResourceUtil;
import org.dromara.hutool.core.lang.Assert;
import org.dromara.hutool.core.map.Dict;
import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.Yaml;
import java.io.InputStream;
import java.io.Reader;
import java.io.Writer;
/**
* 基于Snakeyaml的的YAML读写工具
*
* @author looly
* @since 5.7.14
*/
public class YamlUtil {
/**
* 从classpath或绝对路径加载YAML文件
*
* @param path YAML路径，相对路径相对classpath
* @return 加载的内容，默认Map
*/
public static Dict loadByPath(final String path) {
return loadByPath(path, Dict.class);
}
/**
* 从classpath或绝对路径加载YAML文件
*
* @param Bean类型，默认map
* @param path YAML路径，相对路径相对classpath
* @param type 加载的Bean类型，即转换为的bean
* @return 加载的内容，默认Map
*/
public static T loadByPath(final String path, final Class type) {
return load(ResourceUtil.getStream(path), type);
}
/**
* 从流中加载YAML
*
* @param Bean类型，默认map
* @param in 流
* @param type 加载的Bean类型，即转换为的bean
* @return 加载的内容，默认Map
*/
public static T load(final InputStream in, final Class type) {
return load(IoUtil.toBomReader(in), type);
}
/**
* 加载YAML，加载完毕后关闭{@link Reader}
*
* @param reader {@link Reader}
* @return 加载的Map
*/
public static Dict load(final Reader reader) {
return load(reader, Dict.class);
}
/**
* 加载YAML，加载完毕后关闭{@link Reader}
*
* @param Bean类型，默认map
* @param reader {@link Reader}
* @param type 加载的Bean类型，即转换为的bean
* @return 加载的内容，默认Map
*/
public static T load(final Reader reader, final Class type) {
return load(reader, type, true);
}
/**
* 加载YAML
*
* @param Bean类型，默认map
* @param reader {@link Reader}
* @param type 加载的Bean类型，即转换为的bean
* @param isCloseReader 加载完毕后是否关闭{@link Reader}
* @return 加载的内容，默认Map
*/
@SuppressWarnings("unchecked")
public static T load(final Reader reader, Class type, final boolean isCloseReader) {
Assert.notNull(reader, "Reader must be not null !");
if (null == type) {
type = (Class) Object.class;
}
final Yaml yaml = new Yaml();
try {
return yaml.loadAs(reader, type);
} finally {
if (isCloseReader) {
IoUtil.closeQuietly(reader);
}
}
}
/**
* 将Bean对象或者Map写出到{@link Writer}
*
* @param object 对象
* @param writer {@link Writer}
*/
public static void dump(final Object object, final Writer writer) {
final DumperOptions options = new DumperOptions();
options.setIndent(2);
options.setPrettyFlow(true);
options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
dump(object, writer, options);
}
/**
* 将Bean对象或者Map写出到{@link Writer}
*
* @param object 对象
* @param writer {@link Writer}
* @param dumperOptions 输出风格
*/
public static void dump(final Object object, final Writer writer, DumperOptions dumperOptions) {
if (null == dumperOptions) {
dumperOptions = new DumperOptions();
}
final Yaml yaml = new Yaml(dumperOptions);
yaml.dump(object, writer);
}
}