release branch 0.0.5

Author: houbb

.travis.yml

@@ -1,6 +1,6 @@
 language: java
 jdk:
-- oraclejdk7
+- oraclejdk8
 install: mvn install -DskipTests=true -Dmaven.javadoc.skip=true
 script: mvn test
 after_success:

README.md

@@ -1,6 +1,6 @@
 # csv
 
-基于 java 注解生成加签验签 csv。
+基于 java 注解的 csv 读写框架。
 
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.houbb/csv/badge.svg)](http://mvnrepository.com/artifact/com.github.houbb/csv)
 [![Build Status](https://www.travis-ci.org/houbb/csv.svg?branch=master)](https://www.travis-ci.org/houbb/csv?branch=master)
@@ -34,6 +34,8 @@
 
 - 内置支持集合、数组、Map 的存取
 
+- 支持对象中内嵌其他对象
+
 # 快速开始
 
 ## 环境
@@ -48,7 +50,7 @@ maven 3.x
 <dependency>
  <groupId>com.github.houbb</groupId>
  <artifactId>csv</artifactId>
- <version>0.0.3</version>
+ <version>0.0.5</version>
 </dependency>
 ```
 
@@ -150,3 +152,5 @@ public void commonTest() {
 [02-CSV 字段注解的使用](doc/user/02-csv-注解使用.md)
 
 [03-CSV 集合相关支持](doc/user/03-csv-支持集合类.md)
+
+[04-CSV 内嵌对象使用](doc/user/04-csv-支持内嵌对象.md)

doc/CHANGE_LOG.md

@@ -33,4 +33,10 @@
 |:---|:---|:---|:---|:--|
 | 1 | O | 优化 head/bom 信息的写入 | 2019-6-18 20:32:36 | |
 | 2 | O | 优化读写的实现方式，便于后期拓展 | 2019-6-18 20:32:36 | |
-| 3 | O | 添加缓存，提升性能 | 2019-6-18 20:32:36 | |
+| 3 | O | 添加缓存，提升性能 | 2019-6-18 20:32:36 | |
+
+# release_0.0.5
+
+| 序号 | 变更类型 | 说明 | 时间 | 备注 |
+|:---|:---|:---|:---|:--|
+| 1 | A | 支持内嵌对象 | 2019-6-20 11:18:14 | |

doc/issues/issues-03-deadcycle.md

@@ -0,0 +1,15 @@
+# 如果一个类引用本身
+
+```java
+class User {
+ List<User> children;
+}
+```
+
+很可能会导致死循环。
+
+验证并修复这个问题。
+
+最好在 @since 0.0.6 版本。
+
+# 对于特殊符号的转义。

doc/user/04-csv-支持内嵌对象.md

@@ -0,0 +1,146 @@
+# 支持内嵌对象
+
+有时候我们希望像使用 mongo 一样，非常方便的存取 csv 的嵌套对象。
+
+对于普通的 csv 都没有实现这个特性，本次做了一个尝试，支持内嵌对象的存取。
+
+## 取舍
+
+就像 csv 的简单，需要用到符号 `,` 一样。
+
+内嵌对象为了不破坏 csv 的规范，使用了符号 `:`。
+
+换言之，也就是对象内容中不能使用这个符号。
+
+后期会针对出现的符号进行转义，避免这种冲突。
+
+# 测试案例
+
+所有测试代码可以参考 [test]() 模块。
+
+## 示例对象
+
+- UserEntry.java
+
+```java
+public class UserEntry {
+
+ /**
+ * 名称
+ */
+ private String name;
+
+ /**
+ * 内嵌的用户信息
+ */
+ @CsvEntry
+ private User user;
+
+ //Getter/Setter/ToString
+}
+```
+
+这里在需要内嵌的对象上使用注解 `@CsvEntry` 表示需要进行内嵌的对象转换。
+
+- User.java
+
+其中 User 对象是原来使用的普通 java 对象
+
+```java
+public class User {
+
+ private String name;
+
+ private int age;
+
+ private float score;
+
+ private double money;
+
+ private boolean sex;
+
+ private short level;
+
+ private long id;
+
+ private char status;
+
+ private byte coin;
+
+ //Getter/Setter/ToString
+}
+```
+
+## 写入测试
+
+```java
+public void entryTest() {
+ final String path = "src\\test\\resources\\entry.csv";
+ CsvWriteBs.newInstance(path)
+ .write(buildEntryList());
+}
+```
+
+- buildEntryList()
+
+负责对象构建代码，内容如下：
+
+```java
+/**
+ * 用户明细列表
+ * @return 明细列表
+ * @since 0.0.5
+ */
+private List<UserEntry> buildEntryList() {
+ UserEntry userEntry = new UserEntry();
+ userEntry.name("test");
+ userEntry.user(buildCommonList().get(0));
+ return Collections.singletonList(userEntry);
+}
+```
+
+- buildCommonList()
+
+```java
+private List<User> buildCommonList() {
+ User user = new User();
+ short s = 4;
+ byte b = 1;
+ user.age(10)
+ .name("你好")
+ .id(1L)
+ .score(60)
+ .coin(b)
+ .level(s)
+ .money(200)
+ .sex(true)
+ .status('Y');
+ return Arrays.asList(user);
+}
+```
+
+生成文件效果
+
+```
+name,user
+test,你好:10:60.0:200.0:true:4:1:Y:1
+```
+
+如你所见，这里内嵌对象的属性使用了 `:` 进行分隔。
+
+## 读取测试
+
+```java
+public void entryTest() {
+ final String path = "src\\test\\resources\\entry.csv";
+ List<UserEntry> userList = CsvReadBs.newInstance(path)
+ .read(UserEntry.class);
+ System.out.println(userList);
+}
+```
+
+输出信息
+
+```
+[UserEntry{name='test', user=User{name='你好', age=10, score=60.0, money=200.0, sex=true, level=4, id=1, status=Y, coin=1}}]
+```

pom.xml

@@ -6,7 +6,7 @@
 
  <groupId>com.github.houbb</groupId>
  <artifactId>csv</artifactId>
- <version>0.0.5-SNAPSHOT</version>
+ <version>0.0.5</version>
 
  <properties>
  <!--============================== All Plugins START ==============================-->

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

@@ -15,6 +15,6 @@ public interface IReadConverter<T> {
  * @param context 上下文
  * @return 结果
  */
- T convert(final SingleReadContext<T> context);
+ T convert(final SingleReadContext context);
 
 }

src/main/java/com/github/houbb/csv/support/context/SingleReadContext.java

@@ -9,7 +9,7 @@
  * @author binbin.hou
  * @since 0.0.4
  */
-public class SingleReadContext<T> {
+public class SingleReadContext {
 
  /**
  * 字符串的值
@@ -29,18 +29,31 @@ public class SingleReadContext<T> {
  /**
  * 类信息
  */
- private Class<T> classType;
+ private Class classType;
 
  /**
  * 排序信息
  */
- private ISort<T> sort;
+ private ISort sort;
+
+ /**
+ * 分隔符号
+ * 默认使用：,
+ * 一级明细：:
+ * 二级明细：::
+ * 三级明细: :::
+ * 依次类推。
+ *
+ * 目的：为了保证 , 号的语意性。
+ * @since 0.0.5
+ */
+ private String split;
 
  public String value() {
  return value;
  }
 
- public SingleReadContext<T> value(String value) {
+ public SingleReadContext value(String value) {
  this.value = value;
  return this;
  }
@@ -49,7 +62,7 @@ public Field field() {
  return field;
  }
 
- public SingleReadContext<T> field(Field field) {
+ public SingleReadContext field(Field field) {
  this.field = field;
  return this;
  }
@@ -58,26 +71,35 @@ public Class fieldType() {
  return fieldType;
  }
 
- public SingleReadContext<T> fieldType(Class fieldType) {
+ public SingleReadContext fieldType(Class fieldType) {
  this.fieldType = fieldType;
  return this;
  }
 
- public Class<T> classType() {
+ public Class classType() {
  return classType;
  }
 
- public SingleReadContext<T> classType(Class<T> classType) {
+ public SingleReadContext classType(Class classType) {
  this.classType = classType;
  return this;
  }
 
- public ISort<T> sort() {
+ public ISort sort() {
  return sort;
  }
 
- public SingleReadContext<T> sort(ISort<T> sort) {
+ public SingleReadContext sort(ISort sort) {
  this.sort = sort;
  return this;
  }
+
+ public String split() {
+ return split;
+ }
+
+ public SingleReadContext split(String split) {
+ this.split = split;
+ return this;
+ }
 }

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

@@ -2,14 +2,20 @@
 
 import com.github.houbb.csv.api.IReadConverter;
 import com.github.houbb.csv.support.context.SingleReadContext;
+import com.github.houbb.csv.support.context.SingleWriteContext;
 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.entry.EntryReadConverter;
 import com.github.houbb.csv.support.convert.read.type.ITypeConverter;
 import com.github.houbb.csv.support.convert.read.type.impl.*;
+import com.github.houbb.csv.support.convert.write.entry.EntryWriteConverter;
+import com.github.houbb.csv.util.CsvFieldUtil;
+import com.github.houbb.csv.util.CsvInnerUtil;
 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.support.sort.ISort;
 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;
@@ -48,6 +54,8 @@ public class CommonReadConverter implements IReadConverter<Object> {
  public Object convert(final SingleReadContext context) {
  final String value = context.value();
  final Field field = context.field();
+ final String split = context.split();
+ final ISort sort = context.sort();
 
  //1. 为空判断
  if(StringUtil.isEmpty(value)) {
@@ -70,6 +78,19 @@ public Object convert(final SingleReadContext context) {
  if(ClassTypeUtil.isCollection(refType)) {
  return Instances.singletion(CollectionReadConverter.class).convert(context);
  }
+ // 2.4 对象
+ // 当前字段指定为 @CsvEntry 且为对象
+ if(CsvFieldUtil.isEntryAble(field)) {
+ final String nextSplit = CsvInnerUtil.getNextSplit(split);
+ SingleReadContext singleReadContext = new SingleReadContext();
+ singleReadContext.sort(sort)
+ .value(value)
+ .split(nextSplit)
+ .classType(refType)
+ .field(field)
+ ;
+ return Instances.singletion(EntryReadConverter.class).convert(singleReadContext);
+ }
 
  // 3. 基本类型
  return this.convert(value, refType);

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

@@ -5,9 +5,7 @@
 import com.github.houbb.csv.support.context.SingleReadContext;
 import com.github.houbb.csv.support.convert.read.CommonReadConverter;
 import com.github.houbb.heaven.annotation.ThreadSafe;
-import com.github.houbb.heaven.constant.PunctuationConst;
 import com.github.houbb.heaven.support.instance.impl.Instances;
-import com.github.houbb.heaven.util.lang.StringUtil;
 import com.github.houbb.heaven.util.lang.reflect.ReflectFieldUtil;
 
 import java.lang.reflect.Array;