在springboot中使用easyexcel导出数据excel表格

古城微笑少年丶 2022-12-15 03:39 537阅读 0赞

# 第一步： #

#### 在pom.xml中添加easyexcel依赖 ####

之前测试一些低版本会出现一些问题，所以在这里使用了2.1.6的版本。

<dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>easyexcel</artifactId>
                <version>2.1.6</version>
    </dependency>

# 第二步： #

#### 编写实体类： ####

@ExcelIgnore的作用是隐藏实体类中的字段，当导出excel表格时不导出该字段。  
@ExcelProperty的作用就是设置表格中第一行的字段内容。  
如图：

![在这里插入图片描述][20201015112323203.png_pic_center]

package biz.xcj.options;
    
    import io.swagger.annotations.ApiModel;
    import io.swagger.annotations.ApiModelProperty;
    
    import java.util.Date;
    
    public class ComparisonModel { 
    	@ExcelIgnore
        private Integer comparisonId; //ID不需要导出，所以隐藏
        @ExcelProperty("人员姓名")
        private String comparisonName;
        @ExcelProperty("身份证号码")
        private String comparisonIdCard;
        
       
    
     
    	 public Integer getComparisonId() { 
            return comparisonId;
        }
    
        public void setComparisonId(Integer comparisonId) { 
            this.comparisonId = comparisonId;
        }
        public String getComparisonName() { 
            return comparisonName;
        }
    
        public void setComparisonName(String comparisonName) { 
            this.comparisonName = comparisonName;
        }
    
        public String getComparisonIdCard() { 
            return comparisonIdCard;
        }
    
        public void setComparisonIdCard(String comparisonIdCard) { 
            this.comparisonIdCard = comparisonIdCard;
        }
    }

# 第三步： #

#### 编写工具类 ####

这里直接复制粘贴即可，需要改动的就是ComparisonModel.class，改成自己实体类.class就可以了。

package biz.xcj.util;
    
    import biz.xcj.entity.ComparisonManager;
    import com.alibaba.excel.EasyExcel;
    import com.alibaba.excel.ExcelWriter;
    import com.alibaba.excel.write.metadata.WriteSheet;
    import org.springframework.stereotype.Service;
    
    import javax.servlet.http.HttpServletResponse;
    import java.io.IOException;
    import java.util.List;
    
    public class ExcelUtil { 
        /** * 导出excel工具类 * ComparisonModel 实体类 * @param response * @param list * @throws IOException */
        public static  void  writeExcel(HttpServletResponse response, List<ComparisonModel  > list) throws IOException{ 
            ExcelWriter writer = EasyExcel.write(response.getOutputStream()).build();
            WriteSheet sheet = EasyExcel.writerSheet(0,"sheet").head(ComparisonModel.class).build();
            writer.write(list,sheet);
            writer.finish();
        }
    }

# 第四步： #

#### 编写controller层代码 ####

@RestController
    @RequestMapping("/api")
    public class ExcelController { 
        /** * 导出 * list数据是随便写的用来测试的，自己可以通过任何方法来获取。 * ComparisonModel 实体类 */
        @GetMapping("/writeExcel") //使用post方式会出错，请使用get方式请求。
        public void writeExcel(HttpServletResponse response) throws Exception { 
        	List<ComparisonModel > list = new ArrayList();
        	ComparisonModel  com = new ComparisonModel ();
        	com.setComparisonName(“张三”);
        	com.setComparisonIdCard("1234567889);
        	list.add(com);
        	//不需要改动
            response.setContentType("application/vnd.ms-excel;chartset=utf-8");
            response.setHeader("Content-Disposition","attachment;filename="+"表格名称.xlsx");
            //调用工具类 
            ExcelUtil.writeExcel(response,list);
        }
    }
    }

# 第五步： #

运行项目，然后访问上面的接口地址就可以了，访问之后网页会提示下载excel表格,如图所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTE1MTk2MA_size_16_color_FFFFFF_t_70_pic_center]

[20201015112323203.png_pic_center]: /images/20221123/e24109cc43ae485da9a8222f087938ae.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTE1MTk2MA_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/05d7d11d5e754c4a8beb2575602295c6.png