Merge branch 'master' of https://github.com/biezhi/excel-plus

Author: vpday

README.md

@@ -4,9 +4,7 @@ Easier to read and generate an excel file, supports 2003 and 2007.
 
 [![](https://img.shields.io/travis/biezhi/excel-plus.svg)](https://travis-ci.org/biezhi/excel-plus)
 [![](https://img.shields.io/maven-central/v/io.github.biezhi/excel-plus.svg)](https://mvnrepository.com/artifact/io.github.biezhi/excel-plus)
-[![@biezhi on zhihu](https://img.shields.io/badge/zhihu-%40biezhi-red.svg)](https://www.zhihu.com/people/biezhi)
 [![](https://img.shields.io/badge/license-Apache2-FF0080.svg)](https://github.com/biezhi/excel-plus/blob/master/LICENSE)
-[![](https://img.shields.io/github/followers/biezhi.svg?style=social&label=Follow%20Me)](https://github.com/biezhi)
 
 <a href="https://biezhi.github.io/excel-plus/" target="_blank">中文文档</a>
 
@@ -27,7 +25,7 @@ As maven dependency
 <dependency>
     <groupId>io.github.biezhi</groupId>
     <artifactId>excel-plus</artifactId>
-    <version>0.1.2-RELEASE</version>
+    <version>0.1.6.RELEASE</version>
 </dependency>
 ```
 
@@ -37,7 +35,7 @@ snapshot version
 <dependency>
     <groupId>io.github.biezhi</groupId>
     <artifactId>excel-plus</artifactId>
-    <version>0.1.3-SNAPSHOT</version>
+    <version>0.1.7-SNAPSHOT</version>
 </dependency>
 ```
 
@@ -81,6 +79,10 @@ See [here](https://github.com/biezhi/excel-plus/tree/master/src/test/java/io/git
 
 **Custom export style**
 
+# Thanks
+
+- [ydq](https://github.com/ydq)
+
 # License
 
 [Apache2](https://github.com/biezhi/excel-plus/blob/master/LICENSE)

docs/README.md

@@ -43,7 +43,7 @@
 <dependency>
     <groupId>io.github.biezhi</groupId>
     <artifactId>excel-plus</artifactId>
-    <version>0.1.2-RELEASE</version>
+    <version>0.1.6.RELEASE</version>
 </dependency>
 ```
 
@@ -69,6 +69,10 @@ public class CardSecret {
 
     @ExcelField(order = 3, columnName = "过期时间", datePattern = "yyyy年MM月dd日")
     private Date expiredDate;
+    
+    // 可跳过索引为 4 的列
+    @ExcelField(order = 5, columnName = "使用情况", convertType = UsedTypeConverter.class)
+    private Boolean used;
 
     // getter setter 省略
 }
@@ -98,10 +102,10 @@ public class CardTypeConverter implements Converter<Integer> {
 ```java
 ExcelPlus excelPlus = new ExcelPlus();
 List<CardSecret> cardSecrets = new ArrayList<>();
-cardSecrets.add(new CardSecret(1, "vlfdzepjmlz2y43z7er4", new BigDecimal("20")));
-cardSecrets.add(new CardSecret(2, "rasefq2rzotsmx526z6g", new BigDecimal("10")));
-cardSecrets.add(new CardSecret(2, "2ru44qut6neykb2380wt", new BigDecimal("50")));
-cardSecrets.add(new CardSecret(1, "srcb4c9fdqzuykd6q4zl", new BigDecimal("15")));
+cardSecrets.add(new CardSecret(1, "vlfdzepjmlz2y43z7er4", new BigDecimal("20"), false));
+cardSecrets.add(new CardSecret(2, "rasefq2rzotsmx526z6g", new BigDecimal("10"), false));
+cardSecrets.add(new CardSecret(2, "2ru44qut6neykb2380wt", new BigDecimal("50"), true));
+cardSecrets.add(new CardSecret(1, "srcb4c9fdqzuykd6q4zl", new BigDecimal("15"), false));
 
 excelPlus.export(cardSecrets).writeAsFile(new File("卡密列表.xlsx"));
 ```
@@ -110,9 +114,8 @@ excelPlus.export(cardSecrets).writeAsFile(new File("卡密列表.xlsx"));
 下面这个例子是从Excel 中读取数据到 Java List 容器，如果你想存储在 Set 里我相信你可以做到。
 
 ```java
-List<CardSecret> cardList = excelPlus.read(
-                                new File("卡密列表.xls"), 
-                                CardSecret.class).asList();
+Reader reader = Reader.create().excelFile(new File("卡密列表.xlsx"));
+List<CardSecret> cardList = excelPlus.read(CardSecret.class, reader).asList();
 ```
 
 没错，就是这么简单！如果有更加复杂或自定义的需求可以看下面的进阶使用。
@@ -124,9 +127,9 @@ List<CardSecret> cardList = excelPlus.read(
 有时候我们需要对读取的行数据做一下过滤，这时候就可以使用 `filter` 函数来筛选出合适的数据项。
 
 ```java
-List<CardSecret> readList = excelPlus.read(new File("卡密列表.xls"), CardSecret.class)
-                                     .filter(cardSecret -> !cardSecret.getSecret().isEmpty())
-                                     .asList();
+excelPlus.read(CardSecret.class, reader)
+         .filter(cardSecret -> !cardSecret.getSecret().isEmpty())
+         .asList();
 ```
 
 ## 读取校验
@@ -136,19 +139,18 @@ List<CardSecret> readList = excelPlus.read(new File("卡密列表.xls"), CardSec
 实际工作中你可能将它们交由前端处理。
 
 ```java
-ExcelResult<CardSecret> result = excelPlus
-                        .read(new File("卡密列表.xls"), CardSecret.class)
-                        .valid(cardSecret -> {
-                            if (cardSecret.getAmount().doubleValue() < 20) {
-                                return ValidRow.fail("最小金额为20");
-                            }
-                            return ValidRow.ok();
-                        }).asResult();
+ReaderResult<CardSecret> result = excelPlus.read(new File("卡密列表.xls"), CardSecret.class)
+         .valid((index, cardSecret) -> {
+            if(!cardSecret.getUsed()){
+                return ValidRow.ok();
+            }
+            return ValidRow.fail("已经被使用");
+         });
 
 if (!result.isValid()) {
     result.errors().forEach(System.out::println);
 } else {
-    System.out.println(result.rows().size());
+    System.out.println(result.asList().size());
 }
 ```
 
@@ -161,8 +163,11 @@ if (!result.isValid()) {
 如果你对样式的操作不熟悉可以参考 POI 的列设置[文档](https://poi.apache.org/spreadsheet/quick-guide.html#Creating+Date+Cells)。
 
 ```java
+// 构建数据
 List<CardSecret> cardSecrets = this.buildCardSecrets();
-excelPlus.export(Exporter.create(cardSecrets).headerStyle(workbook -> {
+
+Exporter<CardSecret> exporter = Exporter.create(cardSecrets);
+exporter.headerStyle(workbook -> {
     CellStyle headerStyle = workbook.createCellStyle();
     headerStyle.setAlignment(HorizontalAlignment.LEFT);
 
@@ -174,15 +179,19 @@ excelPlus.export(Exporter.create(cardSecrets).headerStyle(workbook -> {
     headerFont.setBold(true);
     headerStyle.setFont(headerFont);
     return headerStyle;
-})).writeAsFile(new File("卡密列表.xls"));
+});
+
+excelPlus.export(exporter)
+                .writeAsFile(new File("卡密列表.xlsx"));
 ```
 
 ## 浏览器下载
 
 为了方便我们将数据库查询的数据直接输出到浏览器弹出下载，`excel-plus` 也做了一点 _手脚_ 让你一行代码就可以搞定。
 
 ```java
-excelPlus.export(data).writeAsResponse(ResponseWrapper.create(servletResponse, "xxx表格.xls"));
+excelPlus.export(exporter)
+         .writeAsResponse(ResponseWrapper.create(servletResponse, "xxx表格.xls"))
 ```
 
 只需要将 `HttpServletResponse` 对象传入，并输入导出的文件名称，其他的都见鬼去吧。
@@ -205,22 +214,22 @@ excelPlus.export(Exporter.create(cardSecrets).byTemplate("tpl.xls")).writeAsFile
 
 - `ExcelPlus`: 用于操作读取或导出 Excel 文档的类
 - `Converter`: 数据类型转换的顶层接口
-- `ExcelResult`: 当校验数据时候用于存储返回的错误消息和 `List` 数据
+- `ReaderResult`: 存储读取到的列表，包含校验不通过的消息
 - `Exporter`: 用于存储导出 Excel 文档时的配置，如样式、模板位置等
 
 ## 注解使用
 
 该项目中有 4 个注解，分别是 `ExcelField`、`ExcelSheet`、`ReadField`、`WriteField`。
-正常情况下你只会用到第一个注解，下面先来解释一下 `@ExcelField`。
+正常情况下你只会用到第一个注解，下面解释一下 `@ExcelField`。
 
 <b>@ExcelField 注解</b>
 
 | 选项        | 默认值               | 描述                                                               |
 |-------------|----------------------|--------------------------------------------------------------------|
-| order       | -1                   | 用于标识 Excel 中的列索引，从0开始，该选项适用于读取或写入Excel    |
-| columnName  | 必选                 | 导出Excel时的列名称，如：状态、姓名、手机号                        |
-| datePattern | 空                   | 日期格式化的pattern，对 Date、LocalDate、LocalDateTime 生效        |
-| convertType | EmptyConverter.class | 数据类型转换的类Class，实现自Converter接口，实现类需有无参构造函数 |
+| `order`       | -1                   | 用于标识 Excel 中的列索引，从 0 开始，该选项适用于读取或写入 Excel    |
+| `columnName`  | 必选                 | 导出Excel时的列名称，如：状态、姓名、手机号                        |
+| `datePattern` | 空                   | 日期格式化的 `pattern`，对 `Date`、`LocalDate`、`LocalDateTime` 生效        |
+| `convertType` | `EmptyConverter.class` | 数据类型转换的类 Class，实现自 Converter 接口，实现类需有无参构造函数 |
 
 > `@ReadField` 和 `@WriteField` 是针对读取和写入的顺序不一致、日期格式不一致时的覆盖型注解，一般用不到。
 

docs/cover.md renamed to docs/_coverpage.md

@@ -1,4 +1,4 @@
-<img src="media/logo.svg" alt="excel-plus" title="excel-plus" />
+<img src="_media/logo.svg" alt="excel-plus" title="excel-plus" />
 
 > 提高生产力的 Excel 操作库
 
@@ -9,5 +9,3 @@
 
 [GitHub](https://github.com/biezhi/excel-plus)
 [快速开始](#快速开始)
-
-![color](linear-gradient(to bottom, #cceaff 0%, #b4e4c0 100%))

docs/media/logo.svg renamed to docs/_media/logo.svg

@@ -6,98 +6,18 @@
   <meta name="description" content="excel-plus - 提高生产力的 Excel 操作库">
   <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
   <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
-  <link rel="stylesheet" href="//unpkg.com/docsify/themes/buble.css">
-  <style>
-    body {
-      background-color: #f9f9f9;
-    }
-
-    table {
-      border-spacing: .5rem;
-    }
-
-    .cover-main img[alt="trilogy logo"] {
-      margin-top: -3%;
-      width: 420px;
-    }
-
-    section.cover ul {
-      text-align: left;
-      padding-left: 150px;
-    }
-
-    section.cover ul li{
-      list-style-type: square;
-    }
-    .cover-main p > a {
-      margin-top: 5%;
-
-    }
-    section.cover .cover-main > p:last-child a{
-      color: #257A2A;
-      border-color: #257A2A;
-    }
-
-    section.cover .cover-main > p:last-child a:last-child{
-      background-color: #257A2A;
-    }
-    .markdown-section blockquote{
-      border-left-color: #257A2A;
-    }
-    .sidebar-toggle span{
-      background-color: #257A2A;
-    }
-    .markdown-section h3 {
-      margin: 1.2em 0 1.2em;
-    }
-
-    .markdown-section pre {
-      border-left: 0;
-    }
-
-    .markdown-section code,
-    .markdown-section pre > code {
-      font-family: "Operator Mono", "Fira Code", "Ubuntu Mono",
-                   "Droid Sans Mono", "Liberation Mono", "Source Code Pro",
-                   Menlo, Consolas, Inconsolata, Courier, monospace;
-      font-size: 14px;
-      background-color: #e8e8e8;
-      border-radius: 0;
-    }
-  </style>
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
 </head>
 <body>
   <div id="app"></div>
 </body>
 
-<script>
-  window.$docsify = {
-    coverpage: 'cover.md',
-    maxLevel: 3,
-    name: 'Excel Plus',
-    repo: 'https://github.com/biezhi/excel-plus',
-    search: {
-      noData: {
-        '/': '没有找到'
-      },
-      paths: 'auto',
-      placeholder: {
-        '/': '搜索...'
-      }
-    },
-    formatUpdated: '{MM}/{DD} {HH}:{mm}',
-    plugins: [
-      (hook, vm) => {
-        hook.beforeEach(html => {
-          var url = 'https://github.com/biezhi/excel-plus/blob/master/docs/' + vm.route.file
-          var editHtml = '[📝 编辑文档](' + url + ')\n'
-          return html + '\n----\n' + editHtml
-        })
-      }
-    ]
-  }
-</script>
-<script src="//unpkg.com/docsify/lib/docsify.js"></script>
-<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
+<script
+        src="//unpkg.com/docsify/lib/docsify.min.js"
+        data-max-level="3"
+        data-sidebar-toggle
+        data-coverpage
+        data-router></script>
+
 <script src="//unpkg.com/prismjs/components/prism-java.js"></script>
 </html>

docs/index.html

@@ -6,7 +6,7 @@
 
     <groupId>io.github.biezhi</groupId>
     <artifactId>excel-plus</artifactId>
-    <version>0.1.3-SNAPSHOT</version>
+    <version>0.1.7-SNAPSHOT</version>
     <name>excel-plus</name>
     <url>https://biezhi.github.io/excel-plus</url>
     <description>excel read and write framework</description>

pom.xml

@@ -15,6 +15,7 @@
  */
 package io.github.biezhi.excel.plus;
 
+import io.github.biezhi.excel.plus.enums.ExcelType;
 import io.github.biezhi.excel.plus.enums.ParseType;
 import io.github.biezhi.excel.plus.exception.ExcelException;
 import io.github.biezhi.excel.plus.handler.CSVHandler;
@@ -97,12 +98,10 @@ public void writeAsResponse(ResponseWrapper wrapper) throws ExcelException {
     public <T> ReaderResult<T> read(Class<T> type, Reader reader) throws ExcelException {
         List<Pair<Integer, T>> result;
         this.beforeCheck(reader);
-
-        boolean is2007 = reader.getExcelFile().getName().toLowerCase().endsWith(".xlsx");
-        if (reader.getParseType().equals(ParseType.SAX) && is2007) {
+        if (reader.getParseType().equals(ParseType.SAX) && reader.getExcelType() == ExcelType.XLSX) {
             result = new Excel2007Handler<>(type, reader).parse();
         } else {
-            if (reader.getExcelFile().getName().endsWith(".csv")) {
+            if (ExcelType.CSV == reader.getExcelType()) {
                 result = new CSVHandler<>(type, reader).parse();
             } else {
                 result = new DefaultExcelHandler<>(type, reader).parse();
@@ -115,12 +114,15 @@ private void beforeCheck(Reader reader) throws ExcelException {
         if (null == reader) {
             throw new ExcelException("Reader not is null.");
         }
-        if (null == reader.getExcelFile()) {
+        if (null == reader.getExcelFile() && null == reader.getInputStream()) {
             throw new ExcelException("Excel file not is null.");
         }
         if (null == reader.getParseType()) {
             throw new ExcelException("Excel parse type not is null.");
         }
+        if (null == reader.getExcelType()) {
+            throw new ExcelException("Excel file type not is null.");
+        }
         if (reader.getSheetIndex() < 0) {
             throw new ExcelException("SheetIndex Can't be less than 0.");
         }

src/main/java/io/github/biezhi/excel/plus/ExcelPlus.java

@@ -46,7 +46,7 @@ public CSVHandler(Class<T> type, Reader reader) {
     @Override
     public List<Pair<Integer, T>> parse() throws ExcelException {
         List<Pair<Integer, T>> list = new ArrayList<>();
-        try (InputStream in = new FileInputStream(reader.getExcelFile())) {
+        try (InputStream in = reader.getExcelFile() != null ? new FileInputStream(reader.getExcelFile()) : reader.getInputStream()) {
             CSV          csv      = new CSV(true, ',', in);
             List<String> colNames = null;
             if (csv.hasNext()) colNames = new ArrayList<>(csv.next());