Spring Boot findById 教程展示了如何使用 CrudRepository 的 findById 方法通过其 ID 检索实体。
Spring 是用于创建企业应用的流行 Java 应用框架。 Spring Boot 是 Spring 框架的演进，可帮助您轻松创建独立的，生产级的基于 Spring 的应用。
CrudRepository
CrudRepository接口在存储库中为特定类型提供通用 CRUD 操作。 其findById()方法通过其 ID 检索实体。 返回值为Optional<T>。
Optional<T>是一个容器对象，可能包含也可能不包含非空值。 如果存在值，则isPresent()返回 true，get()返回该值。 如果存在该值，则ifPresent()会调用指定的方法； 否则什么都不做。
Spring Boot findById 示例
以下应用设置了City对象的存储库。 在控制台运行器中，我们通过其 ID 检索城市对象。
pom.xmlsrc├───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
这是项目结构。
pom.xml
<?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>sprinbootfindbyid</artifactId> <version>1.0-SNAPSHOT</version> <packaging>jar</packaging> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>11</maven.compiler.source> <maven.compiler.target>11</maven.compiler.target> </properties> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.1.RELEASE</version> </parent> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> <dependency> <groupId>com.h2database</groupId> <artifactId>h2</artifactId> <scope>runtime</scope> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build></project>
Maven POM 文件包含 Spring Data JPA 和 H2 数据库的依赖项。
resources/application.properties
spring.main.banner-mode=offspring.datasource.platform=h2spring.jpa.hibernate.ddl-auto=none
application.properties是 Spring Boot 的主要配置文件。 Spring Boot 标语使用spring.main.banner-mode属性关闭。
spring.datasource.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 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 { @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 int hashCode() { int hash = 7; hash = 79 * hash + Objects.hashCode(this.id); hash = 79 * hash + Objects.hashCode(this.name); hash = 79 * hash + this.population; return hash; } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj == null) { return false; } if (getClass() != obj.getClass()) { return false; } final City other = (City) obj; if (this.population != other.population) { return false; } if (!Objects.equals(this.name, other.name)) { return false; } return Objects.equals(this.id, other.id); } @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;@Repositorypublic 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;@Servicepublic class CityService implements ICityService { @Autowired private CityRepository cityRepository; @Override public Optional<City> findById(Long id) { return cityRepository.findById(id); }}CityService包含findById()方法的实现。 我们使用存储库从数据库检索数据。
@Autowiredprivate CityRepository repository;
注入CityRepository。
@Overridepublic Optional<City> findById(Long id) { return cityRepository.findById(id);}findById()返回可选的<城市>。
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;@Componentpublic class MyRunner implements CommandLineRunner { @Autowired private ICityService 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;@SpringBootApplicationpublic class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); }}Application设置 Spring Boot 应用。 @SpringBootApplication启用自动配置和组件扫描。
$ mvn spring-boot:run -q...City{id=2, name=Budapest, population=1759000}No city found with id 24...我们运行该应用。
在本教程中，我们展示了如何使用CrudRepository's findById()方法查找特定实体。
