Zookeeper学习笔记:简单注册中心

时间:2023-03-08 20:14:10
Zookeeper学习笔记:简单注册中心

zookeeper可以作为微服务注册中心,spring cloud也提供了zookeeper注册中心的支持。

本文介绍如何实现一个简单的zookeeper注册中心,主要的实现方式:

n个服务提供者对外提供http接口获取数据,这些服务提供者把自己的主机、端口信息注册到zookeeper的某个节点上面;

当服务提供者宕机或者服务不可用时,zookeeper节点会删除该提供者的信息;

消费者也连接zookeeper获取可以使用的服务提供者(并且会持续监听节点,节点变化时也会实时更新本地的服务提供者列表),然后发起http请求调用服务接口获取数据

下面简单介绍一下实现方式

1、UserService服务

后台用户管理服务web工程,使用spring mvc注解方式开发,不提供用户操作界面。提供http接口根据用户名获取用户信息,入参用户名字符串,响应为json类型,注册的服务名为UserService

2、UserAdminService服务

用户管理系统web工程,使用spring mvc注解方式开发,这是一个给用户使用的系统。提供登录页面、和首页,登录操作调用UserService提供的http接口根据用户输入的用户名获取用户信息,然后比对密码是否正确,服务名为UserAdminService

3、修改UserService服务工程

1)application.properties配置
 ## zookeeper集群地址
# zk.url=192.168.0.28:2181,192.168.0.29:2181,192.168.0.30:2181
zk.url=127.0.0.1:2181 ## 注册服务使用的二级路径名
service.name=UserService
## IP根据实际部署的服务器修改
server.hostname=127.0.0.1
## 端口根据实际监听端口修改
server.port=8080 ## 注册服务时会创建
## /services/${service.name}/${server.hostname}:${server.port}
## 这样一个临时节点,值为${service.name}

三个服务部署在一台服务器上,分别监听7070、8080、9090,可以使用server.port参数配置

2)ZookeeperRegister类

编写ZookeeperRegister类,根据zk集群地址、服务名、IP、端口等配置注册服务到zookeeper集群

  a)   读取application.properties文件,加载配置

  b)   zkRegist方法会在依赖注入完成后由spring容器调用

  c)   获取zk集群地址、服务名、IP、端口等配置

  d)   创建ZooKeeper对象,来注册服务,也就是在zookeeper创建一个临时节点

  e)   节点规则是: /services/${service.name}/${server.hostname}:${server.port},值为: ${service.name}

  f)    此类对象会被spring容器管理

3)ZookeeperRegister类代码
 @Component
@PropertySource("classpath:application.properties")
public class ZookeeperRegister { private ZooKeeper zkClient; @Autowired
private Environment env; @PostConstruct
public void zkRegist() throws IOException, KeeperException,
InterruptedException { // 获取配置信息
String zkUrl = env.getProperty("zk.url");
String serviceName = env.getProperty("service.name");
String hostName = env.getProperty("server.hostname");
int port = Integer.parseInt(env.getProperty("server.port")); // 创建ZooKeeper对象
// 超时时间为2分
zkClient = new ZooKeeper(zkUrl, 120000, new Watcher() {
@Override
public void process(WatchedEvent event) { }
}); // path = /services/${service.name}/${server.hostname}:${server.port}
// value = ${service.name} Stat exists = zkClient.exists("/services", false);
if (exists == null) {
zkClient.create("/services", "services".getBytes(),
Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT);
exists = zkClient.exists("/services/UserService", false);
if (exists == null) {
zkClient.create("/services/" + serviceName,
serviceName.getBytes(), Ids.OPEN_ACL_UNSAFE,
CreateMode.PERSISTENT);
}
}
// 创建znode节点
// 临时节点
zkClient.create("/services/" + serviceName + "/" + hostName + ":"
+ port, serviceName.getBytes(), Ids.OPEN_ACL_UNSAFE,
CreateMode.EPHEMERAL);
}
}

4、修改UserAdminService服务工程

1)application.properties配置
 ## zookeeper集群地址
# zk.url=192.168.0.28:2181,192.168.0.29:2181,192.168.0.30:2181
zk.url=127.0.0.1:2181
2)UserServiceImpl类

UserServiceImpl类实现Watcher和UserService接口,使用@Service标注,由spring容器管理

  a)    初始化方法中创建ZooKeeper对象,连接到zk集群

  b)    当ZooKeeper中服务提供者节点发生变化时调用getProviders方法重新获取可用的服务提供者

  c)    getUserByUsername方法先从当前可用的提供者集合中随机获取一个提供者,使用httpclient发送请求获取用户数据返回给调用者

把UserService注入到Controller即可使用

3)UserServiceImpl类代码
 @Service
@PropertySource("classpath:application.properties")
public class UserServiceImpl implements UserService, Watcher { private static Logger log = LoggerFactory.getLogger(UserServiceImpl.class); private static final String SERVICE_URL =
"/UserService/user/getUserByUsername?username=";
private static final String SERVICE_REGIST_PATH = "/services/UserService"; @Autowired
private Environment env; private ZooKeeper zkClient;
private List<String> providers = new ArrayList<String>(); @PostConstruct
public void init() {
String zkUrl = env.getProperty("zk.url");
try {
zkClient = new ZooKeeper(zkUrl, 120000, this);
} catch (IOException e) {
throw new RuntimeException(e.getMessage(), e);
}
} @Override
public User getUserByUsername(String username) { User user = null; // 获取一个可以使用的服务提供者
String provider = getProvider(); String url = "http://" + provider + SERVICE_URL + username; // 发送请求获取数据
CloseableHttpClient http = HttpClients.createDefault(); HttpGet httpGet = null;
CloseableHttpResponse response = null;
InputStream in = null; try {
// 构建httpget
httpGet = new HttpGet(new URI(url)); // 发送请求获取响应
response = http.execute(httpGet);
HttpEntity entity = response.getEntity(); // 获取输入流和数据字符串
in = entity.getContent();
String json = IOUtils.toString(in, "utf-8"); log.info(String.format("请求: %s, 响应: %s", url, json)); // 解析json字符串为user对象
user = json2User(json); } catch (URISyntaxException e) {
e.printStackTrace();
} catch (ClientProtocolException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
// 关闭输入流和响应对象
IOUtils.closeQuietly(in);
IOUtils.closeQuietly(response);
}
return user;
} @Override
public void process(WatchedEvent event) {
getProviders();
} private void getProviders() {
try {
this.providers = zkClient.getChildren(SERVICE_REGIST_PATH, true);
log.info(String.format("可用服务提供者: %s", this.providers));
} catch (KeeperException e) {
e.printStackTrace();
} catch (InterruptedException e) {
e.printStackTrace();
}
} private String getProvider() {
int size = this.providers.size();
Random r = new Random();
int i = r.nextInt(size);
String provider = this.providers.get(i);
log.info(String.format("可用服务提供者: %s, 随机获取提供者 [%s], 序号 [%s]",
this.providers, provider, i));
return provider;
} private User json2User(String json) {
ObjectMapper mapper = new ObjectMapper();
User user = null;
try {
user = mapper.readValue(json, User.class);
} catch (JsonParseException e) {
e.printStackTrace();
} catch (JsonMappingException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
return user;
}
}

5、部署测试

1)部署启动zookeeper

Zookeeper学习笔记:简单注册中心

2)服务部署

服务提供者和消费者是部署在同一台机器上面的,监听端口不同

部署三个UserService服务,修改server.port参数,分别监听7070、8080、9090

部署UserAdminService服务,我测试的时候和其中一个服务提供者部署在了同一个tomcat里面,监听9090

其中7070和8080的tomcat使用cmd命令行启动,9090的tomcat在eclipse里面启动便于观察服务消费者的日志

启动了三个tomcat之后可以看看zookeeper的变化

Zookeeper学习笔记:简单注册中心

另外,在UserAdminService服务的日志中可以看到当前可以使用的服务提供者列表

Zookeeper学习笔记:简单注册中心

访问一下http://localhost:9090/UserAdminWeb/login登录,可以看到后台程序获取到了一个可以使用的服务提供者,然后发起了http请求查询用户信息

Zookeeper学习笔记:简单注册中心

Zookeeper学习笔记:简单注册中心

Zookeeper学习笔记:简单注册中心

当某个服务提供者挂掉之后,可以看到消费者的日志,已经重新获取了提供者列表

Zookeeper学习笔记:简单注册中心

6、存在的一些问题

a)    服务提供者突然挂掉之后,zookeeper并不能马上删除该提供者的znode信息,所以在服务消费者这边还需要做一些优化,即发起请求获取用户信息时如果出现问题,应该从可用服务提供者列表删除该提供者信息

b)    服务消费者使用的httpclient发起请求,如果每次获取用户信息都去重新建立tcp连接,效率很低,所以需要使用连接池技术管理用于发起http请求的tcp连接

7、源码下载

https://files.cnblogs.com/files/xugf/Zookeeper%E6%B3%A8%E5%86%8C%E4%B8%AD%E5%BF%83%E6%BA%90%E7%A0%81.zip