2019-2-19 springBoot - jpa 181005

springBoot - jpa

springBoot整合jpa，实体类自动生成数据库表，增删改查。

1:pom导入jar

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

2：创建实体类（实体类加XML配置后再项目启动时会查询数据库，含有该对象表则更新字段，如果不存在则会自动创建该对象表）

@Data//lombok下的注解，用于自动注入实体类中的GET,SET,TOSTRING。。。。
@Entity//标表这是一个实体类
@Table(name="test_teacher")//jpa自动创建表时指定的表名称
@GenericGenerator(name="jpa-uuid",strategy = "uuid")//jpa主键生成规则，以uuid 32位作为表主键
public class Teacher {

    @Id//表示该实体变量为数据库表的主键ID
    @GeneratedValue(generator = "jpa-uuid")//表示该实体变量主键生成规则
    @Column(length = 32)//定义jpa自动创建数据库表时的长度
    private  String id;

    @Column(length = 55,nullable = false)//nullable:表示数据库建表示定义该字段非空
    private  String name;
    @Column(length = 20)
    private  int age;

jpa常用注解

@Entity
@Entity标记在类名上面，作为实体类的标识
@Table
当实体类与其映射的数据库表名不同名时需要使用 @Table 标注说明，该标注与 @Entity 标注并列使用，置于实体类声明语句之前，可写于单独语句行，也可与声明语句同行。
@Table 标注的常用选项是 name，用于指明数据库的表名
@Table标注还有一个两个选项 catalog 和 schema 用于设置表所属的数据库目录或模式，通常为数据库名。uniqueConstraints选项用于设置约束条件，通常不须设置。
@Id
@Id设置对象表示符，标识的实体类的属性映射对应表中的主键
@GeneratedValue
设置标识符的生成策略，常与@Id一起使用
参数：strategy指定具体的生成策略
方式一：@GeneratedValue(strategy=GenerationType.AUTO) 也是默认策略， 即写成@GeneratedValue也可；
类似于hibernate的native策略，生成方式取决于底层的数据库。
方式二：@GeneratedValue(strategy = GenerationType.IDENTITY)指定“自动增长”策略，适用于MySQL；
方式三：@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = “seq_tbl_person”)指定“序列”策略，常用于Oracle，其中generator表示生成器的名字。而且还要指定@SequenceGenerator(name = “seq_tbl_person”, sequenceName = “seq_tbl_person”, allocationSize = 1)注解配合使用
其中name指定生成器的名字（与generator的值一样），sequenceName指定数据库中定义序列的名字，allocationSize指定序列每次增长1
@Column
描述数据库表中该字段的定义,具有一下属性
name：表示数据库表中该字段的名称，默认情形属性名称一致。
nullable：表示该字段是否允许为null，默认为true。
unique：表示该字段是否是唯一标识，默认为false。
length：表示该字段的大小，仅对String类型的字段有效。
insertable：表示在ORM框架执行插入操作时，该字段是否应出现INSETRT语句中，默认为true。
updateable：表示在ORM框架执行更新操作时，该字段是否应该出现在UPDATE语句中，默认为true。对于一经创建就不可以更改的字段，该属性非常有用，如对于birthday字段。
columnDefinition：表示该字段在数据库中的实际类型。通常ORM框架可以根据属性类型自动判断数据库中字段的类型，但是对于Date类型仍无法确定数据库中字段类型究竟是DATE，TIME还是TIMESTAMP。此外，String的默认映射类型为VARCHAR，如果要将String类型映射到特定数据库的BLOB或TEXT字段类型，该属性非常有用。
@OrderBy
在加载数据的时候可以为其指定顺序。
@Transient
表示该属性并非一个到数据库表的字段的映射，ORM框架将忽略该属性。
如果一个属性并非数据库表的字段映射。就务必将其标示为@Transient。否则。ORM框架默认其注解为@Basic
@OneToOne
描述一个一对一的关联
可选
fetch：表示抓取策略，默认为FetchType.LAZY
cascade：表示级联操作策略
@ManyToOne
表示一个多对一的映射,该注解标注的属性通常是数据库表的外键
optional：是否允许该字段为null，该属性应该根据数据库表的外键约束来确定，默认为true
可选
fetch：表示抓取策略，默认为FetchType.EAGER
cascade：表示默认的级联操作策略，可以指定为ALL，PERSIST，MERGE，REFRESH和REMOVE中的若干组合，默认为无级联操作
targetEntity：表示该属性关联的实体类型。该属性通常不必指定，ORM框架根据属性类型自动判断targetEntity。
@OneToMany
描述一个一对多的关联,该属性应该为集体类型,在数据库中并没有实际字段。
fetch：表示抓取策略,默认为FetchType.LAZY,因为关联的多个对象通常不必从数据库预先读取到内存
可选
cascade：表示级联操作策略,对于OneToMany类型的关联非常重要,通常该实体更新或删除时,其关联的实体也应当被更新或删除
例如：实体User和Order是OneToMany的关系，则实体User被删除时，其关联的实体Order也应该被全部删除
@ManyToMany
描述一个多对多的关联.多对多关联上是两个一对多关联,但是在ManyToMany描述中,中间表是由ORM框架自动处理
可选
targetEntity:表示多对多关联的另一个实体类的全名,例如:package.Book.class
mappedBy:表示多对多关联的另一个实体类的对应集合属性名称
两个实体间相互关联的属性必须标记为@ManyToMany,并相互指定targetEntity属性,
需要注意的是,有且只有一个实体的@ManyToMany注解需要指定mappedBy属性,指向targetEntity的集合属性名称
利用ORM工具自动生成的表除了User和Book表外,还自动生成了一个User_Book表,用于实现多对多关联
@JoinColumn
可选
@JoinColumn和@Column类似,介量描述的不是一个简单字段,而一一个关联字段,例如.描述一个@ManyToOne的字段.
name:该字段的名称.由于@JoinColumn描述的是一个关联字段,如ManyToOne,则默认的名称由其关联的实体决定.
例如,实体Order有一个user属性来关联实体User,则Order的user属性为一个外键,
其默认的名称为实体User的名称+下划线+实体User的主键名称
@JoinTable(name = “student_teacher”, inverseJoinColumns = @JoinColumn(name = “tid”), joinColumns = @JoinColumn(name = “sid”))
可选
由第三张表来维护两张表的关系
name：是关系表的名字
joinColumns：自己这一端的主键
inverseJoinColumns：对方的主键
@MappedSuperclass
可选
@MappedSuperclass可以将超类的JPA注解传递给子类,使子类能够继承超类的JPA注解
@Embedded
@Embedded将几个字段组合成一个类,并作为整个Entity的一个属性.
例如User包括id,name,city,street,zip属性.
我们希望city,street,zip属性映射为Address对象.这样,User对象将具有id,name和address这三个属性. Address对象必须定义为@Embededable

3：yml文件

spring:
  datasource://数据库连接配置
    url: jdbc:mysql://localhost:3306/zeng?serverTimezone=UTC&characterEncoding=utf-8&useSSL=false
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: 123456
  jpa://jpa陪住
    database: mysql
    show-sql: true
    hibernate:
      ddl-auto: update
/*ddl-auto:create----每次运行该程序，没有表格会新建表格，表内有数据会清空

ddl-auto:create-drop----每次程序结束的时候会清空表

ddl-auto:update----每次运行程序，没有表格会新建表格，表内有数据不会清空，只会更新

ddl-auto:validate----运行程序会校验数据与数据库的字段类型是否相同，不同会报错
*/      

4:Mapper:继承Repository接口或者Repository子接口 即拥有对应接口中的相关sql语句

@Mapper
public interface CarMapper extends JpaRepository<Car, Long> {

}

1)：Repository：最顶层的接口，是一个空的接口，目的是为了统一所有Repository的类型，且能让组件扫描的时候自动识别。

2)：CrudRepository ：是Repository的子接口，提供CRUD的功能

public interface CrudRepository<T, ID extends Serializable>extends Repository<T, ID> {
S save(S entity);
T findOne(ID primaryKey);
Iterable findAll();
Long count();
void delete(T entity);
boolean exists(ID primaryKey);
}

3)：PagingAndSortingRepository：是CrudRepository的子接口，添加分页和排序的功能

public interface PagingAndSortingRepository<T, ID extends Serializable> extends CrudRepository<T, ID>
Iterable findAll(Sort sort);
Page findAll(Pageable pageable);
}

4)：JpaRepository：是PagingAndSortingRepository的子接口，增加了一些实用的功能，比如：批量操作等。

5)：JpaSpecificationExecutor：用来做负责查询的接口

public interface JpaSpecificationExecutor{
T findOne(Specification spec);
List findAll(Specification spec);
Page findAll(Specification spec, Pageable pageable);
List findAll(Specification spec, Sort sort);
long count(Specification spec);
}

5：复杂的单表查询语句

如果想要根据实体的某个属性来进行查询我们可以在 Mapper 接口中进行接口声明

Car findByName(String name);//根据对象名称查询
Car findByNameAndAndPrice(String name,String price);//根据对象名称并且价格查询
Car findByNameAndAndPrice(@Param("name") String name,@Param("price") String price);
Car findFirstByOrderByLastnameAsc();
User findTopByOrderByAgeDesc();
Page<User> queryFirst10ByLastname(String lastname, Pageable pageable);
List<User> findFirst10ByLastname(String lastname, Sort sort);
List<User> findTop10ByLastname(String lastname, Pageable pageable);

Keyword	Sample	JPQL snippet
And	findByLastnameAndFirstname	… where x.lastname = ?1 and x.firstname = ?2
Or	findByLastnameOrFirstname	… where x.lastname = ?1 or x.firstname = ?2
Is,Equals	findByFirstname,findByFirstnameIs,findByFirstnameEquals	… where x.firstname = ?1
Between	findByStartDateBetween	… where x.startDate between ?1 and ?2
LessThan	findByAgeLessThan	… where x.age < ?1
LessThanEqual	findByAgeLessThanEqual	… where x.age ⇐ ?1
GreaterThan	findByAgeGreaterThan	… where x.age > ?1
GreaterThanEqual	findByAgeGreaterThanEqual	… where x.age >= ?1
After	findByStartDateAfter	… where x.startDate > ?1
Before	findByStartDateBefore	… where x.startDate < ?1
IsNull	findByAgeIsNull	… where x.age is null
IsNotNull,NotNull	findByAge(Is)NotNull	… where x.age not null
Like	findByFirstnameLike	… where x.firstname like ?1
NotLike	findByFirstnameNotLike	… where x.firstname not like ?1
StartingWith	findByFirstnameStartingWith	… where x.firstname like ?1(parameter bound with appended %)
EndingWith	findByFirstnameEndingWith	… where x.firstname like ?1(parameter bound with prepended %)
Containing	findByFirstnameContaining	… where x.firstname like ?1(parameter bound wrapped in%)
OrderBy	findByAgeOrderByLastnameDesc	… where x.age = ?1 order by x.lastname desc
Not	findByLastnameNot	… where x.lastname <> ?1
In	findByAgeIn(Collection<Age> ages)	… where x.age in ?1
NotIn	findByAgeNotIn(Collection<Age> age)	… where x.age not in ?1
True	findByActiveTrue()	… where x.active = true
False	findByActiveFalse()	… where x.active = false
IgnoreCase	findByFirstnameIgnoreCase	… where UPPER(x.firstame) = UPPER(?1)

5：排序分页查询

spring data jpa已经帮我们实现了分页的功能，在查询的方法中，需要传入参数Pageable ,当查询中有多个参数的时候Pageable建议做为最后一个参数传入

/**
* 查询单表所有数据并排序
* @return
*/
@RequestMapping("/findAllSort")
public List<Car> findAllSort(){
Sort sort = new Sort(Sort.Direction.DESC,"id");
List<Car> carList = carMapper.findAll(sort);
return carList;
}
/**
* 查询单表所有数据 排序并且分页
* @return
*/
@RequestMapping("/findAllSortAndPage")
public List<Car> findAllSortAndPage(){
//设置根据对应值排序
Sort sort = new Sort(Sort.Direction.DESC,"id");
//设置分页数据
PageRequest page = PageRequest.of(0,2,sort);
//结果数据
Page<Car> carStot = carMapper.findAll(page);
/*  Page 返回数据包含信息（“第几页”“每页条数”“是否最后一页”等数据）
*{"content":[{"id":3,"name":"雪佛兰","price":"100W"},{"id":2,"name":"保时捷","price":"100W"}],
* "pageable":{"sort":{"sorted":true,"unsorted":false},"offset":0,"pageSize":2,"pageNumber":0,"paged":true,"unpaged":false},
* "last":false,"totalElements":3,"totalPages":2,"number":0,"size":2,"sort":{"sorted":true,"unsorted":false},"numberOfElements":2,"first":true}
*/
return carStot.getContent();
} 

6：复杂的表关联查询

建议使用MyBatis的xml进行复杂的数据库表关联映射查询。JPA查询语法不直观