Spring Boot RowMapper
最后修改于 2023 年 7 月 28 日
在本文中，我们将展示如何将ResultSet的行映射到数据载体。我们使用Java记录作为数据载体。
Spring Boot 是一个流行的应用程序框架，用于在 Java、Kotlin 或 Groovy 中创建企业应用程序。
Java 记录 (record)
Java记录是类的受限形式。 Java记录消除了大量样板代码，包括构造函数，getter，toString，hashCode和equals方法。它们是不可变的。 它们的目的是作为简单的数据载体。
我们可以使用DataClassRowMapper与Java记录无缝集成。请参阅Spring BootDataClassRowMapper教程。
Spring Boot RowMapper 示例
以下应用程序使用RowMapper将结果集行映射到City记录。
build.gradle
...
src
├── main
│ ├── java
│ │ └── com
│ │ └── zetcode
│ │ ├── Application.java
│ │ ├── mapper
│ │ │ └── CityMapper.java
│ │ ├── model
│ │ │ └── City.java
│ │ ├── MyRunner.java
│ │ └── service
│ │ ├── CityService.java
│ │ └── ICityService.java
│ └── resources
│ ├── application.properties
│ ├── data-h2.sql
│ └── schema-h2.sql
└── test
├── java
└── resources
这是 Spring Boot 应用程序的项目结构。
build.gradle
plugins {
id 'org.springframework.boot' version '3.1.1'
id 'io.spring.dependency-management' version '1.1.0'
id 'java'
}
group = 'com.zetcode'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-jdbc'
runtimeOnly 'com.h2database:h2'
}
这是Gradle构建文件。 RowMapper位于spring-boot-starter-jdbc中。
resources/application.properties
spring.main.banner-mode=off spring.sql.init.platform=h2 spring.datasource.driverClassName=org.h2.Driver spring.datasource.url=jdbc:h2:mem:testdb
在 application.properties 中，我们关闭 Spring Boot 标语并设置 H2 数据源。
resources/schema-h2.sql
CREATE TABLE cities(id BIGINT PRIMARY KEY AUTO_INCREMENT,
name VARCHAR(255), population BIGINT);
此 SQL 脚本创建城市表。
resources/data-h2.sql
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);
此SQL脚本用数据填充表。
com/zetcode/model/City.java
package com.zetcode.model;
public record City(Long id, String name, Integer population) {}
我们有一个City记录。 大部分典型的Java模型类的样板代码已被删除。
com/zetcode/mapper/CityMapper.java
package com.zetcode.mapper;
import com.zetcode.model.City;
import org.springframework.jdbc.core.RowMapper;
import java.sql.ResultSet;
import java.sql.SQLException;
public class CityMapper implements RowMapper<City> {
@Override
public City mapRow(ResultSet rs, int rowNum) throws SQLException {
return new City(rs.getLong("id"), rs.getString("name"), rs.getInt("population"));
}
}
CityMapper将结果集的一行映射到City记录。
注意：由于Java记录是不可变的，并且不遵循Java Beans规范，因此我们不能使用
BeanPropertyRowMapper；我们必须创建自己的mapper或使用DataClassRowMapper。com/zetcode/service/ICityService.java
package com.zetcode.service;
import com.zetcode.model.City;
import java.util.List;
public interface ICityService {
List<City> findAll();
City findById(Long id);
}
我们有两个契约方法。
com/zetcode/service/CityService.java
package com.zetcode.service;
import com.zetcode.mapper.CityMapper;
import com.zetcode.model.City;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class CityService implements ICityService {
private final JdbcTemplate jtm;
public CityService(JdbcTemplate jtm) {
this.jtm = jtm;
}
@Override
public List<City> findAll() {
String sql = "SELECT * FROM cities";
return jtm.query(sql, new CityMapper());
}
@Override
public City findById(Long id) {
String sql = "SELECT * FROM cities WHERE id = ?";
return jtm.queryForObject(sql, new CityMapper(), id);
}
}
我们使用CityMapper实现了这两个契约方法。
com/zetcode/MyRunner.java
package com.zetcode;
import com.zetcode.service.ICityService;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
@Component
public class MyRunner implements CommandLineRunner {
private final ICityService cityService;
public MyRunner(ICityService cityService) {
this.cityService = cityService;
}
@Override
public void run(String... args) throws Exception {
var city = cityService.findById(1L);
System.out.println(city);
var data = cityService.findAll();
System.out.println(data);
}
}
在 MyRunner 中，我们通过其 Id 查找一个城市，然后查找所有城市。
com/zetcode/Application.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 应用程序。
$ ./gradlew bootRun ... City[id=1, name=Bratislava, population=432000] [City[id=1, name=Bratislava, population=432000], City[id=2, name=Budapest, population=1759000], City[id=3, name=Prague, population=1280000], City[id=4, name=Warsaw, population=1748000], City[id=5, name=Los Angeles, population=3971000], City[id=6, name=New York, population=8550000], City[id=7, name=Edinburgh, population=464000], City[id=8, name=Berlin, population=3671000]] ...
在本文中，我们使用了Spring Boot RowMapper。