Venus开源remoting框架

wiki地址：http://wiki.hexnova.com/display/Venus/HOME

框架组成

(Venus service framework)+服务路由产品（Venus-Bus）+服务注册中心(Venus-Registry) 组合而成，提供远程服务。它着 开发简单、高性能、高并发能力 的服务端框架。

系统功能目标

• 提供高性能的服务通讯框架
• 具备性能监控（可以清晰的看到每个服务执行的时间、过长可以通过监控告警出去）
• 具备流量控制（每个服务每个时刻的调用次数、每天的峰值情况、）
• 访问控制（服务的授权控制）
• 提供可选择性服务数据缓存（cache支持，key采用表达式，由框架提供缓存支持，而不需要编写任何cache相关的代码）
• 提供框架进行再次研发能力，提供interceptor、validator等接口。
• 提供高性能的服务总线（Venus-Bus），能够轻易接入高性能的服务总线。（Venus-Bus项目支持，针对该venus的协议，以后接入服务总线轻而易举）

开发方面

• 服务接口定义清晰(接口、参数、校验、以及服务鉴权)
• 自动生成接口文档，以方便阅读接口声明
• 客户端框架快速开发、提供多种语言版本的客户端
• 提供3种服务调用方式（同步、异步、回调）
• 服务端框架提供多种协议提供服务，而不需要做额外的开发 

开发人员的关注点

1. 如何服务化

采用接口与实现分离，服务接口是一种契约，他与我们开发web Service类似。

• java开发语言：采用对程序员友好的接口申明形式，开发人员不需要关心客户端与服务端之间的传输协议。
• 其他语言：可以通过该框架提供自定义协议或者Http协议（http协议即将在2.1.0版本release出来）进行交互

2. 服务接口定制

• 定义服务接口
• 接口参数命名
• 定义参数校验规则
• Java语言服务接口尽量不要依赖其他项目. 接口层面只需要接口相关的参数对象类与服务类
• 异常定义

3. 接口参数校验

4. 提供3种交互方式

•  请求应答模式：普通的request、response，一般用于接口有返回值
• 异步请求模式：通常用于接口无返回值，客户端并不关心服务器的处理结果，也不用关心服务器处理多少时间
• 异步回调模式：接口无返回值，处理通常消化大量时间，需要服务端通知处理结果的业务接口

样例：

• 简单的接口例子：HelloService.java
  HelloService接口例子

  package com.meidusa.venus.hello.api;
  
  import com.meidusa.venus.annotations.Endpoint;
  import com.meidusa.venus.annotations.Param;
  import com.meidusa.venus.annotations.Service;
  import com.meidusa.venus.notify.InvocationListener;
  
  /**
   * Service framework的 HelloService 接口例子.
  
   * 支持3种调用方式：
  
   * 
   请求应答模式：普通的request、response，一般用于接口有返回值
   * 
   异步请求模式：通常用于接口无返回值，客户端并不关心服务器的处理结果，也不用关心服务器处理多少时间
   * 
   异步回调模式：接口无返回值，处理通常消化大量时间，需要服务端通知处理结果的业务接口
   *
   * @author Struct
   *
   */
  @Service(name="HelloService",version=1)
  public interface HelloService {
  
  	/**
  	 * 无返回结果的服务调用，支持回调方式，该服务在通讯层面上为异步调用
  	 * @param name
  	 * @param invocationListener 客户端的回调接口
  	 */
  	@Endpoint(name="sayHelloWithCallbak")
  	public abstract void sayHello(@Param(name="name") String name,
  				      @Param(name="callback") InvocationListener invocationListener);
  	/**
  	 * 无返回结果的服务调用，支持同步或者异步调用,
  	 * 该接口申明：同步，并且接口申明异常
  	 * @param name
  	 */
  	@Endpoint(name="sayHello",async=false)
  	public abstract void sayHello(@Param(name="name") String name) throws HelloNotFoundException;
  
  	/**
  	 * 无返回结果的服务调用，支持同步或者异步调用，无异常申明
  	 * @param name
  	 */
  	@Endpoint(name="sayAsyncHello",async=true)
  	public abstract void sayAsyncHello(@Param(name="name") String name);
  
  
  	/**
  	 * 有返回结果的服务调用，该接口只能支持同步调用
  	 * @param name
  	 * @return
  	 */
  	@Endpoint(name="getHello",timeWait=10000)
  	public abstract Hello getHello(@Param(name="name") String name);
  }
  

• 客户端TestCase编写
  客户端TestCase

  package com.meidusa.venus.hello.client;
  
  import java.util.concurrent.CountDownLatch;
  
  import org.junit.Test;
  import org.junit.runner.RunWith;
  import org.springframework.beans.factory.annotation.Autowired;
  import org.springframework.test.context.ContextConfiguration;
  import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
  
  import com.meidusa.venus.exception.CodedException;
  import com.meidusa.venus.hello.api.Hello;
  import com.meidusa.venus.hello.api.HelloNotFoundException;
  import com.meidusa.venus.hello.api.HelloService;
  import com.meidusa.venus.notify.InvocationListener;
  
  @RunWith(SpringJUnit4ClassRunner.class)
  @ContextConfiguration(locations="classpath:/applicationContext-helloworld-client.xml")
  public class TestHelloService {
  
  	@Autowired
  	private HelloService helloService;
  
  	@Test
  	public void saySync(){
  		System.out.println(helloService.getHello("jack"));
  	}
  
  	@Test
  	public void testSyncWithException(){
  		try {
  			helloService.sayHello("jack");
  		} catch (HelloNotFoundException e) {
  			System.out.println("throw an user defined HelloNotFoundException");
  		}
  	}
  
  	@Test
  	public void testAsync(){
  		helloService.sayAsyncHello("jack");
  	}
  
  	@Test
  	public void testCallback() throws Exception{
  		//为了让回调完成，采用countDownLatch计数器方式，避免testcase主线程运行完成而回调未结束的问题
  		final CountDownLatch latch = new CountDownLatch(1);
  
                    //在正常的使用的代码中这个类需要单实例，避免过多的callback listener导致内存问题
                        InvocationListener listener = new InvocationListener() {
  			public void callback(Hello myobject) {
  				System.out.println(" async call back result="+myobject);
  				latch.countDown();
  			}
  
  			@Override
  			public void onException(Exception e) {
  				if(e instanceof CodedException){
  				    CodedException exception = (CodedException) e;
  				    System.out.println(" async call back error:"+exception.getErrorCode()+",message="+exception.getMessage());
  				}else{
  				    System.out.println(" async call back message="+e.getMessage());
  				}
  				latch.countDown();
  
  			}
  		};
  
  		helloService.sayHello("jack",listener);
  		latch.await();
  	}
  
  }

• 服务端的实现
  服务端对HelloService的简单实现

  package com.meidusa.venus.hello.impl;
  
  import java.math.BigDecimal;
  import java.util.HashMap;
  import java.util.Map;
  
  import com.meidusa.venus.hello.api.Hello;
  import com.meidusa.venus.hello.api.HelloNotFoundException;
  import com.meidusa.venus.hello.api.HelloService;
  import com.meidusa.venus.notify.InvocationListener;
  
  public class DefaultHelloService implements HelloService {
  	private String greeting;
  	public String getGreeting() {
  		return greeting;
  	}
  
  	public void setGreeting(String greeting) {
  		this.greeting = greeting;
  	}
  	public Hello getHello(String name) {
  		Hello hello = new Hello();
  		hello.setName(name);
  		hello.setGreeting(greeting);
  		Map<String,Object> map = new HashMap<String,Object>();
  		hello.setMap(map);
  		map.put("1", 1);
  		map.put("2", new Long(2));
  		map.put("3", new Integer(3));
  		hello.setBigDecimal(new BigDecimal("1.341241233412"));
  		return hello;
  	}
  
  	public void sayHello(String name)  throws HelloNotFoundException {
  		throw new HelloNotFoundException(name +" not found");
  	}
  
  	@Override
  	public void sayAsyncHello(String name) {
  		System.out.println("method sayAsyncHello invoked");
  	}
  
  	public void sayHello(String name,
  			InvocationListener invocationListener) {
  		Hello hello = new Hello();
  		hello.setName(name);
  		hello.setGreeting(greeting);
  		Map<String,Object> map = new HashMap<String,Object>();
  		hello.setMap(map);
  		map.put("1", 1);
  		map.put("2", new Long(2));
  		map.put("3", new Integer(3));
  
  		if(invocationListener != null){
  			invocationListener.callback(hello);
  		}
  
  	}
  }