文章目录


Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_ide

源码环境搭建

有一天大佬问我看过zk的源码吗…?

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_zookeeper_02

好的好的 谁说不看呢

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_zookeeper_03

说干就干


clone source

​https://github.com/apache/zookeeper​

当然了,我要看 3.5.8这个版本的

​https://github.com/apache/zookeeper/tree/branch-3.5.8​

Clone ---- HTTPS

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_zookeeper_04

IDEA里

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_zk源码搭建_05

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_ide_06

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_zookeeper_07

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_ide_08

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_zk源码搭建_09


源码结构

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_java_10


启动

查找启动类

根据经验,从启动脚本中去找启动类 ,八成启动类中有个main方法

找启动脚本的 start方法

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_java_11

找到 ​​ZOOMAIN="org.apache.zookeeper.server.quorum.QuorumPeerMain"​

​ZOOCFG="$2"​​ 可知是通过外部传参进来的,那就按照约定的来吧


配置文件

从 zoo_sample.cfg copy一个出来

# The number of milliseconds of each tick
tickTime=2000
# The number of ticks that the initial
# synchronization phase can take
initLimit=10
# The number of ticks that can pass between
# sending a request and getting an acknowledgement
syncLimit=5
# the directory where the snapshot is stored.
# do not use /tmp for storage, /tmp here is just
# example sakes.
dataDir=D:\IdeaProjects\zookeeperSource\data\zk
# the port at which the clients will connect
clientPort=2181
# the maximum number of client connections.
# increase this if you need to handle more clients
#maxClientCnxns=60
#
# Be sure to read the maintenance section of the
# administrator guide before turning on autopurge.
#
# http://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_maintenance
#
# The number of snapshots to retain in dataDir
#autopurge.snapRetainCount=3
# Purge task interval in hours
# Set to "0" to disable auto purge feature
#autopurge.purgeInterval=1

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_zk源码搭建_12


pom文件调整

将zookeeper-server项目里pom.xml文件里依赖的包的scope为provided这一行全部注释掉 【jline除外】


log4j.properties

将conf文件夹里的log4j.properties文件复制一份到zookeeper-server项目的 \target\classes 目录下,不然没有日志

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_zookeeper_13


以源码的方式启动Server

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_java_14

2020-11-27 11:13:47,849 [myid:] - INFO  [main:QuorumPeerConfig@135] - Reading configuration from: D:\IdeaProjects\zookeeperSource\conf\zoo.cfg
2020-11-27 11:13:47,858 [myid:] - WARN [main:VerifyingFileFactory@59] - D:IdeaProjectszookeeperSourcedata is relative. Prepend .\ to indicate that you're sure!
2020-11-27 11:13:47,870 [myid:] - INFO [main:QuorumPeerConfig@387] - clientPortAddress is 0.0.0.0:2181
2020-11-27 11:13:47,872 [myid:] - INFO [main:QuorumPeerConfig@391] - secureClientPort is not set
2020-11-27 11:13:47,876 [myid:] - INFO [main:DatadirCleanupManager@78] - autopurge.snapRetainCount set to 3
2020-11-27 11:13:47,876 [myid:] - INFO [main:DatadirCleanupManager@79] - autopurge.purgeInterval set to 0
2020-11-27 11:13:47,876 [myid:] - INFO [main:DatadirCleanupManager@101] - Purge task is not scheduled.
2020-11-27 11:13:47,876 [myid:] - WARN [main:QuorumPeerMain@125] - Either no config or no quorum defined in config, running in standalone mode
2020-11-27 11:13:47,882 [myid:] - INFO [main:ManagedUtil@45] - Log4j 1.2 jmx support found and enabled.
2020-11-27 11:13:47,951 [myid:] - INFO [main:QuorumPeerConfig@135] - Reading configuration from: D:\IdeaProjects\zookeeperSource\conf\zoo.cfg
2020-11-27 11:13:47,951 [myid:] - WARN [main:VerifyingFileFactory@59] - D:IdeaProjectszookeeperSourcedata is relative. Prepend .\ to indicate that you're sure!
2020-11-27 11:13:47,952 [myid:] - INFO [main:QuorumPeerConfig@387] - clientPortAddress is 0.0.0.0:2181
2020-11-27 11:13:47,952 [myid:] - INFO [main:QuorumPeerConfig@391] - secureClientPort is not set
2020-11-27 11:13:47,952 [myid:] - INFO [main:ZooKeeperServerMain@117] - Starting server
2020-11-27 11:13:47,955 [myid:] - INFO [main:FileTxnSnapLog@115] - zookeeper.snapshot.trust.empty : false
2020-11-27 11:13:47,985 [myid:] - INFO [main:Environment@109] - Server environment:zookeeper.version=1.0.0-1, built on 2020-11-27
2020-11-27 11:13:47,987 [myid:] - INFO [main:Environment@109] - Server environment:host.name=LAPTOP-JF3RBRRJ
2020-11-27 11:13:47,987 [myid:] - INFO [main:Environment@109] - Server environment:java.version=1.8.0_261
2020-11-27 11:13:47,987 [myid:] - INFO [main:Environment@109] - Server environment:java.vendor=Oracle Corporation
2020-11-27 11:13:47,987 [myid:] - INFO [main:Environment@109] - Server environment:java.home=D:\Program Files (x86)\Java\jdk1.8.0_261\jre
2020-11-27 11:13:47,987 [myid:] - INFO [main:Environment@109] - Server environment:java.class.path=D:\Program Files
......
......
......
2020-11-27 11:13:47,987 [myid:] - INFO [main:Environment@109] - Server environment:java.io.tmpdir=C:\Users\artisan\AppData\Local\Temp\
2020-11-27 11:13:47,987 [myid:] - INFO [main:Environment@109] - Server environment:java.compiler=<NA>
2020-11-27 11:13:47,987 [myid:] - INFO [main:Environment@109] - Server environment:os.name=Windows 10
2020-11-27 11:13:47,988 [myid:] - INFO [main:Environment@109] - Server environment:os.arch=amd64
2020-11-27 11:13:47,988 [myid:] - INFO [main:Environment@109] - Server environment:os.version=10.0
2020-11-27 11:13:47,988 [myid:] - INFO [main:Environment@109] - Server environment:user.name=artisan
2020-11-27 11:13:47,988 [myid:] - INFO [main:Environment@109] - Server environment:user.home=C:\Users\artisan
2020-11-27 11:13:47,988 [myid:] - INFO [main:Environment@109] - Server environment:user.dir=D:\IdeaProjects\zookeeperSource
2020-11-27 11:13:47,988 [myid:] - INFO [main:Environment@109] - Server environment:os.memory.free=222MB
2020-11-27 11:13:47,988 [myid:] - INFO [main:Environment@109] - Server environment:os.memory.max=3499MB
2020-11-27 11:13:47,988 [myid:] - INFO [main:Environment@109] - Server environment:os.memory.total=236MB
2020-11-27 11:13:47,990 [myid:] - INFO [main:ZooKeeperServer@938] - minSessionTimeout set to 4000
2020-11-27 11:13:47,990 [myid:] - INFO [main:ZooKeeperServer@947] - maxSessionTimeout set to 40000
2020-11-27 11:13:47,991 [myid:] - INFO [main:ZooKeeperServer@166] - Created server with tickTime 2000 minSessionTimeout 4000 maxSessionTimeout 40000 datadir D:IdeaProjectszookeeperSourcedata\version-2 snapdir D:IdeaProjectszookeeperSourcedata\version-2
2020-11-27 11:13:48,014 [myid:] - INFO [main:Log@169] - Logging initialized @433ms to org.eclipse.jetty.util.log.Slf4jLog
2020-11-27 11:13:48,167 [myid:] - WARN [main:ContextHandler@1520] - o.e.j.s.ServletContextHandler@215be6bb{/,null,UNAVAILABLE} contextPath ends with /*
2020-11-27 11:13:48,167 [myid:] - WARN [main:ContextHandler@1531] - Empty contextPath
2020-11-27 11:13:48,182 [myid:] - INFO [main:Server@359] - jetty-9.4.24.v20191120; built: 2019-11-20T21:37:49.771Z; git: 363d5f2df3a8a28de40604320230664b9c793c16; jvm 1.8.0_261-b12
2020-11-27 11:13:48,223 [myid:] - INFO [main:DefaultSessionIdManager@333] - DefaultSessionIdManager workerName=node0
2020-11-27 11:13:48,223 [myid:] - INFO [main:DefaultSessionIdManager@338] - No SessionScavenger set, using defaults
2020-11-27 11:13:48,226 [myid:] - INFO [main:HouseKeeper@140] - node0 Scavenging every 660000ms
2020-11-27 11:13:48,235 [myid:] - INFO [main:ContextHandler@825] - Started o.e.j.s.ServletContextHandler@215be6bb{/,null,AVAILABLE}
2020-11-27 11:13:48,462 [myid:] - INFO [main:AbstractConnector@330] - Started ServerConnector@17f6480{HTTP/1.1,[http/1.1]}{0.0.0.0:8080}
2020-11-27 11:13:48,463 [myid:] - INFO [main:Server@399] - Started @882ms
2020-11-27 11:13:48,463 [myid:] - INFO [main:JettyAdminServer@112] - Started AdminServer on address 0.0.0.0, port 8080 and command URL /commands
2020-11-27 11:13:48,468 [myid:] - INFO [main:ServerCnxnFactory@135] - Using org.apache.zookeeper.server.NIOServerCnxnFactory as server connection factory
2020-11-27 11:13:48,475 [myid:] - INFO [main:NIOServerCnxnFactory@673] - Configuring NIO connection handler with 10s sessionless connection timeout, 2 selector thread(s), 24 worker threads, and 64 kB direct buffers.
2020-11-27 11:13:48,481 [myid:] - INFO [main:NIOServerCnxnFactory@686] - binding to port 0.0.0.0/0.0.0.0:2181
2020-11-27 11:13:48,498 [myid:] - INFO [main:ZKDatabase@117] - zookeeper.snapshotSizeFactor = 0.33
2020-11-27 11:13:48,511 [myid:] - INFO [main:FileSnap@83] - Reading snapshot D:IdeaProjectszookeeperSourcedata\version-2\snapshot.0
2020-11-27 11:13:48,527 [myid:] - INFO [main:FileTxnSnapLog@404] - Snapshotting: 0x4 to D:IdeaProjectszookeeperSourcedata\version-2\snapshot.4
2020-11-27 11:13:48,547 [myid:] - INFO [main:ContainerManager@64] - Using checkIntervalMs=60000 maxPerMinute=10000

看重点

2020-11-27 11:13:48,463 [myid:] - INFO [main:Server@399] - Started @882ms

2020-11-27 11:13:48,481 [myid:] - INFO [main:NIOServerCnxnFactory@686] - binding to port 0.0.0.0/0.0.0.0:2181


以源码的方式启动Client

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_zk源码搭建_15

启动日志

Connecting to 127.0.0.1:2181
2020-11-27 11:05:41,288 [myid:] - INFO [main:Environment@109] - Client environment:zookeeper.version=1.0.0-1, built on 2020-11-27
2020-11-27 11:05:41,291 [myid:] - INFO [main:Environment@109] - Client environment:host.name=LAPTOP-JF3RBRRJ
2020-11-27 11:05:41,291 [myid:] - INFO [main:Environment@109] - Client environment:java.version=1.8.0_261
2020-11-27 11:05:41,292 [myid:] - INFO [main:Environment@109] - Client environment:java.vendor=Oracle Corporation
2020-11-27 11:05:41,292 [myid:] - INFO [main:Environment@109] - Client environment:java.home=D:\Program Files (x86)\Java\jdk1.8.0_261\jre
2020-11-27 11:05:41,292 [myid:] - INFO [main:Environment@109] - Client environment:java.class.path=D:\Program Files
..........
..........
..........
2020-11-27 11:05:41,293 [myid:] - INFO [main:Environment@109] - Client environment:java.io.tmpdir=C:\Users\artisan\AppData\Local\Temp\
2020-11-27 11:05:41,293 [myid:] - INFO [main:Environment@109] - Client environment:java.compiler=<NA>
2020-11-27 11:05:41,293 [myid:] - INFO [main:Environment@109] - Client environment:os.name=Windows 10
2020-11-27 11:05:41,293 [myid:] - INFO [main:Environment@109] - Client environment:os.arch=amd64
2020-11-27 11:05:41,293 [myid:] - INFO [main:Environment@109] - Client environment:os.version=10.0
2020-11-27 11:05:41,293 [myid:] - INFO [main:Environment@109] - Client environment:user.name=artisan
2020-11-27 11:05:41,293 [myid:] - INFO [main:Environment@109] - Client environment:user.home=C:\Users\artisan
2020-11-27 11:05:41,293 [myid:] - INFO [main:Environment@109] - Client environment:user.dir=D:\IdeaProjects\zookeeperSource
2020-11-27 11:05:41,293 [myid:] - INFO [main:Environment@109] - Client environment:os.memory.free=224MB
2020-11-27 11:05:41,294 [myid:] - INFO [main:Environment@109] - Client environment:os.memory.max=3499MB
2020-11-27 11:05:41,294 [myid:] - INFO [main:Environment@109] - Client environment:os.memory.total=236MB
2020-11-27 11:05:41,296 [myid:] - INFO [main:ZooKeeper@868] - Initiating client connection, connectString=127.0.0.1:2181 sessionTimeout=30000 watcher=org.apache.zookeeper.ZooKeeperMain$MyWatcher@22d8cfe0
2020-11-27 11:05:41,301 [myid:] - INFO [main:X509Util@79] - Setting -D jdk.tls.rejectClientInitiatedRenegotiation=true to disable client-initiated TLS renegotiation
2020-11-27 11:05:41,521 [myid:] - INFO [main:ClientCnxnSocket@237] - jute.maxbuffer value is 4194304 Bytes
2020-11-27 11:05:41,527 [myid:] - INFO [main:ClientCnxn@1653] - zookeeper.request.timeout value is 0. feature enabled=
Welcome to ZooKeeper!
JLine support is disabled
2020-11-27 11:05:41,539 [myid:127.0.0.1:2181] - INFO [main-SendThread(127.0.0.1:2181):ClientCnxn$SendThread@1112] - Opening socket connection to server kubernetes.docker.internal/127.0.0.1:2181. Will not attempt to authenticate using SASL (unknown error)
2020-11-27 11:05:41,540 [myid:127.0.0.1:2181] - INFO [main-SendThread(127.0.0.1:2181):ClientCnxn$SendThread@959] - Socket connection established, initiating session, client: /127.0.0.1:50568, server: kubernetes.docker.internal/127.0.0.1:2181
2020-11-27 11:05:41,562 [myid:127.0.0.1:2181] - INFO [main-SendThread(127.0.0.1:2181):ClientCnxn$SendThread@1394] - Session establishment complete on server kubernetes.docker.internal/127.0.0.1:2181, sessionid = 0x1004701bbe50000, negotiated timeout = 30000

WATCHER::

WatchedEvent state:SyncConnected type:None path:null

验证

在客户端执行ZK命令

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_java_16

好了基本完事儿

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_ide_17


遇到的问题

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_zookeeper_18

缺少Info接口

Info是用来发布的时候生成版本用的,正规的话,需要用 ​​org.apache.zookeeper.version.util.VerGen​​生成Info , 我们这里随便搞个就行了

package org.apache.zookeeper.version;

/**
* @author 小工匠
* @version 1.0
* @description: TODO
* @date 2020/11/27 9:54
* @mark: show me the code , change the world
*/
public interface Info {
int MAJOR = 1;
int MINOR = 0;
int MICRO = 0 ;

String QUALIFIER = null;
int REVISION = -1;
String REVISION_HASH = "1";
String BUILD_DATE = "2020-11-27";

}

缺少org.apache.zookeeper.data.ACL

重新编译 Jute序列化模块

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_java_19

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_zookeeper_20


Could not find artifact pl.project13.maven

Could not find artifact pl.project13.maven:git-commit-id-plugin:jar: in aliyunmaven (https://maven.aliyun.com/repository/central)

忽略即可

Apache ZooKeeper - 构建ZooKeeper源码环境及StandAlone模式下的服务端和客户端启动_zk源码搭建_21