目錄:
- 概述
- 下載配置
- 基本概念
- 數據類型
- 服務端編碼基本步驟
- 客戶端編碼基本步驟
- 數據傳輸協議
- 實例演示(java)
- thrift生成代碼
- 實現接口Iface
- TSimpleServer服務模型
- TThreadPoolServer 服務模型
- TNonblockingServer 服務模型
- THsHaServer服務模型
- 異步客戶端
[一]、概述
Thrift是一個軟件框架,用來進行可擴展且跨語言的服務的開發。它結合了功能強大的軟件堆棧和代碼生成引擎,以構建在 C++, Java, Python, PHP, Ruby, Erlang, Perl, Haskell, C#, Cocoa, JavaScript, Node.js, Smalltalk, and OCaml 等等編程語言間無縫結合的、高效的服務。
Thrift最初由facebook開發,07年四月開放源碼,08年5月進入apache孵化器。thrift允許你定義一個簡單的定義文件中的數據類型和服務接口。以作爲輸入文件,編譯器生成代碼用來方便地生成RPC客戶端和服務器通信的無縫跨編程語言。
官網地址:thrift.apache.org
推薦值得一看的文章:
[二]、下載配置
到官網下載最新版本,截止今日(2012-06-11)最新版本爲0.8.0.
1. 如果是Maven構建項目的,直接在pom.xml 中添加如下內容:
|
<dependency>
<groupId>org.apache.thrift</groupId>
<artifactId>libthrift</artifactId>
<version>0.8.0</version>
</dependency>
|
2.如果自己編譯lib包,把下載的壓縮包解壓到X:盤,然後在X:\thrift-0.8.0\lib\java 目錄下運行ant進行自動編譯,會在X:\thrift-0.8.0\lib\java\build\ 目錄下看到編譯好的lib包:libthrift-0.8.0.jar
[三]、基本概念
1.數據類型
- 基本類型:
- bool:布爾值,true 或 false,對應 Java 的 boolean
- byte:8 位有符號整數,對應 Java 的 byte
- i16:16 位有符號整數,對應 Java 的 short
- i32:32 位有符號整數,對應 Java 的 int
- i64:64 位有符號整數,對應 Java 的 long
- double:64 位浮點數,對應 Java 的 double
- string:utf-8編碼的字符串,對應 Java 的 String
- 結構體類型:
- struct:定義公共的對象,類似於 C 語言中的結構體定義,在 Java 中是一個 JavaBean
- 容器類型:
- list:對應 Java 的 ArrayList
- set:對應 Java 的 HashSet
- map:對應 Java 的 HashMap
- 異常類型:
- exception:對應 Java 的 Exception
- 服務類型:
2.服務端編碼基本步驟:
- 實現服務處理接口impl
- 創建TProcessor
- 創建TServerTransport
- 創建TProtocol
- 創建TServer
- 啓動Server
3.客戶端編碼基本步驟:
- 創建Transport
- 創建TProtocol
- 基於TTransport和TProtocol創建 Client
- 調用Client的相應方法
4.數據傳輸協議
- TBinaryProtocol : 二進制格式.
- TCompactProtocol : 壓縮格式
- TJSONProtocol : JSON格式
- TSimpleJSONProtocol : 提供JSON只寫協議, 生成的文件很容易通過腳本語言解析
tips:客戶端和服務端的協議要一致
[四]、實例演示
1. thrift生成代碼
創建Thrift文件:G:\test\thrift\demoHello.thrift ,內容如下:
|
namespace
java com.micmiu.thrift.demo
service HelloWorldService
{
string
sayHello(1:string
username)
}
|
目錄結構如下:
|
G:\test\thrift>tree
/F
卷 other
的文件夾 PATH
列表
卷序列號爲
D238-BE47
G:.
demoHello.thrift
demouser.thrift
thrift-0.8.0.exe
沒有子文件夾
|
thrift-0.8.0.exe 是官網提供的windows下編譯工具,運用這個工具生成相關代碼:
|
thrift-0.8.0.exe
-r
-gen java
./demoHello.thrift
|
生成後的目錄結構如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
G:\test\thrift>tree
/F
卷 other
的文件夾 PATH
列表
卷序列號爲
D238-BE47
G:.
│ demoHello.thrift
│ demouser.thrift
│ thrift-0.8.0.exe
│
└─gen-java
└─com
└─micmiu
└─thrift
└─demo
HelloWorldService.java
|
將生成的HelloWorldService.java 文件copy到自己測試的工程中,我的工程是用maven構建的,故在pom.xml中增加如下內容:
|
<dependency>
<groupId>org.apache.thrift</groupId>
<artifactId>libthrift</artifactId>
<version>0.8.0</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.5.8</version>
</dependency>
|
2. 實現接口Iface
java代碼:HelloWorldImpl.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
package
com.micmiu.thrift.demo;
import
org.apache.thrift.TException;
/**
* blog http://www.micmiu.com
*
* @author Michael
*
*/
public
class HelloWorldImpl
implements HelloWorldService.Iface
{
public
HelloWorldImpl()
{
}
@Override
public
String sayHello(String
username)
throws TException
{
return
"Hi," +
username +
" welcome to my blog www.micmiu.com";
}
}
|
3.TSimpleServer服務端
簡單的單線程服務模型,一般用於測試。
編寫服務端server代碼:HelloServerDemo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
package
com.micmiu.thrift.demo;
import
org.apache.thrift.TProcessor;
import org.apache.thrift.protocol.TBinaryProtocol;
import
org.apache.thrift.protocol.TCompactProtocol;
import org.apache.thrift.protocol.TJSONProtocol;
import
org.apache.thrift.protocol.TSimpleJSONProtocol;
import org.apache.thrift.server.TServer;
import
org.apache.thrift.server.TSimpleServer;
import org.apache.thrift.transport.TServerSocket;
/**
* blog http://www.micmiu.com
*
* @author Michael
*
*/
public class
HelloServerDemo
{
public
static final
int SERVER_PORT
= 8090;
public
void startServer()
{
try
{
System.out.println("HelloWorld
TSimpleServer start ....");
TProcessor
tprocessor =
new HelloWorldService.Processor<HelloWorldService.Iface>(
new
HelloWorldImpl());
// HelloWorldService.Processor<HelloWorldService.Iface> tprocessor =
// new HelloWorldService.Processor<HelloWorldService.Iface>(
// new HelloWorldImpl());
// 簡單的單線程服務模型,一般用於測試
TServerSocket serverTransport
= new
TServerSocket(SERVER_PORT);
TServer.Args
tArgs =
new TServer.Args(serverTransport);
tArgs.processor(tprocessor);
tArgs.protocolFactory(new
TBinaryProtocol.Factory());
// tArgs.protocolFactory(new TCompactProtocol.Factory());
// tArgs.protocolFactory(new TJSONProtocol.Factory());
TServer server
= new
TSimpleServer(tArgs);
server.serve();
}
catch (Exception
e)
{
System.out.println("Server
start error!!!");
e.printStackTrace();
}
}
/**
* @param args
*/
public
static void
main(String[]
args)
{
HelloServerDemo
server =
new HelloServerDemo();
server.startServer();
}
}
|
編寫客戶端Client代碼:HelloClientDemo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
package
com.micmiu.thrift.demo;
import
org.apache.thrift.TException;
import org.apache.thrift.protocol.TBinaryProtocol;
import
org.apache.thrift.protocol.TCompactProtocol;
import org.apache.thrift.protocol.TJSONProtocol;
import
org.apache.thrift.protocol.TProtocol;
import org.apache.thrift.transport.TSocket;
import
org.apache.thrift.transport.TTransport;
import org.apache.thrift.transport.TTransportException;
/**
* blog http://www.micmiu.com
*
* @author Michael
*
*/
public class
HelloClientDemo
{
public
static final
String SERVER_IP
= "localhost";
public
static final
int SERVER_PORT
= 8090;
public
static final
int TIMEOUT
= 30000;
/**
*
* @param userName
*/
public
void startClient(String
userName)
{
TTransport
transport =
null;
try
{
transport
= new
TSocket(SERVER_IP,
SERVER_PORT,
TIMEOUT);
// 協議要和服務端一致
TProtocol
protocol =
new TBinaryProtocol(transport);
// TProtocol protocol = new TCompactProtocol(transport);
// TProtocol protocol = new TJSONProtocol(transport);
HelloWorldService.Client
client =
new HelloWorldService.Client(
protocol);
transport.open();
String
result =
client.sayHello(userName);
System.out.println("Thrify
client result =: " +
result);
}
catch (TTransportException
e)
{
e.printStackTrace();
}
catch (TException
e)
{
e.printStackTrace();
}
finally {
if
(null
!= transport)
{
transport.close();
}
}
}
/**
* @param args
*/
public
static void
main(String[]
args)
{
HelloClientDemo client
= new
HelloClientDemo();
client.startClient("Michael");
}
}
|
先運行服務端程序,日誌如下:
|
HelloWorld
TSimpleServer start
....
|
再運行客戶端調用程序,日誌如下:
|
Thrify
client result
=:
Hi,Michael
welcome to
my blog www.micmiu.com
|
測試成功,和預期的返回信息一致。
4.TThreadPoolServer 服務模型
線程池服務模型,使用標準的阻塞式IO,預先創建一組線程處理請求。
編寫服務端代碼:HelloServerDemo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
package
com.micmiu.thrift.demo;
import
org.apache.thrift.TProcessor;
import org.apache.thrift.protocol.TBinaryProtocol;
import
org.apache.thrift.server.TServer;
import org.apache.thrift.server.TThreadPoolServer;
import
org.apache.thrift.transport.TServerSocket;
/**
* blog http://www.micmiu.com
*
* @author Michael
*
*/
public
class HelloServerDemo
{
public
static final
int SERVER_PORT
= 8090;
public
void startServer()
{
try
{
System.out.println("HelloWorld
TThreadPoolServer start ....");
TProcessor tprocessor
= new
HelloWorldService.Processor<HelloWorldService.Iface>(
new
HelloWorldImpl());
TServerSocket
serverTransport
= new
TServerSocket(SERVER_PORT);
TThreadPoolServer.Args
ttpsArgs =
new TThreadPoolServer.Args(
serverTransport);
ttpsArgs.processor(tprocessor);
ttpsArgs.protocolFactory(new
TBinaryProtocol.Factory());
// 線程池服務模型,使用標準的阻塞式IO,預先創建一組線程處理請求。
TServer server
= new
TThreadPoolServer(ttpsArgs);
server.serve();
}
catch (Exception
e)
{
System.out.println("Server
start error!!!");
e.printStackTrace();
}
}
/**
* @param args
*/
public
static void
main(String[]
args)
{
HelloServerDemo
server =
new HelloServerDemo();
server.startServer();
}
}
|
客戶端Client代碼和之前的一樣,只要數據傳輸的協議一致即可,客戶端測試成功,結果如下:
|
Thrify
client result
=:
Hi,Michael
welcome to
my blog www.micmiu.com
|
5.TNonblockingServer 服務模型
使用非阻塞式IO,服務端和客戶端需要指定
TFramedTransport 數據傳輸的方式。
編寫服務端代碼:HelloServerDemo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
package
com.micmiu.thrift.demo;
import
org.apache.thrift.TProcessor;
import org.apache.thrift.protocol.TCompactProtocol;
import
org.apache.thrift.server.TNonblockingServer;
import org.apache.thrift.server.TServer;
import
org.apache.thrift.transport.TFramedTransport;
import org.apache.thrift.transport.TNonblockingServerSocket;
/**
* blog http://www.micmiu.com
*
* @author Michael
*
*/
public class
HelloServerDemo
{
public
static final
int SERVER_PORT
= 8090;
public
void startServer()
{
try
{
System.out.println("HelloWorld
TNonblockingServer start ....");
TProcessor
tprocessor =
new HelloWorldService.Processor<HelloWorldService.Iface>(
new
HelloWorldImpl());
TNonblockingServerSocket
tnbSocketTransport =
new TNonblockingServerSocket(
SERVER_PORT);
TNonblockingServer.Args
tnbArgs =
new TNonblockingServer.Args(
tnbSocketTransport);
tnbArgs.processor(tprocessor);
tnbArgs.transportFactory(new
TFramedTransport.Factory());
tnbArgs.protocolFactory(new
TCompactProtocol.Factory());
// 使用非阻塞式IO,服務端和客戶端需要指定TFramedTransport數據傳輸的方式
TServer
server =
new TNonblockingServer(tnbArgs);
server.serve();
}
catch (Exception
e)
{
System.out.println("Server
start error!!!");
e.printStackTrace();
}
}
/**
* @param args
*/
public
static void
main(String[]
args)
{
HelloServerDemo server
= new
HelloServerDemo();
server.startServer();
}
}
|
編寫客戶端代碼:HelloClientDemo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
package
com.micmiu.thrift.demo;
import
org.apache.thrift.TException;
import org.apache.thrift.protocol.TCompactProtocol;
import
org.apache.thrift.protocol.TProtocol;
import org.apache.thrift.transport.TFramedTransport;
import
org.apache.thrift.transport.TSocket;
import org.apache.thrift.transport.TTransport;
import
org.apache.thrift.transport.TTransportException;
/**
* blog http://www.micmiu.com
*
* @author Michael
*
*/
public
class HelloClientDemo
{
public
static final
String SERVER_IP
= "localhost";
public
static final
int SERVER_PORT
= 8090;
public
static final
int TIMEOUT
= 30000;
/**
*
* @param userName
*/
public
void startClient(String
userName)
{
TTransport transport
= null;
try
{
transport
= new
TFramedTransport(new
TSocket(SERVER_IP,
SERVER_PORT,
TIMEOUT));
// 協議要和服務端一致
TProtocol
protocol =
new TCompactProtocol(transport);
HelloWorldService.Client
client =
new HelloWorldService.Client(
protocol);
transport.open();
String
result =
client.sayHello(userName);
System.out.println("Thrify
client result =: " +
result);
}
catch (TTransportException
e)
{
e.printStackTrace();
}
catch (TException
e)
{
e.printStackTrace();
}
finally {
if
(null
!= transport)
{
transport.close();
}
}
}
/**
* @param args
*/
public
static void
main(String[]
args)
{
HelloClientDemo client
= new
HelloClientDemo();
client.startClient("Michael");
}
}
|
客戶端的測試成功,結果如下:
|
Thrify
client result
=:
Hi,Michael
welcome to
my blog www.micmiu.com
|
6.THsHaServer服務模型
半同步半異步的服務端模型,需要指定爲: TFramedTransport 數據傳輸的方式。
編寫服務端代碼:HelloServerDemo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
package
com.micmiu.thrift.demo;
import
org.apache.thrift.TProcessor;
import org.apache.thrift.protocol.TBinaryProtocol;
import
org.apache.thrift.protocol.TCompactProtocol;
import org.apache.thrift.server.THsHaServer;
import
org.apache.thrift.server.TNonblockingServer;
import org.apache.thrift.server.TServer;
import
org.apache.thrift.server.TSimpleServer;
import org.apache.thrift.server.TThreadPoolServer;
import
org.apache.thrift.transport.TFramedTransport;
import org.apache.thrift.transport.TNonblockingServerSocket;
import
org.apache.thrift.transport.TServerSocket;
/**
* blog http://www.micmiu.com
*
* @author Michael
*
*/
public
class HelloServerDemo
{
public
static final
int SERVER_PORT
= 8090;
public
void startServer()
{
try
{
System.out.println("HelloWorld
THsHaServer start ....");
TProcessor tprocessor
= new
HelloWorldService.Processor<HelloWorldService.Iface>(
new
HelloWorldImpl());
TNonblockingServerSocket
tnbSocketTransport
= new
TNonblockingServerSocket(
SERVER_PORT);
THsHaServer.Args
thhsArgs =
new THsHaServer.Args(tnbSocketTransport);
thhsArgs.processor(tprocessor);
thhsArgs.transportFactory(new
TFramedTransport.Factory());
thhsArgs.protocolFactory(new
TBinaryProtocol.Factory());
//半同步半異步的服務模型
TServer
server =
new THsHaServer(thhsArgs);
server.serve();
}
catch (Exception
e)
{
System.out.println("Server
start error!!!");
e.printStackTrace();
}
}
/**
* @param args
*/
public
static void
main(String[]
args)
{
HelloServerDemo server
= new
HelloServerDemo();
server.startServer();
}
}
|
客戶端代碼和上面 4 中的類似,只要注意傳輸協議一致以及指定傳輸方式爲TFramedTransport。
7.異步客戶端
編寫服務端代碼:HelloServerDemo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
package
com.micmiu.thrift.demo;
import
org.apache.thrift.TProcessor;
import org.apache.thrift.protocol.TCompactProtocol;
import
org.apache.thrift.server.TNonblockingServer;
import org.apache.thrift.server.TServer;
import
org.apache.thrift.transport.TFramedTransport;
import org.apache.thrift.transport.TNonblockingServerSocket;
/**
* blog http://www.micmiu.com
*
* @author Michael
*
*/
public class
HelloServerDemo
{
public
static final
int SERVER_PORT
= 8090;
public
void startServer()
{
try
{
System.out.println("HelloWorld
TNonblockingServer start ....");
TProcessor
tprocessor =
new HelloWorldService.Processor<HelloWorldService.Iface>(
new
HelloWorldImpl());
TNonblockingServerSocket
tnbSocketTransport =
new TNonblockingServerSocket(
SERVER_PORT);
TNonblockingServer.Args
tnbArgs =
new TNonblockingServer.Args(
tnbSocketTransport);
tnbArgs.processor(tprocessor);
tnbArgs.transportFactory(new
TFramedTransport.Factory());
tnbArgs.protocolFactory(new
TCompactProtocol.Factory());
// 使用非阻塞式IO,服務端和客戶端需要指定TFramedTransport數據傳輸的方式
TServer
server =
new TNonblockingServer(tnbArgs);
server.serve();
}
catch (Exception
e)
{
System.out.println("Server
start error!!!");
e.printStackTrace();
}
}
/**
* @param args
*/
public
static void
main(String[]
args)
{
HelloServerDemo server
= new
HelloServerDemo();
server.startServer();
}
}
|
編寫客戶端Client代碼:HelloAsynClientDemo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
package
com.micmiu.thrift.demo;
import
java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import org.apache.thrift.TException;
import
org.apache.thrift.async.AsyncMethodCallback;
import org.apache.thrift.async.TAsyncClientManager;
import
org.apache.thrift.protocol.TCompactProtocol;
import org.apache.thrift.protocol.TProtocolFactory;
import
org.apache.thrift.transport.TNonblockingSocket;
import org.apache.thrift.transport.TNonblockingTransport;
import com.micmiu.thrift.demo.HelloWorldService.AsyncClient.sayHello_call;
/**
* blog http://www.micmiu.com
*
* @author Michael
*
*/
public class
HelloAsynClientDemo
{
public
static final
String SERVER_IP
= "localhost";
public
static final
int SERVER_PORT
= 8090;
public
static final
int TIMEOUT
= 30000;
/**
*
* @param userName
*/
public
void startClient(String
userName)
{
try
{
TAsyncClientManager clientManager
= new
TAsyncClientManager();
TNonblockingTransport
transport =
new TNonblockingSocket(SERVER_IP,
SERVER_PORT,
TIMEOUT);
TProtocolFactory tprotocol
= new
TCompactProtocol.Factory();
HelloWorldService.AsyncClient
asyncClient =
new HelloWorldService.AsyncClient(
tprotocol,
clientManager,
transport);
System.out.println("Client
start .....");
CountDownLatch
latch =
new CountDownLatch(1);
AsynCallback callBack
= new
AsynCallback(latch);
System.out.println("call
method sayHello start ...");
asyncClient.sayHello(userName,
callBack);
System.out.println("call
method sayHello .... end");
boolean
wait =
latch.await(30,
TimeUnit.SECONDS);
System.out.println("latch.await
=:" +
wait);
}
catch (Exception
e)
{
e.printStackTrace();
}
System.out.println("startClient
end.");
}
public
class AsynCallback
implements AsyncMethodCallback<sayHello_call>
{
private
CountDownLatch latch;
public
AsynCallback(CountDownLatch
latch)
{
this.latch
= latch;
}
@Override
public
void onComplete(sayHello_call
response)
{
System.out.println("onComplete");
try
{
// Thread.sleep(1000L * 1);
System.out.println("AsynCall
result =:"
+
response.getResult().toString());
}
catch (TException
e)
{
e.printStackTrace();
}
catch (Exception
e)
{
e.printStackTrace();
}
finally {
latch.countDown();
}
}
@Override
public
void onError(Exception
exception)
{
System.out.println("onError
:" +
exception.getMessage());
latch.countDown();
}
}
/**
* @param args
*/
public
static void
main(String[]
args)
{
HelloAsynClientDemo client
= new
HelloAsynClientDemo();
client.startClient("Michael");
}
}
|
先運行服務程序,再運行客戶端程序,測試結果如下:
|
Client
start .....
call method sayHello
start ...
call
method sayHello
....
end
onComplete
AsynCall
result =:Hi,Michael
welcome to
my blog www.micmiu.com
latch.await
=:true
startClient
end.
|
————