Spring Boot 2.7.x应用中集中维护Cassandra查询的最佳方式

方案1：利用Spring Boot外部化配置（推荐） #

Spring Boot原生支持将配置抽离到外部文件，直接在配置中定义Cassandra查询语句，代码中通过注入方式引用，修改配置后仅需重启应用，无需重新构建。

实现步骤： #

1. 在外部配置文件（如application-cassandra.yml）中定义查询：

cassandra.queries:
  extract-data: "SELECT id, name, email FROM user WHERE created_at >= ?0 AND created_at <= ?1"
  count-active-users: "SELECT COUNT(*) FROM user WHERE status = 'ACTIVE'"

2. 在Spring Batch的Reader或数据操作类中注入查询：

@Component
public class CassandraUserReader extends AbstractPaginatedItemReader<User> {

    private final CassandraOperations cassandraOperations;
    
    @Value("${cassandra.queries.extract-data}")
    private String extractDataQuery;

    public CassandraUserReader(CassandraOperations cassandraOperations) {
        this.cassandraOperations = cassandraOperations;
    }

    @Override
    protected Iterator<User> doPageRead() {
        // 使用注入的查询执行数据提取
        return cassandraOperations.queryForIterator(extractDataQuery, new Object[]{startDate, endDate}, User.class);
    }
}

3. 部署时将配置文件放在Spring Boot可识别的外部路径（如应用根目录下的config/文件夹、环境变量指定路径），修改查询后重启应用即可生效。

方案2：将查询存储在外部结构化文件 #

若查询数量较多或需要更清晰的分类管理，可将查询写入单独的JSON/XML文件，通过Spring的资源加载器动态读取。

实现步骤： #

1. 创建外部查询文件cassandra-queries.json：

{
  "user-queries": {
    "extract-data": "SELECT id, name, email FROM user WHERE created_at >= ?0 AND created_at <= ?1",
    "count-active-users": "SELECT COUNT(*) FROM user WHERE status = 'ACTIVE'"
  },
  "order-queries": {
    "extract-recent-orders": "SELECT order_id, user_id, amount FROM orders WHERE order_date >= ?0"
  }
}

2. 编写查询加载工具类：

@Component
public class CassandraQueryLoader {

    private final Map<String, String> queryMap = new HashMap<>();

    public CassandraQueryLoader(ResourceLoader resourceLoader) throws IOException {
        // 指定外部文件路径，可通过配置项动态指定
        Resource resource = resourceLoader.getResource("file:/opt/app/config/cassandra-queries.json");
        ObjectMapper objectMapper = new ObjectMapper();
        JsonNode rootNode = objectMapper.readTree(resource.getInputStream());
        
        // 遍历加载所有查询
        rootNode.fields().forEachRemaining(category -> {
            category.getValue().fields().forEachRemaining(query -> {
                queryMap.put(category.getKey() + "." + query.getKey(), query.getValue().asText());
            });
        });
    }

    public String getQuery(String queryKey) {
        return queryMap.getOrDefault(queryKey, "");
    }
}

3. 在业务类中使用：

@Autowired
private CassandraQueryLoader queryLoader;

// 获取指定查询
String extractQuery = queryLoader.getQuery("user-queries.extract-data");

修改外部查询文件后，重启应用即可生效，无需重新构建。

方案3：使用配置中心（分布式场景适用） #

如果是分布式系统，可将查询配置托管到Nacos、Consul等配置中心，结合Spring Boot的动态刷新能力，无需重启应用即可更新查询。

实现示例（以Nacos为例）： #

1. 在Nacos配置中心添加查询配置：

cassandra.queries.extract-data=SELECT id, name, email FROM user WHERE created_at >= ?0 AND created_at <= ?1

2. 项目中集成Nacos并开启配置刷新：

@RefreshScope
@Component
public class QueryHolder {

    @Value("${cassandra.queries.extract-data}")
    private String extractDataQuery;

    public String getExtractDataQuery() {
        return extractDataQuery;
    }
}

3. 修改Nacos中的配置后，调用Spring Boot的/actuator/refresh端点触发配置更新，查询语句会实时生效，无需重启或重建应用。

注意事项 #

• 确保外部查询文件/配置中心的访问权限正常，应用具备读取权限。
• 动态刷新场景下，需注意线程安全，避免查询语句在执行过程中被修改引发异常。
• 复杂查询建议使用占位符传递参数，避免硬编码参数值，提升查询灵活性。

内容的提问来源于stack exchange，提问作者Shiva k