Bekerja dengan Apache Thrift

1. Ikhtisar

Pada artikel ini, kita akan menemukan cara mengembangkan aplikasi klien-server lintas platform dengan bantuan kerangka kerja RPC yang disebut Apache Thrift.

Kami akan membahas:

  • Mendefinisikan tipe data dan antarmuka layanan dengan IDL
  • Memasang perpustakaan dan menghasilkan sumber untuk berbagai bahasa
  • Menerapkan antarmuka yang ditentukan dalam bahasa tertentu
  • Menerapkan perangkat lunak klien / server

Jika Anda ingin langsung ke contoh, lanjutkan langsung ke bagian 5.

2. Apache Thrift

Apache Thrift awalnya dikembangkan oleh tim pengembangan Facebook dan saat ini dikelola oleh Apache.

Dibandingkan dengan Protocol Buffer, yang mengelola proses serialisasi / deserialisasi objek lintas platform, Thrift terutama berfokus pada lapisan komunikasi antara komponen sistem Anda.

Thrift menggunakan Bahasa Deskripsi Antarmuka (IDL) khusus untuk menentukan tipe data dan antarmuka layanan yang disimpan sebagai file .thrift dan digunakan nanti sebagai input oleh penyusun untuk menghasilkan kode sumber perangkat lunak klien dan server yang berkomunikasi melalui bahasa pemrograman yang berbeda.

Untuk menggunakan Apache Thrift di project Anda, tambahkan dependensi Maven ini:

 org.apache.thrift libthrift 0.10.0 

Anda dapat menemukan versi terbaru di repositori Maven.

3. Bahasa Deskripsi Antarmuka

Seperti yang telah dijelaskan, IDL memungkinkan pendefinisian antarmuka komunikasi dalam bahasa netral. Di bawah ini Anda akan menemukan jenis yang saat ini didukung.

3.1. Jenis Dasar

  • bool - nilai boolean (benar atau salah)
  • byte - bilangan bulat bertanda 8-bit
  • i16 - integer bertanda tangan 16-bit
  • i32 - integer bertanda tangan 32-bit
  • i64 - bilangan bulat 64-bit
  • double - bilangan floating point 64-bit
  • string - string teks yang dikodekan menggunakan pengkodean UTF-8

3.2. Jenis Khusus

  • biner - urutan byte yang tidak dikodekan
  • opsional - tipe Opsional Java 8

3.3. Structs

Thrift struct setara dengan kelas dalam bahasa OOP tetapi tanpa pewarisan. Sebuah struct memiliki seperangkat bidang sangat diketik, masing-masing dengan nama yang unik sebagai pengenal. Bidang mungkin memiliki berbagai anotasi (ID bidang numerik, nilai default opsional, dll.).

3.4. Wadah

Kontainer barang bekas adalah kontainer yang sangat diketik:

  • daftar - daftar elemen yang dipesan
  • set - satu set elemen unik yang tidak berurutan
  • map - peta kunci yang benar-benar unik untuk nilai

Elemen kontainer dapat berupa jenis barang bekas yang valid.

3.5. Pengecualian

Pengecualian secara fungsional setara dengan struct , kecuali bahwa mereka mewarisi dari pengecualian asli.

3.6. Jasa

Layanan sebenarnya adalah antarmuka komunikasi yang ditentukan menggunakan tipe Hemat. Mereka terdiri dari satu set fungsi bernama, masing-masing dengan daftar parameter dan tipe kembalian.

4. Pembuatan Kode Sumber

4.1. Dukungan bahasa

Ada daftar panjang bahasa yang didukung saat ini:

  • C ++
  • C #
  • Pergilah
  • Haskell
  • Jawa
  • Javascript
  • Node.js
  • Perl
  • PHP
  • Python
  • Rubi

Anda dapat memeriksa daftar lengkapnya di sini.

4.2. Menggunakan File Eksekusi Perpustakaan

Cukup unduh versi terbaru, buat dan instal jika perlu, dan gunakan sintaks berikut:

cd path/to/thrift thrift -r --gen [LANGUAGE] [FILENAME]

In the commands set above, [LANGUAGE] is one of the supported languages and [FILENAME] is a file with IDL definition.

Note the -r flag. It tells Thrift to generate code recursively once it notices includes in a given .thrift file.

4.3. Using Maven Plugin

Add the plugin in your pom.xml file:

 org.apache.thrift.tools maven-thrift-plugin 0.1.11  path/to/thrift    thrift-sources generate-sources  compile    

After that just execute the following command:

mvn clean install

Note that this plugin will not have any further maintenance anymore. Please visit this page for more information.

5. Example of a Client-Server Application

5.1. Defining Thrift File

Let's write some simple service with exceptions and structures:

namespace cpp com.baeldung.thrift.impl namespace java com.baeldung.thrift.impl exception InvalidOperationException { 1: i32 code, 2: string description } struct CrossPlatformResource { 1: i32 id, 2: string name, 3: optional string salutation } service CrossPlatformService { CrossPlatformResource get(1:i32 id) throws (1:InvalidOperationException e), void save(1:CrossPlatformResource resource) throws (1:InvalidOperationException e), list  getList() throws (1:InvalidOperationException e), bool ping() throws (1:InvalidOperationException e) }

As you can see, the syntax is pretty simple and self-explanatory. We define a set of namespaces (per implementation language), an exception type, a struct, and finally a service interface which will be shared across different components.

Then just store it as a service.thrift file.

5.2. Compiling and Generating a Code

Now it's time to run a compiler which will generate the code for us:

thrift -r -out generated --gen java /path/to/service.thrift

As you might see, we added a special flag -out to specify the output directory for generated files. If you did not get any errors, the generated directory will contain 3 files:

  • CrossPlatformResource.java
  • CrossPlatformService.java
  • InvalidOperationException.java

Let's generate a C++ version of the service by running:

thrift -r -out generated --gen cpp /path/to/service.thrift

Now we get 2 different valid implementations (Java and C++) of the same service interface.

5.3. Adding a Service Implementation

Although Thrift has done most of the work for us, we still need to write our own implementations of the CrossPlatformService. In order to do that, we just need to implement a CrossPlatformService.Iface interface:

public class CrossPlatformServiceImpl implements CrossPlatformService.Iface { @Override public CrossPlatformResource get(int id) throws InvalidOperationException, TException { return new CrossPlatformResource(); } @Override public void save(CrossPlatformResource resource) throws InvalidOperationException, TException { saveResource(); } @Override public List getList() throws InvalidOperationException, TException { return Collections.emptyList(); } @Override public boolean ping() throws InvalidOperationException, TException { return true; } }

5.4. Writing a Server

As we said, we want to build a cross-platform client-server application, so we need a server for it. The great thing about Apache Thrift is that it has its own client-server communication framework which makes communication a piece of cake:

public class CrossPlatformServiceServer { public void start() throws TTransportException { TServerTransport serverTransport = new TServerSocket(9090); server = new TSimpleServer(new TServer.Args(serverTransport) .processor(new CrossPlatformService.Processor(new CrossPlatformServiceImpl()))); System.out.print("Starting the server... "); server.serve(); System.out.println("done."); } public void stop() { if (server != null && server.isServing()) { System.out.print("Stopping the server... "); server.stop(); System.out.println("done."); } } } 

First thing is to define a transport layer with the implementation of TServerTransport interface (or abstract class, to be more precise). Since we are talking about server, we need to provide a port to listen to. Then we need to define a TServer instance and choose one of the available implementations:

  • TSimpleServer – for simple server
  • TThreadPoolServer – for multi-threaded server
  • TNonblockingServer – for non-blocking multi-threaded server

And finally, provide a processor implementation for chosen server which was already generated for us by Thrift, i.e. CrossPlatofformService.Processor class.

5.5. Writing a Client

And here is the client's implementation:

TTransport transport = new TSocket("localhost", 9090); transport.open(); TProtocol protocol = new TBinaryProtocol(transport); CrossPlatformService.Client client = new CrossPlatformService.Client(protocol); boolean result = client.ping(); transport.close();

From a client perspective, the actions are pretty similar.

First of all, define the transport and point it to our server instance, then choose the suitable protocol. The only difference is that here we initialize the client instance which was, once again, already generated by Thrift, i.e. CrossPlatformService.Client class.

Since it is based on .thrift file definitions we can directly call methods described there. In this particular example, client.ping() will make a remote call to the server which will respond with true.

6. Conclusion

In this article, we've shown you the basic concepts and steps in working with Apache Thrift, and we've shown how to create a working example which utilizes Thrift library.

Seperti biasanya, semua contoh dapat selalu ditemukan di repositori GitHub.