SpringBoot整合EasyExcel

谁借莪１个温暖的怀抱￠ 2022-10-05 12:57 200阅读 0赞

本文演示SpringBoot整合EasyExcel，并导出数据。  
一、项目搭建  
新建一个SpringBoot项目，引入依赖：

<properties>
            <java.version>1.8</java.version>
            <easyexcel.version>2.2.6</easyexcel.version>
            <lombok.version>1.16.10</lombok.version>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            
            <dependency>
                <groupId>com.spring4all</groupId>
                <artifactId>swagger-spring-boot-starter</artifactId>
                <version>1.8.0.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-validation</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok.version}</version>
            </dependency>
            
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>easyexcel</artifactId>
                <version>${easyexcel.version}</version>
            </dependency>
        </dependencies>

二、配置文件  
配置项目端口号：

server:
      port: 8989

三、配置类  
①Swagger配置类

@Configuration
    @EnableSwagger2
    public class Swagger2Configure {
        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                    .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                    .paths(PathSelectors.any()).build();
        }
    
        /**
        定义展示的信息，例如标题、描述、版本等
         */
    private ApiInfo apiInfo() {
            return new ApiInfoBuilder().title("api文档")
                    .version("1.0").build();
        }
    }

②EasyExcel工具类

public class ExcelUtils {
        public static void download(HttpServletResponse response, String fileName,String sheetName,Class cls, List data) throws IOException {
            response.setContentType("application/vnd.ms-excel");
            response.setCharacterEncoding("utf-8");
            String fname = URLEncoder.encode(fileName, "utf-8");
            response.setHeader("Content-disposition","attachment;filename=" + fname + ExcelTypeEnum.XLSX.getValue());
            LongestMatchColumnWidthStyleStrategy longestMatchColumnWidthStyleStrategy = new LongestMatchColumnWidthStyleStrategy();
            EasyExcel.write(response.getOutputStream(), cls)
                    .sheet(sheetName)
                    .registerWriteHandler(longestMatchColumnWidthStyleStrategy)
                    .doWrite(data);
            response.flushBuffer();
        }
    }

③数据实体类

@Data
    public class Student {
    
        @ExcelProperty(value = {"编号"}, index = 0)
        private Integer id;
        @ExcelProperty(value = {"姓名"}, index = 1)
        private String name;
        @ExcelProperty(value = {"年龄"}, index = 2)
        private Integer age;
    
        public Student(Integer id, String name, Integer age) {
            this.id = id;
            this.name = name;
            this.age = age;
        }
    }

四、编码实现  
①编写Controller类及测试请求方法：

@Api(tags = "demo测试")
    @RestController
    @RequestMapping("/")
    public class TestController {
    
        @PostMapping("export")
        @ApiOperation("导出学生数据")
        public void export(HttpServletResponse response) {
    
            List<Student> data = buildData();
            try {
                ExcelUtils.download(response, "StudentInfo", "Test", Student.class, data);
            } catch (Exception e) {
                System.out.println(e.getMessage());
            }
        }
    
        public static List<Student> buildData(){
            List<Student> data = new ArrayList<>();
            for (int i = 1; i < 51; i++) {
                data.add(new Student(i,"学生"+i,i));
            }
            return data;
        }
    }

②启动类

@SpringBootApplication
    public class DemoApplication {
        public static void main(String[] args) {
            SpringApplication.run(DemoApplication.class, args);
        }
    
    }

③启动项目并访问http://localhost:8989/swagger-ui.html：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xkbGxvdmVneWg_size_16_color_FFFFFF_t_70][]

下载文件后验证：

![20210609103547448.png][]  
测试验证OK。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xkbGxvdmVneWg_size_16_color_FFFFFF_t_70]: /images/20221005/abd91bad4a1f4eeeb718b566c54dba77.png
[20210609103547448.png]: /images/20221005/6f5d6754d2d945ff918ac6451ffa5ce5.png