SpringBoot JPA 快速上手

现在 SpringBoot 上比较主流的持久层 ORM 框架应该就是 MyBatis 和 JPA 了。JPA 对于简单查询（特别是作业）非常方便，可以说开箱即用，但是面对复杂查询就要稍微多学一点；而 MyBatis 写起来虽然没那么简洁，但在复杂查询的时候直接上 SQL 语句就完事了

引入 JPA 与 MySQL 依赖

在 pom.xml 中添加如下两条

<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <scope>runtime</scope>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-jpa</artifactId>
  <scope>compile</scope>
</dependency>

配置 application.yml

提醒一下，URL 中的数据库要提前建好，比如下面示例中的数据库是 library

然后用户名和密码也在这里配置

spring:
    datasource:
        url: jdbc:mysql://localhost:3306/library?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
        username: root
        password: root
        driver-class-name: com.mysql.cj.jdbc.Driver
    jpa:
        properties:
            hibernate:
                hbm2ddl:
                    auto: update
        database-platform: org.hibernate.dialect.MySQL5InnoDBDialect
        show-sql: true

Hello World

JPA 每一个 Entity 就是一张表，在 Entity 里的每一个成员变量就是表里的一列，另外 JPA 还能够自动建表，十分省事

@Entity
public class Book {

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

    String name;

}

注意：对于实体，本文都省略了 Getter、Setter 和构造函数

然后对于一个 Entity，需要写一个继承自 JpaRepository 的接口供逻辑层调用，不需要写实现类

public interface BookRepo extends JpaRepository<Book, Long> {
}

最后我们可以跑一下单元测试

@SpringBootTest
class BookRepoTests {

    @Autowired BookRepo repo;

    @Test
    void test() {

    // 增
    Book book1 = repo.save(new Book(null, "Book 1"));
    Book book2 = repo.save(new Book(null, "Book 2"));

    // 删
    repo.deleteById(book1.getId());

    // 改
    book2.setName("Book 2x");
    repo.save(book2);

    // 查
    Book book3 = repo.findById(book2.getId()).orElse(null);
    assertEquals("Book 2x", book3.getName());
    }

}

需要注意的是 JPA 的 save 方法，如果实体的 ID 为空或零，他会 INSERT，否则 UPDATE
并且 save 方法的返回值才能作为最终有效的实体，作为参数传入的实体 JPA 不保证有效

自定义查询

根据语法提示我们发现 JpaRepository 提供了跟 ID 有关的很多访问数据库的方法，但是对于其他查询就要自己写，比如使用 ID 之外的字段来查询记录

直接在方法名中写查询语句就行了，不过要注意字段名的大小写

我们修改 BookRepo 如下

public interface BookRepo extends JpaRepository<Book, Long> {

    // 根据 name 获取所有的书
    List<Book> findByName(String name);

    // 根据 name 获取匹配的书的数量
    Long countByName(String name);
}

多表关联

我们可能会遇到两张表相关联的情况，比如上面的例子就可能若干本书关联同一个作者

我们先写一个 Author 的实体，或者说表

@Entity
public class Author {

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

    String name;

}

并添加一个 Repo

public interface AuthorRepo extends JpaRepository<Author, Long> {
}

然后修改 Book 如下

这里的 ManyToOne 表示多个 Book 对应同一个 Author，此外还有 OneToMany、ManyToMany 等

@Entity
public class Book {

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

    String name;

    @ManyToOne
    @JoinColumn
    Author author;

}

接下来写个单元测试跑一跑

@SpringBootTest
class BookRepoTests {

    @Autowired
    AuthorRepo authorRepo;

    @Autowired
    BookRepo bookRepo;

    @Test
    void test() {

    Author author = new Author(null, "a1");
    author = authorRepo.save(author);

    Book book1 = new Book(null, "b1", author);
    Book book2 = new Book(null, "b2", author);
    book1 = bookRepo.save(book1);
    book2 = bookRepo.save(book2);

    assertEquals(book1.getAuthor().getId(), book2.getAuthor().getId());
    }
}

30 March 2020

Web 应用