在现代的Web应用中，用户管理是一个常见的需求。用户可能需要查看和下载他们的个人信息或者用户列表。本文将介绍如何使用Java和Spring框架实现用户列表的下载功能，具体采用Excel格式。
一、项目准备
首先，确保你的项目中已经引入了Spring Boot依赖，并且包括处理Excel文件所需的库，比如Apache POI（或其他）。
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>4.0.3</version>
</dependency>二、创建用户服务
用户服务负责获取用户列表数据。以下是一个简单的用户服务示例：
@Service
public class UsersService {
public List<Users> list() {
// 这里可以从数据库获取用户列表
return new ArrayList<>(); // 返回一个用户列表
}
}
三、实现用户控制器
接下来，我们需要创建控制器，处理获取用户列表和下载Excel文件的请求。以下是实现代码：
@RestController
@RequestMapping("/users")
public class UsersController {
@Autowired
private UsersService usersService;
/**
* 获取用户列表
*
* @return 用户列表
*/
@RequestMapping("/list")
public List<Users> list() {
return usersService.list();
}
/**
* 下载用户列表 excel
*/
@RequestMapping("/download")
public void download(HttpServletResponse response) throws IOException {
try {
List<Users> list = usersService.list();
AtomicInteger i = new AtomicInteger(1);
list.forEach(user -> user.setSerialNumber(i.getAndIncrement()));
response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
response.setCharacterEncoding("utf-8");
String fileName = URLEncoder.encode("用户信息", StandardCharsets.UTF_8).replaceAll("\\+", "%20");
response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
// EasyExcel.write(response.getOutputStream(), Users.class).autoCloseStream(Boolean.FALSE).sheet("用户信息")
// .doWrite(list);
// 自定义模板
File file = ResourceUtils.getFile("classpath:templates/template.xlsx");
EasyExcel.write(response.getOutputStream(), Users.class).withTemplate(file).autoCloseStream(Boolean.FALSE).sheet("用户信息")
.doFill(list);
} catch (Exception e) {
// 重置response
response.reset();
response.setContentType("application/json");
response.setCharacterEncoding("utf-8");
Map<String, String> map = MapUtils.newHashMap();
map.put("status", "failure");
map.put("message", "下载文件失败" + e.getMessage());
response.getWriter().println(JSON.toJSONString(map));
}
}
}
四、生成Excel文档
在download方法中，你可以使用Apache POI库生成Excel文档。基本逻辑是创建一个工作簿（Workbook），在其中添加工作表（Sheet），然后逐行插入数据。使用模板，效果如下：
五、总结
本文介绍了在Java中使用Spring框架实现用户列表下载功能的基本步骤。通过以上代码，用户可以获取到最新的用户数据并且方便地下载为Excel文件。在实际开发中，你可以根据需求进一步优化和扩展此功能，例如添加异常处理、用户权限检查等。
