Yoho-Documents / Share · Commits

Go to a project

Authored by FengRuwei
Commit d070356557b40b8bbd3000e58dbbc06dc30635d7 1 parent 0b1379f1

update

Inline Side-by-side
Showing 1 changed file with 220 additions and 220 deletions
1 -# Zookeeper & Curator 服务注册  
2 -  
3 -curator是最简单的Zookeeper客户端  
4 -####Curator主要组件  
5 -+ Recipes (扩展:包括分布式锁、队列、选举等)  
6 -+ Framework (框架)  
7 -+ Utilities (工具)  
8 -+ Client (客户端)  
9 -+ Errors (错误处理)  
10 -  
11 -另外Curator提供了一些扩展库，比如用于服务注册的curator-x-discovery，yohobuy_core模块中核心的服务注册机制也是基于curator的discovery库。  
12 -  
13 -之前写过yoho的服务注册和发现模块的大致流程和类图分析，但未涉及到具体的服务注册过程，本文主要对服务注册进行简单的学习。  
14 -首先主要学习的是使用Curator进行简单的服务注册与发现，后面结合yohobuy_core的服务注册实现进一步学习。  
15 -  
16 -### 服务定义 ServiceInstance  
17 -Curator 中使用可以使用ServiceInstance作为服务定义对象  
18 -通常一个服务对象具有服务名、服务id、地址、端口和有效数据等属性，  
19 -下面就是ServiceInstance类的变量定义。  
20 -```java  
21 -public class ServiceInstance<T> {  
22 - private final String name;  
23 - private final String id;  
24 - private final String address;  
25 - private final Integer port;  
26 - private final Integer sslPort;  
27 - private final T payload;  
28 - private final long registrationTimeUTC;  
29 - private final ServiceType serviceType;  
30 - private final UriSpec uriSpec;  
31 - ...  
32 -}  
33 -```  
34 -服务注册过程就是将ServiceInstance实例写到Zookeeper层次结构中，服务名name会生成一个ZkNode,id会生成这个name下孩子节点，因为同一个服务名下面可以有很多具体的服务实例，所以这种情况下会有很多个id。在注册的时候会指定根路径，所以注册之后的服务在zookeeper中如下图所示  
35 -```  
36 -根路径(注册时指定)  
37 -|_____name1 //服务名1  
38 -| |______id1->序列化ServiceInstance1  
39 -| |______id2->序列化ServiceInstance2  
40 -|  
41 -|_____name2 //服务名2  
42 -| |______id1->序列化ServiceInstance1  
43 -| |______id2->序列化ServiceInstance2  
44 -|  
45 -```  
46 -可以先通过客户端连接到本地zookeeper查看下yoho的服务注册情况，其注册在/yoho/services/路径下，会发现有很多服务，再进服务查看可以看到这个服务下有多少个实例，其节点为其id(yoho_core中服务未设置id，使用的是默认生成的一大串字符串)。  
47 -要注意到是服务在注册时生成的name服务名节点是持久的节点，而服务名下面的实例id节点是临时节点，在注册服务的程序退出之后，其也会消失。  
48 -  
49 -构造服务实例的方法很简单，可以通过ServiceInstance的build方法进行建造。  
50 -在练习中定义了一个简单的服务业务类XServInstance  
51 -``` java  
52 -public class XServInstance implements Serializable{  
53 - private String id;  
54 - private String name;  
55 - private String path;  
56 - get&set()...  
57 -}  
58 -  
59 -```  
60 -建造ServiceInstance的代码如下:  
61 -```java  
62 -ServiceInstance<XServInstance> serviceInstance= ServiceInstance.<XServInstance>builder()  
63 - .id(instance.getId())  
64 - .name(instance.getName())  
65 - .payload(instance).build();  
66 -  
67 -```  
68 -### 服务注册 ServiceDiscovery  
69 -Curator使用ServiceDiscovery进行服务注册，可以把它认为是服务管理中心，通过它也能查找我们的服务。ServiceDiscovery同样采用建造者方式，由ServiceDiscoveryBuilder进行构造,在构造完成之后需要调用start方法！SERV_PAHT指定我们服务需要注册在zookeeper的哪个目录  
70 -```java  
71 -JsonInstanceSerializer<XServInstance> serializer=new JsonInstanceSerializer<XServInstance>(XServInstance.class);  
72 -serviceDiscovery= ServiceDiscoveryBuilder.builder(XServInstance.class)  
73 - .basePath(SERV_PATH)  
74 - .client(client)  
75 - .serializer(serializer)  
76 - .build();  
77 -serviceDiscovery.start();  
78 -  
79 -```  
80 -client是curator的zookeeper客户端，通过下面方式构造:  
81 -```java  
82 -RetryPolicy retryPolicy=new RetryOneTime(1000);  
83 -//CONNECT_STR : "127.0.0.1:2181"  
84 -client= CuratorFrameworkFactory.newClient(CONNECT_STR,retryPolicy);  
85 -client.start()//必须调用  
86 -  
87 -```  
88 -注册服务的代码就一行:  
89 -```java  
90 -serviceDiscovery.registerService(serviceInstance);  
91 -```  
92 -此时服务已注册，在程序未退出时查看SERV_PATH下的内容即注册服务serviceInstance的name，再下一层就是id了，如果同一个服务注册了多个，则会有多个id(注册id相同只会有一个)。退出程序之后，由其注册的id也就没了。  
93 -ServiceDiscovery除了注册服务，同时也能查询服务，其三个主要的查询方法如下:  
94 -  
95 -+ Collection<String> queryForNames() //查询所有服务名  
96 -+ Collection<ServiceInstance<T>> queryForInstances(String name) //查询指定服务名下的所有服务实例  
97 -+ ServiceInstance<T> queryForInstance(String name, String id) //根据服务名和id查询服务实例  
98 -  
99 -  
100 -  
101 -  
102 -### 服务提供 ServiceProvider  
103 -这一步是Curator自带的服务提供方式，在yoho_core中并未采用自带的服务提供者，而是通过ServiceDiscovery查询(queryForInstances)到服务之后，通过自己的策略进行服务选择(后期待续)。这里直接使用curator现成的服务提供者。  
104 -  
105 -服务提供者的构造通过serviceDiscovery内部的建造者方法进行构造，同样必须先start()  
106 -需要注意的是providerStrategy的提供策略，对服务提供者设置一个服务选择策略，因为同一个服务名下有很多具体服务实例，具体选择哪一个可以由该策略决定：  
107 -常用的有RoundRobinStrategy 轮询，RandomStrategy 随机选择 ，StickyStrategy 粘性策略(总是选择同一个，没试过比较特殊，可能适用于某些服务调用者和提供者需要记录什么调用记录的情况下吧)  
108 -```java  
109 -ServiceProvider servPro = serviceDiscovery.serviceProviderBuilder()  
110 - .serviceName(servName)  
111 - .providerStrategy(new RoundRobinStrategy<XServInstance>())  
112 - .build();  
113 -servPro.start();  
114 -```  
115 -获取一个服务通过以下方式进行获取  
116 -```java  
117 -ServiceInstance<XServInstance> serviceInstance=servPro.getInstance();  
118 -```  
119 -  
120 -yoho_core内的CuratorXDiscoveryClientWrapper用来选择服务，其用到了ServiceCache，本文描述的方式不同，待下次学习分解...  
121 -  
122 -最后附上本练习简单的服务注册中心代码和测试代码  
123 -## XServCenter  
124 -```java  
125 -public class XServCenter {  
126 - public static final String SERV_PATH="/myServices";  
127 - ServiceDiscovery<XServInstance> serviceDiscovery ;  
128 - Map<String,ServiceProvider> providerMap=new HashMap<String, ServiceProvider>();  
129 -  
130 - public void init(CuratorFramework client) throws Exception {  
131 - JsonInstanceSerializer<XServInstance> serializer=new JsonInstanceSerializer<XServInstance>(XServInstance.class);  
132 - serviceDiscovery= ServiceDiscoveryBuilder.builder(XServInstance.class)  
133 - .basePath(SERV_PATH)  
134 - .client(client)  
135 - .serializer(serializer)  
136 - .build();  
137 - serviceDiscovery.start();  
138 - }  
139 -  
140 - public void regist(XServInstance instance) throws Exception {  
141 - ServiceInstance<XServInstance> serviceInstance= ServiceInstance.<XServInstance>builder()  
142 - .id(instance.getId())  
143 - .name(instance.getName())  
144 - .payload(instance).build();  
145 - serviceDiscovery.registerService(serviceInstance);  
146 -  
147 - }  
148 -  
149 - public void list() throws Exception {  
150 - Collection<String> servNames=serviceDiscovery.queryForNames();  
151 - for(String servName:servNames){  
152 - Collection<ServiceInstance<XServInstance>> instances=serviceDiscovery.queryForInstances("/"+servName);  
153 - System.out.println(servName);  
154 - for(ServiceInstance<XServInstance> instance:instances){  
155 - System.out.println("------- : "+instance.getId());  
156 - }  
157 -  
158 - }  
159 - }  
160 -  
161 - public void getServiceByName(String servName) throws Exception {  
162 - ServiceProvider servPro =providerMap.get(servName);  
163 - if (servPro==null) {  
164 - servPro = serviceDiscovery.serviceProviderBuilder()  
165 - .serviceName(servName) //RandomStrategy StickyStrategy  
166 - .providerStrategy(new RoundRobinStrategy<XServInstance>())  
167 - .build();  
168 - servPro.start();  
169 - providerMap.put(servName,servPro);  
170 - }  
171 - ServiceInstance<XServInstance> serviceInstance=servPro.getInstance();  
172 - System.out.println("getServiceByName "+serviceInstance.getId());  
173 - }  
174 -  
175 -```  
176 -  
177 -## Test  
178 -```java  
179 -public class ServTest {  
180 - public static final String CONNECT_STR="127.0.0.1:2181";  
181 - public static CuratorFramework client;  
182 - public static void main(String args[]) throws Exception {  
183 - RetryPolicy retryPolicy=new RetryOneTime(1000);  
184 - client= CuratorFrameworkFactory.newClient(CONNECT_STR,retryPolicy);  
185 - if(client==null) return;  
186 - client.start();  
187 - XServCenter xServCenter=new XServCenter();  
188 - xServCenter.init(client);  
189 - for(int i=0;i<10;i++) {  
190 - for(int j=0;j<10;j++) {  
191 - XServInstance xServInstance = new XServInstance();  
192 - xServInstance.setId("serv_id_" + i+"_"+j);  
193 - xServInstance.setName("serv_name_" + i);  
194 - xServCenter.regist(xServInstance);  
195 - }  
196 - }  
197 - System.out.println("#####list######");  
198 - xServCenter.list();  
199 -  
200 - for(int i=0;i<1000;i++) {  
201 - xServCenter.getServiceByName("serv_name_1");  
202 - Thread.sleep(500);  
203 - }  
204 -  
205 - Thread.sleep(600000);  
206 -  
207 - Runtime.getRuntime().addShutdownHook(new Thread(){  
208 - public void run() {  
209 - CloseableUtils.closeQuietly(client);  
210 - }  
211 - });  
212 - }  
213 -}  
214 -```  
215 -  
216 -  
217 -  
218 -  
219 -  
220 - 1 +# Zookeeper & Curator 服务注册
  2 +
  3 +curator是最简单的Zookeeper客户端
  4 +####Curator主要组件
  5 ++ Recipes (扩展:包括分布式锁、队列、选举等)
  6 ++ Framework (框架)
  7 ++ Utilities (工具)
  8 ++ Client (客户端)
  9 ++ Errors (错误处理)
  10 +
  11 +另外Curator提供了一些扩展库，比如用于服务注册的curator-x-discovery，yohobuy_core模块中核心的服务注册机制也是基于curator的discovery库。
  12 +
  13 +之前写过yoho的服务注册和发现模块的大致流程和类图分析，但未涉及到具体的服务注册过程，本文主要对服务注册进行简单的学习。
  14 +首先主要学习的是使用Curator进行简单的服务注册与发现，后面结合yohobuy_core的服务注册实现进一步学习。
  15 +
  16 +### 服务定义 ServiceInstance
  17 +Curator 中可以使用ServiceInstance作为服务定义对象
  18 +通常一个服务对象具有服务名、服务id、地址、端口和有效数据等属性，
  19 +下面就是ServiceInstance类的变量定义。
  20 +```java
  21 +public class ServiceInstance<T> {
  22 + private final String name;
  23 + private final String id;
  24 + private final String address;
  25 + private final Integer port;
  26 + private final Integer sslPort;
  27 + private final T payload;
  28 + private final long registrationTimeUTC;
  29 + private final ServiceType serviceType;
  30 + private final UriSpec uriSpec;
  31 + ...
  32 +}
  33 +```
  34 +服务注册过程就是将ServiceInstance实例写到Zookeeper层次结构中，服务名name会生成一个ZkNode,id会生成这个name下孩子节点，因为同一个服务名下面可以有很多具体的服务实例，所以这种情况下会有很多个id。在注册的时候会指定根路径，所以注册之后的服务在zookeeper中如下图所示
  35 +```
  36 +根路径(注册时指定)
  37 +|_____name1 //服务名1
  38 +| |______id1->序列化ServiceInstance1
  39 +| |______id2->序列化ServiceInstance2
  40 +|
  41 +|_____name2 //服务名2
  42 +| |______id1->序列化ServiceInstance1
  43 +| |______id2->序列化ServiceInstance2
  44 +|
  45 +```
  46 +可以先通过客户端连接到本地zookeeper查看下yoho的服务注册情况，其注册在/yoho/services/路径下，会发现有很多服务，再进服务查看可以看到这个服务下有多少个实例，其节点为其id(yoho_core中服务未设置id，使用的是默认生成的一大串字符串)。
  47 +要注意到是服务在注册时生成的name服务名节点是持久的节点，而服务名下面的实例id节点是临时节点，在注册服务的程序退出之后，其也会消失。
  48 +
  49 +构造服务实例的方法很简单，可以通过ServiceInstance的build方法进行建造。
  50 +在练习中定义了一个简单的服务业务类XServInstance
  51 +``` java
  52 +public class XServInstance implements Serializable{
  53 + private String id;
  54 + private String name;
  55 + private String path;
  56 + get&set()...
  57 +}
  58 +
  59 +```
  60 +建造ServiceInstance的代码如下:
  61 +```java
  62 +ServiceInstance<XServInstance> serviceInstance= ServiceInstance.<XServInstance>builder()
  63 + .id(instance.getId())
  64 + .name(instance.getName())
  65 + .payload(instance).build();
  66 +
  67 +```
  68 +### 服务注册 ServiceDiscovery
  69 +Curator使用ServiceDiscovery进行服务注册，可以把它认为是服务管理中心，通过它也能查找我们的服务。ServiceDiscovery同样采用建造者方式，由ServiceDiscoveryBuilder进行构造,在构造完成之后需要调用start方法！SERV_PAHT指定我们服务需要注册在zookeeper的哪个目录
  70 +```java
  71 +JsonInstanceSerializer<XServInstance> serializer=new JsonInstanceSerializer<XServInstance>(XServInstance.class);
  72 +serviceDiscovery= ServiceDiscoveryBuilder.builder(XServInstance.class)
  73 + .basePath(SERV_PATH)
  74 + .client(client)
  75 + .serializer(serializer)
  76 + .build();
  77 +serviceDiscovery.start();
  78 +
  79 +```
  80 +client是curator的zookeeper客户端，通过下面方式构造:
  81 +```java
  82 +RetryPolicy retryPolicy=new RetryOneTime(1000);
  83 +//CONNECT_STR : "127.0.0.1:2181"
  84 +client= CuratorFrameworkFactory.newClient(CONNECT_STR,retryPolicy);
  85 +client.start()//必须调用
  86 +
  87 +```
  88 +注册服务的代码就一行:
  89 +```java
  90 +serviceDiscovery.registerService(serviceInstance);
  91 +```
  92 +此时服务已注册，在程序未退出时查看SERV_PATH下的内容即注册服务serviceInstance的name，再下一层就是id了，如果同一个服务注册了多个，则会有多个id(注册id相同只会有一个)。退出程序之后，由其注册的id也就没了。
  93 +ServiceDiscovery除了注册服务，同时也能查询服务，其三个主要的查询方法如下:
  94 +
  95 ++ Collection<String> queryForNames() //查询所有服务名
  96 ++ Collection<ServiceInstance<T>> queryForInstances(String name) //查询指定服务名下的所有服务实例
  97 ++ ServiceInstance<T> queryForInstance(String name, String id) //根据服务名和id查询服务实例
  98 +
  99 +
  100 +
  101 +
  102 +### 服务提供 ServiceProvider
  103 +这一步是Curator自带的服务提供方式，在yoho_core中并未采用自带的服务提供者，而是通过ServiceDiscovery查询(queryForInstances)到服务之后，通过自己的策略进行服务选择(后期待续)。这里直接使用curator现成的服务提供者。
  104 +
  105 +服务提供者的构造通过serviceDiscovery内部的建造者方法进行构造，同样必须先start()
  106 +需要注意的是providerStrategy的提供策略，对服务提供者设置一个服务选择策略，因为同一个服务名下有很多具体服务实例，具体选择哪一个可以由该策略决定：
  107 +常用的有RoundRobinStrategy 轮询，RandomStrategy 随机选择 ，StickyStrategy 粘性策略(总是选择同一个，没试过比较特殊，可能适用于某些服务调用者和提供者需要记录什么调用记录的情况下吧)
  108 +```java
  109 +ServiceProvider servPro = serviceDiscovery.serviceProviderBuilder()
  110 + .serviceName(servName)
  111 + .providerStrategy(new RoundRobinStrategy<XServInstance>())
  112 + .build();
  113 +servPro.start();
  114 +```
  115 +获取一个服务通过以下方式进行获取
  116 +```java
  117 +ServiceInstance<XServInstance> serviceInstance=servPro.getInstance();
  118 +```
  119 +
  120 +yoho_core内的CuratorXDiscoveryClientWrapper用来选择服务，其用到了ServiceCache，本文描述的方式不同，待下次学习分解...
  121 +
  122 +最后附上本练习简单的服务注册中心代码和测试代码
  123 +## XServCenter
  124 +```java
  125 +public class XServCenter {
  126 + public static final String SERV_PATH="/myServices";
  127 + ServiceDiscovery<XServInstance> serviceDiscovery ;
  128 + Map<String,ServiceProvider> providerMap=new HashMap<String, ServiceProvider>();
  129 +
  130 + public void init(CuratorFramework client) throws Exception {
  131 + JsonInstanceSerializer<XServInstance> serializer=new JsonInstanceSerializer<XServInstance>(XServInstance.class);
  132 + serviceDiscovery= ServiceDiscoveryBuilder.builder(XServInstance.class)
  133 + .basePath(SERV_PATH)
  134 + .client(client)
  135 + .serializer(serializer)
  136 + .build();
  137 + serviceDiscovery.start();
  138 + }
  139 +
  140 + public void regist(XServInstance instance) throws Exception {
  141 + ServiceInstance<XServInstance> serviceInstance= ServiceInstance.<XServInstance>builder()
  142 + .id(instance.getId())
  143 + .name(instance.getName())
  144 + .payload(instance).build();
  145 + serviceDiscovery.registerService(serviceInstance);
  146 +
  147 + }
  148 +
  149 + public void list() throws Exception {
  150 + Collection<String> servNames=serviceDiscovery.queryForNames();
  151 + for(String servName:servNames){
  152 + Collection<ServiceInstance<XServInstance>> instances=serviceDiscovery.queryForInstances("/"+servName);
  153 + System.out.println(servName);
  154 + for(ServiceInstance<XServInstance> instance:instances){
  155 + System.out.println("------- : "+instance.getId());
  156 + }
  157 +
  158 + }
  159 + }
  160 +
  161 + public void getServiceByName(String servName) throws Exception {
  162 + ServiceProvider servPro =providerMap.get(servName);
  163 + if (servPro==null) {
  164 + servPro = serviceDiscovery.serviceProviderBuilder()
  165 + .serviceName(servName) //RandomStrategy StickyStrategy
  166 + .providerStrategy(new RoundRobinStrategy<XServInstance>())
  167 + .build();
  168 + servPro.start();
  169 + providerMap.put(servName,servPro);
  170 + }
  171 + ServiceInstance<XServInstance> serviceInstance=servPro.getInstance();
  172 + System.out.println("getServiceByName "+serviceInstance.getId());
  173 + }
  174 +
  175 +```
  176 +
  177 +## Test
  178 +```java
  179 +public class ServTest {
  180 + public static final String CONNECT_STR="127.0.0.1:2181";
  181 + public static CuratorFramework client;
  182 + public static void main(String args[]) throws Exception {
  183 + RetryPolicy retryPolicy=new RetryOneTime(1000);
  184 + client= CuratorFrameworkFactory.newClient(CONNECT_STR,retryPolicy);
  185 + if(client==null) return;
  186 + client.start();
  187 + XServCenter xServCenter=new XServCenter();
  188 + xServCenter.init(client);
  189 + for(int i=0;i<10;i++) {
  190 + for(int j=0;j<10;j++) {
  191 + XServInstance xServInstance = new XServInstance();
  192 + xServInstance.setId("serv_id_" + i+"_"+j);
  193 + xServInstance.setName("serv_name_" + i);
  194 + xServCenter.regist(xServInstance);
  195 + }
  196 + }
  197 + System.out.println("#####list######");
  198 + xServCenter.list();
  199 +
  200 + for(int i=0;i<1000;i++) {
  201 + xServCenter.getServiceByName("serv_name_1");
  202 + Thread.sleep(500);
  203 + }
  204 +
  205 + Thread.sleep(600000);
  206 +
  207 + Runtime.getRuntime().addShutdownHook(new Thread(){
  208 + public void run() {
  209 + CloseableUtils.closeQuietly(client);
  210 + }
  211 + });
  212 + }
  213 +}
  214 +```
  215 +
  216 +
  217 +
  218 +
  219 +
  220 +