[Feature] add for new

Author: houbb

README.md

@@ -26,9 +26,13 @@
 
 - Fluent 流式写法
 
-- 基于 java 注解
+- 基于 java 注解，支持自定义的转换和灵活配置
 
-- 字段类型转换的灵活支持，内置 8 大基本类型以及 String 类型转换
+- 内置 8 大基本类型以及 String 类型转换
+
+- 解决 Excel 直接打开，utf-8 乱码问题
+
+- 内置支持集合、数组、Map 的存取
 
 # 快速开始
 
@@ -44,7 +48,7 @@ maven 3.x
 <dependency>
  <groupId>com.github.houbb</groupId>
  <artifactId>csv</artifactId>
- <version>0.0.2</version>
+ <version>0.0.3</version>
 </dependency>
 ```
 
@@ -141,6 +145,8 @@ public void commonTest() {
 
 # 拓展阅读
 
-[CSV 引导类方法说明](doc/user/01-csv-引导类.md)
+[01-CSV 引导类方法说明](doc/user/01-csv-引导类.md)
+
+[02-CSV 字段注解的使用](doc/user/02-csv-注解使用.md)
 
-[CSV 字段注解的使用](doc/user/02-csv-注解使用.md)
+[03-CSV 集合相关支持](doc/user/03-csv-支持集合类.md)

doc/CHANGE_LOG.md

@@ -14,3 +14,15 @@
 | 序号 | 变更类型 | 说明 | 时间 | 备注 |
 |:---|:---|:---|:---|:--|
 | 1 | A | 基本功能的实现 | 2019-6-1 13:55:32 | |
+
+# release_0.0.2
+
+| 序号 | 变更类型 | 说明 | 时间 | 备注 |
+|:---|:---|:---|:---|:--|
+| 1 | O | 注解相关测试用例的完善 | 2019-6-10 13:55:32 | |
+
+# release_0.0.3
+
+| 序号 | 变更类型 | 说明 | 时间 | 备注 |
+|:---|:---|:---|:---|:--|
+| 1 | A | 支持集合、数组、Map 等常见集合 | 2019-6-17 19:42:30 | |

doc/user/03-csv-支持集合类.md

@@ -0,0 +1,101 @@
+# 集合类
+
+有时候对象中会包含数组、Map、Collection 等常见集合。
+
+为了存储的便利性，默认提供集合的相关支持。
+
+特性和普通字段保持一致，如果指定注解转换，则以注解为准。
+
+## 使用示例
+
+- UserCollection.java
+
+用于演示集合的对象
+
+```java
+public class UserCollection {
+
+ private String[] arrays;
+
+ private LinkedList<String> lists;
+
+ private Map<String, String> maps;
+
+ private Set<String> sets;
+
+ //Getter/Setter/toString()
+}
+```
+
+## 存储
+
+- 待存储对象的构建
+
+```java
+/**
+ * 构建基于集合的测试列表
+ * @return 列表
+ * @since 0.0.3
+ */
+private List<UserCollection> buildCollectionList() {
+ UserCollection user = new UserCollection();
+ String[] arrays = new String[]{"a", "b", "c"};
+ LinkedList<String> lists = new LinkedList<>(Arrays.asList(arrays));
+ Map<String, String> maps = new HashMap<>();
+ maps.put("key", "value");
+ maps.put("key2", "value2");
+ Set<String> sets = new HashSet<>();
+ sets.add("set1");
+ sets.add("set2");
+
+ user.setLists(lists);
+ user.setArrays(arrays);
+ user.setMaps(maps);
+ user.setSets(sets);
+ return Arrays.asList(user);
+}
+```
+
+- 执行存储
+
+```java
+public void collectionTest() {
+ final String path = "src\\test\\resources\\collection.csv";
+ CsvWriteBs.newInstance(path)
+ .write(buildCollectionList());
+}
+```
+
+- 存储效果
+
+```
+arrays,lists,maps,sets
+a|b,a|b|c,key2=value2|key=value,set1|set2
+```
+
+## 读取
+
+- 测试类
+
+```java
+public void collectionTest() {
+ final String path = "src\\test\\resources\\collection.csv";
+ List<UserCollection> userList = CsvReadBs.newInstance(path)
+ .read(UserCollection.class);
+ System.out.println(userList);
+}
+```
+
+- 测试日志
+
+```
+[UserCollection{arrays=[a, b], lists=[a, b, c], maps={key=value, key2=value2}, sets=[set2, set1]}]
+```
+
+# 注意
+
+为了保证 csv 以 `,` 分隔的统一性。
+
+集合使用 `|` 进行分隔，其中 map 的 key/value 分隔，用到了 `=`。
+
+在使用时要注意，不要包含上述的符号，否则会出现解析错乱。

pom.xml

@@ -25,7 +25,7 @@
  <project.compiler.level>1.7</project.compiler.level>
 
  <!--============================== INTER ==============================-->
- <heaven.version>0.1.7</heaven.version>
+ <heaven.version>0.1.14</heaven.version>
 
  <!--============================== OTHER ==============================-->
  <junit.version>4.12</junit.version>

src/main/java/com/github/houbb/csv/api/IReadConverter.java

@@ -1,5 +1,7 @@
 package com.github.houbb.csv.api;
 
+import java.lang.reflect.Field;
+
 /**
  * 读取转换器，将 string 转换为 field
  * @author binbin.hou
@@ -11,10 +13,9 @@ public interface IReadConverter<T> {
  /**
  * 执行转换
  * @param value 字符串值
- * @param fieldType 字段类型
+ * @param field 字段类型
  * @return 结果
  */
- T convert(final String value,
- final Class fieldType);
+ T convert(final String value, final Field field);
 
 }

src/main/java/com/github/houbb/csv/support/convert/read/BooleanReadConverter.java

@@ -1,13 +1,21 @@
 package com.github.houbb.csv.support.convert.read;
 
 import com.github.houbb.csv.api.IReadConverter;
+import com.github.houbb.csv.support.convert.read.collection.ArrayReadConverter;
+import com.github.houbb.csv.support.convert.read.collection.CollectionReadConverter;
+import com.github.houbb.csv.support.convert.read.collection.MapReadConverter;
+import com.github.houbb.csv.support.convert.read.type.ITypeConverter;
+import com.github.houbb.csv.support.convert.read.type.impl.*;
 import com.github.houbb.heaven.annotation.ThreadSafe;
 import com.github.houbb.heaven.support.instance.impl.InstanceFactory;
+import com.github.houbb.heaven.support.instance.impl.Instances;
 import com.github.houbb.heaven.util.lang.ObjectUtil;
 import com.github.houbb.heaven.util.lang.StringUtil;
 import com.github.houbb.heaven.util.lang.reflect.ClassTypeUtil;
 import com.github.houbb.heaven.util.lang.reflect.PrimitiveUtil;
+import com.github.houbb.heaven.util.util.ArrayUtil;
 
+import java.lang.reflect.Field;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -17,12 +25,12 @@
  * @since 0.0.1
  */
 @ThreadSafe
-public class CommonReadConverter implements IReadConverter<Object> {
+public class CommonReadConverter implements IReadConverter<Object>, ITypeConverter<Object> {
 
  /**
  * 转换器映射关系
  */
- private static final Map<Class, IReadConverter> CONVERTER_MAP = new HashMap<>();
+ private static final Map<Class, ITypeConverter> CONVERTER_MAP = new HashMap<>();
 
  static {
  CONVERTER_MAP.put(String.class, InstanceFactory.getInstance().singleton(StringReadConverter.class));
@@ -37,25 +45,54 @@ public class CommonReadConverter implements IReadConverter<Object> {
  }
 
  @Override
- public Object convert(String value, Class fieldType) {
+ public Object convert(String value, final Field field) {
  //1. 为空判断
  if(StringUtil.isEmpty(value)) {
  return null;
  }
 
- //2. 维护一个映射关系
- Class refType = fieldType;
- if(fieldType.isPrimitive()) {
- refType = PrimitiveUtil.getReferenceType(fieldType);
+ // 获取当前字段类型
+ Class refType = field.getType();
+
+ //2 特殊集合的处理
+ // 2.1 数组
+ if(ClassTypeUtil.isArray(refType)) {
+ return Instances.singletion(ArrayReadConverter.class).convert(value, field);
+ }
+ // 2.2 map
+ if(ClassTypeUtil.isMap(refType)) {
+ return Instances.singletion(MapReadConverter.class).convert(value, field);
  }
- IReadConverter readConverter = CONVERTER_MAP.get(refType);
+ // 2.3 collection
+ if(ClassTypeUtil.isCollection(refType)) {
+ return Instances.singletion(CollectionReadConverter.class).convert(value, field);
+ }
+
+ // 3. 基本类型
+ return convert(value, refType);
+ }
+
+
+ @Override
+ public Object convert(String value, final Class type) {
+ //1. 快速返回
+ if(StringUtil.isEmpty(value)
+ || ObjectUtil.isNull(type)) {
+ return null;
+ }
+
+ // 2. 根据类型处理
+ Class actualType = type;
+ if(actualType.isPrimitive()) {
+ actualType = PrimitiveUtil.getReferenceType(actualType);
+ }
+ ITypeConverter readConverter = CONVERTER_MAP.get(actualType);
  if(ObjectUtil.isNotNull(readConverter)) {
- return readConverter.convert(value, fieldType);
+ return readConverter.convert(value, actualType);
  }
 
  //3. 不属于基本类型，则直接返回 null
  return null;
  }
 
-
 }