快捷導(dǎo)航

SpringBoot讀取ZooKeeper(ZK)屬性的方法實(shí)現(xiàn)

更新時(shí)間：2025年06月09日 11:23:41 作者：weixin_43833540

本文主要介紹了SpringBoot讀取ZooKeeper(ZK)屬性的方法實(shí)現(xiàn),強(qiáng)調(diào)使用@ConfigurationProperties實(shí)現(xiàn)類(lèi)型安全和自動(dòng)刷新,對(duì)比傳統(tǒng)方式優(yōu)缺點(diǎn),感興趣的可以了解一下

1. 在配置文件中定義 ZK 屬性

在 application.properties 或 application.yml 中添加 ZK 相關(guān)配置：

application.properties

# 單源配置示例
zookeeper.source.default.rootnode=/democonfig
zookeeper.source.default.servers=192.168.124.1:2181,192.168.124.2:2181
zookeeper.source.default.acls=root:iiot!@#zk$

# 多源配置示例（可選）
zookeeper.source.backup.rootnode=/backup-config
zookeeper.source.backup.servers=192.168.124.3:2181

application.yml

zookeeper:
  source:
    default:
      rootnode: /democonfig
      servers: 192.168.124.1:2181,192.168.124.2:2181
      acls: root:iiot!@#zk$
    backup:
      rootnode: /backup-config
      servers: 192.168.124.3:2181

2. 創(chuàng)建配置類(lèi)綁定屬性

使用 @ConfigurationProperties 綁定 ZK 配置：

import lombok.Getter;
import lombok.Setter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.Map;

@Component
@ConfigurationProperties(prefix = "zookeeper")
@Getter
@Setter
public class ZookeeperConfig {
    private Map<String, SourceProperties> source = new HashMap<>();

    @Getter
    @Setter
    public static class SourceProperties {
        private String rootnode;
        private String servers;
        private String acls;
    }
}

3. 初始化 ZK 客戶端

在 Spring 容器中初始化 ZK 客戶端，確保配置已注入：

import org.apache.zookeeper.ZooKeeper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.io.IOException;

@Component
public class ZookeeperClient {
    private static final int SESSION_TIMEOUT = 5000;
    private final ZooKeeper zooKeeper;

    @Autowired
    public ZookeeperClient(ZookeeperConfig zookeeperConfig) {
        try {
            // 獲取默認(rèn)源配置
            ZookeeperConfig.SourceProperties source = zookeeperConfig.getSource().get("default");
            if (source == null) {
                throw new IllegalArgumentException("ZooKeeper source 'default' not configured");
            }
            this.zooKeeper = new ZooKeeper(
                source.getServers(),
                SESSION_TIMEOUT,
                null
            );
        } catch (IOException e) {
            throw new RuntimeException("Failed to connect to ZooKeeper", e);
        }
    }

    public ZooKeeper getZooKeeper() {
        return zooKeeper;
    }
}

4. 使用配置屬性

在任意 Spring Bean 中注入 ZookeeperConfig 或 ZookeeperClient，并讀取屬性：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class MyService {
    @Autowired
    private ZookeeperConfig zookeeperConfig;

    @Autowired
    private ZookeeperClient zookeeperClient;

    public void printZkConfig() {
        // 直接讀取配置
        ZookeeperConfig.SourceProperties source = zookeeperConfig.getSource().get("default");
        System.out.println("ZK Root Node: " + source.getRootnode());
        System.out.println("ZK Servers: " + source.getServers());

        // 通過(guò)客戶端使用 ZK 連接
        ZooKeeper zk = zookeeperClient.getZooKeeper();
        System.out.println("ZK Session ID: " + zk.getSessionId());
    }
}

5. 多源配置支持

如果需要切換不同的 ZK 源（如 default 和 backup），可擴(kuò)展 ZookeeperClient：

@Component
public class ZookeeperClient {
    private final Map<String, ZooKeeper> clients = new HashMap<>();

    @Autowired
    public ZookeeperClient(ZookeeperConfig zookeeperConfig) {
        zookeeperConfig.getSource().forEach((name, config) -> {
            try {
                clients.put(name, new ZooKeeper(
                    config.getServers(),
                    SESSION_TIMEOUT,
                    null
                ));
            } catch (IOException e) {
                throw new RuntimeException("Failed to connect to ZooKeeper source: " + name, e);
            }
        });
    }

    public ZooKeeper getClient(String sourceName) {
        return clients.getOrDefault(sourceName, clients.get("default"));
    }
}

6. 注意事項(xiàng)

配置文件路徑：確保 application.properties 或 application.yml 在類(lèi)路徑下（src/main/resources）。
屬性鍵命名規(guī)則：
- 使用 kebab-case（如 zookeeper.source.default.servers）。
- 綁定到 @ConfigurationProperties 時(shí)，自動(dòng)轉(zhuǎn)換為駝峰命名（如 source.default.servers → source.get("default").getServers()）。
優(yōu)先級(jí)：
- 系統(tǒng)屬性（-D 參數(shù)） > 配置文件 > 代碼默認(rèn)值。
異常處理：在 ZK 客戶端初始化時(shí)捕獲 IOException，并提供友好的錯(cuò)誤提示。
單例與依賴注入：避免在 Spring 容器初始化前手動(dòng)創(chuàng)建 ZookeeperClient（如在 main 方法中），應(yīng)通過(guò) @Autowired 注入。

對(duì)比：傳統(tǒng)屬性讀取 vs Spring Boot 原生方式

方式	優(yōu)點(diǎn)	缺點(diǎn)
傳統(tǒng) `PropertyConfig`	簡(jiǎn)單直接，無(wú)需 Spring 依賴	不支持自動(dòng)刷新、類(lèi)型安全、配置校驗(yàn)
Spring Boot `@ConfigurationProperties`	類(lèi)型安全、支持校驗(yàn)、自動(dòng)刷新（需配置）	需要定義配置類(lèi)，學(xué)習(xí)成本略高

通過(guò)以上步驟，你可以在 Spring Boot 中優(yōu)雅地讀取和管理 ZooKeeper 的配置屬性。

到此這篇關(guān)于SpringBoot讀取ZooKeeper(ZK)屬性的方法實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)SpringBoot讀取ZooKeeper內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: