SpringData JPA的常用语法汇总

下面将详细讲解关于Spring Data JPA的常用语法汇总。

一、什么是Spring Data JPA

Spring Data JPA是Spring框架的一个扩展模块，可以使用简单且统一的API，提供了CRUD操作，还支持基于方法名称的查询、@Query查询以及Specification查询等。它更加注重与实体类相关的持久化层操作，将封装JPA的强大功能，让开发人员能够更加轻松地实现与数据库相关的操作。

二、常用语法汇总

1. 创建Repository

Spring Data JPA通过@Repository注释来表示接口继承的是Repository接口，并通过泛型来指定Repository所操作的实体类和实体类的主键类型。下面是一个创建Repository的示例：

@Repository
public interface UserRepository extends JpaRepository<User, Long> {

}

上面的示例中，User表示实体类，Long表示该实体类的主键类型，UserRepository就是所创建的Repository接口，继承了JpaRepository<User, Long>。在Repository接口中，我们可以定义自己的方法或使用Spring Data JPA默认提供方法，实现调用相关服务。

2. 基于方法名查询

Spring Data JPA提供了一种基于方法名称的查询方式，这使得我们可以仅仅通过方法名就能实现接口的实现类自动生成。下面是一个基于方法名查询的示例：

public interface UserRepository extends JpaRepository<User, Long> {
    User findByUsername(String username);
}

上面的示例中，findByUsername就是要实现的方法名称，表示根据username字段查询符合条件的User实体。这里只需要定义方法名称即可，Spring Data JPA会自动帮我们生成SQL查询语句。

3. 基于@Query注解自定义查询

除了基于方法名的查询方式，Spring Data JPA还支持使用@Query注解自定义查询。下面是一个基于@Query注解自定义查询的示例：

public interface UserRepository extends JpaRepository<User, Long> {
    @Query("SELECT u FROM User u WHERE u.username = ?1")
    User findByUsername(String username);
}

上面的示例中，@Query注解括号中的内容表示实现的SQL查询语句，?1表示第一个参数。这里的查询方式是使用JPQL查询，JPA会执行参数验证和预编译查询等等一系列操作。

4. 分页查询

Spring Data JPA将分页查询封装成了Page对象，我们可以方便地使用该对象来实现分页查询操作。下面是一个分页查询的示例：

public interface UserRepository extends JpaRepository<User, Long> {
    Page<User> findAll(Pageable pageable);
}

上面的示例中，Pageable表示查询的分页信息，包括pageSize（每页大小）和pageNumber（当前页号）等信息。我们可以通过创建一个PageRequest对象并传递两个参数来实现Pageable对象。例如：

PageRequest pageRequest = PageRequest.of(0, 10); //查询第一页，每页10条数据
Page<User> userPage = userRepository.findAll(pageRequest); //查询结果

5. 使用Specification查询

Spring Data JPA还提供了一种使用Specification查询的方式，与@Query注解自定义查询相比，Specification查询方式更加安全，可以防止SQL注入等问题。下面是一个使用Specification查询的示例：

public interface UserRepository extends JpaRepository<User, Long>, JpaSpecificationExecutor<User> {

}

//调用
Specification<User> specification = (root, criteriaQuery, criteriaBuilder) -> criteriaBuilder.equal(root.get("username"), "xxx");
userRepository.findAll(specification);

上面的示例中我们首先需要扩展JpaSpecificationExecutor<User>接口，提供#findAll(Specification)操作。然后我们使用Lambda表达式实现一个Specification并传递给findAll(specification)方法。

三、示例说明

上面我们提到了一些关于Spring Data JPA的常用语法，下面我们来看看具体的实例说明。

示例一：基于方法名查询

假设我们的项目中需要查询一个用户通过username来获取该个用户详细信息。我们可以使用基于方法名的查询方式来实现该查询。首先，我们需要在继承了JpaRepository<User, Long>的UserRepository中添加如下方法：

public interface UserRepository extends JpaRepository<User, Long> {
    User findByUsername(String username);
}

此时，Spring Data JPA会自动将方法名中的findByUsername去掉前缀findBy(前缀是该方法所获取的实体对象的属性值)，并根据后面的部分Username组成SQL查询语句SELECT * FROM User WHERE username = ?，并为参数?赋予username的值。如下示例：

public class JpaDemo {

    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(JpaDemo.class, args);
        UserRepository userRepository = context.getBean(UserRepository.class);

        User user = userRepository.findByUsername("admin"); //查询符合username=admin的User实体
        System.out.println(user);
        context.close();
    }
}

示例二：使用Specification查询

假设我们的项目中需要查询符合username等于xxx和password长度等于6的用户。此时我们可以使用Specification查询方式来实现该功能。首先需要在继承了JpaRepository<User, Long>的UserRepository中添加如下方法：

@Repository
public interface UserRepository extends JpaRepository<User, Long>, JpaSpecificationExecutor<User> {

}

此时，Spring Data JPA会自动将JpaSpecificationExecutor<User>中定义的#findAll(Specification)方法实现。然后我们可以使用Lambda表达式实现该Specification：

public class JpaDemo {

    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(JpaDemo.class, args);
        UserRepository userRepository = context.getBean(UserRepository.class);

        Specification<User> specification = (root, criteriaQuery, criteriaBuilder) -> {
            Predicate predicate = criteriaBuilder.equal(root.get("username"), "xxx");//查询username等于xxx
            predicate = criteriaBuilder.and(predicate, criteriaBuilder.equal(criteriaBuilder.length(root.get("password")), 6));//并且查询password的长度为6
            return predicate;
        };
        List<User> userList = userRepository.findAll(specification); //获取符合条件的User实体列表
        System.out.println(userList);
        context.close();
    }
}

上面的示例中，我们首先传递了一个root参数，表示查询的根节点。然后我们使用criteriaBuilder创建查询条件，将符合多个条件的Predicate合并，并将合并后的结果返回，最终使用findAll()查询符合条件的结果。