# EasyXls

**Repository Path**: geekjava/EasyXls

## Basic Information

- **Project Name**: EasyXls
- **Description**: 简单的excel（xls格式）和java.util.List互相转换
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 29
- **Created**: 2016-05-11
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#EasyXls

使用EasyXls可以使你很方便的操作Excel。本项目目的是解决简单的（不带任何样式）xls文件的导入导出。  

##EasyXls特点

1. 支持xls转换为`List<Pojo>`对象

2. 支持xls转换为`List<Map>`对象

3. 支持`List<Pojo>`转换为xls

4. 支持`List<Map>`转换为xls

5. 支持xml配置形式

6. 支持java编码创建`Config`配置

##Maven
```xml
<dependency>
  <groupId>com.github.abel533</groupId>
  <artifactId>EasyXls</artifactId>
  <version>1.1.0</version>
</dependency>
```

##版本1.1.0 - 2015-10-08

- 输出excel时，增加对`OutputStream`支持(1.0.0版本时支持`InputStream`转换为`List<?>`)
- 对IO流的支持可以方便上传和下载时的操作

##xml配置向导

项目中包含一个简单的xml生成向导，使用该项导时，需要在项目中创建main方法并调用如下方法：  

```java
EasyXls.openGenerater();
```

##支持的列类型
 - int
 - long
 - float
 - double
 - java.lang.Integer
 - java.lang.Long
 - java.lang.Float
 - java.lang.Double
 - java.util.Date
 - java.math.BigDecimal

##项目依赖  

```xml
<dependency>
  <groupId>net.sourceforge.jexcelapi</groupId>
  <artifactId>jxl</artifactId>
  <version>2.6.12</version>
</dependency>
```  

##配置项说明  

有一些属性只在写入到xls时有效，这些会标记【写】，有些只在读取xls时使用的标记【读】，通用的不做标记。

###整体配置  

- **cache:**使用xml配置时可以选择是否启用缓存，启用缓存后不会重复解析xml配置文件，这样会提高反复使用的效率。但是如果修改了xml配置，新的配置不会生效。

- **sheet:**sheet标签的名字【写】

- **class:**excel对应的POJO类或Map

- **sheetNum:**读取第几个sheet页【读】

- **startRow:**从第几行开始读取【读】

- **maxRow:**最大读取行，超出行数的不进行读取【读】   

- **header:**是否导出标题，默认导出【写】   

###列Column配置

- **name:**对应的java字段名

- **header:**对应的excel标题名【写】

- **type:**对应列的类型，不设置时，如果使用的POJO，会自动匹配字段类型。如果使用的Map，使用xls自身的格式【读】  

- **width:**对应列的宽度（单位：像素）【写】

- **key:**必须包含值的列，如果该列为空，就会停止往下读取。主要防止读取空白行，只有第一个设置key=true的列有效【读】   


##示例

以下代码均来自测试代码（test目录下）  

部分xml：  

```xml
<?xml version="1.0" encoding="GBK" standalone="yes"?>
<excel>
  <cache>false</cache>
  <sheet>一次性费用</sheet>
  <class>po.Charges</class>
  <sheetNum>0</sheetNum>
  <startRow>1</startRow>
  <columns>
    <column>
      <name>year</name>
      <header>年度</header>
      <type>java.lang.Integer</type>
      <width>50</width>
    </column>
    <column>
      <name>ownersname</name>
      <header>户主姓名</header>
      <type>java.lang.String</type>
      <width>120</width>
    </column>
  </columns>
</excel>
```

使用xml配置读取xls：  

```java
@Test
public void testMap() {
    try {
        List list = EasyXls.xls2List(
                Xls2ListTest.class.getResource("/ChargesMap.xml").getPath(),
                new File(Xls2ListTest.class.getResource("2.xls").getPath()));
        System.out.println(list);
    } catch (Exception e) {
        e.printStackTrace();
    }
}
```  

使用java代码创建Config并读取xls：  

```java
@Test
public void testConfig() {
    try {
        //创建一个配置
        ExcelConfig config = new ExcelConfig.Builder(Charges.class)
                .sheetNum(0)
                .startRow(1)
                .key("name")
                .addColumn("year", "communityid", "roomno", "ownersid", "ownersname", "property").build();
        List list = EasyXls.xls2List(config, Xls2ListTest.class.getResourceAsStream("2.xls"));
        for (int i = 0; i < list.size(); i++) {
            System.out.println(((Charges) list.get(i)).getOwnersname());
        }
    } catch (Exception e) {
        e.printStackTrace();
    }
}
```

这里对列的处理很简单，excel文件的列和column的列一一对应即可。  

使用xml配置读取，使用Config方式写入到新的excel文件：  

```java
@Test
public void testMap2() {
    InputStream is = Xls2ListTest.class.getResourceAsStream("2.xls");
    try {
        String xmlPath = Xls2ListTest.class.getResource("/ChargesMap.xml").getPath();
        List list = EasyXls.xls2List(xmlPath, is);

        Map map = new HashMap();
        map.put("year", 2013);
        map.put("ownersname", "测试户主");
        list.add(map);

        EasyXls.list2Xls(list, xmlPath, "d:/", "testMap.xls");

        ExcelConfig config = new ExcelConfig.Builder(Charges.class)
                .sheetNum(0)
                .startRow(1)
                .separater(",")
                .key("name")
                .addColumn("year,年度", "communityid,小区ID",
                        "roomno,房号", "ownersid,户主ID",
                        "ownersname,户主姓名", "property,物业费").build();
        EasyXls.list2Xls(config, list, "d:/", "testMap2.xls");
    } catch (Exception e) {
        e.printStackTrace();
    }
}
```  

这里为了调用方便，先使用`.separater(",")`方法设定分隔符（默认为英文逗号），然后在`addColumn`方法中使用如`"year,年度"`这种方式赋值。  

这种赋值方式最多支持4个参数，分别对应name,header,width,type，如：  

>"year,年度,200,java.lang.Integer"  

使用POJO类时不需要写type，当使用Map时，可以使用type指定类型。