如何在Spring Data中从application.properties获取查询语句？

要实现这个需求其实很简单，Spring Data JPA的@Query注解支持使用Spring表达式语言（SpEL）来动态注入配置文件中的查询语句，下面给你两种可行的方案：

方案一：直接通过Spring Environment读取配置 #

这是最直接的方式，Spring容器中的Environment对象可以直接访问application.properties里的配置项，你只需要修改Repository的@Query注解内容：

@Repository
public interface OrderRepository extends CrudRepository<Order, UUID> {
    @Query("#{environment.getProperty('app.queryExample')}")
    Set<Order> findByExampleQuery();
}

这样Spring就会自动从application.properties中读取app.queryExample的值作为JPQL查询语句执行。

方案二：使用配置类绑定属性（适合多配置场景） #

如果你的项目中有多个相关的配置项，推荐把它们绑定到一个专门的配置类中，这样代码更清晰：

第一步：创建配置类 #

@Configuration
@ConfigurationProperties(prefix = "app")
public class AppProperties {
    private String queryExample;

    // 别忘了添加Getter和Setter
    public String getQueryExample() {
        return queryExample;
    }

    public void setQueryExample(String queryExample) {
        this.queryExample = queryExample;
    }
}

第二步：在Repository中引用配置类的属性 #

@Repository
public interface OrderRepository extends CrudRepository<Order, UUID> {
    @Query("#{appProperties.queryExample}")
    Set<Order> findByExampleQuery();
}

这里的appProperties是配置类的默认bean名称（类名首字母小写），如果你给配置类自定义了bean名称，记得替换成对应的名称。

一些注意事项 #

• 如果你的查询是原生SQL而不是JPQL，需要在@Query注解中加上nativeQuery = true，比如：

  @Query(value = "#{environment.getProperty('app.queryExample')}", nativeQuery = true)
  

• 确保application.properties中的查询语句语法正确，比如你写的select o from Order o是合法的JPQL语句，要避免语法错误导致运行时异常。
• 如果你用的是Spring Boot 2.2之前的版本，可能需要在主启动类上添加@EnableConfigurationProperties(AppProperties.class)来启用配置属性绑定。

内容的提问来源于stack exchange，提问作者nagy.zsolt.hun