Ikasoa Documentation
Ikasoa-rpc是一款高性能轻量级的RPC框架,基于apache thrift开发,客户端可以像调用本地接口那样去调用远程接口.
要求java运行环境为java8
-
ikasoa-core 基础核心包
-
ikasoa-rpc RPC(远程过程调用协议)实现
-
ikasoa-example 示例
-
Maven配置
需要配置Ikamobile的Nexus私服,并添加ikasoa的依赖:
pom.xml
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
......
<!-- 配置Nexus私服 -->
<repositories>
<repository>
<id>ikamobile-nexus</id>
<name>ikamobile Nexus Repository</name>
<url>http://repo.ikamobile.cn:8081/nexus/content/groups/public/</url>
</repository>
<repository>
<snapshots>
<enabled>true</enabled>
</snapshots>
<id>public</id>
<name>Public Repositories</name>
<url>http://repo.ikamobile.cn:8081/nexus/content/repositories/snapshots/</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>ikamobile-nexus</id>
<name>ikamobile Nexus Repository</name>
<url>http://repo.ikamobile.cn:8081/nexus/content/groups/public/</url>
</pluginRepository>
<pluginRepository>
<id>public</id>
<name>Public Repositories</name>
<url>http://repo.ikamobile.cn:8081/nexus/content/repositories/snapshots/</url>
</pluginRepository>
</pluginRepositories>
<distributionManagement>
<repository>
<id>ikamobile-nexus</id>
<name>Internal Releases</name>
<url>http://repo.ikamobile.cn:8081/nexus/content/repositories/releases/</url>
</repository>
<snapshotRepository>
<id>ikamobile-nexus</id>
<name>ikamobile Snapshots</name>
<url>http://repo.ikamobile.cn:8081/nexus/content/repositories/snapshots</url>
</snapshotRepository>
</distributionManagement>
......
<dependencies>
......
<!-- 在这里添加对ikasoa的依赖 -->
<dependency>
<groupId>com.ikamobile</groupId>
<artifactId>ikasoa-rpc</artifactId>
<version>0.2-BETA</version>
</dependency>
......
</dependencies>
</project>-
导入工程&编译代码
工程目录下命令行执行”mvn eclipse:eclipse”,并导入eclipse.(如果IDE非eclipse,则使用相对应的方式导入)
执行命令”mvn clean package”打包.
-
创建接口和实现
新建例子接口(ExampleService.java),对象(ExampleVO.java)和实现 (ExampleServiceImpl.java)类:
ExampleService.java
package com.ikamobile.ikasoa.example;
public interface ExampleService {
// 查询对象
public ExampleVO findVO(int id);
}ExampleVO.java
package com.ikamobile.ikasoa.example;
public class ExampleVO {
private int id;
private String string;
public ExampleVO() {
}
public ExampleVO(int id, String string) {
this.id = id;
this.string = string;
}
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getString() {
return string;
}
public void setString(String string) {
this.string = string;
}
}ExampleServiceImpl.java
package com.ikamobile.ikasoa.example;
public class ExampleServiceImpl implements ExampleService {
@Override
public ExampleVO findVO(int id) {
return new ExampleVO(id, “helloworld”);
}
}- 创建执行类
Main.java
package com.ikamobile.ikasoa.example;
import com.ikamobile.ikasoa.rpc.DefaultIkasoaFactory;
import com.ikamobile.ikasoa.rpc.IkasoaException;
import com.ikamobile.ikasoa.rpc.IkasoaFactory;
import com.ikamobile.ikasoa.rpc.IkasoaServer;
public class Main {
public static void main(String[] args) {
IkasoaFactory ikasoaFactory = new DefaultIkasoaFactory();
try {
// 获取Ikasoa服务
IkasoaServer ikasoaServer = ikasoaFactory.getIkasoaServer(ExampleServiceImpl.class, 9999);
// 启动服务
ikasoaServer.run();
// 客户端获取远程接口实现
ExampleService es = ikasoaFactory.getIkasoaClient(ExampleService.class, "localhost", 9999);
// 客户端输出结果
System.out.println(es.findVO(1).getString());
// 停止服务
ikasoaServer.stop();
} catch (IkasoaException e) {
e.printStackTrace();
}
}
}-
执行Main.java
如输出”helloword”则表示执行成功.
例子程序需要使用到Spring框架.
- 服务端例子
bean.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.1.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsd">
......
<!-- 服务端配置 -->
<bean id="rpcServer" class="example.ikasoa.RpcServer" init-method="run" destroy-method="stop">
<constructor-arg index="0" ref="ikasoaFactory"/>
<constructor-arg index="1">
<value>9993</value><!-- 设置服务开放端口 -->
</constructor-arg>
</bean>
<bean id="ikasoaFactory" class="com.ikamobile.ikasoa.core.DefaultIkasoaFactory"/>
......
</beans>RpcServer.java
package example.ikasoa;
import com.ikamobile.ikasoa.rpc.IkasoaException;
import com.ikamobile.ikasoa.rpc.IkasoaFactory;
import com.ikamobile.ikasoa.rpc.IkasoaServer;
public class RpcServer {
private IkasoaServer server;
public RpcServer(IkasoaFactory ikasoaFactory, int serverPort) throws IkasoaException {
// 实现类必须最终类,不能是抽象类
this.server = ikasoaFactory.getIkasoaServer(ExampleServiceImpl.class, serverPort);
// 如果已有实例化后的对象(例如通过Spring注入的对象),则可以通过ImplClsCon类进行封装,Ikasoa将会直接引用该类的实例,而不会重新实例化.
// 例子如下:
// this.server = ikasoaFactory.getIkasoaServer(new ImplClsCon(ExampleServiceImpl.class, exampleServiceImpl), serverPort);
// 如有多个接口实现,可以传入List.
// 例子如下:
// List<ImplClsCon> sList = new ArrayList<ImplClsCon>();
// sList.add(new ImplClsCon(ExampleServiceImpl.class));
// sList.add(new ImplClsCon(Example2ServiceImpl.class));
// IkasoaServer ikasoaServer = ikasoaFactory.getIkasoaServer(sList, port);
System.out.println("服务端口:" + serverPort);
for (String key : this.server.getIkasoaServiceKeys()) {
System.out.println("加载服务:" + key);
}
}
public void run() {
server.run();
}
public void stop() {
server.stop();
}
}- 客户端例子
RpcClient.java
package example.ikasoa;
import com.ikamobile.ikasoa.rpc.DefaultIkasoaFactory;
public class RpcClient {
public static void main(String[] args) {
// 如果接口之间有继承关系,则只需要配置子接口类
// 设置服务器地址为”hocalhost”,端口为9993
ExampleService es = new DefaultIkasoaFactory().getIkasoaClient(ExampleService.class, "localhost", 9993);
// 如果有多个服务提供者,服务器地址和端口也可以传入List,系统将自动执行负载均衡(默认负载均衡规则为轮询,此外还支持随机).
// 例子如下:
// List<ServerInfo> serverInfoList = new ArrayList<ServerInfo>();
// serverInfoList.add(new ServerInfo("localhost", 9993));
// serverInfoList.add(new ServerInfo("192.168.1.41", 9993));
// ExampleService es = new DefaultIkasoaFactory().getIkasoaClient(ExampleService.class, serverInfoList);
System.out.println(es.findVO(1).getString());
}
}-
执行RpcClient.java
如输出”helloword”则表示执行成功.
- 客户端调用Thrift服务端例子
ThriftClientDemo.java
package example.ikasoa;
import org.apache.thrift.transport.TTransport;
import org.apache.thrift.transport.TTransportFactory;
import com.ikamobile.ikasoa.core.thrift.client.ThriftClient;
import com.ikamobile.ikasoa.core.thrift.client.ThriftClientConfiguration;
import com.ikamobile.ikasoa.rpc.DefaultIkasoaFactory;
import com.ikamobile.tmcs.controller.thrift.server.acceptor.GeneralThriftAcceptor;
public class ThriftClientDemo {
public static void main(String[] args) {
ThriftClientConfiguration configuration = new ThriftClientConfiguration();
configuration.setTransportFactory(new TTransportFactory()); // 协议需要与服务端匹配
ThriftClient thriftClient = new DefaultIkasoaFactory(configuration).getThriftClient("121.40.119.240", 9201); // 配置Thrift的服务器地址和端口
TTransport transport = null;
try {
transport = thriftClient.getTransport();
transport.open();
// GeneralThriftAcceptor为IDL中配置的service
GeneralThriftAcceptor.Client client = new GeneralThriftAcceptor.Client(
thriftClient.getProtocol(transport, "GeneralThriftAcceptor")); // 参数"GeneralThriftAcceptor"为服务的key,如果没有则可以不传
// 打印结果
System.out.println(client.getTmc(1));
} catch (Exception e) {
e.printStackTrace();
} finally {
transport.close();
}
}
}Ikasoa默认使用Thrift作为服务类型的实现,但也提供了Netty以供选择.
- 使用Thrift服务
......
IkasoaFactory ikasoaFactory = new DefaultIkasoaFactory();
......- 使用Netty服务
......
IkasoaFactory ikasoaFactory = new NettyIkasoaFactory();
......Ikasoa提供了3种序列化方式,分别为fastjson,xml,kryo,默认使用fastjson.
- 选择fastjson作为序列化方式(默认)
......
IkasoaFactory ikasoaFactory = new DefaultIkasoaFactory();
// 也可以写为如下方式:
// IkasoaFactory ikasoaFactory = new DefaultIkasoaFactory(new Configurator(ProtocolType.JSON));
......- 选择xml作为序列化方式
......
IkasoaFactory ikasoaFactory = new DefaultIkasoaFactory(new Configurator(ProtocolType.XML));
......- 选择kryo作为序列化方式
......
IkasoaFactory ikasoaFactory = new DefaultIkasoaFactory(new Configurator(ProtocolType.KRYO));
......-
使用fastjson作为序列化方式时,fastjson依赖版本建议与ikasoa所依赖的版本一致(当前为1.2.12).否则可能出现服务名不能匹配,无法调用服务的情况.
-
使用kryo作为序列化方式时,如果参数或返回值以父类(或抽象类)的形式传递,转换为子类时可能会丢失子类属性值,建议尽量以子类形式传递参数.fastjson方式非集合类参数或返回值没有问题,xml方式都没有问题.
-
使用fastjson作为序列化方式时,传递的Bean对象必须要有默认构造方法(建议使用类似lombok这样的工具来处理Bean对象).
-
使用kryo作为序列化方式时,暂不支持自定义异常对象,如果抛出自定义异常对象,异常类型不能正确识别.
sulei@ikamobile.com | 2016-06-12