add doc

CHANGELOG.md

@@ -3,7 +3,7 @@
 
 -------------------------------------------------------------------------------------------------------------
 
-# 5.7.20 (2022-01-14)
+# 5.7.20 (2022-01-15)
 
 ### 🐣新特性
 * 【core   】     增加对null值友好的groupingBy操作的Collector实现，可指定map类型（pr#498@Gitee）
@@ -18,6 +18,7 @@
 * 【core   】     修复RegexPool汉字匹配范围小问题（pr#2081@Github）
 * 【core   】     修复OS中的拼写错误（pr#500@Gitee）
 * 【core   】     修复CustomKeyMap的merge失效问题（issue#2086@Github）
+* 【core   】     修复FileUtil.appendLines换行问题（issue#I4QCEZ@Gitee）
 
 -------------------------------------------------------------------------------------------------------------
 # 5.7.19 (2022-01-07)

hutool-core/src/main/java/cn/hutool/core/io/FileUtil.java

@@ -2876,7 +2876,12 @@ public class FileUtil extends PathUtil {
 	}
 
 	/**
-	 * 将列表写入文件，追加模式
+	 * 将列表写入文件，追加模式，策略为：
+	 * <ul>
+	 *     <li>当文件为空，从开头追加，尾部不加空行</li>
+	 *     <li>当有内容，换行追加，尾部不加空行</li>
+	 *     <li>当有内容，并末尾有空行，依旧换行追加</li>
+	 * </ul>
 	 *
 	 * @param <T>     集合元素类型
 	 * @param list    列表

hutool-core/src/main/java/cn/hutool/core/util/EscapeUtil.java

@@ -10,6 +10,7 @@ import cn.hutool.core.text.escape.XmlUnescape;
  * 转义和反转义工具类Escape / Unescape<br>
  * escape采用ISO Latin字符集对指定的字符串进行编码。<br>
  * 所有的空格符、标点符号、特殊字符以及其他非ASCII字符都将被转化成%xx格式的字符编码(xx等于该字符在字符集表里面的编码的16进制数字)。
+ * TODO 6.x迁移到core.text.escape包下
  *
  * @author xiaoleilu
  */

hutool-core/src/test/java/cn/hutool/core/io/FileUtilTest.java

@@ -1,5 +1,6 @@
 package cn.hutool.core.io;
 
+import cn.hutool.core.collection.ListUtil;
 import cn.hutool.core.io.file.LineSeparator;
 import cn.hutool.core.lang.Console;
 import cn.hutool.core.util.CharsetUtil;
@@ -444,4 +445,11 @@ public class FileUtilTest {
 		File file2 = new File(".");
 		Assert.assertTrue(FileUtil.isSub(file, file2));
 	}
+
+	@Test
+	@Ignore
+	public void appendLinesTest(){
+		List<String> list = ListUtil.toList("a", "b", "c");
+		FileUtil.appendLines(list, FileUtil.file("d:/test/appendLines.txt"), CharsetUtil.CHARSET_UTF_8);
+	}
 }