项目的DEMO代码:https://github.com/heyu52/-spring-cloud
什么是JPA
JPA是Java Persistence API的简称,中文名Java持久层API,是JDK 5.0注解或XML描述对象-关系表的映射关系,并将运行期的实体对象持久化到数据库中。
Sun引入新的JPA ORM规范出于两个原因:其一,简化现有Java EE和Java SE应用开发工作;其二,Sun希望整合ORM技术,实现天下归一。Spring Data JPA 是 Spring Boot 体系中约定优于配置的最佳实现,大大简化了项目中数据库的操作。
操作步骤如下:
创建一个项目
我们还是使用之前的数据库
查看依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
添加配置文件
spring.datasource.url=jdbc:mysql://localhost:3306/Spring?serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=csdn
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#JPA
spring.jpa.properties.hibernate.hbm2ddl.auto=update
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5InnoDBDialect
#SQL 输出
spring.jpa.show-sql=true
#format 一下 SQL 进行输出
spring.jpa.properties.hibernate.format_sql=true
这里我们要特别注意spring.jpa.properties.hibernate.hbm2ddl.auto,它有以下四个值:
- create:表示启动的时候先drop,再create
- create-drop: 也表示创建,只不过再系统关闭前执行一下drop
- update: 这个操作启动的时候会去检查schema是否一致,如果不一致会做scheme更新
- validate: 启动时验证现有schema与你配置的hibernate是否一致,如果不一致就抛出异常,并不做更新
其中update 最常用的属性,也根据model类生成表,即使表结构改变了,表中的行仍然存在,不会删除以前的行。
spring.jpa.show-sql 表示执行时输出脚本。
新建model
package com.csdn.demo.model;
import javax.persistence.*;
@Entity
public class User {
@Id
@GeneratedValue(strategy=GenerationType.IDENTITY)
private Long id;
@Column(nullable = false)
private String name;
@Column(nullable = false)
private String sex;
@Column(nullable = false)
private int age;
public User() {
}
public User(String name, String sex, int age) {
this.name = name;
this.sex = sex;
this.age = age;
}
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 String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
public int getAge() {
return age;
}
public void setAge(String age) {
this.sex = age;
}
@Override
public String toString() {
return this.getId() + "," + this.getName() + "," + this.getSex() + "," + this.getAge();
}
}
对以上注释时行说明
- @Entity(name=“EntityName”) 必须,用来标注一个数据库对应的实体,数据库中创建的表名默认和类名一致。其中,name 为可选,对应数据库中一个表,使用此注解标记 Pojo 是一个 JPA 实体。
- @Column主要是对列的说明,比如不能为空,并且唯一@Column(nullable = false, unique = true)
- @Id 必须,@Id 定义了映射到数据库表的主键的属性,一个实体只能有一个属性被映射为主键
- @GeneratedValue(strategy=GenerationType,generator="") 可选,strategy:
表示主键 生成策略,有 AUTO、INDENTITY、SEQUENCE 和 TABLE 4 种,分别表示让 ORM 框架自动选择,
generator: 表示主键生成器器的名称。
Repository 构建
创建的 Repository 只要继承 JpaRepository 即可,就会帮我们自动生成很多内置方法。
package com.csdn.demo.Repository;
import com.csdn.demo.model.User;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;
@Repository
public interface UserRepository extends JpaRepository<User, Long> {
}
创建Controller
package com.csdn.demo.web;
import com.csdn.demo.Repository.UserRepository;
import com.csdn.demo.model.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
@RestController
public class UserController {
@Autowired
private UserRepository userRepository;
@RequestMapping("/CreateUser")
public String CreateUser() {
userRepository.save(new User("csdn20190714", "男", 100));
return "创建成功";
}
@RequestMapping("/FindUserById")
public ArrayList<User> FindUserById(long id) {
ArrayList<User> users = new ArrayList<User>();
Optional<User> optionalUser = userRepository.findById(id);
if (optionalUser.isPresent()) {
User user = optionalUser.get();
users.add(user);
} else {
}
return users;
}
}
测试
运行项目,浏览器输入地址:http://127.0.0.1:8080/CreateUser
运行项目,浏览器输入地址:http://127.0.0.1:8080/FindUserById?id=64
关于JpaRepository
我们可以查看JpaRepository的定义
@NoRepositoryBean
public interface JpaRepository<T, ID> extends PagingAndSortingRepository<T, ID>, QueryByExampleExecutor<T> {
List<T> findAll();
List<T> findAll(Sort var1);
List<T> findAllById(Iterable<ID> var1);
<S extends T> List<S> saveAll(Iterable<S> var1);
void flush();
<S extends T> S saveAndFlush(S var1);
void deleteInBatch(Iterable<T> var1);
void deleteAllInBatch();
T getOne(ID var1);
<S extends T> List<S> findAll(Example<S> var1);
<S extends T> List<S> findAll(Example<S> var1, Sort var2);
}
再查看QueryByExampleExecutor
public interface QueryByExampleExecutor<T> {
<S extends T> Optional<S> findOne(Example<S> var1);
<S extends T> Iterable<S> findAll(Example<S> var1);
<S extends T> Iterable<S> findAll(Example<S> var1, Sort var2);
<S extends T> Page<S> findAll(Example<S> var1, Pageable var2);
<S extends T> long count(Example<S> var1);
<S extends T> boolean exists(Example<S> var1);
}
查看PagingAndSortingRepository
@NoRepositoryBean
public interface PagingAndSortingRepository<T, ID> extends CrudRepository<T, ID> {
Iterable<T> findAll(Sort var1);
Page<T> findAll(Pageable var1);
}
查看CrudRepository
@NoRepositoryBean
public interface CrudRepository<T, ID> extends Repository<T, ID> {
<S extends T> S save(S var1);
<S extends T> Iterable<S> saveAll(Iterable<S> var1);
Optional<T> findById(ID var1);
boolean existsById(ID var1);
Iterable<T> findAll();
Iterable<T> findAllById(Iterable<ID> var1);
long count();
void deleteById(ID var1);
void delete(T var1);
void deleteAll(Iterable<? extends T> var1);
void deleteAll();
}
可以看到,里面实现完了增删改查及分页排序等功能,因此使用 JPA 操作数据库时,只需要构建的 Repository 继承了 JpaRepository,就会拥有了很多常用的数据库操作方法,各个方法就不一一执行测试了。
自定义查询
如果你觉得自带的方法,都不能够满足你的要求,那你也可以自己来实现。
接口增加一个方法
@Repository
public interface UserRepository extends JpaRepository<User, Long> {
ArrayList<User> findByName(String name);
}
UserController也增加一个方法
@RequestMapping("/findByName")
public ArrayList<User> findByName(String name) {
return userRepository.findByName(name);
}
运行项目,浏览器输入地址:http://127.0.0.1:8080/findByName?name=csdn20190714
自定义方法,也可以加一些关键字 And、or,比如
ArrayList<User> findByNameOrSex(String name, String sex);
如果是修改数据库,比如
Long deleteByName(String name);
Long countByName(String name);