天天看點

SpringBoot2 整合 Zookeeper元件,管理架構中服務協調一、Zookeeper基礎簡介二、安全管理操作三、整合 SpringBoot2 架構四、源代碼位址

本文源碼: GitHub·點這裡 || GitEE·點這裡

一、Zookeeper基礎簡介

1、概念簡介

Zookeeper是一個Apache開源的分布式的應用,為系統架構提供協調服務。從設計模式角度來審視:該元件是一個基于觀察者模式設計的架構,負責存儲和管理資料,接受觀察者的注冊,一旦資料的狀态發生變化,Zookeeper就将負責通知已經在Zookeeper上注冊的觀察者做出相應的反應,進而實作叢集中類似Master/Slave管理模式。ZooKeeper的目标就是封裝好複雜易出錯的關鍵服務,将簡單易用的接口和性能高效、功能穩定的系統提供給使用者。

2、基本理論

  • 資料結構

ZooKeeper記錄資料的結構與Linux檔案系統相似,整體可以看作一棵樹,每個節點稱ZNode。每個Znode預設能夠存儲1MB的資料,每個ZNode都可以通過其路徑唯一辨別。

SpringBoot2 整合 Zookeeper元件,管理架構中服務協調一、Zookeeper基礎簡介二、安全管理操作三、整合 SpringBoot2 架構四、源代碼位址
  • 節點類型

短暫(ephemeral):用戶端和伺服器端斷開連接配接後,建立的節點自動删除。

持久(persistent):用戶端和伺服器端斷開連接配接後,建立的節點持久化儲存。

  • 叢集服務

在Zookeeper叢集服務是由一個上司者(leader),多個跟随者(follower)組成的叢集。上司者負責進行投票的發起和決議,更新叢集服務狀态。跟随者用于接收客戶請求并向用戶端傳回結果,在選舉Leader過程中參與投票。叢集中隻要有半數以上節點存活,Zookeeper叢集就能正常服務。

  • 資料一緻性

每個server儲存一份相同的資料拷貝,用戶端無論請求到被叢集中哪個server處理,得到的資料都是一緻的。

3、應用場景

  • 經典應用:Dubbo架構的服務注冊和發現;
  • 分布式消息同步和協調機制;
  • 伺服器節點動态上下線;
  • 統一配置管理、負載均衡、叢集管理;

二、安全管理操作

1、操作權限

ZooKeeper的節點有5種操作權限:CREATE(增)、READ(查)、WRITE(改)、DELETE(删)、ADMIN(管理)等相關權限,這5種權限集合可以簡寫為crwda,每個單詞的首字元拼接而成。

2、認證方式:

  • world

預設方式,開放的權限,意解為全世界都能随意通路。

  • auth

已經授權且認證通過的使用者才可以通路。

  • digest

使用者名:密碼方式認證,實際業務開發中最常用的方式。

  • IP白名單

授權指定的Ip位址,和指定的權限點,控制通路。

3、Digest授權流程

  • 添加認證使用者

addauth digest 使用者名:密碼

  • 設定權限

setAcl /path auth:使用者名:密碼:權限

  • 檢視Acl設定

getAcl /path

  • 完整操作流程
-- 添加授權使用者
[zk: localhost:2181] addauth digest smile:123456
-- 建立節點
[zk: localhost:2181] create /cicada cicada
-- 節點授權
[zk: localhost:2181] setAcl /cicada auth:smile:123456:cdrwa
-- 檢視授權
[zk: localhost:2181] getAcl /cicada           

三、整合 SpringBoot2 架構

1、核心依賴

Curator是Apache開源的一個Zookeeper用戶端連接配接和操作的元件,Curator架構在Zookeeper原生API接口上進行二次包裝。提供ZooKeeper各種應用場景:比如:分布式鎖服務、叢集上司選舉、共享計數器、緩存機制、分布式隊列等API封裝。

<dependency>
    <groupId>org.apache.curator</groupId>
    <artifactId>curator-framework</artifactId>
    <version>2.12.0</version>
</dependency>
<dependency>
    <groupId>org.apache.curator</groupId>
    <artifactId>curator-recipes</artifactId>
    <version>2.12.0</version>
</dependency>
<dependency>
    <groupId>org.apache.curator</groupId>
    <artifactId>curator-client</artifactId>
    <version>2.12.0</version>
</dependency>           

2、Zookeeper參數

zoo:
  keeper:
    #開啟标志
    enabled: true
    #伺服器位址
    server: 127.0.0.1:2181
    #命名空間,被稱為ZNode
    namespace: cicada
    #權限控制,加密
    digest: smile:123456
    #會話逾時時間
    sessionTimeoutMs: 3000
    #連接配接逾時時間
    connectionTimeoutMs: 60000
     #最大重試次數
    maxRetries: 2
    #初始休眠時間
    baseSleepTimeMs: 1000           

3、服務初始化配置

@Configuration
public class ZookeeperConfig {
    private static final Logger LOGGER = LoggerFactory.getLogger(ZookeeperConfig.class) ;
    @Resource
    private ZookeeperParam zookeeperParam ;
    private static CuratorFramework client = null ;
    /**
     * 初始化
     */
    @PostConstruct
    public void init (){
        //重試政策,初試時間1秒,重試10次
        RetryPolicy policy = new ExponentialBackoffRetry(
                zookeeperParam.getBaseSleepTimeMs(),
                zookeeperParam.getMaxRetries());
        //通過工廠建立Curator
        client = CuratorFrameworkFactory.builder()
                .connectString(zookeeperParam.getServer())
                .authorization("digest",zookeeperParam.getDigest().getBytes())
                .connectionTimeoutMs(zookeeperParam.getConnectionTimeoutMs())
                .sessionTimeoutMs(zookeeperParam.getSessionTimeoutMs())
                .retryPolicy(policy).build();
        //開啟連接配接
        client.start();
        LOGGER.info("zookeeper 初始化完成...");
    }
    public static CuratorFramework getClient (){
        return client ;
    }
    public static void closeClient (){
        if (client != null){
            client.close();
        }
    }
}           

4、封裝系列接口

public interface ZookeeperService {
    /**
     * 判斷節點是否存在
     */
    boolean isExistNode (final String path) ;
    /**
     * 建立節點
     */
    void createNode (CreateMode mode,String path ) ;
    /**
     * 設定節點資料
     */
    void setNodeData (String path, String nodeData) ;
    /**
     * 建立節點
     */
    void createNodeAndData (CreateMode mode, String path , String nodeData) ;
    /**
     * 擷取節點資料
     */
    String getNodeData (String path) ;
    /**
     * 擷取節點下資料
     */
    List<String> getNodeChild (String path) ;
    /**
     * 是否遞歸删除節點
     */
    void deleteNode (String path,Boolean recursive) ;
    /**
     * 擷取讀寫鎖
     */
    InterProcessReadWriteLock getReadWriteLock (String path) ;
}           

5、接口實作

@Service
public class ZookeeperServiceImpl implements ZookeeperService {
    private static final Logger LOGGER = LoggerFactory.getLogger(ZookeeperServiceImpl.class);
    @Override
    public boolean isExistNode(String path) {
        CuratorFramework client = ZookeeperConfig.getClient();
        client.sync() ;
        try {
            Stat stat = client.checkExists().forPath(path);
            return client.checkExists().forPath(path) != null;
        } catch (Exception e) {
            LOGGER.error("isExistNode error...", e);
            e.printStackTrace();
        }
        return false;
    }
    @Override
    public void createNode(CreateMode mode, String path) {
        CuratorFramework client = ZookeeperConfig.getClient() ;
        try {
            // 遞歸建立所需父節點
            client.create().creatingParentsIfNeeded().withMode(mode).forPath(path);
        } catch (Exception e) {
            LOGGER.error("createNode error...", e);
            e.printStackTrace();
        }
    }
    @Override
    public void setNodeData(String path, String nodeData) {
        CuratorFramework client = ZookeeperConfig.getClient() ;
        try {
            // 設定節點資料
            client.setData().forPath(path, nodeData.getBytes("UTF-8"));
        } catch (Exception e) {
            LOGGER.error("setNodeData error...", e);
            e.printStackTrace();
        }
    }
    @Override
    public void createNodeAndData(CreateMode mode, String path, String nodeData) {
        CuratorFramework client = ZookeeperConfig.getClient() ;
        try {
            // 建立節點,關聯資料
            client.create().creatingParentsIfNeeded().withMode(mode)
                  .forPath(path,nodeData.getBytes("UTF-8"));
        } catch (Exception e) {
            LOGGER.error("createNode error...", e);
            e.printStackTrace();
        }
    }
    @Override
    public String getNodeData(String path) {
        CuratorFramework client = ZookeeperConfig.getClient() ;
        try {
            // 資料讀取和轉換
            byte[] dataByte = client.getData().forPath(path) ;
            String data = new String(dataByte,"UTF-8") ;
            if (StringUtils.isNotEmpty(data)){
                return data ;
            }
        }catch (Exception e) {
            LOGGER.error("getNodeData error...", e);
            e.printStackTrace();
        }
        return null;
    }
    @Override
    public List<String> getNodeChild(String path) {
        CuratorFramework client = ZookeeperConfig.getClient() ;
        List<String> nodeChildDataList = new ArrayList<>();
        try {
            // 節點下資料集
            nodeChildDataList = client.getChildren().forPath(path);
        } catch (Exception e) {
            LOGGER.error("getNodeChild error...", e);
            e.printStackTrace();
        }
        return nodeChildDataList;
    }
    @Override
    public void deleteNode(String path, Boolean recursive) {
        CuratorFramework client = ZookeeperConfig.getClient() ;
        try {
            if(recursive) {
                // 遞歸删除節點
                client.delete().guaranteed().deletingChildrenIfNeeded().forPath(path);
            } else {
                // 删除單個節點
                client.delete().guaranteed().forPath(path);
            }
        } catch (Exception e) {
            LOGGER.error("deleteNode error...", e);
            e.printStackTrace();
        }
    }
    @Override
    public InterProcessReadWriteLock getReadWriteLock(String path) {
        CuratorFramework client = ZookeeperConfig.getClient() ;
        // 寫鎖互斥、讀寫互斥
        InterProcessReadWriteLock readWriteLock = new InterProcessReadWriteLock(client, path);
        return readWriteLock ;
    }
}           

6、基于Swagger2接口

@Api("Zookeeper接口管理")
@RestController
public class ZookeeperApi {
    @Resource
    private ZookeeperService zookeeperService ;
    @ApiOperation(value="查詢節點資料")
    @GetMapping("/getNodeData")
    public String getNodeData (String path) {
        return zookeeperService.getNodeData(path) ;
    }
    @ApiOperation(value="判斷節點是否存在")
    @GetMapping("/isExistNode")
    public boolean isExistNode (final String path){
        return zookeeperService.isExistNode(path) ;
    }
    @ApiOperation(value="建立節點")
    @GetMapping("/createNode")
    public String createNode (CreateMode mode, String path ){
        zookeeperService.createNode(mode,path) ;
        return "success" ;
    }
    @ApiOperation(value="設定節點資料")
    @GetMapping("/setNodeData")
    public String setNodeData (String path, String nodeData) {
        zookeeperService.setNodeData(path,nodeData) ;
        return "success" ;
    }
    @ApiOperation(value="建立并設定節點資料")
    @GetMapping("/createNodeAndData")
    public String createNodeAndData (CreateMode mode, String path , String nodeData){
        zookeeperService.createNodeAndData(mode,path,nodeData) ;
        return "success" ;
    }
    @ApiOperation(value="遞歸擷取節點資料")
    @GetMapping("/getNodeChild")
    public List<String> getNodeChild (String path) {
        return zookeeperService.getNodeChild(path) ;
    }
    @ApiOperation(value="是否遞歸删除節點")
    @GetMapping("/deleteNode")
    public String deleteNode (String path,Boolean recursive) {
        zookeeperService.deleteNode(path,recursive) ;
        return "success" ;
    }
}           

四、源代碼位址

GitHub·位址
https://github.com/cicadasmile/middle-ware-parent
GitEE·位址
https://gitee.com/cicadasmile/middle-ware-parent