欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

spring-data-jpa的使用和入门

程序员文章站 2024-03-12 22:59:03
...

1.开发环境的搭建

导入项目依赖的jar包:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.imooc</groupId>
    <artifactId>springdata</artifactId>
    <version>1.0-SNAPSHOT</version>


    <dependencies>
        <!--MySQL Driver-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.38</version>
        </dependency>

        <!--junit-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.10</version>
        </dependency>

        <!--spring-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>4.3.5.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>4.3.5.RELEASE</version>
        </dependency>

        <!--spring data jpa-->
        <dependency>
            <groupId>org.springframework.data</groupId>
            <artifactId>spring-data-jpa</artifactId>
            <version>1.8.0.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-entitymanager</artifactId>
            <version>4.3.6.Final</version>
        </dependency>

    </dependencies>
</project>

配置数据源,EntityMangerFactory,事物管理,注解相关等

<?xml version="1.0" encoding="UTF-8"?>

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:tx="http://www.springframework.org/schema/tx"
       xmlns:jpa="http://www.springframework.org/schema/data/jpa"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/data/jpa http://www.springframework.org/schema/data/jpa/spring-jpa-1.3.xsd
		http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd">

    <!--1 配置数据源-->
    <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
        <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
        <property name="username" value="root"/>
        <property name="password" value="123"/>
        <property name="url" value="jdbc:mysql:///jpa"/>
    </bean>

    <!--2 配置EntityManagerFactory-->
    <bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <property name="jpaVendorAdapter">
            <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter"/>
        </property>
        <property name="packagesToScan" value="com.pingan"/>

        <property name="jpaProperties">
            <props>
                <prop key="hibernate.ejb.naming_strategy">org.hibernate.cfg.ImprovedNamingStrategy</prop>
                <prop key="hibernate.dialect">org.hibernate.dialect.MySQL5InnoDBDialect</prop>
                <prop key="hibernate.show_sql">true</prop> <!--展示sql  -->
                <prop key="hibernate.format_sql">true</prop>  <!--格式化sql  -->
                <prop key="hibernate.hbm2ddl.auto">update</prop> <!--由实体自动生成表  -->
            </props>
        </property>

    </bean>

    <!--3 配置事务管理器-->
    <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
        <property name="entityManagerFactory" ref="entityManagerFactory"/>
    </bean>

    <!--4 配置支持注解的事务-->
    <tx:annotation-driven transaction-manager="transactionManager"/>

    <!--5 配置spring data-->
    <jpa:repositories base-package="com.pingan" entity-manager-factory-ref="entityManagerFactory"/>

    <context:component-scan base-package="com.pingan"/>

</beans>

2.Spring-data-jpa中的实体配置及其映射关系

@Entity  //实体,必填
@Table(name = "t_user") //实体-表映射,如果没有,则自动生成的表名为类名的小写
public class User {
	
	@GeneratedValue  //主键策略
	@Id 			 //主键ID
	private Integer id;
	
	private String name;
	
	@Column(name = "pwd",length=20) //属性和表列的映射,length表示映射到表中列的长度
	private String password;
	
	private Integer age;
	
	private Date birthday;
	
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public String getPassword() {
		return password;
	}
	public void setPassword(String password) {
		this.password = password;
	}
	
	public Integer getAge() {
		return age;
	}
	public void setAge(Integer age) {
		this.age = age;
	}
	@Temporal(TemporalType.DATE)  //时间日期格式,详细见下
	public Date getBirthday() {
		return birthday;
	}
	public void setBirthday(Date birthday) {
		this.birthday = birthday;
	}

}

2.1.关于日期格式化的@Temporal注解的使用

@Temporal标签的作用很简单:

1、如果在某类中有Date类型的属性,数据库中存储可能是'yyyy-MM-dd hh:MM:ss'要在查询时获得年月日,在该属性上标注
@Temporal(TemporalType.DATE) 会得到形如'yyyy-MM-dd' 格式的日期。

    DATE :等于java.sql.Date

    日期:

    @Temporal(TemporalType.DATE)
    @Column(name = "applyDate", nullable = false, length = 12)
    public Date getApplyDate() {
        return applyDate;
    }

    在页面端取值:2016--09--28

2、如果在某类中有Date类型的属性,数据库中存储可能是'yyyy-MM-dd hh:MM:ss'要获得时分秒,在该属性上标注
 @Temporal(TemporalType.TIME) 会得到形如'HH:MM:SS' 格式的日期。

    TIME :等于java.sql.Time

    时间:

    @Temporal(TemporalType.TIME)

    在页面端取值:15:50:30

3、如果在某类中有Date类型的属性,数据库中存储可能是'yyyy-MM-dd hh:MM:ss'要获得'是'yyyy-MM-dd hh:MM:ss',在该属性上标注
 @Temporal(TemporalType.TIMESTAMP) 会得到形如'HH:MM:SS' 格式的日期

    TIMESTAMP :等于java.sql.Timestamp

    日期和时间(默认):

    @Temporal(TemporalType.TIMESTAMP)
    在页面端取值:2016-09-28 15:52:32:000

3.Dao的规范

在传统的DAO层中,我们访问数据库,有以下方式jbUtils,jdbcTemplate,Hibernate,Mybatis等框架,而在使用jpa的时候,我们的dao层只需要定义接口,而不需要去定义接口的实现类,spring-data-jpa会自动的帮我们做出配置和实现

在spring-data-jpa中,定义dao层继承去实现Respository接口,即可自动实现一些方法

3.1 Repository接口的层级关系

spring-data-jpa的使用和入门


3.2 在dao接口中继承Repository接口,通过方法名称完成查询

public interface UserRepository extends Repository<User, Integer> {
                                                //实体类      实体类主键类型
    User findByName(String name);

}

在dao接口中定义方法需要符合jpa的方法定义的规则

a.方法名字以read,find,get开头

b.涉及条件查询的属性要以关键字连接,条件属性首字母大写

spring-data-jpa的使用和入门

c.支持级联查询,后面详述

3.3 通过@Query注解完成查询

/**
	 * @Query 通过查询实体
	 * 它的注解传递参数的2种方式
	 * 1.使用占位符, 此方式要求形参与定义的 JPQL 的参数位置一致,?1表示第一个参数,?2表示第二个参数
	 * 2.使用使用命名参数, 此方式形参与定义的 JPQL 的参数位置不必一致,:name 表示参数,通过@param 注解来定义该参数
	 */
	@Query("select o from User o where name = ?1")
	User queryUser(String name);
	
	
	@Query("select o from User o where name = :name")
	User queryUser2(@Param("name") String name);
	
	/**
	 * @Query 通过本地查询,直接查询表,需要配置nativeQuery = true,实现直接查询表,而不是在通过实体查询
	 */
	@Query(nativeQuery = true ,value = "select count(*) from t_user" )
	User queryUserCount();
	
	/**
	 *	 带有like关键字的查询,spring-data允许直接我们在传递参数的时候带%,也可以在占位符参数或者命名参数中使用%
	 */
	
	@Query("select o from User o where name like :name")
	User queryUserNameLike(@Param("name") String name);//调用时候 queryUserNameLike("%pei%");
	
	@Query("select o from User o where name like %:name%")
	User queryUserNameLike1(@Param("name") String name);
	
	@Query("select o from User o where name like %?1%")
	User queryUserNameLike2(@Param("name") String name);

3.5. @Query中的删除和更新

通过使用@Modifying注解配合@Query注解完成UPDATE和DELETE,在JPQL中不支持INSERT

UPDATE和DELETE操作需要使用事务,所以我们在调用的service层中添加事务

dao层更新的中方法:

@Modifying
@Query("update User o set o.name = :name where o.id = :id")
User updateUserName(@Param("name") String name,@Param("id")Integer id);

service层中添加事务

@Service
public class UserServiceImpl {
	
	@Autowired
	private UserRepository userRepository;
	
	@Transactional   //import javax.transaction.Transactional;
	public void updateUserName(String name,Integer id) {
		userRepository.updateUserName(name, id);
	}

}

4. Repository的子接口

4.1 CrudRepository接口,有CRUD相关方法如下,在Service层中调用时候需要添加事务@Transactional

public interface CrudRepository<T, ID> extends Repository<T, ID> {

	<S extends T> S save(S entity);
	<S extends T> Iterable<S> saveAll(Iterable<S> entities);
	Optional<T> findById(ID id);
	boolean existsById(ID id);
	Iterable<T> findAll();
	Iterable<T> findAllById(Iterable<ID> ids);
	long count();
	void deleteById(ID id);
	void delete(T entity);
	void deleteAll(Iterable<? extends T> entities);
	void deleteAll();
}

4.2 PagingAndSortRepository 继承自CrudRepository,除了CRUD的方法外,还有分页和排序的方法

public interface PagingAndSortingRepository<T, ID> extends CrudRepository<T, ID> {

	
	Iterable<T> findAll(Sort sort); //带排序的查询

	Page<T> findAll(Pageable pageable); //带排序的分页查询
}

4.2.1 创建排序Sort对象和分页Pageable对象

pageRequest对象的常用构造方法

public PageRequest(int page, int size) {
		this(page, size, Sort.unsorted());
	}
	
	public PageRequest(int page, int size, Direction direction, String... properties) {
		this(page, size, Sort.by(direction, properties));
	}
	
	public PageRequest(int page, int size, Sort sort) {
		super(page, size);
		this.sort = sort;
	}

构造Sort对象时候需要传入Order对象,Order对象需要根据列和排序的规则进行创建

在Service中定义方法如下:

	public void queryPage() {
		
		//排序的对象
		Order order = Order.asc("name");//根据name升序,相当于:Order o = new Order(Direction.ASC, "name");
		Sort sort = new Sort(order); //创建排序对象
		
		//分页的对象
		//Pageable page = new PageRequest(0, 20);//第一个参数表示:第几页(从0开始,0表示第一页),第二个参数表示:每页的记录数
		PageRequest page = new PageRequest(0, 20, sort);
		Page<User> pageList = user2Repository.findAll(page);
		 
		int totalPages = pageList.getTotalPages();//查询的总页数
		long totalCount = pageList.getTotalElements(); //查询的总记录数
		int number = pageList.getNumber()+1; //查询的当前第几页,从0开始
		List<User> content = pageList.getContent();//当前页面的集合
		int ofElements = pageList.getNumberOfElements(); //当前页面的记录数	             
 }

4.3 jpaRepositopry 继承PagingAndSortingRepository,常用方法有:

public interface JpaRepository<T, ID extends Serializable> extends PagingAndSortingRepository<T, ID> {
	List<T> findAll();
	List<T> findAll(Sort sort);
	List<T> findAll(Iterable<ID> ids);
	<S extends T> List<S> save(Iterable<S> entities);
	void flush();
	<S extends T> S saveAndFlush(S entity);
	void deleteInBatch(Iterable<T> entities);
	void deleteAllInBatch();
	T getOne(ID id);
}

jpaRepository中saveAndFlush(S entity)相当于JPA的merge()方法,merge()方法如下

① 传入的是一个临时对象(没有 id):会创建一个新的对象,把临时对象的属性复制到新的对象中,然后对新的对象执行持久化操作将新的对象插入了数据库
 ② 传入的是一个游离对象(有 ID):若在 EntityManager 缓存中没有该对象,在数据库中也没有对应的记录,JPA 会创建一个新的对象,把当前游离对象的属性复制到新的对象中,
    对新创建的对象执行 insert 操作,插入的是新的对象
③ 传入的是游离对象,即传入的对象有 OID,缓存中没有,但数据库中有对应的对象:JPA 会查询对应的记录,然后返回该记录对应的对象把当前游离对象的属性复制到查询到的对象中,对查询到的对象执行 update 操作
④ 传入的是游离对象,即传入的对象有 OID,EntityManager 缓存中有对应的对象:JPA 会把当前游离对象的属性复制到查询到的 EntityManager 缓存中的对象,对 EntityManager 缓存中的对象执行 update 操作


5.JpaSpecificationExecutor 接口

Specification中封装了JPA Criteria 的查询条件,之前Repository接口中无法传入查询条件,也就是无法创建条件查询,所以我们需要依赖这个接口去创建条件查询,JpaSpecificationExecutor提供了以下方法,其中Specification就是我们需要传递的条件查询的对象,里面封装了一些我们需要的条件

public interface JpaSpecificationExecutor<T> {

	T findOne(Specification<T> spec);

	List<T> findAll(Specification<T> spec);

	Page<T> findAll(Specification<T> spec, Pageable pageable);

	List<T> findAll(Specification<T> spec, Sort sort);

	long count(Specification<T> spec);
}

使用的时候多继承一个JpaSpecificationExecutor接口,就可以使用上面的方法了:

public interface User3Repository extends PagingAndSortingRepository<User, Integer> ,JpaSpecificationExecutor<User>{
	
}

那么我们如何创建Specification来创建条件查询呢?

		/**
		 * Root :就是我们需要查询的类型(对象)
		 * query :添加查询条件
		 * cb:构建Predicate 查询条件对象
		 */
		Specification<User> spec = new Specification<User>() {
			@Override
			public Predicate toPredicate(Root<User> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
				// Predicate 就是查询条件对象
				Path path = root.get("age"); //Root相当于User的根对象,可以通过这个对象获取User的属性,Path 就是相当于是从Root获取age的路径的对象
				//CriteriaBuilder 构建对象,可以通过表达式构建条件,cb.gt(path, 30);
				return cb.gt(path, 20);
			}
		};
		
		Page<User> all = user2Repository.findAll(spec, page);
其中:

spring-data-jpa的使用和入门

6. spring-data-jpa的级联查询









提供接口

相关标签: spring-data jpa