osgi实战项目(osmp)一步一步玩转osgi之服务发现与服务路由(4)

<div class="iteye-blog-content-contain" style="font-size: 14px;">
<p>这一节里主要讲解osmp的服务发现与路由。osmp通过osmp-http组件对外发布了一个cxf的restful服务，所有的请求都通过这个restful这个接口接受请求并解析请求后再调用osgi的服务完成请求后返回到前端。</p>
<p> </p>
<p>request->osmp-http的restful接口->解析请求->osgi服务发现->服务路由->调用服务->返回-->组装返回参数->返回</p>
<p> </p>
<p>osmp通过osmp-service组件来对服务进行统一管理，主要功能包括服务的监听、bundle的监听、服务容器管理、服务注册到zookeeper等功能。</p>
<p> </p>
<p><span style="background-color: #ccffcc;">在osgi里可以通过<strong>ServiceTracker</strong> 服务跟踪器来跟踪某一类接口服务的新增、修改、删除等操作，通过BundlerContext.addBundleListener()注册 bundle监听器（<strong>BundleListener</strong>）来监听bundle各生命周期的事件，比如bundle的安装、卸载、更新、启动、停止等事件。</span></p>
<p> </p>
<p>osmp为了便于对服务的统一管理，<span style="background-color: #ffff99;">要求所有的服务都必须实现 osmp-intf-define里的定义的BaseDataService接口</span>。这样我们就可以通过服务跟踪器跟踪到BaseDataService接口的服务新增、修改、删除等事件！</p>
<p>具体代码可以参照osmp-service里 ServiceWatcher.java类</p>
<p> </p>
<pre name="code" class="java">/*
* Project: OSMP
* FileName: ServiceWatcher.java
* version: V1.0
*/
package com.osmp.service.watch;

import java.util.Date;
import java.util.UUID;

import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleEvent;
import org.osgi.framework.BundleListener;
import org.osgi.framework.ServiceReference;
import org.osgi.util.tracker.ServiceTracker;
import org.osgi.util.tracker.ServiceTrackerCustomizer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.osgi.context.BundleContextAware;
import org.springframework.util.Assert;

import com.osmp.intf.define.config.FrameConst;
import com.osmp.intf.define.interceptor.ServiceInterceptor;
import com.osmp.intf.define.service.BaseDataService;
import com.osmp.intf.define.service.ZookeeperService;
import com.osmp.service.bean.DataServiceInfo;
import com.osmp.service.bean.InterceptorInfo;
import com.osmp.service.factory.ServiceFactoryImpl;
import com.osmp.service.manager.ServiceStateManager;
import com.osmp.service.registration.ServiceContainer;
import com.osmp.service.util.ServiceUtil;
import com.osmp.utils.net.RequestInfoHelper;

/**
*
* Description:服务注册、注销、监听
* @author: wangkaiping
* @date: 2016年8月9日 上午10:27:15上午10:51:30
*/
public class ServiceWatcher implements BundleContextAware, InitializingBean, DisposableBean {
private Logger logger = LoggerFactory.getLogger(ServiceWatcher.class);

private ServiceTracker dataServiceTracker;
private ServiceTracker serviceInterceptorTracker;

private ServiceStateManager serviceStateManager;
private ServiceFactoryImpl serviceFactoryImpl;
private BundleContext context;
private ZookeeperService zookeeper;
private final static String NODE_CHANGE = "/osmp/nodechange";

@Override
public void setBundleContext(BundleContext context) {
this.context = context;
}

public void setServiceFactoryImpl(ServiceFactoryImpl serviceFactoryImpl) {
this.serviceFactoryImpl = serviceFactoryImpl;
}

public void setServiceStateManager(ServiceStateManager serviceStateManager) {
this.serviceStateManager = serviceStateManager;
}

public void setZookeeper(ZookeeperService zookeeper) {
this.zookeeper = zookeeper;
}

@Override
public void destroy() throws Exception {
if (dataServiceTracker != null) {
dataServiceTracker.close();
}
if (serviceInterceptorTracker != null) {
serviceInterceptorTracker.close();
}

logger.info("服务监听结束");
}

@Override
public void afterPropertiesSet() throws Exception {
Assert.notNull(context);
Assert.notNull(serviceStateManager);
Assert.notNull(serviceFactoryImpl);
dataServiceTracker = new ServiceTracker(context, BaseDataService.class.getName(),
new DataServiceTrackerCustomizer());
serviceInterceptorTracker = new ServiceTracker(context, ServiceInterceptor.class.getName(),
new ServiceInterceptorTrackerCustomizer());

dataServiceTracker.open(true);
serviceInterceptorTracker.open(true);

context.addBundleListener(new BundleListener() {

@Override
public void bundleChanged(BundleEvent event) {
if (event.getType() == BundleEvent.UNINSTALLED) {
String name = event.getBundle().getSymbolicName();
try {
logger.info("uninstall bundle " + name);
zookeeper.deleteNodeByBundle(name);
ServiceWatcher.this.nodeUpdate();
} catch (Exception e) {
logger.error(
"zookeeper delete service by bundle, bundle name : "
+ name, e);
}
}
}
});

logger.info("服务监听启动");
}

// dataService监听
private class DataServiceTrackerCustomizer implements ServiceTrackerCustomizer {
@Override
public Object addingService(ServiceReference reference) {
BaseDataService bsService = (BaseDataService) context.getService(reference);
String bundleName = reference.getBundle().getSymbolicName();
String bundleVersion = reference.getBundle().getVersion().toString();
Object name = reference.getProperty(FrameConst.SERVICE_NAME);
if (name == null || "".equals(name)) {
logger.error("组件" + bundleName + "(" + bundleVersion
+ ") dataService服务name未设置");
return bsService;
}
Object mark = reference.getProperty(FrameConst.SERVICE_MARK);
ServiceContainer.getInstance().putDataService(bundleName, bundleVersion, name.toString(), bsService);
DataServiceInfo info = new DataServiceInfo();
info.setBundle(bundleName);
info.setVersion(bundleVersion);
info.setName(name.toString());
info.setState(1);
info.setUpdateTime(new Date());
info.setMark(mark == null ? "" : mark.toString());
serviceStateManager.updateDataService(info);
String path = ZookeeperService.ROOT_PATH
+ ZookeeperService.SERVICE + "/"
+ RequestInfoHelper.getLocalIp() + "/";
logger.debug("register service path: " + path + " bundle : " + bundleName + " to zookeeper ");
ServiceWatcher.this.registerService(path, info);
return bsService;
}

@Override
public void modifiedService(ServiceReference reference, Object service) {
}

@Override
public void removedService(ServiceReference reference, Object service) {
String bundleName = reference.getBundle().getSymbolicName();
String bundleVersion = reference.getBundle().getVersion()
.toString();
Object name = reference.getProperty(FrameConst.SERVICE_NAME);
if (name == null || "".equals(name)) {
logger.error("组件" + bundleName + "(" + bundleVersion
+ ") dataService服务name未设置");
return;
}
ServiceContainer.getInstance().removeDataService(bundleName, bundleVersion, name.toString());
Object mark = reference.getProperty(FrameConst.SERVICE_MARK);
DataServiceInfo info = new DataServiceInfo();
info.setBundle(bundleName);
info.setVersion(bundleVersion);
info.setName(name.toString());
info.setState(0);
info.setMark(mark == null ? "" : mark.toString());
info.setUpdateTime(new Date());
serviceStateManager.updateDataService(info);
System.out.println("===============remove service bundleName:"
+ bundleName + " name: " + name.toString() + " mark: "
+ mark.toString());
String path = ZookeeperService.ROOT_PATH
+ ZookeeperService.SERVICE + "/"
+ RequestInfoHelper.getLocalIp() + "/";
ServiceWatcher.this.unRegisterService(path, info);
}

}

// ServiceInterceptor监听
private class ServiceInterceptorTrackerCustomizer implements ServiceTrackerCustomizer {
@Override
public Object addingService(ServiceReference reference) {
ServiceInterceptor sicpt = (ServiceInterceptor) context.getService(reference);
String bundleName = reference.getBundle().getSymbolicName();
String bundleVersion = reference.getBundle().getVersion().toString();
Object name = reference.getProperty(FrameConst.SERVICE_NAME);
if (name == null || "".equals(name)) {
logger.error("组件" + bundleName + "(" + bundleVersion
+ ") serviceInterceptor服务name未设置");
return sicpt;
}
Object mark = reference.getProperty(FrameConst.SERVICE_MARK);
ServiceContainer.getInstance().putInterceptor(
ServiceUtil.generateServiceName(bundleName, bundleVersion, name.toString()), sicpt);
InterceptorInfo info = new InterceptorInfo();
info.setBundle(bundleName);
info.setVersion(bundleVersion);
info.setName(name.toString());
info.setState(1);
info.setUpdateTime(new Date());
info.setMark(mark == null ? "" : mark.toString());
serviceStateManager.updateServiceInterceptor(info);
return sicpt;
}

@Override
public void modifiedService(ServiceReference reference, Object service) {
}

@Override
public void removedService(ServiceReference reference, Object service) {
String bundleName = reference.getBundle().getSymbolicName();
String bundleVersion = reference.getBundle().getVersion().toString();
Object name = reference.getProperty(FrameConst.SERVICE_NAME);
if (name == null || "".equals(name)) {
logger.error("组件" + bundleName + "(" + bundleVersion
+ ") serviceInterceptor服务name未设置");
return;
}
Object mark = reference.getProperty(FrameConst.SERVICE_MARK);
ServiceContainer.getInstance().removeInterceptor(
ServiceUtil.generateServiceName(bundleName, bundleVersion, name.toString()));
InterceptorInfo info = new InterceptorInfo();
info.setBundle(bundleName);
info.setVersion(bundleVersion);
info.setName(name.toString());
info.setState(0);
info.setMark(mark == null ? "" : mark.toString());
info.setUpdateTime(new Date());
serviceStateManager.updateServiceInterceptor(info);
}

}

/**
* 向zookeeper注册服务
*
* @param path
* @param ds
*/
public void registerService(String path, DataServiceInfo ds) {
String bundle = ds.getBundle();
String cname = ds.getMark();
String name = ds.getName();
String version = ds.getVersion();
String status = String.valueOf(ds.getState());
try {
if (!zookeeper.exists(path + name)) {
zookeeper.createNode(path + name);
}
if (!zookeeper.exists(path + name + "/bundle")) {
zookeeper.createNode(path + name + "/bundle", bundle);
} else {
zookeeper.setNodeData(path + name + "/bundle", bundle);
}
if (!zookeeper.exists(path + name + "/cname")) {
zookeeper.createNode(path + name + "/cname", cname);
} else {
zookeeper.setNodeData(path + name + "/cname", cname);
}
if (!zookeeper.exists(path + name + "/version")) {
zookeeper.createNode(path + name + "/version", version);
} else {
zookeeper.setNodeData(path + name + "/version", version);
}
if (!zookeeper.exists(path + name + "/status")) {
zookeeper.createNode(path + name + "/status", status);
} else {
zookeeper.setNodeData(path + name + "/status", status);
}
this.nodeUpdate();
} catch (Exception e) {
e.printStackTrace();
logger.error("zookeeper register service fail, service name : "
+ name, e);
}
}

/**
* 卸载服务
*
* @param path
* @param ds
*/
public void unRegisterService(String path, DataServiceInfo ds) {
String name = ds.getName();
try {
if (zookeeper.exists(path + name + "/status")) {
zookeeper.setNodeData(path + name + "/status",
String.valueOf(ds.getState()));
this.nodeUpdate();
}
} catch (Exception e) {
e.printStackTrace();
logger.error("zookeeper unRegister service fail, service name : "
+ name, e);
}
}

/**
* 更新节点状态变化
*/
public void nodeUpdate(){
String data = UUID.randomUUID().toString();
try {
if(zookeeper.exists(NODE_CHANGE)){
zookeeper.setNodeData(NODE_CHANGE, data);
}else{
zookeeper.createNode(NODE_CHANGE);
zookeeper.setNodeData(NODE_CHANGE, data);
}
} catch (Exception e) {
logger.error("更新节点变化状态错误", e);
}
}

}
</pre>
<p> </p>
<ol>
<li><span style="line-height: 21px;">ServiceWatcher 实现　BundleContextAware接口，将BundleContext 设置进来。</span></li>
<li><span style="line-height: 21px;">在ServiceWatcher初始化的时候 实例化了两个服务跟踪器 （ServiceTracker）分别用来跟踪 BaseDataService、ServiceInterceptor 两类接口的服务。</span></li>
<li><span style="line-height: 21px;">在ServiceWatcher初始化的时候 给BundleContext新增Bunlde监听用来监听bundle的事件</span></li>
<li><span style="line-height: 21px;">ServiceTracker需要传递一个ServiceTrackerCustomizer实例来具体执行监听的事件，在这里我们通过DataServiceTrackerCustomizer来具体执行BaseDataService接口服务跟踪操作。</span></li>
<li>
<span style="line-height: 21px;">当</span><span style="line-height: 21px;">BaseDataService 服务被发布到osgi容器里的时候，会自动调用DataServiceTrackerCustomizer.addingService(ServiceReference reference) 方法，通过BundleContext.getService(ServiceReference reference),我们可以获取到当前被发布到osgi容器里的服务。</span>
</li>
<li><span style="line-height: 21px;">通过获取bundleName、bundleVersion、以前发布服务时定义的tag标签（name）组成唯一的key(bundleName+bundleVersion+name) 以获取到service为value。将此保存到服务容器（Map）里。</span></li>
</ol>
<p>注：osmp-service里将监听到的服务同时保存到数据库里和注册到zookeeper请暂时忽略，稍后osmp注册中会作详细讲解。</p>
<p> </p>
<p>服务发现和路由：</p>
<p> </p>
<p>osmp-http接收到请求后解析服务名称，通过服务查询此服务是否绑定了拦截器，如果绑定了拦截器，则先执行拦截器链，拦截器如果执行失败则直接返回，如果拦截器执行成功则通过服务名称获取服务，获取服务成功后直接执行服务的execute方法，将并结果返回！</p>
<p> </p>
<p>这里讲的简单点儿，具体osmp封装了一层代理实现，有兴趣的可以直接查看osmp-http源码。</p>
<p> </p>
<p>至此osmp的服务发现和服务调用功能就讲到这里，如有不明白的地方欢迎加群：335898216交流</p>
<p> </p>
<p> </p>
<p> </p>
</div>