由于模板Dao的实现,使得这些具体实体的Dao层已经变的非常“薄”,有一些具体实体的Dao实现可能完全就是对模板Dao的简单代理,并且往往这样的实现类可能会出现在很多实体上。Spring-data-jpa的出现正可以让这样一个已经很“薄”的数据访问层变成只是一层接口的编写方式,所以说Spring-data-jpa依赖于Hibernate。比如:
public interface UserRepository extends JpaRepository<User, Long> {
User findByName(String name);
@Query("from User u where u.name=:name")
User findUser(@Param("name") String name);
}
我们只需要通过编写一个继承自
JpaRepository
的接口就能完成数据访问,下面以一个具体实例来体验Spring-data-jpa给我们带来的强大功能。
使用示例
1.工程配置
在pom.xml
中添加相关依赖:
<dependency
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
在application.xml
中配置:数据库连接信息(如使用嵌入式数据库则不需要)、自动创建表结构的设置,例如使用mysql的情况如下:
spring.datasource.url=jdbc:mysql://localhost:3306/springboot
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
#hibernate
spring.jpa.properties.hibernate.hbm2ddl.auto=create-drop
spring.jpa.properties.hibernate.hbm2ddl.auto
是hibernate的配置属性,其主要作用是:自动创建、更新、验证数据库表结构。该参数的几种配置如下:
create
:每次加载hibernate时都会删除上一次的生成的表,然后根据你的model类再重新来生成新表,哪怕两次没有任何改变也要这样执行,这就是导致数据库表数据丢失的一个重要原因。create-drop
:每次加载hibernate时根据model类生成表,但是sessionFactory一关闭,表就自动删除。update
:最常用的属性,第一次加载hibernate时根据model类会自动建立起表的结构(前提是先建立好数据库),以后加载hibernate时根据model类自动更新表结构,即使表结构改变了但表中的行仍然存在不会删除以前的行。要注意的是当部署到服务器后,表结构是不会被马上建立起来的,是要等应用第一次运行起来后才会。validate
:每次加载hibernate时,验证创建数据库表结构,只会和数据库中的表进行比较,不会创建新表,但是会插入新值。
至此已经完成基础配置,你会发现Spring Boot的便利之处:JPA的传统配置在persistence.xml
文件中,但是这里不需要。当然,最好在构建项目时候按照最佳实践的项目结构,这样以确保各种配置都能被框架扫描到。
2.创建实体
创建一个User实体,包含id(主键)、name(姓名)、age(年龄)属性,通过ORM框架其会被映射到数据库表中,由于配置了hibernate.hbm2ddl.auto
,在应用启动的时候框架会自动去数据库中创建对应的表。
package com.lyd.domain;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
@Entity
public class User {
@Id
@GeneratedValue
private Long id;
@Column(nullable = false)
private String name;
@Column(nullable = false)
private Integer age;
// 构造函数
// get/set方法...
}
3,创建数据访问接口
下面针对User实体创建对应的Repository
接口实现对该实体的数据访问,如下代码:
package com.lyd.domain;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;
public interface UserRepository extends JpaRepository<User, Long>{
User findByName(String name);
User findByNameAndAge(String name, Integer age);
@Query("FROM User u WHERE u.name=:name")
User findUser(@Param("name") String name);
}
在Spring-data-jpa中,只需要编写类似上面这样的接口就可实现数据访问。
下面对上面的UserRepository
做一些解释,该接口继承自JpaRepository
,通过查看JpaRepository
接口的API文档,可以看到该接口本身已经实现了创建(save)、更新(save)、删除(delete)、查询(findAll、findOne)等基本操作的函数,因此对于这些基础操作的数据访问就不需要开发者再自己定义。
在我们实际开发中,JpaRepository
接口定义的接口往往还不够或者性能不够优化,我们需要进一步实现更复杂一些的查询或操作。由于本文重点在spring boot中整合spring-data-jpa,spring-data-jpa中的常见使用请参考官方文档。
在上例中,我们可以看到下面两个函数:
User findByName(String name)
User findByNameAndAge(String name, Integer age)
它们分别实现了按name查询User实体和按name和age查询User实体,可以看到我们这里没有任何类SQL语句就完成了两个条件查询方法。这就是Spring-data-jpa的一大特性:通过解析方法名创建查询。
除了通过解析方法名来创建查询外,它也提供通过使用@Query 注解来创建查询,您只需要编写JPQL语句,并通过类似“:name”来映射@Param指定的参数,就像例子中的第三个findUser函数一样。
4.单元测试
在完成了上面的数据访问接口之后,主要通过数据操作和查询来反复验证操作的正确性。
package com.lyd;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import com.lyd.domain.User;
import com.lyd.domain.UserRepository;
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(Application.class)
public class ApplicationTest {
@Autowired
private UserRepository userService;
@Test
public void test(){
// 创建10条记录
userService.save(new User("AAA", 10));
userService.save(new User("BBB", 20));
userService.save(new User("CCC", 30));
userService.save(new User("DDD", 40));
userService.save(new User("EEE", 50));
userService.save(new User("FFF", 60));
userService.save(new User("GGG", 70));
userService.save(new User("HHH", 80));
userService.save(new User("III", 90));
userService.save(new User("JJJ", 100));
// 测试findAll, 查询所有记录
Assert.assertEquals(10, userService.findAll().size());
// 测试findByName, 查询姓名为AAA的User
Assert.assertEquals(10, userService.findByName("AAA").getAge().intValue());
// 测试findUser, 查询姓名为AAA的User
Assert.assertEquals(10, userService.findUser("AAA").getAge().intValue());
// 测试findByNameAndAge, 查询姓名为AAA并且年龄为10的User
Assert.assertEquals(10, userService.findByNameAndAge("AAA", 10).getAge().intValue());
// 测试删除姓名为AAA的User
userService.delete(userService.findByName("AAA"));
// 测试findAll, 查询所有记录, 验证上面的删除是否成功
Assert.assertEquals(9, userService.findAll().size());
}
}
下面是完整项目结构: