add YamlUtil

hutool-setting/src/main/java/cn/hutool/setting/yaml/YamlUtil.java

@@ -0,0 +1,133 @@
+package cn.hutool.setting.yaml;
+
+import cn.hutool.core.io.IoUtil;
+import cn.hutool.core.io.resource.ResourceUtil;
+import cn.hutool.core.lang.Assert;
+import cn.hutool.core.lang.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(String path) {
+		return loadByPath(path, Dict.class);
+	}
+
+	/**
+	 * 从classpath或绝对路径加载YAML文件
+	 *
+	 * @param <T>  Bean类型，默认map
+	 * @param path YAML路径，相对路径相对classpath
+	 * @param type 加载的Bean类型，即转换为的bean
+	 * @return 加载的内容，默认Map
+	 */
+	public static <T> T loadByPath(String path, Class<T> type) {
+		return load(ResourceUtil.getStream(path), type);
+	}
+
+	/**
+	 * 从流中加载YAML
+	 *
+	 * @param <T>  Bean类型，默认map
+	 * @param in   流
+	 * @param type 加载的Bean类型，即转换为的bean
+	 * @return 加载的内容，默认Map
+	 */
+	public static <T> T load(InputStream in, Class<T> type) {
+		return load(IoUtil.getBomReader(in), type);
+	}
+
+	/**
+	 * 加载YAML，加载完毕后关闭{@link Reader}
+	 *
+	 * @param reader {@link Reader}
+	 * @return 加载的Map
+	 */
+	public static Dict load(Reader reader) {
+		return load(reader, Dict.class);
+	}
+
+	/**
+	 * 加载YAML，加载完毕后关闭{@link Reader}
+	 *
+	 * @param <T>    Bean类型，默认map
+	 * @param reader {@link Reader}
+	 * @param type   加载的Bean类型，即转换为的bean
+	 * @return 加载的内容，默认Map
+	 */
+	public static <T> T load(Reader reader, Class<T> type) {
+		return load(reader, type, true);
+	}
+
+	/**
+	 * 加载YAML
+	 *
+	 * @param <T>           Bean类型，默认map
+	 * @param reader        {@link Reader}
+	 * @param type          加载的Bean类型，即转换为的bean
+	 * @param isCloseReader 加载完毕后是否关闭{@link Reader}
+	 * @return 加载的内容，默认Map
+	 */
+	public static <T> T load(Reader reader, Class<T> type, boolean isCloseReader) {
+		Assert.notNull(reader, "Reader must be not null !");
+		if (null == type) {
+			//noinspection unchecked
+			type = (Class<T>) Object.class;
+		}
+
+		final Yaml yaml = new Yaml();
+		try {
+			return yaml.loadAs(reader, type);
+		} finally {
+			if (isCloseReader) {
+				IoUtil.close(reader);
+			}
+		}
+	}
+
+	/**
+	 * 将Bean对象或者Map写出到{@link Writer}
+	 *
+	 * @param object 对象
+	 * @param writer {@link Writer}
+	 */
+	public static void dump(Object object, 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(Object object, Writer writer, DumperOptions dumperOptions) {
+		if (null == dumperOptions) {
+			dumperOptions = new DumperOptions();
+		}
+		final Yaml yaml = new Yaml(dumperOptions);
+		yaml.dump(object, writer);
+	}
+}

hutool-setting/src/main/java/cn/hutool/setting/yaml/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * YAML文件的读写封装，基于snakeyaml
+ *
+ * @author looly
+ *
+ */
+package cn.hutool.setting.yaml;

hutool-setting/src/test/java/cn/hutool/setting/PropsTest.java

@@ -1,4 +1,4 @@
-package cn.hutool.setting.test;
+package cn.hutool.setting;
 
 import cn.hutool.core.date.DateUtil;
 import cn.hutool.log.LogFactory;
@@ -17,7 +17,7 @@ import java.util.Objects;
 
 /**
  * Setting单元测试
- * 
+ *
  * @author Looly
  *
  */
@@ -50,23 +50,23 @@ public class PropsTest {
 		String driver = props.getStr("driver");
 		Assert.assertEquals(driver, "com.mysql.jdbc.Driver");
 	}
-	
+
 	@Test
 	public void toBeanTest() {
 		Props props = Props.getProp("to_bean_test.properties");
-		
+
 		ConfigProperties cfg = props.toBean(ConfigProperties.class, "mail");
 		Assert.assertEquals("mailer@mail.com", cfg.getHost());
 		Assert.assertEquals(9000, cfg.getPort());
 		Assert.assertEquals("mailer@mail.com", cfg.getFrom());
-		
+
 		Assert.assertEquals("john", cfg.getCredentials().getUsername());
 		Assert.assertEquals("password", cfg.getCredentials().getPassword());
 		Assert.assertEquals("SHA1", cfg.getCredentials().getAuthMethod());
-		
+
 		Assert.assertEquals("true", cfg.getAdditionalHeaders().get("redelivery"));
 		Assert.assertEquals("true", cfg.getAdditionalHeaders().get("secure"));
-		
+
 		Assert.assertEquals("admin@mail.com", cfg.getDefaultRecipients().get(0));
 		Assert.assertEquals("owner@mail.com", cfg.getDefaultRecipients().get(1));
 	}
@@ -98,7 +98,7 @@ public class PropsTest {
 		private List<String> defaultRecipients;
 		private Map<String, String> additionalHeaders;
 	}
-	
+
 	@Data
 	public static class Credentials {
 		private String authMethod;

hutool-setting/src/test/java/cn/hutool/setting/PropsUtilTest.java

@@ -1,4 +1,4 @@
-package cn.hutool.setting.test;
+package cn.hutool.setting;
 
 import cn.hutool.setting.dialect.PropsUtil;
 import org.junit.Assert;
@@ -7,7 +7,7 @@ import org.junit.Test;
 import java.util.Objects;
 
 public class PropsUtilTest {
-	
+
 	@Test
 	public void getTest() {
 		String driver = PropsUtil.get("test").getStr("driver");

hutool-setting/src/test/java/cn/hutool/setting/SettingTest.java

@@ -1,12 +1,10 @@
-package cn.hutool.setting.test;
+package cn.hutool.setting;
 
+import cn.hutool.core.lang.Console;
 import org.junit.Assert;
 import org.junit.Ignore;
 import org.junit.Test;
 
-import cn.hutool.core.lang.Console;
-import cn.hutool.setting.Setting;
-
 /**
  * Setting单元测试
  *

hutool-setting/src/test/java/cn/hutool/setting/SettingUtilTest.java

@@ -1,12 +1,10 @@
-package cn.hutool.setting.test;
+package cn.hutool.setting;
 
 import org.junit.Assert;
 import org.junit.Test;
 
-import cn.hutool.setting.SettingUtil;
-
 public class SettingUtilTest {
-	
+
 	@Test
 	public void getTest() {
 		String driver = SettingUtil.get("test").get("demo", "driver");

hutool-setting/src/test/java/cn/hutool/setting/yaml/YamlUtilTest.java

@@ -0,0 +1,36 @@
+package cn.hutool.setting.yaml;
+
+import cn.hutool.core.io.FileUtil;
+import cn.hutool.core.lang.Dict;
+import cn.hutool.core.util.CharsetUtil;
+import org.junit.Assert;
+import org.junit.Ignore;
+import org.junit.Test;
+
+import java.util.List;
+
+public class YamlUtilTest {
+
+	@Test
+	public void loadByPathTest() {
+		final Dict result = YamlUtil.loadByPath("test.yaml", Dict.class);
+
+		Assert.assertEquals("John", result.getStr("firstName"));
+
+		final List<Integer> numbers = result.getByPath("contactDetails.number");
+		Assert.assertEquals(123456789, (int) numbers.get(0));
+		Assert.assertEquals(456786868, (int) numbers.get(1));
+	}
+
+	@Test
+	@Ignore
+	public void dumpTest() {
+		final Dict dict = Dict.create()
+				.set("name", "hutool")
+				.set("count", 1000);
+
+		YamlUtil.dump(
+				dict
+				, FileUtil.getWriter("d:/test/dump.yaml", CharsetUtil.CHARSET_UTF_8, false));
+	}
+}

hutool-setting/src/test/resources/test.yaml

@@ -0,0 +1,13 @@
+firstName: "John"
+lastName: "Doe"
+age: 31
+contactDetails:
+  - type: "mobile"
+    number: 123456789
+  - type: "landline"
+    number: 456786868
+homeAddress:
+  line: "Xyz, DEF Street"
+  city: "City Y"
+  state: "State Y"
+  zip: 345657