SpringData JPA中@OneToMany和@ManyToOne的用法详解

一. 假设需求场景

在我们开发的过程中,经常出现两个对象存在一对多或多对一的关系。如何在程序在表明这两个对象的关系,以及如何利用这种关系优雅地使用它们。

其实,在javax.persistence包下有这样两个注解——@OneTomany和@ManyToOne,可以为我们所用。

现在,我们假设需要开发一个校园管理系统,管理各大高校的学生。这是一种典型的一对多场景,学校和学生的关系。这里,我们涉及简单的级联保存,查询,删除。

二. 代码实现

2.1 级联存储操作

Student类和School类

@Data
@Table
@Entity
@Accessors(chain = true)
public class Student {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;
    private String name;
    @ManyToOne
    @JoinColumn(name = "school_fk")
    private School school;
}

Student类上面的四个注解不做解释,id主键使用自增策略。Student中有个School的实例变量school,表明学生所属的学校。@ManyToOne(多对一注解)代表在学生和学校关系中“多”的那方,学生是“多”的那方,所以在Student类里面使用@ManyToOne。

那么,@ManyToOne中One当然是指学校了,也就是School类。

@JoinColumn(name = “school_fk”)指明School类的主键id在student表中的字段名,如果此注解不存在,生成的student表如下:
在这里插入图片描述

@Data
@Table
@Entity
@Accessors(chain = true)
public class School {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;
    private String name;
    @OneToMany(mappedBy="school",cascade = CascadeType.PERSIST)
    private List<Student> students;
}

在School类中,维护一个类型为List的students实例变量。@OneToMany(一对多注解)代表在学生和学校关系中“一”的那方,学校是“一”的那方,所以在School类里面使用@OneToMany。

那么,@OneToMany中many当然是指学生了,也就是Student类。注意@OneToMany中有个mappedBy参数设置为school,这个值是我们在Student类中的School类型的变量名;cascade参数表示级联操作的类型,它只能是CascadeType的6种枚举类型。

有的博客经常写成cascade = CascadeType.ALL,这其实会误导大家,因为里面的级联删除会让你怀疑人生。

我们先使用CascadeType.PERSIST,表示在持久化的级联操作,也就是保存学校的时候可以一起保存学生。

StudentRepository和SchoolRepository

public interface StudentRepository extends JpaRepository<Student, Integer> {
}
public interface SchoolRepository extends JpaRepository<School, Integer> {
}

测试类

@RunWith(SpringRunner.class)
@SpringBootTest
public class MultiDateSourceApplicationTests {
    @Autowired
    SchoolRepository schoolRepository;
    @Test
    public void contextLoads() {
        Student jackMa = new Student().setName("Jack Ma");
        Student jackChen = new Student().setName("Jack Chen");
        School school = new School().setName("湖畔大学");
        List<Student> students = new ArrayList<>();
        students.add(jackMa);
        students.add(jackChen);
        jackMa.setSchool(school);
        jackChen.setSchool(school);
        school.setStudents(students);
        schoolRepository.save(school);
    }
}

运行测试类后,数据库的表数据如下:
在这里插入图片描述
在程序中,我们并没有调用StudentRepository的save方法,但是我们在@OneToMany中添加了级联保存参数CascadeType.PERSIST,所以在保存学校的时候能自动保存学生, jackMa.setSchool(school);jackChen.setSchool(school);这两句肯定不能少的。

2.2 查询操作和toSting问题

上面的添加操作成功了,让我们来试试查询操作。
在这里插入图片描述
控制台:打印出的错误是org.hibernate.LazyInitializationException: failed to lazily initialize a collection of role: com.cauchy6317.multidatesource.cascadestudy.entity.School.students, could not initialize proxy - no Session

这是因为@OneToMany的fetch参数默认设置为FetchType.Lazy模式,即懒加载模式。

也就是说,我们查询mySchool的时候,并没有把在该学校的学生查出来。而且,School类的toString方法需要知道students,所以debug模式下mySchool变量报错。

我们把@OneToMany的fetch参数改为Fetch.EAGER,即热加载。

@OneToMany(mappedBy="school", cascade = CascadeType.PERSIST, fetch = FetchType.EAGER)
private List<Student> students;

再运行一次…
在这里插入图片描述
这次的错误是StackOverflowError,为什么会这样呢?堆栈溢出,也就是我们写的程序出现了死循环。可是我们都没写循环语句啊,不急,我们先看看这个mySchool数据。

我们发现mySchool里面有students,而且students里面又有school变量,变量school里面自然又有students了。由此看来,是这个死循环的导致。也就是Student和School的toString方法,循环调用彼此。

所以只需要修改其中一个的toString方法,使它的toString方法不涉及另一个类型的变量,也就是排除另一个类型的变量。lombok考虑到这点了,可以使用ToString.exclude。

在官网的ToString介绍页面中,我看到了这个有意思的小字部分。
在这里插入图片描述
哈哈哈,这个地方已经说明了如果使用数组中包含自身,ToString方法会报StackOverflowError。

那么,我们在Student类中使用ToString.exclude,还是在School类中使用ToString.exclude呢?我们先在School类中试试。

@ToString.Exclude
@OneToMany(mappedBy="school", cascade = CascadeType.PERSIST, fetch = FetchType.EAGER)
private List<Student> students;

这次我们把学生也打印出来一个。
在这里插入图片描述
可以看到,mySchool的ToString方法没有将students打印出来;student的toSting方法将School打印出来了。如果在Student类的school变量上使用@ToString.EXCLUDE的话,那么mySchool就会打印出很多student来。

所以,我觉得还是在private List students;上使用@ToString.EXCLUDE较好。

2.3 级联删除

前面我们说过级联删除会让人怀疑人生,让我们用代码来感受一下。

@ToString.Exclude
@OneToMany(mappedBy="school", cascade = {CascadeType.PERSIST, CascadeType.REMOVE}, fetch = FetchType.EAGER)
private List<Student> students;

我们在School类中,使用级联删除。也就是说,当我们删除某个学校的时候,把这个学校下的所有学生删除掉!
在这里插入图片描述
现在查看数据库的表,可以清楚的看到。school中id为1的学校没有了,而且student中学校外键为1的学生也全部被删了。或许你会觉得这也没什么大不了的,因为学校不存在了,学校里的学生自然不存在了。好,那就让我们来见识一下级联删除的真正威力。我们如果也在Student类中使用了级联删除会怎么样?

@ManyToOne(cascade = CascadeType.REMOVE)
@JoinColumn(name = "school_fk")
private School school;

也就是说,当我们删除某个学生时,会级联删除学生所在的学校。我们用代码测试一下是不是这样。

public interface StudentRepository extends JpaRepository<Student, Integer> {
    /**
     * 根据姓名删除学生对象
     * @param name
     * @return
     */
    @Transactional
    Integer deleteByName(String name);
}

在这里插入图片描述
可以看到数据插入成功了,当我们放掉断点后。
在这里插入图片描述
可以看到出现了三条删除语句,我再看看数据库的学生表,发现Jack Chen也被删除了。这是因为我们在Student类和School类中都使用了级联删除,当我们删除Jack Ma的时候,级联删除了湖畔大学,当删除湖畔大学后又级联删除了所有湖畔大学的student。这就好比,你打算开除一个学生,结果把学校和学生的数据全删没了。是不是很刺激?

2.4 pom.xml

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.10</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.28</version>
        </dependency>
    </dependencies>

环境:springboot2.1.7+jdk1.8+mysql8.0+druid1.1.10+Springdata JPA+Lombok

  • 3
    点赞
  • 17
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
### 回答1: Spring Data JPA的@Query注解可以在抽象方法上使用。该注解允许我们直接编写自定义的SQL查询语句,以替代默认的基于方法命名规则的查询。 使用@Query注解,我们可以在抽象方法上定义自己的查询语句。可以通过在注解编写原生的SQL查询语句或者使用JPQL查询语句来完成。 当使用原生的SQL查询语句时,我们需要设置nativeQuery参数为true。这样Spring Data JPA就会将查询结果与实体类进行映射。 如果使用JPQL查询语句,我们可以通过在查询语句引用实体类和其属性来构建查询语句。Spring Data JPA会根据查询语句的返回类型自动进行结果映射。 在@Query注解,我们还可以使用命名参数或者索引参数来指定查询参数。通过在查询方法的参数前添加@Param注解,我们可以将方法参数与查询参数进行映射。 除了定义查询语句,@Query注解还可以指定查询的排序方式、分页和锁定等。我们可以使用关键字ORDER BY来设置排序字段,使用关键字LIMIT和OFFSET来设置分页查询的起始位置和返回记录数。同时,我们还可以使用关键字FOR UPDATE来设置查询结果的锁定。 通过在抽象方法上使用@Query注解,我们可以实现更加灵活和复杂的查询需求。它为我们提供了一种强大的方式来利用Spring Data JPA进行自定义查询,以满足特定业务场景的需求。 ### 回答2: Spring Data JPA提供了一个 @Query 注解,可以在抽象方法上使用。 @Query 注解用于在 Repository 接口定义查询方法的具体查询语句。通过使用 @Query 注解,我们可以将自定义的 JPQL 或者 SQL 语句与方法绑定在一起。 使用 @Query 注解有以下几个优点: 1. 灵活性:可以使用自定义的查询语句,满足特定的数据查询需求。 2. 类型安全:由于使用了命名参数或者索引参数,可以避免 SQL 注入等安全问题。 3. 提高代码可读性:通过在方法上添加 @Query 注解,可以直接看到方法的具体查询是如何实现的,提高代码的可读性和可维护性。 4. 内置分页支持:可以在 @Query 注解使用内置的分页查询方法,如 Pageable 和 Sort。 使用 @Query 注解时,可以将查询语句写在注解的 value 属性。语句可以是原生的 SQL 语句,也可以是 JPQL 查询语句。在查询语句,可以使用实体类的属性名来代替数据库表字段名。 另外,@Query 注解还支持使用命名参数和索引参数。命名参数使用冒号(:)加参数名的方式,在方法参数使用 @Param 注解指定参数名。索引参数使用问号(?)加索引位置的方式。 需要注意的是,使用 @Query 注解时,方法的返回类型可以是具体的实体类,也可以是包装类、List、Set 或者其他集合类。如果需要分页查询,返回类型可以是 Page 或者 Slice 类型。 总的来说,通过在抽象方法使用 Spring Data JPA 的 @Query 注解,可以更加灵活地定义自定义查询,提高代码的可读性和可维护性。 ### 回答3: Spring Data JPA提供了 @Query 注解,它可以用在抽象方法上,用于自定义查询语句。 使用 @Query 注解,我们可以在抽象方法上定义自己的JPQL(Java Persistence Query Language)或SQL查询语句。通过在注解定义查询语句,我们可以灵活地执行各种复杂的查询操作。 在定义查询语句时,我们可以使用实体类的属性名来引用实体的字段,并且可以使用 JPA 提供的各种查询关键字和函数进行组合。除此之外,我们还可以使用一些特殊的 JPA 提供的关键字,如:distinct、is not null、is null、order by等。 在定义查询语句时,@Query 注解还支持使用命名参数和位置参数两种方式来传递参数。命名参数使用 :paramName 的方式来引用参数,而位置参数使用 ?1、?2 等符号来引用参数。我们可以根据实际情况选择适合的参数传递方式。 除了定义查询语句,@Query 注解还有其他一些属性。例如,我们可以使用 @Modifying 注解来告诉 Spring Data JPA 这个查询是一个更新操作,需要通过 @Transactional 注解来开启事务。另外,还可以使用 @Query 注解的 nativeQuery 属性来指示是否执行原生 SQL 查询。 总之,通过在抽象方法上使用 @Query 注解,我们可以自定义我们需要的查询语句,使得我们可以方便地执行各种复杂的查询操作。这样,在使用 Spring Data JPA 进行数据访问时,我们就能够更加灵活地控制查询操作,并且减少重复代码的编写。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值