release branch 0.1.0

Author: houbb

CHANGE_LOG.md

@@ -0,0 +1,74 @@
+# 变更日志
+
+| 类型 | 说明 |
+|:----|:----|
+| A | 新增 |
+| U | 更新 |
+| D | 删除 |
+| T | 测试 |
+| O | 优化 |
+| F | 修复BUG |
+
+# release_0.0.1
+
+| 序号 | 变更类型 | 说明 | 时间 | 备注 |
+|:---|:---|:---|:---|:--|
+| 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 | |
+
+# release_0.0.4
+
+| 序号 | 变更类型 | 说明 | 时间 | 备注 |
+|:---|:---|:---|:---|:--|
+| 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 | |
+
+# release_0.0.5
+
+| 序号 | 变更类型 | 说明 | 时间 | 备注 |
+|:---|:---|:---|:---|:--|
+| 1 | A | 支持内嵌对象 | 2019-6-20 11:18:14 | |
+
+# release_0.0.6
+
+| 序号 | 变更类型 | 说明 | 时间 | 备注 |
+|:---|:---|:---|:---|:--|
+| 1 | A | 支持特殊字符的转义 | 2019-6-20 17:23:30 | |
+
+# release_0.0.7
+
+| 序号 | 变更类型 | 说明 | 时间 | 备注 |
+|:---|:---|:---|:---|:--|
+| 1 | F | 修复文件生成序列化标识问题 | 2020-2-10 09:36:32 | |
+
+# release_0.0.8
+
+| 序号 | 变更类型 | 说明 | 时间 | 备注 |
+|:---|:---|:---|:---|:--|
+| 1 | A | 支持各种信息读取的新方式 | 2020-3-23 16:44:27 | |
+| 2 | A | 新增 CsvHelper，为操作提供便利性。 | 2020-3-23 16:44:27 | |
+| 3 | O | CsvReaderBs 引导类优化，便于后期调整 | 2020-3-23 16:44:27 | |
+
+# release_0.0.9
+
+| 序号 | 变更类型 | 说明 | 时间 | 备注 |
+|:---|:---|:---|:---|:--|
+| 1 | A | 支持文件写入为 APPEND 模式 | 2020-10-26 23:59:34 | |
+
+# release_0.1.0
+
+| 序号 | 变更类型 | 说明 | 时间 | 备注 |
+|:---|:---|:---|:---|:--|
+| 1 | A | 新增枚举值映射处理 | 2020-10-26 23:59:34 | |

README.md

@@ -47,11 +47,11 @@
 
 - 支持特殊字符转义
 
-### v0.0.9 变更
+### v0.1.0 变更
 
-- write() 写入文件方式调整
+- 枚举值映射
 
-多次写入相同文件时，默认使用 APPEND 的方式对内容进行追加。
+支持快速简单的枚举值映射
 
 # 快速开始
 

doc/user/02-csv-注解使用.md

@@ -35,6 +35,29 @@
  * @return 处理实现类
  */
  Class<? extends IWriteConverter> writeConverter() default StringWriteConverter.class;
+
+ /**
+ * 读映射
+ *
+ * S:成功;F:失败
+ * 枚举值用 ; 分割，映射用 : 分割。
+ *
+ * 优先级：相比较 readConverter 优先使用 readMapping，如果值不为空，且当前字段的值为 String，才进行处理。否则忽略。
+ * 注意：必须要有 : 分割符号，否则报错。只对 String 类型字段生效。
+ * @return 读
+ * @since 0.1.0
+ */
+ String readMapping() default "";
+
+ /**
+ * 写映射
+ *
+ * 优先级：相比较 writeConverter 优先使用 writeMapping，如果值不为空，且当前字段的值为 String，才进行处理。否则忽略。
+ * 注意：必须要有 : 分割符号，否则报错。只对 String 类型字段生效。
+ * @return 映射结果
+ * @since 0.1.0
+ */
+ String writeMapping() default "";
 ```
 
 ## 属性概览表
@@ -46,6 +69,8 @@
 | writeRequire | true | 当前字段是否需要写入 csv 文件 |
 | readConverter | CommonReadConverter | 将 csv 中的字符串转化为当前字段类型，支持 8 大基本类型+String |
 | writeConverter | StringWriteConverter | 直接调用当前字段值 toString() 方法，null 直接为空字符串 |
+| readMapping | "" | 读取时的枚举值映射 |
+| writeMapping | "" | 写入时的枚举值映射 |
 
 其中 readConverter/writeConverter 支持用户自定义
 
@@ -156,3 +181,51 @@ public void annotationTest() {
 ```
 [UserAnnotation{name='你好', password='null', birthday=Mon Jun 03 00:00:00 CST 2019}]
 ```
+
+# 枚举映射
+
+## 对象定义
+
+```java
+public class UserMapping {
+
+ @Csv(readMapping = "S:成功;F:失败", writeMapping = "S:成功;F:失败")
+ private String status;
+ 
+ //getter/setter/toString()
+
+}
+```
+
+这种方法适合快速的枚举导出，如果比较复杂，可以使用对应的 converter 即可。
+
+## 写入
+
+```java
+UserMapping userMapping = new UserMapping();
+userMapping.status("S");
+
+CsvHelper.write(Collections.singletonList(userMapping), CsvWriters.filePath("src\\test\\resources\\mapping.csv"));
+```
+
+输出文件效果
+
+```
+status
+成功
+```
+
+枚举值 S 被映射成了成功。
+
+## 读取
+
+有写入，就有对应的读取。
+
+```java
+final String path = "src\\test\\resources\\mapping.csv";
+
+List<UserMapping> userList = CsvHelper.read(path, UserMapping.class);
+Assert.assertEquals("[UserMapping{status='S'}]", userList.toString());
+```
+
+可以把成功映射为 S，便于一些枚举值的映射处理和存储。

release.bat

@@ -10,9 +10,9 @@ ECHO "============================= RELEASE START..."
 
 :: 版本号信息(需要手动指定)
 :::: 旧版本名称
-SET version=0.0.9
+SET version=0.1.0
 :::: 新版本名称
-SET newVersion=0.1.0
+SET newVersion=0.1.1
 :::: 组织名称
 SET groupName=com.github.houbb
 :::: 项目名称

src/main/java/com/github/houbb/csv/annotation/Csv.java

@@ -49,4 +49,27 @@
  */
  Class<? extends IWriteConverter> writeConverter() default CommonWriteConverter.class;
 
+ /**
+ * 读映射
+ *
+ * S:成功;F:失败
+ * 枚举值用 ; 分割，映射用 : 分割。
+ *
+ * 优先级：相比较 readConverter 优先使用 readMapping，如果值不为空，且当前字段的值为 String，才进行处理。否则忽略。
+ * 注意：必须要有 : 分割符号，否则报错。只对 String 类型字段生效。
+ * @return 读
+ * @since 0.1.0
+ */
+ String readMapping() default "";
+
+ /**
+ * 写映射
+ *
+ * 优先级：相比较 writeConverter 优先使用 writeMapping，如果值不为空，且当前字段的值为 String，才进行处理。否则忽略。
+ * 注意：必须要有 : 分割符号，否则报错。只对 String 类型字段生效。
+ * @return 映射结果
+ * @since 0.1.0
+ */
+ String writeMapping() default "";
+
 }

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

@@ -0,0 +1,31 @@
+package com.github.houbb.csv.api;
+
+/**
+ * 枚举值编码和描述接口
+ * @author binbin.hou
+ * @since 0.1.0
+ */
+public interface ICodeDesc {
+
+ /**
+ * 获取编码
+ * @return 编码
+ * @since 0.1.0
+ */
+ String getCode();
+
+ /**
+ * 获取描述
+ * @return 描述
+ * @since 0.1.0
+ */
+ String getDesc();
+
+ /**
+ * 列表
+ * @return 列表
+ * @since 0.1.0
+ */
+ ICodeDesc[] list();
+
+}

src/main/java/com/github/houbb/csv/constant/CsvConst.java

@@ -54,4 +54,16 @@ private CsvConst(){}
  */
  public static final int DEFAULT_END_INDEX = Integer.MAX_VALUE;
 
+ /**
+ * 映射分割符号
+ * @since 0.1.0
+ */
+ public static final String MAPPING_SPLITTER = ";";
+
+ /**
+ * 每一组元素的分割符号
+ * @since 0.1.0
+ */
+ public static final String MAPPING_UNIT_SPLITTER = ":";
+
 }

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

@@ -1,5 +1,6 @@
 package com.github.houbb.csv.support.context;
 
+import com.github.houbb.csv.annotation.Csv;
 import com.github.houbb.heaven.support.sort.ISort;
 
 import java.lang.reflect.Field;
@@ -55,6 +56,12 @@ public class SingleReadContext {
  */
  private boolean escape;
 
+ /**
+ * csv 注解信息
+ * @since 0.1.0
+ */
+ private Csv csv;
+
  /**
  * 创建新的实例
  * @return 新的实例
@@ -126,4 +133,13 @@ public SingleReadContext escape(boolean escape) {
  this.escape = escape;
  return this;
  }
+
+ public Csv csv() {
+ return csv;
+ }
+
+ public SingleReadContext csv(Csv csv) {
+ this.csv = csv;
+ return this;
+ }
 }

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

@@ -1,5 +1,6 @@
 package com.github.houbb.csv.support.context;
 
+import com.github.houbb.csv.annotation.Csv;
 import com.github.houbb.heaven.support.sort.ISort;
 
 import java.lang.reflect.Field;
@@ -63,6 +64,12 @@ public static SingleWriteContext newInstance() {
  */
  private boolean escape;
 
+ /**
+ * 注解信息
+ * @since 0.1.0
+ */
+ private Csv csv;
+
  public ISort sort() {
  return sort;
  }
@@ -116,4 +123,13 @@ public SingleWriteContext escape(boolean escape) {
  this.escape = escape;
  return this;
  }
+
+ public Csv csv() {
+ return csv;
+ }
+
+ public SingleWriteContext csv(Csv csv) {
+ this.csv = csv;
+ return this;
+ }
 }

src/main/java/com/github/houbb/csv/support/convert/mapping/ReadMappingConverter.java

@@ -0,0 +1,35 @@
+package com.github.houbb.csv.support.convert.mapping;
+
+import com.github.houbb.csv.api.IReadConverter;
+import com.github.houbb.csv.support.context.SingleReadContext;
+import com.github.houbb.csv.util.CsvInnerUtil;
+import com.github.houbb.heaven.annotation.ThreadSafe;
+import com.github.houbb.heaven.util.lang.StringUtil;
+
+import java.util.Map;
+
+/**
+ * 读取转换器，将 string 转换为 field
+ * @author binbin.hou
+ * @since 0.1.0
+ */
+@ThreadSafe
+public class ReadMappingConverter implements IReadConverter<String> {
+
+ @Override
+ public String convert(SingleReadContext context) {
+ String value = context.value();
+ if(StringUtil.isEmpty(value)) {
+ return value;
+ }
+
+ Map<String, String> map = CsvInnerUtil.getMappingMap(context.csv().readMapping());
+ for(Map.Entry<String, String> entry : map.entrySet()) {
+ if(entry.getValue().equalsIgnoreCase(value)) {
+ return entry.getKey();
+ }
+ }
+ return value;
+ }
+
+}