Spring Data JPA

来源:互联网 发布:蜂窝移动数据选项 编辑:程序博客网 时间:2024/05/17 04:46

先介绍一个基于注解配置简单的demo

package nd.sdp.lcreporting.config;import org.springframework.beans.factory.annotation.Value;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.context.annotation.PropertySource;import org.springframework.data.jpa.repository.config.EnableJpaAuditing;import org.springframework.data.jpa.repository.config.EnableJpaRepositories;import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;import org.springframework.jdbc.datasource.DataSourceTransactionManager;import org.springframework.orm.jpa.JpaTransactionManager;import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter;import org.springframework.transaction.PlatformTransactionManager;import org.springframework.transaction.annotation.EnableTransactionManagement;import javax.sql.DataSource;@Configuration@PropertySource(value = {"classpath:c3p0.properties"})@EnableJpaRepositories(        basePackages = {                "com.cn.repository.dhb"        },        entityManagerFactoryRef = "espEntityManagerFactory",        transactionManagerRef = "espTransactionManager")@EnableTransactionManagement(proxyTargetClass = true)@EnableJpaAuditingpublic class EspMySQLConfig {    @Value("${esp.c3p0.url}")    private String c3p0Url;    @Value("${esp.c3p0.user}")    private String c3p0User;    @Value("${esp.c3p0.password}")    private String c3p0Password;    @Bean    PlatformTransactionManager espTransactionManager() {        return new JpaTransactionManager(espEntityManagerFactory().getObject());    }    @Bean    LocalContainerEntityManagerFactoryBean espEntityManagerFactory() {        HibernateJpaVendorAdapter jpaVendorAdapter = new HibernateJpaVendorAdapter();        jpaVendorAdapter.setGenerateDdl(false);        jpaVendorAdapter.setShowSql(true);        LocalContainerEntityManagerFactoryBean factoryBean = new LocalContainerEntityManagerFactoryBean();        factoryBean.setDataSource(espDataSource());        factoryBean.setJpaVendorAdapter(jpaVendorAdapter);        factoryBean.setPackagesToScan("com.cn.domain");        return factoryBean;    }    @Bean    DataSource espDataSource() {        C3P0DataSourceBuilder builder = new C3P0DataSourceBuilder();        return builder.build(c3p0Url, c3p0User, c3p0Password);    }    @Bean    DataSourceTransactionManager dataSourceTransactionManager() {        return new DataSourceTransactionManager(espDataSource());    }    @Bean    NamedParameterJdbcTemplate namedParameterJdbcTemplate() {        return new NamedParameterJdbcTemplate(espDataSource());    }    @Bean(name = "lcJdbcTemplate")    NamedParameterJdbcTemplate lcJdbcTemplate() {        return new NamedParameterJdbcTemplate(espDataSource());    }}


Entity:

@Entitypublic class Customer {    @Id    @GeneratedValue(strategy=GenerationType.AUTO)    private long id;    private String firstName;    private String lastName;    private Customer() {}    public Customer(String firstName, String lastName) {        this.firstName = firstName;        this.lastName = lastName;    }    @Override    public String toString() {        return String.format(                "Customer[id=%d, firstName='%s', lastName='%s']",                id, firstName, lastName);    }}

@Entity:说明该类是一个jpa entity,如果缺少@Table注解则默认匹配表Customer
@Id:jpa通过它定义识别对象Id,使用注解@GeneratedValue让id自动增长


CustomerRepository.java是jpa用来存储Customer对象的仓库。

@Repositorypublic interface CustomerRepository extends JpaRepository<Customer, Long> {    List<Customer> findByLastName(String lastName);}

@EnableJpaRepositories:告诉JPA找到继承了repository的接口,并为它创建相应的实现类,JpaRepository也继承了repository。 
DataSource:声明一个存储对象的数据库 
LocalContainerEntityManagerFactoryBean:对象的操作类,通过lef.setPackagesToScan("hello");避免了创建 persistence.xml ,它告诉JPA到hello包下面找bean类 
JpaVendorAdapter:为LocalContainerEntityManagerFactoryBean定义了基于hibernate的JPA适配器 
PlatformTransactionManager:用于处理事务持久化 



以下是基于xml配置:

1、Spring-data-jpa的基本介绍:JPA诞生的缘由是为了整合第三方ORM框架,建立一种标准的方式,百度百科说是JDK为了实现ORM的天下归一,目前也是在按照这个方向发展,但是还没能完全实现。在ORM框架中,Hibernate是一支很大的部队,使用很广泛,也很方便,能力也很强,同时Hibernate也是和JPA整合的比较良好,我们可以认为JPA是标准,事实上也是,JPA几乎都是接口,实现都是Hibernate在做,宏观上面看,在JPA的统一之下Hibernate很良好的运行。

  上面阐述了JPA和Hibernate的关系,那么Spring-data-jpa又是个什么东西呢?这地方需要稍微解释一下,我们做Java开发的都知道Spring的强大,到目前为止,企业级应用Spring几乎是无所不能,无所不在,已经是事实上的标准了,企业级应用不使用Spring的几乎没有,这样说没错吧。而Spring整合第三方框架的能力又很强,他要做的不仅仅是个最早的IOC容器这么简单一回事,现在Spring涉及的方面太广,主要是体现在和第三方工具的整合上。而在与第三方整合这方面,Spring做了持久化这一块的工作,我个人的感觉是Spring希望把持久化这块内容也拿下。于是就有了Spring-data-**这一系列包。包括,Spring-data-jpa,Spring-data-template,Spring-data-mongodb,Spring-data-redis,还有个民间产品,mybatis-spring,和前面类似,这是和mybatis整合的第三方包,这些都是干的持久化工具干的事儿。

  这里介绍Spring-data-jpa,表示与jpa的整合。

  2、我们都知道,在使用持久化工具的时候,一般都有一个对象来操作数据库,在原生的Hibernate中叫做Session,在JPA中叫做EntityManager,在MyBatis中叫做SqlSession,通过这个对象来操作数据库。我们一般按照三层结构来看的话,Service层做业务逻辑处理,Dao层和数据库打交道,在Dao中,就存在着上面的对象。那么ORM框架本身提供的功能有什么呢?答案是基本的CRUD,所有的基础CRUD框架都提供,我们使用起来感觉很方便,很给力,业务逻辑层面的处理ORM是没有提供的,如果使用原生的框架,业务逻辑代码我们一般会自定义,会自己去写SQL语句,然后执行。在这个时候,Spring-data-jpa的威力就体现出来了,ORM提供的能力他都提供,ORM框架没有提供的业务逻辑功能Spring-data-jpa也提供,全方位的解决用户的需求。使用Spring-data-jpa进行开发的过程中,常用的功能,我们几乎不需要写一条sql语句,至少在我看来,企业级应用基本上可以不用写任何一条sql,当然spring-data-jpa也提供自己写sql的方式,这个就看个人怎么选择,都可以。我觉得都行。

  2.1与Spring整合我们从spring配置文件开始,为了节省篇幅,这里我只写出配置文件的结构。

<?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:p="http://www.springframework.org/schema/p"     xmlns:aop="http://www.springframework.org/schema/aop"     xmlns:tx="http://www.springframework.org/schema/tx"     xmlns:context="http://www.springframework.org/schema/context"     xmlns:mongo="http://www.springframework.org/schema/data/mongo"    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-3.0.xsd           http://www.springframework.org/schema/aop                http://www.springframework.org/schema/aop/spring-aop-3.0.xsd              http://www.springframework.org/schema/tx           http://www.springframework.org/schema/tx/spring-tx-3.0.xsd           http://www.springframework.org/schema/context                http://www.springframework.org/schema/context/spring-context-3.0.xsd           http://www.springframework.org/schema/data/mongo           http://www.springframework.org/schema/data/mongo/spring-mongo-1.0.xsd           http://www.springframework.org/schema/data/jpa http://www.springframework.org/schema/data/jpa/spring-jpa.xsd">    <!-- 数据库连接 -->    <context:property-placeholder location="classpath:your-config.properties" ignore-unresolvable="true" />    <!-- service包 -->    <context:component-scan base-package="your service package" />    <!-- 使用cglib进行动态代理 -->    <aop:aspectj-autoproxy proxy-target-class="true" />    <!-- 支持注解方式声明式事务 -->    <tx:annotation-driven transaction-manager="transactionManager" proxy-target-class="true" />    <!-- dao -->    <jpa:repositories base-package="your dao package" repository-impl-postfix="Impl" entity-manager-factory-ref="entityManagerFactory" transaction-manager-ref="transactionManager" />    <!-- 实体管理器 -->    <bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">        <property name="dataSource" ref="dataSource" />        <property name="packagesToScan" value="your entity package" />        <property name="persistenceProvider">            <bean class="org.hibernate.ejb.HibernatePersistence" />        </property>        <property name="jpaVendorAdapter">            <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter">                <property name="generateDdl" value="false" />                <property name="database" value="MYSQL" />                <property name="databasePlatform" value="org.hibernate.dialect.MySQL5InnoDBDialect" />                <!-- <property name="showSql" value="true" /> -->            </bean>        </property>        <property name="jpaDialect">            <bean class="org.springframework.orm.jpa.vendor.HibernateJpaDialect" />        </property>        <property name="jpaPropertyMap">            <map>                <entry key="hibernate.query.substitutions" value="true 1, false 0" />                <entry key="hibernate.default_batch_fetch_size" value="16" />                <entry key="hibernate.max_fetch_depth" value="2" />                <entry key="hibernate.generate_statistics" value="true" />                <entry key="hibernate.bytecode.use_reflection_optimizer" value="true" />                <entry key="hibernate.cache.use_second_level_cache" value="false" />                <entry key="hibernate.cache.use_query_cache" value="false" />            </map>        </property>    </bean>        <!-- 事务管理器 -->    <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">        <property name="entityManagerFactory" ref="entityManagerFactory"/>    </bean>        <!-- 数据源 -->    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">        <property name="driverClassName" value="${driver}" />        <property name="url" value="${url}" />        <property name="username" value="${userName}" />        <property name="password" value="${password}" />        <property name="initialSize" value="${druid.initialSize}" />        <property name="maxActive" value="${druid.maxActive}" />        <property name="maxIdle" value="${druid.maxIdle}" />        <property name="minIdle" value="${druid.minIdle}" />        <property name="maxWait" value="${druid.maxWait}" />        <property name="removeAbandoned" value="${druid.removeAbandoned}" />        <property name="removeAbandonedTimeout" value="${druid.removeAbandonedTimeout}" />        <property name="timeBetweenEvictionRunsMillis" value="${druid.timeBetweenEvictionRunsMillis}" />        <property name="minEvictableIdleTimeMillis" value="${druid.minEvictableIdleTimeMillis}" />        <property name="validationQuery" value="${druid.validationQuery}" />        <property name="testWhileIdle" value="${druid.testWhileIdle}" />        <property name="testOnBorrow" value="${druid.testOnBorrow}" />        <property name="testOnReturn" value="${druid.testOnReturn}" />        <property name="poolPreparedStatements" value="${druid.poolPreparedStatements}" />        <property name="maxPoolPreparedStatementPerConnectionSize" value="${druid.maxPoolPreparedStatementPerConnectionSize}" />        <property name="filters" value="${druid.filters}" />    </bean>        <!-- 事务 -->    <tx:advice id="txAdvice" transaction-manager="transactionManager">        <tx:attributes>            <tx:method name="*" />            <tx:method name="get*" read-only="true" />            <tx:method name="find*" read-only="true" />            <tx:method name="select*" read-only="true" />            <tx:method name="delete*" propagation="REQUIRED" />            <tx:method name="update*" propagation="REQUIRED" />            <tx:method name="add*" propagation="REQUIRED" />            <tx:method name="insert*" propagation="REQUIRED" />        </tx:attributes>    </tx:advice>    <!-- 事务入口 -->    <aop:config>        <aop:pointcut id="allServiceMethod" expression="execution(* your service implements package.*.*(..))" />        <aop:advisor pointcut-ref="allServiceMethod" advice-ref="txAdvice" />    </aop:config></beans>

2.2对上面的配置文件进行简单的解释,只对“实体管理器”和“dao”进行解释,其他的配置在任何地方都差不太多。

    1.对“实体管理器”解释:我们知道原生的jpa的配置信息是必须放在META-INF目录下面的,并且名字必须叫做persistence.xml,这个叫做persistence-unit,就叫做持久化单元,放在这下面我们感觉不方便,不好,于是Spring提供了

org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean

这样一个类,可以让你的随心所欲的起这个配置文件的名字,也可以随心所欲的修改这个文件的位置,只需要在这里指向这个位置就行。然而更加方便的做法是,直接把配置信息就写在这里更好,于是就有了这实体管理器这个bean。使用

<property name="packagesToScan" value="your entity package" />

这个属性来加载我们的entity。

  2.3 解释“dao”这个bean。这里衍生一下,进行一下名词解释,我们知道dao这个层叫做Data Access Object,数据库访问对象,这是一个广泛的词语,在jpa当中,我们还有一个词语叫做Repository,这里我们一般就用Repository结尾来表示这个dao,比如UserDao,这里我们使用UserRepository,当然名字无所谓,随意取,你可以意会一下我的意思,感受一下这里的含义和区别,同理,在mybatis中我们一般也不叫dao,mybatis由于使用xml映射文件(当然也提供注解,但是官方文档上面表示在有些地方,比如多表的复杂查询方面,注解还是无解,只能xml),我们一般使用mapper结尾,比如我们也不叫UserDao,而叫UserMapper。

  上面拓展了一下关于dao的解释,那么这里的这个配置信息是什么意思呢?首先base-package属性,代表你的Repository接口的位置,repository-impl-postfix属性代表接口的实现类的后缀结尾字符,比如我们的UserRepository,那么他的实现类就叫做UserRepositoryImpl,和我们平时的使用习惯完全一致,于此同时,spring-data-jpa的习惯是接口和实现类都需要放在同一个包里面(不知道有没有其他方式能分开放,这不是重点,放在一起也无所谓,影响不大),再次的,这里我们的UserRepositoryImpl这个类的定义的时候我们不需要去指定实现UserRepository接口,根据spring-data-jpa自动就能判断二者的关系。

  比如:我们的UserRepository和UserRepositoryImpl这两个类就像下面这样来写。

public interface UserRepository extends JpaRepository<User, Integer>{}public class UserRepositoryImpl {}

那么这里为什么要这么做呢?原因是:spring-data-jpa提供基础的CRUD工作,同时也提供业务逻辑的功能(前面说了,这是该框架的威力所在),所以我们的Repository接口要做两项工作,继承spring-data-jpa提供的基础CRUD功能的接口,比如JpaRepository接口,同时自己还需要在UserRepository这个接口中定义自己的方法,那么导致的结局就是UserRepository这个接口中有很多的方法,那么如果我们的UserRepositoryImpl实现了UserRepository接口,导致的后果就是我们势必需要重写里面的所有方法,这是Java语法的规定,如此一来,悲剧就产生了,UserRepositoryImpl里面我们有很多的@Override方法,这显然是不行的,结论就是,这里我们不用去写implements部分。

  spring-data-jpa实现了上面的能力,那他是怎么实现的呢?这里我们通过源代码的方式来呈现他的来龙去脉,这个过程中cglib发挥了杰出的作用。

  在spring-data-jpa内部,有一个类,叫做

public class SimpleJpaRepository<T, ID extends Serializable> implements JpaRepository<T, ID>,        JpaSpecificationExecutor<T>

我们可以看到这个类是实现了JpaRepository接口的,事实上如果我们按照上面的配置,在同一个包下面有UserRepository,但是没有UserRepositoryImpl这个类的话,在运行时期UserRepository这个接口的实现就是上面的SimpleJpaRepository这个接口。而如果有UserRepositoryImpl这个文件的话,那么UserRepository的实现类就是UserRepositoryImpl,而UserRepositoryImpl这个类又是SimpleJpaRepository的子类,如此一来就很好的解决了上面的这个不用写implements的问题。我们通过阅读这个类的源代码可以发现,里面包装了entityManager,底层的调用关系还是entityManager在进行CRUD。

@Entity@Table(name = "user")public class User {    @Id    @GeneratedValue(strategy = GenerationType.IDENTITY)    private Integer id;    private String name;    private String password;    private String birthday;    // getter,setter}

UserRepository接口

public interface UserRepository extends JpaRepository<User, Integer>{}

通过上面3步,所有的工作就做完了,User的基础CRUD都能做了,简约而不简单。

我们的测试类UserRepositoryTest

public class UserRepositoryTest {        @Autowired    private UserRepository userRepository;        @Test    public void baseTest() throws Exception {        User user = new User();        user.setName("Jay");        user.setPassword("123456");        user.setBirthday("2008-08-08");        userRepository.save(user);//        userRepository.delete(user);//        userRepository.findOne(1);    }}

测试通过。
  说到这里,和spring已经完成。接下来第三点,基本使用

4.前面把基础的东西说清楚了,接下来就是spring-data-jpa的正餐了,真正威力的地方。

  4.1 我们的系统中一般都会有用户登录这个接口,在不使用spring-data-jpa的时候我们怎么做,首先在service层定义一个登录方法。如:

User login(String name, String password);

然后在serviceImpl中写该方法的实现,大致这样:

@Override    public User login(String name, String password) {        return userDao.login(name, password);    }

接下来,UserDao大概是这么个样子:

User getUserByNameAndPassword(String name, String password);

然后在UserDaoImpl中大概是这么个样子:

 public User getUserByNameAndPassword(String name, String password) {        Query query = em.createQuery("select * from User t where t.name = ?1 and t.password = ?2");        query.setParameter(1, name);        query.setParameter(2, password);        return (User) query.getSingleResult();    }

ok,这个代码运行良好,那么这样子大概有十来行代码,我们感觉这个功能实现了,很不错。然而这样子真正简捷么?如果这样子就满足了,那么spring-data-jpa就没有必要存在了,前面提到spring-data-jpa能够帮助你完成业务逻辑代码的处理,那他是怎么处理的呢?这里我们根本不需要UserDaoImpl这个类,只需要在UserRepository接口中定义一个方法

User findByNameAndPassword(String name, String password);

然后在service中调用这个方法就完事了,所有的逻辑只需要这么一行代码,一个没有实现的接口方法。通过debug信息,我们看到输出的sql语句是

select * from user where name = ? and password = ?

跟上面的传统方式一模一样的结果。这简单到令人发指的程度,那么这一能力是如何实现的呢?原理是:spring-data-jpa会根据方法的名字来自动生成sql语句,我们只需要按照方法定义的规则即可,上面的方法findByNameAndPassword,spring-data-jpa规定,方法都以findBy开头,sql的where部分就是NameAndPassword,被spring-data-jpa翻译之后就编程了下面这种形态:

where name = ? and password = ?

接下来:就是比较复杂的操作了,比如动态查询,分页,下面详细介绍spring-data-jpa的第二大杀手锏,强大的动态查询能力。
在上面的介绍中,对于我们传统的企业级应用的基本操作已经能够基本上全部实现,企业级应用一般都会有一个模糊查询的功能,并且是多条的查询,在有查询条件的时候我们需要在where后面接上一个 xxx = yyy 或者 xxx like '% + yyy + %'类似这样的sql。那么我们传统的JDBC的做法是使用很多的if语句根据传过来的查询条件来拼sql,mybatis的做法也类似,由于mybatis有强大的动态xml文件的标签,在处理这种问题的时候显得非常的好,但是二者的原理都一致,那spring-data-jpa的原理也同样很类似,这个道理也就说明了解决多表关联动态查询根儿上也就是这么回事。

  那么spring-data-jpa的做法是怎么的呢?有两种方式。可以选择其中一种,也可以结合使用,在一般的查询中使用其中一种就够了,就是第二种,但是有一类查询比较棘手,比如报表相关的,报表查询由于涉及的表很多,这些表不一定就是两两之间有关系,比如字典表,就很独立,在这种情况之下,使用拼接sql的方式要容易一些。下面分别介绍这两种方式。

a.使用JPQL,和Hibernate的HQL很类似。
   前面说道了在UserRepository接口的同一个包下面建立一个普通类UserRepositoryImpl来表示该类的实现类,同时前面也介绍了完全不需要这个类的存在,但是如果使用JPQL的方式就必须要有这个类。如下:

public class StudentRepositoryImpl {        @PersistenceContext    private EntityManager em;    @SuppressWarnings("unchecked")    public Page<Student> search(User user) {        String dataSql = "select t from User t where 1 = 1";        String countSql = "select count(t) from User t where 1 = 1";                if(null != user && !StringUtils.isEmpty(user.getName())) {            dataSql += " and t.name = ?1";            countSql += " and t.name = ?1";        }                Query dataQuery = em.createQuery(dataSql);        Query countQuery = em.createQuery(countSql);                if(null != user && !StringUtils.isEmpty(user.getName())) {            dataQuery.setParameter(1, user.getName());            countQuery.setParameter(1, user.getName());        }long totalSize = (long) countQuery.getSingleResult();        Page<User> page = new Page();        page.setTotalSize(totalSize);        List<User> data = dataQuery.getResultList();        page.setData(data);        return page;    }    }

通过上面的方法,我们查询并且封装了一个User对象的分页信息。代码能够良好的运行。这种做法也是我们传统的经典做法。那么spring-data-jpa还有另外一种更好的方式,那就是所谓的类型检查的方式,上面我们的sql是字符串,没有进行类型检查,而下面的方式就使用了类型检查的方式。这个道理在mybatis中也有体现,mybatis可以使用字符串sql的方式,也可以使用接口的方式,而mybatis的官方推荐使用接口方式,因为有类型检查,会更安全。

  b.使用JPA的动态接口

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);}

上面说了,使用这种方式我们压根儿就不需要UserRepositoryImpl这个类,说到这里,仿佛我们就发现了spring-data-jpa为什么把Repository和RepositoryImpl文件放在同一个包下面,因为我们的应用很可能根本就一个Impl文件都不存在,那么在那个包下面就只有一堆接口,即使把Repository和RepositoryImpl都放在同一个包下面,也不会造成这个包下面有正常情况下2倍那么多的文件,根本原因:只有接口而没有实现类。

上面我们的UserRepository类继承了JpaRepository和JpaSpecificationExecutor类,而我们的UserRepository这个对象都会注入到UserService里面,于是如果使用这种方式,我们的逻辑直接就写在service里面了,下面的代码:一个学生Student类,一个班级Clazz类,Student里面有一个对象Clazz,在数据库中是clazz_id,这是典型的多对一的关系。我们在配置好entity里面的关系之后。就可以在StudentServiceImpl类中做Student的模糊查询,典型的前端grid的模糊查询。代码是这样子的:

@Servicepublic class StudentServiceImpl extends BaseServiceImpl<Student> implements StudentService {        @Autowired    private StudentRepository studentRepository;        @Override    public Student login(Student student) {        return studentRepository.findByNameAndPassword(student.getName(), student.getPassword());    }    @Override    public Page<Student> search(final Student student, PageInfo page) {        return studentRepository.findAll(new Specification<Student>() {            @Override            public Predicate toPredicate(Root<Student> root, CriteriaQuery<?> query, CriteriaBuilder cb) {                                Predicate stuNameLike = null;                if(null != student && !StringUtils.isEmpty(student.getName())) {           // 这里也可以root.get("name").as(String.class)这种方式来强转泛型类型                    stuNameLike = cb.like(root.<String> get("name"), "%" + student.getName() + "%");                }                                Predicate clazzNameLike = null;                if(null != student && null != student.getClazz() && !StringUtils.isEmpty(student.getClazz().getName())) {                    clazzNameLike = cb.like(root.<String> get("clazz").<String> get("name"), "%" + student.getClazz().getName() + "%");                }                                if(null != stuNameLike) query.where(stuNameLike);                if(null != clazzNameLike) query.where(clazzNameLike);                return null;            }        }, new PageRequest(page.getPage() - 1, page.getLimit(), new Sort(Direction.DESC, page.getSortName())));    }}

先解释下这里的意思,然后我们在结合框架的源码来深入分析。

这里我们是2个表关联查询,查询条件包括Student表和Clazz表,类似的2个以上的表方式差不多,但是正如上面所说,这种做法适合所有的表都是两两能够关联上的,涉及的表太多,或者是有一些字典表,那就使用sql拼接的方式,简单一些。

先简单解释一下代码的含义,然后结合框架源码来详细分析。两个Predicate对象,Predicate按照中文意思是判断,断言的意思,那么放在我们的sql中就是where后面的东西,比如

name like '% + jay + %';

下面的PageRequest代表分页信息,PageRequest里面的Sort对象是排序信息。上面的代码事实上是在动态的组合最终的sql语句,这里使用了一个策略模式,或者callback,就是

studentRepository.findAll(一个接口)

第一步就需要构建出这个参数CriteriaQuery类型的参数,这里使用建造者模式,

CriteriaBuilder builder = em.getCriteriaBuilder();CriteriaQuery<Student> query = builder.createQuery(Student.class);
接下来:
Root<Student> root = query.from(Student.class);

在这里,我们看方法名from,意思是获取Student的Root,其实也就是个Student的包装对象,就代表这条sql语句里面的主体。接下来:

Predicate p1 = builder.like(root.<String> get("name"), "%" + student.getName() + "%");        Predicate p2 = builder.equal(root.<String> get("password"), student.getPassword());

Predicate是判断的意思,放在sql语句中就是where后面 xxx = yyy, xxx like yyy这种,也就是查询条件,这里构造了2个查询条件,分别是根据student的name属性进行like查询和根据student的password进行“=”查询,在sql中就是

name like = ? and password = ?

这种形式,接下来

query.where(p1, p2);

这样子一个完整的动态查询就构建完成了,接下来调用getSingleResult或者getResultList返回结果,这里jpa的单个查询如果为空的话会报异常,这点感觉框架设计的不好,如果查询为空直接返回一个null或者一个空的List更好一点。


这是jpa原生的动态查询方式,过程大致就是,创建builder => 创建Query => 构造条件 => 查询。这么4个步骤,这里代码运行良好,如果不使用spring-data-jpa,我们就需要这么来做,但是spring-data-jpa帮我们做得更为彻底,从上面的4个步骤中,我们发现:所有的查询除了第三步不一样,其他几步都是一模一样的,不使用spring-data-jpa的情况下,我们要么4步骤写完,要么自己写个工具类,封装一下,这里spring-data-jpa就是帮我们完成的这样一个动作,那就是在JpaSpecification<T>这个接口中的

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

这个方法,前面说了,这是个策略模式,参数spec是个接口,前面也说了框架内部对于这个接口有默认的实现类

@Repository@Transactional(readOnly = true)public class SimpleJpaRepository<T, ID extends Serializable> implements JpaRepository<T, ID>,        JpaSpecificationExecutor<T> {   }

我们的Repository接口就是继承这个接口,而通过cglib的RepositoryImpl的代理类也是这个类的子类,默认也就实现了该方法。这个方法的方法体是这样的:

/*     * (non-Javadoc)     * @see org.springframework.data.jpa.repository.JpaSpecificationExecutor#findOne(org.springframework.data.jpa.domain.Specification)     */    public T findOne(Specification<T> spec) {        try {            return getQuery(spec, (Sort) null).getSingleResult();        } catch (NoResultException e) {            return null;        }    }

这里的


getQuery(spec, (Sort) null)
返回类型是


TypedQuery<T>
进入这个getQuery方法:

/**     * Creates a {@link TypedQuery} for the given {@link Specification} and {@link Sort}.     *      * @param spec can be {@literal null}.     * @param sort can be {@literal null}.     * @return     */    protected TypedQuery<T> getQuery(Specification<T> spec, Sort sort) {        CriteriaBuilder builder = em.getCriteriaBuilder();        CriteriaQuery<T> query = builder.createQuery(getDomainClass());        Root<T> root = applySpecificationToCriteria(spec, query);        query.select(root);        if (sort != null) {            query.orderBy(toOrders(sort, root, builder));        }        return applyRepositoryMethodMetadata(em.createQuery(query));    }

一切玄机尽收眼底,这个方法的内容和我们前面使用原生jpa的api的过程是一样的,而再进入

Root<T> root = applySpecificationToCriteria(spec, query);
这个方法:

/**     * Applies the given {@link Specification} to the given {@link CriteriaQuery}.     *      * @param spec can be {@literal null}.     * @param query must not be {@literal null}.     * @return     */    private <S> Root<T> applySpecificationToCriteria(Specification<T> spec, CriteriaQuery<S> query) {        Assert.notNull(query);        Root<T> root = query.from(getDomainClass());        if (spec == null) {            return root;        }        CriteriaBuilder builder = em.getCriteriaBuilder();        Predicate predicate = spec.toPredicate(root, query, builder);        if (predicate != null) {            query.where(predicate);        }        return root;    }

我们可以发现spec参数调用了toPredicate方法,也就是我们前面service里面匿名内部类的实现。

到这里spring-data-jpa的默认实现已经完全明了。总结一下使用动态查询:前面说的原生api需要4步,而使用spring-data-jpa只需要一步,那就是重写匿名内部类的toPredicate方法。在重复一下上面的Student和Clazz的查询代码,

@Override    public Page<Student> search(final Student student, PageInfo page) {        return studentRepository.findAll(new Specification<Student>() {            @Override            public Predicate toPredicate(Root<Student> root, CriteriaQuery<?> query, CriteriaBuilder cb) {                                Predicate stuNameLike = null;                if(null != student && !StringUtils.isEmpty(student.getName())) {                    stuNameLike = cb.like(root.<String> get("name"), "%" + student.getName() + "%");                }                                Predicate clazzNameLike = null;                if(null != student && null != student.getClazz() && !StringUtils.isEmpty(student.getClazz().getName())) {                    clazzNameLike = cb.like(root.<String> get("clazz").<String> get("name"), "%" + student.getClazz().getName() + "%");                }                                if(null != stuNameLike) query.where(stuNameLike);                if(null != clazzNameLike) query.where(clazzNameLike);                return null;            }        }, new PageRequest(page.getPage() - 1, page.getLimit(), new Sort(Direction.DESC, page.getSortName())));    }

到这里位置,spring-data-jpa的介绍基本上就完成了,涵盖了该框架使用的方方面面。接下来还有一块比较实用的东西,我们看到上面第15行位置的条件查询,这里使用了一个多级的get,这个是spring-data-jpa支持的,就是嵌套对象的属性,这种做法一般我们叫方法的级联调用,就是调用的时候返回自己本身,这个在处理xml的工具中比较常见,主要是为了代码的美观作用,没什么其他的用途。


0 0
原创粉丝点击