ZetCode

Spring Boot findById

最后修改于 2023 年 7 月 18 日

Spring Boot findById 教程展示了如何使用 CrudRepository 的 findById 方法通过其 Id 检索实体。

Spring 是一个流行的 Java/Kotlin 应用程序框架，用于创建企业级应用程序。 Spring Boot 是 Spring 框架的演进，它有助于以最小的努力创建基于 Spring 的、可独立运行的、生产级的应用程序。

CrudRepository

CrudRepository 接口为特定类型的存储库提供了通用的 CRUD 操作。 它的 findById 方法通过其 id 检索实体。 返回值是 Optional<T>。

Optional<T> 是一个容器对象，它可能包含也可能不包含非空值。 如果存在一个值，isPresent 返回 true，并且 get 返回该值。 ifPresent 在存在值时调用指定的方法； 否则什么也不做。

Spring Boot findById 示例

以下应用程序设置了 City 对象的存储库。 在控制台运行器中，我们通过它们的 Id 检索城市对象。

build.gradle
...
src
├── main
│   ├── java
│   │   └── com
│   │       └── zetcode
│   │           ├── Application.java
│   │           ├── MyRunner.java
│   │           ├── model
│   │           │   └── City.java
│   │           ├── repository
│   │           │   └── CityRepository.java
│   │           └── service
│   │               ├── CityService.java
│   │               └── ICityService.java
│   └── resources
│       ├── application.properties
│       ├── data-h2.sql
│       └── schema-h2.sql
└── test
    ├── java
    └── resources

这是项目结构。

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-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-json'
    runtimeOnly 'com.h2database:h2'
}

build.gradle 文件包含 Spring Data JPA、Jackson 和 H2 数据库的依赖项。

resources/application.properties 
spring.main.banner-mode=off
spring.sql.init.platform=h2
spring.jpa.hibernate.ddl-auto=none

application.properties 是 Spring Boot 的主要配置文件。 Spring Boot 启动横幅通过 spring.main.banner-mode 属性关闭。

spring.sql.init.platform 设置数据库的供应商名称。它用于初始化脚本中。spring.jpa.hibernate.ddl-auto 禁用了从实体自动创建模式的功能。

resources/schema-h2.sql 
CREATE TABLE cities(id INT PRIMARY KEY AUTO_INCREMENT,
    name VARCHAR(255), population INT);

当应用程序启动时，将执行 schema-h2.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('Suzhou', 4327066);
INSERT INTO cities(name, population) VALUES('Zhengzhou', 4122087);
INSERT INTO cities(name, population) VALUES('Berlin', 3671000);

该表使用来自 data-h2.sql 文件的数据填充。

com/zetcode/model/City.java 
package com.zetcode.model;

import java.util.Objects;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import jakarta.persistence.Table;

@Entity
@Table(name = "cities")
public class City {

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;

    private String name;
    private int population;

    public City() {
    }

    public City(String name, int population) {
        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 boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        City city = (City) o;
        return population == city.population &&
               Objects.equals(name, city.name);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, population);
    }

    @Override
    public String toString() {

        var builder = new StringBuilder();
        builder.append("City{id=").append(id).append(", name=")
                .append(name).append(", population=")
                .append(population).append("}");

        return builder.toString();
    }
}

这是 City 实体。

com/zetcode/repository/CityRepository.java 
package com.zetcode.repository;

import com.zetcode.model.City;
import org.springframework.data.repository.CrudRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface CityRepository extends CrudRepository<City, Long> {

}

通过扩展 Spring CrudRepository，我们为我们的数据存储库实现了一些基本方法。

com/zetcode/service/ICityService.java 
package com.zetcode.service;

import com.zetcode.model.City;

import java.util.Optional;

public interface ICityService {

    Optional<City> findById(Long id);
}

ICityService 提供了一个合约方法，用于通过其 Id 获取城市。

com/zetcode/service/CityService.java 
package com.zetcode.service;

import com.zetcode.model.City;
import com.zetcode.repository.CityRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.Optional;

@Service
public class CityService implements ICityService {

    private final CityRepository cityRepository;

    @Autowired
    public CityService(CityRepository cityRepository) {
        this.cityRepository = cityRepository;
    }

    @Override
    public Optional<City> findById(Long id) {

        return cityRepository.findById(id);
    }
}

CityService 包含 findById 方法的实现。 我们使用存储库从数据库中检索数据。

private final CityRepository cityRepository;

public CityService(CityRepository cityRepository) {
    this.cityRepository = cityRepository;
}

CityRepository 被注入。

@Override
public Optional<City> findById(Long id) {

    return cityRepository.findById(id);
}

findById 返回 Optional<City>。

com/zetcode/MyRunner.java 
package com.zetcode;

import com.zetcode.service.ICityService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class MyRunner implements CommandLineRunner {

    private final ICityService cityService;

    @Autowired
    public MyRunner(ICityService cityService) {
        this.cityService = cityService;
    }

    @Override
    public void run(String... args) throws Exception {

        var id1 = 2L;
        cityService.findById(id1).ifPresent(System.out::println);

        var id2 = 24L;
        var val = cityService.findById(id2);

        if (val.isPresent()) {
            System.out.println(val.get());
        } else {
            System.out.printf("No city found with id %d%n", id2);
        }
    }
}

在 MyRunner 中，我们查找两个城市实体。

var id1 = 2L;
cityService.findById(id1).ifPresent(System.out::println);

我们通过其 Id 查找一个城市，如果它存在，我们将其打印到控制台。 否则，什么也不打印。

var id2 = 24L;
var val = cityService.findById(id2);

if (val.isPresent()) {
    System.out.println(val.get());
} else {
    System.out.printf("No city found with id %d%n", id2);
}

在第二种情况下，我们使用 isPresent 检查值的存在。 如果存在值，我们将其打印出来。 如果没有，我们会打印一条消息，说明未找到该城市。

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=2, name=Budapest, population=1759000}
No city found with id 24
...

我们运行应用程序。

在本文中，我们展示了如何使用 CrudRepository 的 findById 方法找到一个特定的实体。

作者

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

列出 所有 Spring Boot 教程。