jax-rs规范和spring规范生成Excel文件

首先说明一点:

spring规范下使用@GetMapping等注解的接口与jax-rs规范下使用@Path+@GET等注解的接口不能混用,否则导致一方无效.

spring规范下使用@GetMapping等注解的接口生成并下载Excel文件:

主要有一步: 创建接口

import org.apache.poi.hssf.usermodel.HSSFCell;
import org.apache.poi.hssf.usermodel.HSSFRow;
import org.apache.poi.hssf.usermodel.HSSFSheet;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

@RestController
public class MyController {
    @GetMapping("/generateTemplate")
    public void generateTemplate(HttpServletResponse response) throws IOException {
        HSSFWorkbook workbook = new HSSFWorkbook();// 生成excel文件
        HSSFSheet sheet = workbook.createSheet("日常岗位");// 生成里面的sheet页
        Map<Integer, String> map = getCellValueMap();
        HSSFRow row = sheet.createRow(0);// 生成第一行
        for (int i = 0; i < 10; i++) {
            HSSFCell cell = row.createCell(i);// 生成每行各列的单元格
            cell.setCellValue(map.get(i));// 对单元格赋值
        }
        response.setHeader("Content-Disposition", "attachment;Filename=" + System.currentTimeMillis() + ".xls");// 告诉浏览器下载文件
        ServletOutputStream outputStream = response.getOutputStream();// 获取响应的输出流
        workbook.write(outputStream);// 将文件对象放进响应的输出流中
        outputStream.close();// 关闭输出流
    }

    private Map<Integer, String> getCellValueMap() {
        Map<Integer, String> map = new HashMap<>();
        map.put(0, "姓名");
        map.put(1, "年龄");
        map.put(2, "工号");
        map.put(3, "身高");
        return map;
    }
}
效果:

注意5点:

　　1. Excel的生成顺序: 先文件对象--然后sheet页对象--然后行对象--然后单元格对象--最后往单元格里面装东西

　　2. 设置响应头属性Content-Disposition为attachment附件,表示告诉浏览器接收到这个响应后要从输出流中下载文件,而文件的名称通过Filename=xxx指定为xxx

　　3. 将文件对象放进输出流后,一定要关闭输出流

　　4. HSSF用于生成xls格式的Excel文件, XSSF用于生成xlsx格式的Excel文件

　　5. spring规范下的接口,直接在参数列表中引入HttpServletResponse声明,即可获取当前请求的响应对象

jax-rs规范下使用@Path+@GET等注解的接口生成并下载Excel文件:

主要有2步: 创建接口+注册资源配置

-----------------------------------创建接口------------------------------------

import org.apache.poi.xssf.usermodel.XSSFCell;
import org.apache.poi.xssf.usermodel.XSSFRow;
import org.apache.poi.xssf.usermodel.XSSFSheet;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;

import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.core.Context;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

@Path("/")
public class MyController2 {
    @Path("/generateTemplate2")
    @GET
    public void generateTemplate(@Context HttpServletResponse response) throws IOException {
        XSSFWorkbook workbook = new XSSFWorkbook();
        XSSFSheet sheet = workbook.createSheet("日常岗位");
        Map<Integer, String> map = getCellValueMap();
        XSSFRow row = sheet.createRow(0);
        for (int i = 0; i < 4; i++) {
            XSSFCell cell = row.createCell(i);
            cell.setCellValue(map.get(i));
        }
        response.setHeader("Content-Disposition", "attachment;Filename=" + System.currentTimeMillis() + ".xlsx");
        ServletOutputStream outputStream = response.getOutputStream();
        workbook.write(outputStream);
        outputStream.close();
    }

    private Map<Integer, String> getCellValueMap() {
        Map<Integer, String> map = new HashMap<>();
        map.put(0, "姓名");
        map.put(1, "年龄");
        map.put(2, "工号");
        map.put(3, "身高");
        return map;
    }
}
----------------------------资源配置-----------------------------

import org.glassfish.jersey.server.ResourceConfig;
import org.springframework.stereotype.Component;

@Component
public class MyJaxConfig extends ResourceConfig {
    public MyJaxConfig(){
//        super.register(MyController3.class);
        super.register(MyController2.class);
//        super.register(MyController.class);
    }
}
效果:

注意3点:

1. 上面4点要注意的,此处同理

2. jax-rs规范的接口如果想获取当前请求的响应对象,需要2点: 既要引入HttpServletResponse声明,又要在声明前加入@Context注解,这点不同于spring规范.

3. 使用jax-rs规范,需要注册对外接口所在类, 有多少就调用多少次super.register()方法多少次, 注意super,register(Class c, Contract... constracts)不是一次注册多个.

====================================================================

总结:

1. Java对Excel文件抽象的结构是: 文件--sheet页--行--单元格,所以要按照这个顺序层层深入到单元格才能设置数据

2. spring规范注解与jax-rs规范注解下的接口不能混用

3. xls文件由HSSF生成和操作, xlsx文件由XSSF生成和操作,两者不能互相代替

4. 使用jax-rs规范注解时,需要注册资源类,有多少个资源类,就应该register多少次.暂时没有一次注册多个资源的方法,当然自己可以定义一个工具类,实现一次注册多个

5. 当接口的响应是要下载文件时, 要指定响应头的Content-Disposition属性为attachment附件类型,同时指定文件的全名(包括扩展类型),这是在通过response告诉浏览器是要下载文件

6. 要下载的文件放在响应的输出流中,put后要关闭流.