ZetCode

Spring Boot @OneToMany

最后修改于 2023 年 7 月 27 日

在本文中,我们将展示如何在 Spring Boot 应用程序中创建一对多关系。

Spring 是一个流行的 Java 应用程序框架,而 Spring Boot 是 Spring 的一个演进,它有助于轻松创建独立的、生产级别的基于 Spring 的应用程序。

实体 是一个将被持久化的 Java 对象。 实体类用 @Id, @Table@Column 等注解修饰。 实体之间存在关系(也称为关联)。 基本关联是一对一、一对多和多对多。

一对多关系

在一对多关系中,一个表中的一条记录可以与另一个表中的一条或多条记录关联。 例如,一个客户可以有多个订单。

关系可以是单向的或双向的。 在单向关系中,我们只有一个方向的导航访问;在双向关系中,我们可以在两个方向上进行访问。 假设我们有两个实体:User 和 Post。 实体之间存在一对多关系;一个用户可以有多个帖子。 在单向关系中,我们可以从用户获取帖子。 在双向关系中,我们也可以从帖子中获取用户。

Spring 一对多单向示例

在下面的示例中,我们将创建一个简单的 Spring Boot 应用程序,该应用程序在两个实体之间具有单向的一对多关系。

在示例中,我们有 UserPost 实体。 一个用户可以有多个帖子;因此,这两个实体之间存在一对多关系。

build.gradle
...
src
├───main
│   ├───java
│   │   └───com
│   │       └───zetcode
│   │           │   Application.java
│   │           │   MyRunner.java
│   │           ├───model
│   │           │       Post.java
│   │           │       User.java
│   │           └───repository
│   │                   PostRepository.java
│   │                   UserRepository.java
│   └───resources
│           application.properties
└───test
    └───java

这是项目结构。

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 'com.h2database:h2'
}

这是 Gradle build.gradle 文件。 我们添加了 spring-boot-starter-data-jpa 启动器和内存 H2 数据库。

resources/application.properties
spring.main.banner-mode=off
spring.jpa.show-sql=true
logging.pattern.console=%clr(%d{yy-MM-dd E HH:mm:ss.SSS}){blue} %clr(%-5p) %clr(%logger{0}){blue} %clr(%m){faint}%n

application.properties 中,我们关闭 Spring banner,启用 SQL 日志记录,并自定义整体日志记录模式。

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

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

@Entity
@Table(name="users")
public class User {

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

    private String firstName;
    private String lastName;

    @OneToMany
    @JoinColumn
    private Set<Post> posts;

    public User() {}

    public User(String firstName, String lastName) {

        this.firstName = firstName;
        this.lastName = lastName;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        User user = (User) o;
        return Objects.equals(id, user.id) &&
                Objects.equals(firstName, user.firstName) &&
                Objects.equals(lastName, user.lastName) &&
                Objects.equals(posts, user.posts);
    }

    @Override
    public int hashCode() {
        return Objects.hash(id, firstName, lastName, posts);
    }

    public Long getId() {
        return id;
    }

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public Set<Post> getPosts() {
        return posts;
    }

    public void setPosts(Set<Post> posts) {
        this.posts = posts;
    }

    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder("User{");
        sb.append("id=").append(id);
        sb.append(", firstName='").append(firstName).append('\'');
        sb.append(", lastName='").append(lastName).append('\'');
        sb.append(", posts=").append(posts);
        sb.append('}');
        return sb.toString();
    }
}

这是 User 模型类。 它具有以下字段:id, firstNamelastName

@OneToMany
@JoinColumn
private Set<Post> posts;

使用 @OneToMany 注解和 Set 集合,我们创建了一个一对多关系。 @JoinColumn 在对应的 users 表中创建一个外键。 如果没有 @JoinColumn 注解,Hibernate 将创建一个 users_posts 关联表。

com/zetcode/mode/Post.java
package com.zetcode.model;

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

@Entity
@Table(name="tasks")
public class Post {

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

    private String name;

    public Post() {}

    public Post(String name) {

        this.name = name;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Post post = (Post) o;
        return Objects.equals(id, post.id) &&
                Objects.equals(name, post.name);
    }

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

    public Long getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder("Post{");
        sb.append("id=").append(id);
        sb.append(", name='").append(name).append('\'');
        sb.append('}');
        return sb.toString();
    }
}

这是 Post 模型类。 它具有以下属性:idname。 它没有用于关系的额外注解。

注意:在 Java 企业应用程序中,定义一个使用存储库的服务层是一个好习惯。 由于简单起见,我们跳过了服务层。

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

import com.zetcode.model.Post;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface PostRepository extends JpaRepository<Post, Long> {

}

PostRepository 定义了用于存储帖子对象的位置。

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

import com.zetcode.model.User;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface UserRepository extends JpaRepository<User, Long> {

}

UserRepository 定义了用于存储用户对象的位置。

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

import com.zetcode.model.Post;
import com.zetcode.model.User;
import com.zetcode.repository.PostRepository;
import com.zetcode.repository.UserRepository;
import jakarta.transaction.Transactional;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

import java.util.List;
import java.util.Set;

@Component
public class MyRunner implements CommandLineRunner {

    private static final Logger logger = LoggerFactory.getLogger(MyRunner.class);

    private final UserRepository userRepository;
    private final PostRepository postRepository;

    @Autowired
    public MyRunner(UserRepository userRepository, PostRepository postRepository) {
        this.userRepository = userRepository;
        this.postRepository = postRepository;
    }

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

        logger.info("Saving data");

        var p1 = new Post("Post 1");
        var p2 = new Post("Post 2");
        var p3 = new Post("Post 3");
        var p4 = new Post("Post 4");
        var p5 = new Post("Post 5");

        var u1 = new User("John", "Doe");
        var u2 = new User("Bobby", "Brown");
        var u3 = new User("Lucy", "Smith");

        u1.setPosts(Set.of(p1, p2, p3));
        u2.setPosts(Set.of(p4));
        u3.setPosts(Set.of(p5));

        postRepository.saveAll(List.of(p1, p2, p3, p4, p5));
        userRepository.saveAll(List.of(u1, u2, u3));

        userRepository.findById(1L).ifPresent(user ->
                logger.info("{} {} has Posts: {}", user.getFirstName(),
                        user.getLastName(), user.getPosts()));

        userRepository.findById(2L).ifPresent(user ->
                logger.info("{} {} has Posts: {}", user.getFirstName(),
                        user.getLastName(), user.getPosts()));
    }
}

MyRunner 中,我们创建用户和帖子。 我们定义了用户和帖子之间的关系。

private final UserRepository userRepository;
private final PostRepository postRepository;

@Autowired
public MyRunner(UserRepository userRepository, PostRepository postRepository) {
    this.userRepository = userRepository;
    this.postRepository = postRepository;
}

我们注入了两个存储库。

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

数据库操作必须用 @Transactional 注解修饰。

var p1 = new Post("Post 1");
var p2 = new Post("Post 2");
var p3 = new Post("Post 3");
var p4 = new Post("Post 4");
var p5 = new Post("Post 5");

var u1 = new User("John", "Doe");
var u2 = new User("Bobby", "Brown");
var u3 = new User("Lucy", "Smith");

我们创建了五个帖子和三个用户。

u1.setPosts(Set.of(p1, p2, p3));
u2.setPosts(Set.of(p4));
u3.setPosts(Set.of(p5));

我们将帖子与用户关联起来。

postRepository.saveAll(List.of(p1, p2, p3, p4, p5));
userRepository.saveAll(List.of(u1, u2, u3));

保存用户和帖子对象。

userRepository.findById(1L).ifPresent(User ->
logger.info("{} {} has Posts: {}", User.getFirstName(),
        User.getLastName(), User.getPosts()));

我们找到 ID 为 1 的用户的所有帖子。

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);
    }
}

此代码设置了 Spring Boot 应用程序。

在本文中,我们使用了一对多关系。

作者

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

列出 所有 Spring Boot 教程