当前位置：首页 » 《关注互联网》 » 正文

公司的报表工具太难用，我三天撸了个Excel工具，运营小姐姐直呼太好用了，现已开源！！（建议收藏）_冰河的专栏

7 人参与  2021年09月12日 10:43  分类 : 《关注互联网》  评论

点击全文阅读


大家好，我是冰河~~

不管是传统软件企业还是互联网企业，不管是管理软件还是面向C端的互联网应用。都不可避免的会涉及到报表操作，而对于报表业务来说，一个很重要的功能就是将数据导出到Excel。

如果我们在业务代码中，嵌入很多导出Excel的逻辑，那我们的代码就会变得异常臃肿，不利于维护，而且导出Excel的核心逻辑基本相同。那我们能否将导出Excel的核心逻辑封装成一个工具，当我们需要导出Excel时，只是向工具简单的传入数据呢？于是乎，mykit-excel诞生了！

mykit-excel的github链接地址为：

https://github.com/sunshinelyz/mykit-excel

欢迎各位小伙伴Star和Fork源码，也欢迎大家pr你牛逼哄哄的代码，我们一起来养肥它！

如果文章对你有点帮助，小伙伴们点赞、收藏、评论和分享，走起呀~~

框架简述

mykit-excel插件是通用的Excel导入导出框架，旨在提供通用的Excel导入导出功能，支持以注解方式选择JavaBean中的部分字段导出，并提供注解指定Excel列标题和排序功能。

框架结构

  • mykit-excel-annotation: mykit-excel框架的注解模块，提供注解标识类中的哪些字段需要导出到Excel
  • mykit-excel-common: mykit-excel框架的通用工具类，提供通用的工具模板
  • mykit-excel-servlet: mykit-excel框架提供的Web模块，能够支持Web请求导出Excel
  • mykit-excel-springmvc: mykit-excel框架提供的SpringMVC模块，能够支持Web请求导出Excel
  • mykit-excel-test: mykit-excel框架提供的常规测试模块
  • mykit-excel-springboot: mykit-excel框架提供的SpringBoot测试模块

测试用例

（1）测试常规导出Excel工具类的Java类为：io.mykit.excel.springboot.normal.export.TestExportExcelUtils，直接运行该类即可。

（2）测试注解导出Excel工具类的Java类为：io.mykit.excel.springboot.annotation.export.TestAnnotationExportExcelUtils，直接运行该类即可。

（3）测试SpringMVC导出Excel的Java类为io.mykit.excel.springboot.normal.springmvc.NormalExportExcelContorller，运行SpringBoot的启动类io.mykit.excel.springboot.MykitExcelCoreApplication之后，使用resources/html目录下的normalExportExcel.html文件导出Excel即可。如果设置的IP和端口与mykit-excel-springboot模块不同，则修改normalExportExcel.html文件中的IP和端口即可。

（4）测试基于注解导出Java类为io.mykit.excel.springboot.annotation.springmvc.AnnotationExportExcelController，运行SpringBoot的启动类io.mykit.excel.springboot.MykitExcelCoreApplication 之后，使用resources/html目录下的annotationExportExcel.html文件导出Excel即可。如果设置的IP和端口与mykit-excel-springboot模块不同，则修改annotationExportExcel.html文件中的IP和端口即可。

注解说明

如果使用注解方式导出Excel，则需要在JavaBean的属性字段上添加@ExcelColumn注解，此注解中有三个属性，分别如下：

  • isExport：表示是否将当前字段导出到Excel，true：是；false：否
  • title：导出到Excel时的当前列的标题；
  • sort：当前字段导出到Excel的列时，在Excel中的位置，值越小，当前列越靠前。

使用方式

普通方式导出Excel

如果是普通的Java项目，只是将Excel文件导出到本地磁盘，则只需要在项目的pom.xml文件中增加如下配置

<dependency>
    <groupId>io.mykit.excel</groupId>
    <artifactId>mykit-excel-common</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>

创建测试JavaBean

@Data
public class Student implements Serializable {
    private static final long serialVersionUID = -2987207599880734028L;
    private int id;
    private String name;
    private String sex;

    public Student(){

    }

    public Student(int id, String name, String sex){
        this.id = id;
        this.name = name;
        this.sex = sex;
    }
}

接下来，在程序中按照如下方式导出Excel文件即可

public static void main(String[] args) throws Exception{
    ExportExcelUtils<Student> utils = new ExportExcelUtils<Student>();
    List<Student> list = new ArrayList<Student>();
    for (int i = 0; i < 10; i++) {
        list.add(new Student(111,"张三","男"));
        list.add(new Student(111,"李四","男"));
        list.add(new Student(111,"王五","女"));
    }
    String[] columnNames = { "ID", "姓名", "性别" };
    utils.exportExcel("用户导出", columnNames, list, new FileOutputStream("E:/test.xls"), ExportExcelUtils.EXCEL_FILE_2003);
}

导出的文件如下所示

注解方式导出Excel

如果是普通的Java项目，以注解方式将Excel文件导出到本地磁盘，则只需要在项目的pom.xml文件中增加如下配置

<dependency>
    <groupId>io.mykit.excel</groupId>
    <artifactId>mykit-excel-common</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>

创建测试JavaBean

(1) 创建父类JavaBean

@Data
public class Person implements Serializable {
    private static final long serialVersionUID = 3251965335162340137L;

    @ExcelColumn(isExport = true, title = "编号", sort = 2)
    private String id ;

    @ExcelColumn(isExport = true, title = "姓名", sort = 3)
    private String name;
    
    public Person(){
    }

    public Person(String id, String name){
        this.id = id;
        this.name = name;
    }
}

(2) 创建子类JavaBean

@Data
public class Student extends Person{
    private static final long serialVersionUID = -6180523202831503132L;

    @ExcelColumn(isExport = false, title = "班级编号", sort = 1)
    private String classNo;

    private Integer score;

    @ExcelColumn(isExport = true, title = "爱好", sort = 5)
    private String hobby;
    
    public Student(){
    }

    public Student(String id, String name, String classNo, Integer score, String hobby){
        super(id, name);
        this.classNo = classNo;
        this.score = score;
        this.hobby = hobby;
    }
}

接下来，在程序中按照如下方式导出Excel文件即可

public class TestAnnotationExportExcelUtils {
    public static void main(String[] args) throws FileNotFoundException {
        // 准备数据
        List<Student> list = new ArrayList<Student>();
        for (int i = 1; i <= 10; i++) {
            list.add(new Student("00" + i, "张三", "001", 100, "篮球"));
        }
        AnnotationExcelExportUtils<Student> utils = new AnnotationExcelExportUtils<Student>();
        utils.exportExcel("用户导出", list, new FileOutputStream("e:/E:/test.xls"), Student.class, AnnotationExcelExportUtils.EXCEL_FILE_2003);
    }
}

导出的文件如下所示

Web方式导出Excel

如果是基于Java Web或Spring MVC项目，需要导出Excel，则需要在项目的pom.xml文件中，加入如下配置

<dependency>
    <groupId>io.mykit.excel</groupId>
    <artifactId>mykit-excel-servlet</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>

创建测试JavaBean

@Data
public class Student implements Serializable {
    private static final long serialVersionUID = -2987207599880734028L;
    private int id;
    private String name;
    private String sex;

    public Student(){

    }

    public Student(int id, String name, String sex){
        this.id = id;
        this.name = name;
        this.sex = sex;
    }
}

接下来，在程序中按照如下方式导出Excel文件即可

@RequestMapping("/excel")
public void getExcel(HttpServletRequest request, HttpServletResponse response) throws Exception {
    // 准备数据
    List<Student> list = new ArrayList<Student>();
    for (int i = 0; i < 10; i++) {
        list.add(new Student(111,"张三","男"));
        list.add(new Student(111,"李四","男"));
        list.add(new Student(111,"王五","女"));
    }
    String[] columnNames = { "ID", "姓名", " 性别"};
    String fileName = "springboot_excel";
    ExportExcelWrapper<Student> util = new ExportExcelWrapper<Student>();
    util.exportExcel(fileName, fileName, columnNames, list, response, ExportExcelUtils.EXCEL_FILE_2003);
}

导出的文件如下所示

基于注解的Web方式导出Excel

如果是基于Java Web或Spring MVC项目，需要基于注解导出Excel，则需要在项目的pom.xml文件中，加入如下配置

<dependency>
    <groupId>io.mykit.excel</groupId>
    <artifactId>mykit-excel-servlet</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>

创建测试JavaBean

(1) 创建父类JavaBean

@Data
public class Person implements Serializable {
    private static final long serialVersionUID = 3251965335162340137L;

    @ExcelColumn(isExport = true, title = "编号", sort = 2)
    private String id ;

    @ExcelColumn(isExport = true, title = "姓名", sort = 3)
    private String name;
    
    public Person(){
    }

    public Person(String id, String name){
        this.id = id;
        this.name = name;
    }
}

(2) 创建子类JavaBean

@Data
public class Student extends Person{
    private static final long serialVersionUID = -6180523202831503132L;

    @ExcelColumn(isExport = false, title = "班级编号", sort = 1)
    private String classNo;

    private Integer score;

    @ExcelColumn(isExport = true, title = "爱好", sort = 5)
    private String hobby;
    
    public Student(){
    }

    public Student(String id, String name, String classNo, Integer score, String hobby){
        super(id, name);
        this.classNo = classNo;
        this.score = score;
        this.hobby = hobby;
    }
}

接下来，在程序中按照如下方式导出Excel文件即可

@Controller
@RequestMapping(value = "/annotation/export")
public class AnnotationExportExcelController {

    @RequestMapping("/excel")
    public void getExcel(HttpServletRequest request, HttpServletResponse response) throws Exception {
        // 准备数据
        List<Student> list = new ArrayList<Student>();
        for (int i = 1; i <= 10; i++) {
            list.add(new Student("00" + i, "张三", "001", 100, "篮球"));
        }
        String fileName = "springboot_excel";
        ExportExcelWrapper<Student> wrapper = new ExportExcelWrapper<Student>();
        wrapper.annotationExportExcel(fileName, fileName, list, Student.class, response, ExportExcelWrapper.EXCEL_FILE_2003);
    }
}

导出的文件如下所示

前端测试代码

前端测试代码放在mykit-excel-springboot模块的src/main/resources/html目录下，修改html文件中的连接地址后，将其放在Tomcat或其他Web容器中，进行测试即可。

测试方式

常规测试

直接运行mykit-excel-springboot项目中的io.mykit.excel.springboot.normal.export.TestExportExcelUtils类即可

基于注解的常规测试

直接运行mykit-excel-springboot项目中的io.mykit.excel.springboot.annotation.export.TestAnnotationExportExcelUtils类即可

Web测试

（1）启动mykit-excel-springboot项目，即运行mykit-excel-springboot项目中的io.mykit.excel.springboot.MykitExcelCoreApplication类

（2）将mykit-excel-springboot项目的src/main/resources/html下的normalExportExcel.html文件发布到Tomcat等Web容器中访问normalExportExcel.html文件的连接地址， 打开页面点击“Submit”按钮即可。

基于注解的Web测试

（1）启动mykit-excel-springboot项目，即运行mykit-excel-springboot项目中的io.mykit.excel.springboot.MykitExcelCoreApplication类。

（2）将mykit-excel-springboot项目的src/main/resources/html下的annotationExportExcel.html文件发布到Tomcat等Web容器中访问annotationExportExcel.html文件的连接地址， 打开页面点击“Submit”按钮即可。

写在最后

如果你想进大厂，想升职加薪，或者对自己现有的工作比较迷茫，都可以私信我交流，希望我的一些经历能够帮助到大家~~

推荐阅读：

  • 《实践出真知：全网最强秒杀系统架构解密，不是所有的秒杀都是秒杀！！》
  • 《从零到上亿用户，我是如何一步步优化MySQL数据库的？（建议收藏）》
  • 《我用多线程进一步优化了亿级流量电商业务下的海量数据校对系统，性能再次提升了200%！！（全程干货，建议收藏）》
  • 《我用多线程优化了亿级流量电商业务下的海量数据校对系统，性能直接提升了200%！！（全程干货，建议收藏）》
  • 《我用10张图总结出了这份并发编程最佳学习路线！！（建议收藏）》
  • 《高并发场景下一种比读写锁更快的锁，看完我彻底折服了！！（建议收藏）》
  • 《全网最全性能优化总结！！（冰河吐血整理，建议收藏）》
  • 《三天撸完了MyBatis，各位随便问！！（冰河吐血整理，建议收藏）》
  • 《奉劝那些刚参加工作的学弟学妹们：要想进大厂，这些并发编程知识是你必须要掌握的！完整学习路线！！（建议收藏）》
  • 《奉劝那些刚参加工作的学弟学妹们：要想进大厂，这些核心技能是你必须要掌握的！完整学习路线！！（建议收藏）》
  • 《奉劝那些刚参加工作的学弟学妹们：这些计算机与操作系统基础知识越早知道越好！万字长文太顶了！！（建议收藏）》
  • 《我用三天时间开发了一款老少皆宜的国民级游戏，支持播放音乐，现开放完整源代码和注释（建议收藏）！！》
  • 《我是全网最硬核的高并发编程作者，CSDN最值得关注的博主，大家同意吗？（建议收藏）》
  • 《毕业五年，从月薪3000到年薪百万，我掌握了哪些核心技能？（建议收藏）》
  • 《我入侵了隔壁妹子的Wifi，发现。。。（全程实战干货，建议收藏）》
  • 《千万不要轻易尝试“熊猫烧香”，这不，我后悔了！》
  • 《清明节偷偷训练“熊猫烧香”，结果我的电脑为熊猫“献身了”！》
  • 《7.3万字肝爆Java8新特性，我不信你能看完！（建议收藏）》
  • 《在业务高峰期拔掉服务器电源是一种怎样的体验？》
  • 《全网最全Linux命令总结！！（史上最全，建议收藏）》
  • 《用Python写了个工具，完美破解了MySQL！！（建议收藏）》
  • 《SimpleDateFormat类到底为啥不是线程安全的？（附六种解决方案，建议收藏）》
  • 《MySQL 8中新增的这三大索引，直接让MySQL起飞了，你竟然还不知道！！（建议收藏）》
  • 《撸完Spring源码，我开源了这个分布式缓存框架！！（建议收藏）》
  • 《亿级流量高并发秒杀系统商品“超卖”了，只因使用的JDK同步容器中存在这两个巨大的坑！！（踩坑实录，建议收藏）》
  • 《奉劝那些刚参加工作的学弟学妹们：要想学好并发编程，这些并发容器的坑是你必须要注意的！！（建议收藏）》

好了，今天就到这儿吧，小伙伴们点赞、收藏、评论，一键三连走起呀，我是冰河，我们下期见~~


点击全文阅读


本文链接：http://zhangshiyu.com/post/27601.html

导出  注解  收藏  
<< 上一篇 下一篇 >>

  • 评论（0）
  • 赞助本站

◎欢迎参与讨论，请在这里发表您的看法、交流您的观点。

最新文章

  • 林柒薇宋延桉小说全文免费阅读穿到八零年代和司令丈夫离婚那天全文免费阅读
  • 好看的妻子嫁作他人妇，我和女儿不认小说-妻子嫁作他人妇，我和女儿不认最新章节阅读
  • 《七零：那两口子万人嫌，太发癫了》完整版-盛春香裴清远在线全文阅读
  • 最新小说被山里糙汉追着满地跑主角闵小小闵烨全文在线阅读
  • 李慕云陶金辉全文小说最新章节阅读李慕云陶金辉
  • 《看到三十年后的联姻生活，我决定离婚》颜雯程绛-小说txt全文阅读
  • 长公主她风华正茂无弹窗在线阅读
  • 你敢说话，我就敢质疑主角是李云初张景小说百度云全文完整版阅读
  • 娶资助的贫困生当晚，她和竹马一起入洞房小说(完结)-安枫符垚无删减阅读
  • 心机女插足后，她和相亲对象闪婚了（全本）姜初棠夏芝芝完整章节列表免费阅读
  • 被撞流产后，我选择离婚小说百度云完整章节列表免费阅读
  • 沈糯周钦然《老公白月光在我家别墅养胎》全章节免费阅读

    关于我们 | 我要投稿 | 免责申明

    Copyright © 2020-2022 ZhangShiYu.com Rights Reserved.豫ICP备2022013469号-1