JPA Repository: 自定义SQL的2种方法

目录

1、JPA 实体 Entity

2. 基于方法命名规则自动生成 SQL（默认机制）

3. 使用@Query注解实现自定义 SQL（更灵活的方式）

（1）自定义 SQL 语句

（2）原生 SQL 使用

---

在 JPA 中自定义方法的 SQL 实现可以是基于方法命名规则自动生成，也可以通过@Query注解来灵活指定（包括 JPQL 或原生 SQL）。

1、JPA 实体 Entity

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private String email;

    // 构造函数、Getter 和 Setter 方法
    public User() {
    }

    public User(String name, String email) {
        this.name = name;
        this.email = email;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

2. 基于方法命名规则自动生成 SQL（默认机制）

• 方法命名解析
  JPA 会根据自定义方法的命名来自动生成相应的 SQL 语句。对于findByEmail方法，JPA 遵循特定的命名约定。这里的findBy是前缀，表示这是一个查询操作，Email部分对应实体类中的属性名。根据这个命名，JPA 会生成类似SELECT * FROM user_table WHERE email =?的 SQL 语句（假设表名为user_table，这里的表名通常是根据实体类名通过一定规则转换得到的）。
• 参数绑定
  当调用findByEmail方法并传入参数（如findByEmail("example@mail.com")）时，JPA 会自动将参数值绑定到生成的 SQL 语句中的占位符（?）上。

• import org.springframework.data.jpa.repository.JpaRepository;
  import org.springframework.stereotype.Repository;
  
  @Repository
  public interface UserRepository extends JpaRepository<User, Long> {
      // 可以在这里定义自定义的查询方法，例如：
      // User findByEmail(String email);
  }

3. 使用@Query注解实现自定义 SQL（更灵活的方式）

• （1）自定义 SQL 语句

  • 如果需要更复杂的查询逻辑，或者想要明确指定 SQL 语句，可以使用@Query注解。例如：

• @Repository
  public interface UserRepository extends JpaRepository<User, Long> {
      @Query("SELECT u FROM User u WHERE u.email LIKE %?1%")
      List<User> findByEmailContaining(String email);
  }

  这里使用@Query注解指定了一个 JPQL（Java Persistence Query Language）语句。JPQL 是一种面向对象的查询语言，与 SQL 类似但操作的是实体对象而不是数据库表。在这个例子中，SELECT u FROM User u WHERE u.email LIKE %?1%表示从User实体中查询email属性包含指定字符串的用户。?1是参数占位符，表示方法中的第一个参数（即email参数）。

• （2）原生 SQL 使用

  • 如果想要使用原生 SQL 语句，可以在@Query注解中设置nativeQuery = true。例如：

• @Repository
  public interface UserRepository extends JpaRepository<User, Long> {
      @Query(nativeQuery = true, value = "SELECT * FROM user_table WHERE email LIKE %?1%")
      List<User> findByEmailContainingNative(String email);
  }

  import org.springframework.data.domain.Page;
  import org.springframework.data.domain.Pageable;
  import org.springframework.data.jpa.repository.JpaRepository;
  import org.springframework.data.jpa.repository.Query;
  import org.springframework.data.repository.query.Param;
  import org.springframework.stereotype.Repository;
  
  @Repository
  public interface UserRepository extends JpaRepository<User, Long> {
  
      // 使用 @Query 注解实现原生 SQL 查询，同时结合分页和排序
      @Query(nativeQuery = true, value = "SELECT * FROM user WHERE name LIKE CONCAT('%', :name, '%') ORDER BY name, email")
      Page<User> findUsersByNameContaining(@Param("name") String name, Pageable pageable);
  }

  当使用 JPQL 时，@Query("SELECT u FROM User u WHERE u.name LIKE %:name% ORDER BY u.name, u.email")中的:name是一个命名参数。这种方式比使用位置参数（如?1、?2等）更具可读性。在执行查询时，JPA 会将方法参数值绑定到这个命名参数上。

• 这种方式直接使用数据库原生的 SQL 语句，但会降低代码的数据库移植性，因为不同数据库的 SQL 语法可能略有不同。