总结:
- jpa是什么,spring data jpa是什么?
jpa是一套规范,不是一套产品。jpa是一套规范,不是一套产品。
spring data jpa是spring基于ORM框架、JPA规范的基础上封装的一套JPA应用框架,提供了包括增删改等在内的常用功能,且易扩展!
spring data jpa让我们解脱了dao层的操作,基本所有的CRUD都可以依赖它来实现。 - 基本查询
基本查询分两种:
1.spring data的默认实现(继承JpaRepository父类,或使用默认方法,如save、delete、count、findAll等等)
2.根据查询的方法名自动解析成SQL(如findXXBy
,readAXXBy
,queryXXBy
,countXXBy
,findByEmailLike
) - 复杂查询
3.1 分页查询
spring data jpa帮我们实现了分页功能,需要传入参数Pageable,当有多个参数传入时,建议Pageable作为最后一个参数传入
3.2 限制查询
有时候我们只需要查询前N个元素,或者支取前一个实体。
//分页查询
Page<User> findALL(Pageable pageable);
Page<User> findByUserName(String userName,Pageable pageable);
//限制查询
User findFirstByOrderByLastnameAsc();
- 自定义SQL查询
在查询方法上使用@query注解,如果涉及到删除和修改加上@Modifying,也可以添加@Transactional对书屋的支持,查询超时的设置。 - 多表查询
两种方式:
1.利用hibernate的级联查询实现
2.创建一个结果集的接口来接受连表查询后的结果(在运行中spring会给这个接口生成一个代理来接收返回的结果,代码汇总使用getXX的形式获取) - 多数据源的支持
1.同源数据库的多源支持
三个步骤:
- 配置多数据源
- 不同源的实体放入不同的数据源、事务支持
- 声明不同的包路径下使用不同的数据源、事务支持
2.异构数据库多源支持
比如即需要对mysql支持,也需要对MongoDB支持。
实体类声明@Entity关系型数据库支持类型、声明@Document为mongodb支持类型,不同的数据源使用不同的实体就可以了
但是,如果User用户既使用mysql也使用MongoDB,也可以做混合使用
也可以通过不同包路径进行声明,比如A包路径下使用mysql,B包路径下使用MongoDB。
介绍spring data jpa的常用方法与注意事项
Spring data jpa介绍
jpa 是什么?
jpa 是sun官方提出的java持久化规范。它为java开发人员提供了一种对象/关系映射工具来管理java应用中的关系数据。他的出现主要是为了简化现有的持久化开发工作和整合ORM技术,结束现在Hibernate、TopLink、JDO等ORM框架各自为营的局面。
注意:jpa是一套规范,不是一套产品,像Hibernate、TopLink、JDO这些是一套产品,是JPA的实现产品。
- Spring data jpa是spring 基于 ORM框架、JPA规范的基础上封装的一套JPA应用框架,可使开发者用极简的代码即可实现对数据的访问和操作。它提供了包括增删改查等在内的常用功能,且易扩展!学习并使用Spring data jpa 可以极大的提高开发效率。
- Spring data jpa让我们解脱了dao层的操作,基本所有的CRUD都可以依赖它来实现
基本查询
基本查询分两种:一种是spring data 默认已经实现,一种是根据查询的方法来自动解析成SQL。
预先生成方法
spring data jpa 默认预先生成了一些基本的CURD的方法,例如:增删改等等。
首先有一个entity:
@Entity(name="user")
public class UserEntity implements Serializable{
/**
*/
private static final long serialVersionUID = 1L;
@Id
@GeneratedValue
private long id;
@Column(nullable=false, unique=true)
private String userName;
@Column()
private String passWord;
@Column()
private SexEnums userSex;
@Column()
private String nickName;
//省略set、get
}
1 继承 JpaRepository
public interface UserRepository extends JpaRepository<User, Long> {
}
2 使用默认方法
@Test
public void testBaseQuery() throws Exception {
User user=new User();
userRepository.findAll();
userRepository.findOne(1l);
userRepository.save(user);
userRepository.delete(user);
userRepository.count();
userRepository.exists(1l);
// ...
}
自定义简单查询
自定义的简单查询就是根据方法名来自动生成SQL,主要的语法是 findXXBy
,readAXXBy
,queryXXBy
,countXXBy
,getXXBy后面跟属性名称:
User findByUserName(String userName);
也可以加一些关键字And、Or
User findByUserNameOrEmail(String username, String email);
修改、删除、统计也是类似语法
Long deleteById(Long id);
Long countByUserName(String userName)
基本上SQL体系的关键词都可以使用,例如:Like、IgnoreCase、OrderBy。
List<User> findByEmailLike(String email);
User findByUserNameIgnoreCase(String userName);
List<User> findByUserNameOrderByEmailDesc(String email);
具体关键词,使用方法和生成sql如下表
复杂查询
在实际的开发中我们需要用到分页、删除、连表等查询的时候就需要特殊方法或者自定义SQL
1 分页查询
分页查询在实际使用中非常普遍了,Spring dadta jpa已经帮我们实现了分页的功能,在查询的方法中,需要传入参数Pageable,当查询中多个参数的时候,Pageable建议作为最后一个参数传入
Page<User> findALL(Pageable pageable);
Page<User> findByUserName(String userName,Pageable pageable);
Pageable 是Spring 封装的分页实现类,使用的时候需要传入页数、每页条数和排序规则
public void testPageQuery() throws Exception{
int page = 1, size=10;
Sort sort = new Sort(Direction.DESC, "id");
PageAble pageable = new PageRequest(page, size, sort);
userRepository.findAll(pageable);
userRepository.findByUserName("testName", pageable);
}
限制查询
有时候我们只需要查询前N个元素,或者支取前一个实体。
User findFirstByOrderByLastnameAsc();
User findTopByOrderByAgeDesc();
Page<User> queryFirst10ByLastname(String lastname, Pageable pageable);
List<User> findFirst10ByLastname(String lastname, Sort sort);
List<User> findTop10ByLastname(String lastname, Pageable pageable);
2 自定义SQL查询
其实Spring data 绝大部分的SQL都可以根据方法名定义的方式来实现,但是由于某些原因我们想使用自定义的sql来查询,spring data也是完美支持的;
在查询方法上使用@query
注解,如涉及到删除和修改加上在这里@Modifying
。也可以根据需要添加 @Transactional
对事务的支持,查询超时的设置等。
@Modifying
@Query("update User u set u.userName = ?1 where c.id = ?2")
int modifyByIdAndUserId(String userName, Long id);
@Transactional
@Modifying
@Query("delete from User where id = ?1")
void deleteByUserId(Long id);
@Transactional(timeout = 10)
@Query("select u from User u where u.emailAddress = ?1")
User findByEmailAddress(String emailAddress);
3 多表查询
多表查询在spring data jpa中有两种实现方式,第一种是利用hibernate 的级联查询来实现,第二种是创建一个结果集的接口来接受连表查询后的结果,这里主要讲第二种方式。
1 定义一个结果集的接口类
public interface HotelSummary {
City getCity();
String getName();
Double getAverageRating();
default Integer getAverageRatingRounded() {
return getAverageRating() == null ? null : (int) Math.round(getAverageRating());
}
}
2 查询的方法返回类型设置为新创建的接口
@Query("select h.city as city, h.name as name, avg(r.rating) as averageRating "
- "from Hotel h left outer join h.reviews r where h.city = ?1 group by h")
Page<HotelSummary> findByCity(City city, Pageable pageable); //返回类型为新创建的接口类型
@Query("select h.name as name, avg(r.rating) as averageRating "
- "from Hotel h left outer join h.reviews r group by h")
Page<HotelSummary> findByCity(Pageable pageable);
3 使用
Page<HotelSummary> hotels = this.hotelRepository.findByCity(new PageRequest(0, 10, Direction.ASC, "name"));
for(HotelSummary summay:hotels){
System.out.println("Name" +summay.getName());
}
在运行中Spring会给接口(HotelSummary)自动生产一个代理类来接收返回的结果,代码汇总使用getXX的形式来获取
多数据源的支持
同源数据库的多源支持
日常项目中因为使用分布式开发模式,不同的服务有不同的数据源,常常需要在一个项目中使用多个数据源,因此需要配置spring data jpa对多数据源的使用,一般分为三个步骤:
- 1 配置多数据源
- 2 不同源的实体类放入不同包路径
- 3 声明不同的包路径下使用不同的数据源、事务支持
这里有一篇文章写得很清楚:Spring Boot多数据源配置与使用
异构数据库多源支持
比如我们的项目中,即需要对mysql的支持,也需要对mongoDB的查询等。
实体类声明@Entity
关系型数据库支持类型、声明@Document
为mongodb支持类型,不同的数据源使用不同的实体就可以了。
interface PersonRepository extends Repository<Person, Long> {
…
}
@Entity
public class Person {
…
}
interface UserRepository extends Repository<User, Long> {
…
}
@Document
public class User {
…
}
但是,如果User用户既使用mysql也使用MongoDB,也可以做混合使用
interface JpaPersonRepository extends Repository<Person, Long> {
…
}
interface MongoDBPersonRepository extends Repository<Person, Long> {
…
}
@Entity
@Document
public class Person {
…
}
也可以通过对不同的包路径进行声明,比如A包路径下使用mysql,B包路径下使用MongoDB
@EnableJpaRepositories(basePackages = "com.neo.repositories.jpa")
@EnableMongoRepositories(basePackages = "com.neo.repositories.mongo")
interface Configuration { }
其他
使用枚举
使用枚举的时候,我们希望数据库中存储的事枚举对应的String类型,而不是枚举的索引值,需要在属性上面添加@Enumerated(EnumType.STRING)
注解
@Enumerated(EnumType.STRING)
@Column(nullable = true)
private UserType type;
不需要和数据库映射的属性
正常情况下我们在实体类上加上注解 @Entity, 就会让实体类和表相关联。如果其中某个属性我们不需要和数据库来关联,只是在展示的时候做计算,只需要加上 @Transient属性即可。
@Transient
private String userName;
这里有一个开源项目几乎使用了这里介绍的所有标签和布局,大家可以参考:参考案例