Spring Boot DataClassRowMapper

上次修改时间：2023 年 7 月 23 日

在本文中，我们将展示如何使用 DataClassRowMapper 将表行转换为指定 Bean 类的新实例。

Spring Boot 是一个流行的应用程序框架，用于在 Java、Kotlin 或 Groovy 中创建企业应用程序。

DataClassRowMapper

DataClassRowMapper 是一个 RowMapper 实现，它将表行转换为指定映射目标类的新实例。 映射目标类必须是一个顶级类。

DataClassRowMapper 允许我们使用 Java 记录 (records)。

Spring Boot DataClassRowMapper 示例

以下应用程序使用 DataClassRowMapper 将结果集行映射到 City Bean。

build.gradle
...
src
├── main
│   ├── java
│   │   └── com
│   │       └── zetcode
│   │           ├── Application.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 应用程序的项目结构。

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'
}

build.gradle 文件包含 spring-boot-starter-jdbc 和 h2 的依赖项。

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 数据源。

CREATE TABLE cities(id BIGINT PRIMARY KEY AUTO_INCREMENT,
    name VARCHAR(255), population BIGINT);

此 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 脚本使用数据填充表。

package com.zetcode.model;

public record City(Long id, String name, Integer population) {}

这是 City 模型类。

package com.zetcode.service;

import com.zetcode.model.City;

import java.util.List;

public interface ICityService {

    List<City> findAll();
    City findById(Long id);
}

ICityService 中有两个契约方法。

package com.zetcode.service;

import com.zetcode.model.City;
import org.springframework.jdbc.core.DataClassRowMapper;
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, DataClassRowMapper.newInstance(City.class));
    }

    @Override
    public City findById(Long id) {
        String sql = "SELECT * FROM cities WHERE id = ?";
        return jtm.queryForObject(sql, new DataClassRowMapper<>(City.class), id);
    }
}

我们有两个契约方法的实现，使用 DataClassRowMapper。 列值基于将从结果集元数据获得的列名与相应的 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 查找一个城市，然后查找所有城市。

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 DataClassRowMapper。

作者

我的名字是 Jan Bodnar，我是一位充满激情的程序员，拥有丰富的编程经验。 自 2007 年以来，我一直在撰写编程文章。 迄今为止，我撰写了 1,400 多篇文章和 8 本电子书。 我拥有超过十年的编程教学经验。

列出 所有 Spring Boot 教程。