Spring Boot CSV 教程 · ZetCode 中文系列教程

# Spring Boot CSV 教程 > 原文： [http://zetcode.com/articles/springbootcsv/](http://zetcode.com/articles/springbootcsv/) 在本教程中，我們將在 Spring Boot RESTful 應用中以 CSV 格式提供內容。我們使用 OpenCSV 庫。 Spring 是用于創建企業應用的流行 Java 應用框架。 Spring Boot 是 Spring 框架發展的下一步。它有助于以最小的努力創建獨立的，基于生產級的 Spring 應用。它放棄了 XML 配置，并大量使用約定而不是配置原則。 CSV（逗號分隔值）是一種簡單的數據格式，其中（大多數）值之間用逗號分隔，每一行代表一個記錄。數據存儲在純文本文件中。作為電子表格和數據庫中使用的導入和導出格式，它非常流行。 OpenCSV 是 Java 的開源，簡單 CSV 解析器庫。 Hibernate 是 Java 語言的對象關系映射框架。它提供了一個框架，用于將面向對象的域模型映射到關系數據庫。對象關系映射（ORM）是一種編程技術，用于在面向對象的編程語言中的不兼容類型系統之間轉換數據。 Spring Data JPA 是 Spring Data 項目的一部分，該項目使實現基于 JPA 的存儲庫變得更加容易。 Spring Data JPA 使用 JPA 將數據存儲在關系數據庫中。它可以在運行時從存儲庫接口自動創建存儲庫實現。 RESTFul 應用遵循 REST 架構樣式，該樣式用于設計網絡應用。 RESTful 應用生成 HTTP 請求，這些請求對資源執行 CRUD（創建/讀取/更新/刪除）操作。 ## Spring Boot CSV 示例我們的應用是一個 Spring Boot RESTful 應用，它以 CSV 格式從 H2 數據庫返回數據。 ```java $ tree . ├── pom.xml └── src ├── main │ ├── java │ │ └── com │ │ └── zetcode │ │ ├── Application.java │ │ ├── bean │ │ │ └── City.java │ │ ├── controller │ │ │ └── MyCsvController.java │ │ ├── repository │ │ │ └── CityRepository.java │ │ ├── service │ │ │ ├── CityService.java │ │ │ └── ICityService.java │ │ └── util │ │ └── WriteCsvToResponse.java │ └── resources │ ├── application.yml │ └── import.sql └── test └── java ``` 這是項目結構。 `pom.xml` ```java <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.zetcode</groupId> <artifactId>SpringBootCSV</artifactId> <version>1.0-SNAPSHOT</version> <packaging>jar</packaging> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.3.RELEASE</version> </parent> <dependencies> <dependency> <groupId>com.h2database</groupId> <artifactId>h2</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>com.opencsv</groupId> <artifactId>opencsv</artifactId> <version>3.9</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project> ``` 這是 Maven 構建文件。 `h2`依賴項添加了一個 H2 數據庫驅動程序。 `opencsv`依賴項添加了 OpenCSV 庫的驅動程序。 Spring Boot 啟動器是一組方便的依賴項描述符，我們可以在我們的應用中包含這些描述符。它們極大地簡化了 Maven 配置。 `spring-boot-starter-parent`為 Spring Boot 應用提供了一些常用配置。 `spring-boot-starter-web`是使用 Spring MVC 構建 Web（包括 RESTful）應用的入門工具。它使用 Tomcat 作為默認的嵌入式容器。 `spring-boot-starter-data-jpa`是將 Spring Data JPA 與 Hibernate 結合使用的入門工具。在`spring-boot-maven-plugin`提供了 Maven 的 Spring Boot 支持，使我們能夠打包可執行的 JAR 或 WAR 檔案。它的`spring-boot:run`目標運行 Spring Boot 應用。 `application.yml` ```java server: port: 8086 context-path: /rest spring: main: banner-mode: "off" jpa: database: h2 hibernate: dialect: org.hibernate.dialect.H2Dialect ddl-auto: create-drop logging: level: org: springframework: ERROR ``` `application.yml`文件包含 Spring Boot 應用的各種配置設置。我們具有服務器端口和上下文路徑（應用名稱）的映射。我們通過`localhost:8086/rest/` URL 訪問我們的應用。使用`banner-mode`屬性，我們可以關閉 Spring 橫幅。 JPA `database`值指定要操作的目標數據庫。在本例中，我們指定了 Hibernate 方言`org.hibernate.dialect.H2Dialect`。 `ddl-auto`是數據定義語言模式； `create-drop`選項將自動創建和刪除數據庫模式。 H2 數據庫在內存中運行。另外，我們將 spring 框架的日志記錄級別設置為`ERROR`。在`application.yml`文件位于中`src/main/resources`目錄。 `City.java` ```java package com.zetcode.bean; import java.io.Serializable; import javax.persistence.Entity; import javax.persistence.GeneratedValue; import javax.persistence.GenerationType; import javax.persistence.Id; import javax.persistence.Table; @Entity @Table(name = "CITIES") public class City implements Serializable { private static final long serialVersionUID = 1L; @Id @GeneratedValue(strategy = GenerationType.AUTO) private Long id; private String name; private int population; public City() { } public City(Long id, String name, int population) { this.id = id; this.name = name; this.population = population; } public Long getId() { return id; } public void setId(Long id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getPopulation() { return population; } public void setPopulation(int population) { this.population = population; } @Override public String toString() { return "City{" + "id=" + id + ", name=" + name + ", population=" + population + '}'; } } ``` 這是`City`實體。每個實體必須至少定義兩件事：`@Entity`注解和帶有`@Id`注解的 ID 字段。我們已經將`ddl-auto`選項設置為`create-drop`，這意味著 Hibernate 將根據該實體創建表模式。 ```java @Entity @Table(name = "CITIES") public class City implements Serializable { ``` `@Entity`注解指定該類是一個實體，并映射到數據庫表。 `@Table`實體指定要用于映射的數據庫表的名稱。 ```java @Id @GeneratedValue(strategy = GenerationType.AUTO) private Long id; ``` `@Id`注解指定實體的主鍵，`@GeneratedValue`提供規范主鍵值的生成策略。 `import.sql` ```java INSERT INTO CITIES(NAME, POPULATION) VALUES('Bratislava', 432000); INSERT INTO CITIES(NAME, POPULATION) VALUES('Budapest', 1759000); INSERT INTO CITIES(NAME, POPULATION) VALUES('Prague', 1280000); INSERT INTO CITIES(NAME, POPULATION) VALUES('Warsaw', 1748000); INSERT INTO CITIES(NAME, POPULATION) VALUES('Los Angeles', 3971000); INSERT INTO CITIES(NAME, POPULATION) VALUES('New York', 8550000); INSERT INTO CITIES(NAME, POPULATION) VALUES('Edinburgh', 464000); INSERT INTO CITIES(NAME, POPULATION) VALUES('Berlin', 3671000); ``` 模式是由 Hibernate 自動創建的。之后，將執行`import.sql`文件以將數據填充到表中。 `CityRepository.java` ```java package com.zetcode.repository; import com.zetcode.bean.City; import org.springframework.data.repository.CrudRepository; import org.springframework.stereotype.Repository; @Repository public interface CityRepository extends CrudRepository<City, Long> { } ``` 通過從 Spring `CrudRepository`擴展，我們將為我們的數據存儲庫實現一些方法，包括`findAll()`和`findOne()`。這樣，我們節省了大量樣板代碼。 `ICityService.java` ```java package com.zetcode.service; import com.zetcode.bean.City; import java.util.List; public interface ICityService { public List<City> findAll(); public City findById(Long id); } ``` `ICityService`提供了獲取所有城市并通過其 ID 從數據源獲取城市的契約方法。 `CityService.java` ```java package com.zetcode.service; import com.zetcode.bean.City; import com.zetcode.repository.CityRepository; import java.util.List; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; @Service public class CityService implements ICityService { @Autowired private CityRepository repository; @Override public List<City> findAll() { List<City> cities = (List<City>) repository.findAll(); return cities; } @Override public City findById(Long id) { City city = repository.findOne(id); return city; } } ``` `CityService`包含`findAll()`和`findById()`方法的實現。我們使用存儲庫從數據庫檢索數據。 ```java @Autowired private CityRepository repository; ``` 注入`CityRepository`。 ```java List<City> cities = (List<City>) repository.findAll(); ``` 存儲庫的`findAll()`方法返回城市列表。 ```java City city = repository.findOne(id); ``` 存儲庫的`findOne()`方法返回一個特定的城市對象。 `MyCsvController.java` ```java package com.zetcode.controller; import com.zetcode.bean.City; import com.zetcode.service.ICityService; import com.zetcode.util.WriteCsvToResponse; import java.io.IOException; import java.util.List; import javax.servlet.http.HttpServletResponse; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class MyCsvController { @Autowired ICityService cityService; @RequestMapping(value = "/cities", produces = "text/csv") public void findCities(HttpServletResponse response) throws IOException { List<City> cities = (List<City>) cityService.findAll(); WriteCsvToResponse.writeCities(response.getWriter(), cities); } @RequestMapping(value = "/cities/{cityId}", produces = "text/csv") public void findCity(@PathVariable Long cityId, HttpServletResponse response) throws IOException { City city = cityService.findById(cityId); WriteCsvToResponse.writeCity(response.getWriter(), city); } } ``` 這是 Spring Boot RESTful 應用的控制器類。 `@RestController`注解創建一個 RESTful 控制器。傳統的 MVC 控制器使用`ModelAndView`，而 RESTful 控制器僅返回對象，并且對象數據通常以 JSON 或 XML 格式直接寫入 HTTP 響應（通常）。在本例中，我們選擇了 CSV 格式。 ```java @Autowired private ICityService cityService; ``` 我們在`countryService`字段中插入`ICityService`。 ```java @RequestMapping(value = "/cities", produces = "text/csv") public void findCities(HttpServletResponse response) throws IOException { ... } ``` `@RequestMapping`注解用于將 Web 請求映射到 Spring 控制器方法。 `produces`選項設置媒體類型，在本例中為`text/csv`。我們將帶有`/cities`路徑的請求映射到控制器的`findCities()`方法。默認請求是 GET 請求。 ```java List<City> cities = (List<City>) cityService.findAll(); WriteCsvToResponse.writeCities(response.getWriter(), cities); ``` 我們稱`cityService`的`findAll()`來獲取所有城市。我們將 CSV 數據寫入`HttpServletResponse`對象。 Java Bean 與 CSV 數據的映射委托給`WriteCsvToResponse`類。 ```java @RequestMapping(value = "/cities/{cityId}", produces = "text/csv") public void findCity(@PathVariable Long cityId, HttpServletResponse response) throws IOException { City city = cityService.findById(cityId); WriteCsvToResponse.writeCity(response.getWriter(), city); } ``` 在第二種方法中，我們有一個 URL 路徑，其中包含要檢索的城市的 ID。我們使用`@PathVariable`注解將 URL 模板變量綁定到方法`cityId`參數。 `WriteCsvToResponse.java` ```java package com.zetcode.util; import com.opencsv.CSVWriter; import com.opencsv.bean.ColumnPositionMappingStrategy; import com.opencsv.bean.StatefulBeanToCsv; import com.opencsv.bean.StatefulBeanToCsvBuilder; import com.opencsv.exceptions.CsvException; import com.zetcode.bean.City; import java.io.PrintWriter; import java.util.List; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class WriteCsvToResponse { private static final Logger LOGGER = LoggerFactory.getLogger(WriteCsvToResponse.class); public static void writeCities(PrintWriter writer, List<City> cities) { try { ColumnPositionMappingStrategy mapStrategy = new ColumnPositionMappingStrategy(); mapStrategy.setType(City.class); mapStrategy.generateHeader(); String[] columns = new String[]{"id", "name", "population"}; mapStrategy.setColumnMapping(columns); StatefulBeanToCsv btcsv = new StatefulBeanToCsvBuilder(writer) .withQuotechar(CSVWriter.NO_QUOTE_CHARACTER) .withMappingStrategy(mapStrategy) .withSeparator(',') .build(); btcsv.write(cities); } catch (CsvException ex) { LOGGER.error("Error mapping Bean to CSV", ex); } } public static void writeCity(PrintWriter writer, City city) { try { ColumnPositionMappingStrategy mapStrategy = new ColumnPositionMappingStrategy(); mapStrategy.setType(City.class); String[] columns = new String[]{"id", "name", "population"}; mapStrategy.setColumnMapping(columns); StatefulBeanToCsv btcsv = new StatefulBeanToCsvBuilder(writer) .withQuotechar(CSVWriter.NO_QUOTE_CHARACTER) .withMappingStrategy(mapStrategy) .withSeparator(',') .build(); btcsv.write(city); } catch (CsvException ex) { LOGGER.error("Error mapping Bean to CSV", ex); } } } ``` 在`WriteCsvToResponse`中，我們使用 OpenCSV 庫將 Java bean 轉換為 CSV，并將最終輸出寫入`HttpServletResponse`中。 ```java ColumnPositionMappingStrategy mapStrategy = new ColumnPositionMappingStrategy(); mapStrategy.setType(City.class); ``` `MappingStrategy`定義如何將 Java 屬性映射到 CSV 列名稱。 `ColumnPositionMappingStrategy`使用列位置進行映射。 ```java String[] columns = new String[]{"id", "name", "population"}; mapStrategy.setColumnMapping(columns); ``` 我們設置列名。 ```java StatefulBeanToCsv btcsv = new StatefulBeanToCsvBuilder(writer) .withQuotechar(CSVWriter.NO_QUOTE_CHARACTER) .withMappingStrategy(mapStrategy) .withSeparator(',') .build(); ``` `StatefulBeanToCsv`類以 CSV 格式寫出 bean 給寫程序，以保留狀態信息并明智地猜測要應用的映射策略。 ```java btcsv.write(city); ``` 最后，編寫了 bean。 `Application.java` ```java package com.zetcode; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` `Application`設置 Spring Boot 應用。 `@SpringBootApplication`啟用自動配置和組件掃描。 ```java $ mvn spring-boot:run ``` 使用`mvn spring-boot:run`命令，運行應用。該應用部署在嵌入式 Tomcat 服務器上。 ```java $ curl localhost:8086/rest/cities 1,Bratislava,432000 2,Budapest,1759000 3,Prague,1280000 4,Warsaw,1748000 5,Los Angeles,3971000 6,New York,8550000 7,Edinburgh,464000 8,Berlin,3671000 ``` 使用`curl`命令，我們可以獲得所有城市。 ```java $ curl localhost:8086/rest/cities/1 1,Bratislava,432000 ``` 在這里，我們得到了一個由其 ID 標識的城市。在本教程中，我們已從 Spring Boot RESTful 應用以 CSV 格式將數據返回給客戶端。我們使用了 OpenCSV 庫。您可能也對相關教程感興趣： * [在 Spring Boot](/articles/springbootloadres/) 中加載資源 * [Spring Boot H2 REST 教程](/articles/springbootresth2/) * [Spring Boot Thymeleaf 教程](/articles/springbootthymeleaf/) * [Spring Boot Mustache 教程](/articles/springbootmustache/) * [Spring Boot Swing 集成教程](/articles/springbootswing/) * [Spring Web 應用介紹](/articles/springwebfirst/) * [Spring Boot RESTFul 應用](/articles/springbootrestsimple/) * [經典 Spring 應用中的`JdbcTemplate`](/articles/springjdbctemplate/)