自定义查询方法 - @Query 注解 - 使用注解编写查询

Java - Web - Spring 《自定义查询方法 - @Query 注解 - 使用注解编写查询》

在 Java Web 开发中，Spring 框架为我们提供了强大的持久化支持。Spring Data JPA 是 Spring 框架中用于简化 JPA（Java Persistence API）使用的模块，它允许我们通过定义接口方法来自动生成数据库查询。然而，在某些复杂的查询场景下，自动生成的查询可能无法满足需求，这时就可以使用 @Query 注解来自定义查询方法。本文将详细介绍 @Query 注解的使用，包括基本用法、参数绑定、原生 SQL 查询等，并给出相应的演示代码。

1. 引入依赖

首先，确保在你的项目中引入 Spring Data JPA 和相关数据库驱动的依赖。以 Maven 为例，在 pom.xml 中添加以下依赖：

<dependencies>
    <!-- Spring Data JPA -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <!-- H2 数据库驱动 -->
    <dependency>
        <groupId>com.h2database</groupId>
        <artifactId>h2</artifactId>
        <scope>runtime</scope>
    </dependency>
</dependencies>

2. 定义实体类

创建一个简单的实体类 User，用于表示数据库中的用户信息：

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 int age;
    // 构造方法、Getter 和 Setter 方法
    public User() {}
    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }
    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 int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
    @Override
    public String toString() {
        return "User{id=" + id + ", name='" + name + "', age=" + age + "}";
    }
}

3. 定义 Repository 接口

创建一个 UserRepository 接口，继承自 JpaRepository，并使用 @Query 注解定义自定义查询方法：

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import java.util.List;
public interface UserRepository extends JpaRepository<User, Long> {
    /**
     * 使用 @Query 注解编写 JPQL 查询，根据年龄查询用户
     */
    @Query("SELECT u FROM User u WHERE u.age > :age")
    List<User> findUsersByAgeGreaterThan(int age);
    /**
     * 使用原生 SQL 查询，根据姓名模糊查询用户
     */
    @Query(value = "SELECT * FROM user WHERE name LIKE %:name%", nativeQuery = true)
    List<User> findUsersByNameContaining(String name);
}

代码解释：

• @Query 注解用于定义自定义查询。value 属性指定查询语句，可以是 JPQL（Java Persistence Query Language）或原生 SQL。
• nativeQuery 属性默认为 false，表示使用 JPQL 查询；如果设置为 true，则使用原生 SQL 查询。
• :age 和 :name 是参数占位符，用于绑定方法的参数。

4. 编写服务类和测试代码

创建一个服务类 UserService，用于调用 UserRepository 的方法：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class UserService {
    @Autowired
    private UserRepository userRepository;
    public List<User> getUsersByAgeGreaterThan(int age) {
        return userRepository.findUsersByAgeGreaterThan(age);
    }
    public List<User> getUsersByNameContaining(String name) {
        return userRepository.findUsersByNameContaining(name);
    }
}

编写测试代码，验证自定义查询方法的功能：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import java.util.List;
@SpringBootApplication
public class Application implements CommandLineRunner {
    @Autowired
    private UserService userService;
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
    @Override
    public void run(String... args) throws Exception {
        // 查询年龄大于 20 的用户
        List<User> usersByAge = userService.getUsersByAgeGreaterThan(20);
        System.out.println("Users with age greater than 20:");
        usersByAge.forEach(System.out::println);
        // 查询姓名包含 "John" 的用户
        List<User> usersByName = userService.getUsersByNameContaining("John");
        System.out.println("Users with name containing 'John':");
        usersByName.forEach(System.out::println);
    }
}

5. @Query 注解总结

总结

通过 @Query 注解，我们可以在 Spring Data JPA 中灵活地编写自定义查询方法，满足各种复杂的查询需求。无论是使用 JPQL 还是原生 SQL，都能方便地实现数据库查询操作。在实际开发中，根据具体情况选择合适的查询方式，以提高代码的可读性和性能。

希望本文能帮助你更好地理解和使用 @Query 注解，让你在 Java Web 开发中更加得心应手。