Apache Thrift

Apache Thrift
Original author(s)Facebook, Inc.
Developer(s)Apache Software Foundation
Stable release
0.21.0 / 9 September 2024; 59 days ago (2024-09-09)[1]
RepositoryThrift repository
Written inActionScript, C, C#, C++, D, Dart, Delphi, Erlang, Go, Haskell, Haxe, Java, JavaScript, Node.js, OCaml, Perl, PHP, Python, Rust, Scala, Smalltalk
TypeRemote procedure call framework
LicenseApache 2.0
Websitethrift.apache.org

Thrift is an IDL (Interface Definition Language) and binary communication protocol[2] used for defining and creating services for programming languages.[3] It was developed by Facebook. Since 2020, it is an open source project in the Apache Software Foundation.

It uses a remote procedure call (RPC) framework and combines a software stack with a code generation engine to build cross-platform services. Thrift can connect applications written in a variety of languages and frameworks, including ActionScript, C, C++,[4] C#,[5] Cocoa, Delphi, Erlang, Go, Haskell, Java, JavaScript, Objective-C, OCaml, Perl, PHP, Python, Ruby, Elixir, Rust, Scala, Smalltalk, and Swift.[6] The implementation was described in an April 2007 technical paper released by Facebook, now hosted on Apache.[7][8]

Architecture

The Apache Thrift API client/server architecture

Thrift includes a complete stack for creating clients and servers.[9] The top part is generated code from the Thrift definition. From this file, the services generate client and processor codes. In contrast to built-in types, created data structures are sent as a result of generated code. The protocol and transport layer are part of the runtime library. With Thrift, it is possible to define a service and change the protocol and transport without recompiling the code. Besides the client part, Thrift includes server infrastructure such as blocking, non-blocking, and multi-threaded servers. The underlying I/O part of the stack is implemented differently for different programming languages.[9]

Thrift supports a number of protocols:[9]

  • TBinaryProtocol – A binary format not optimized for space efficiency. Faster to process than the text protocol.
  • TCompactProtocol – More compact binary format.
  • TJSONProtocol – Uses JSON for the encoding of data.
  • TSimpleJSONProtocol – A write-only protocol that cannot be parsed by Thrift because it drops metadata using JSON. Suitable for parsing by scripting languages.[10]

The supported transports are:

  • TSimpleFileTransport – This transport writes to a file.
  • TFramedTransport – This transport is required when using a non-blocking server. It sends data in frames, each preceded by length information.
  • TMemoryTransport – Uses memory for I/O. The Java implementation uses a simple ByteArrayOutputStream internally.
  • TSocket – Uses blocking socket I/O for transport.
  • TZlibTransport – Performs compression using zlib. Used in conjunction with another transport.

Thrift also provides a number of servers, which are:

  • TNonblockingServer – A multi-threaded server using non-blocking I/O (Java implementation uses NIO channels). TFramedTransport must be used with this server.
  • TSimpleServer – A single-threaded server using standard blocking I/O.
  • TThreadedServer – A multi-threaded server using a thread per connection model and standard blocking I/O.
  • TThreadPoolServer – A multi-threaded server using a thread pool and standard blocking I/O.

Thrift is written in C++, but can create code for some other programming languages. To create a Thrift service, one has to write Thrift files that describe it, generate the code in the destination language, write some code to start the server, and call it from the client. An example of such a description file: 

enum PhoneType {
  HOME,
  WORK,
  MOBILE,
  OTHER
}

struct Phone {
  1: i32 id,
  2: string number,
  3: PhoneType type
}

service PhoneService {
  Phone findById(1: i32 id),
  list<Phone> findAll()
}

Thrift will generate the code out of this descriptive information. For instance, in Java, the PhoneType will be enum inside the Phone class.

See also

References

  1. ^ "Apache Thrift - Downloads". Retrieved September 27, 2024.
  2. ^ "Installing and using Apache Cassandra With Java Part 4 (Thrift Client)". Sodeso – Software Development Solutions. Archived from the original on March 31, 2022. Retrieved March 30, 2011. Thrift is a separate Apache project which is a binary communication protocol
  3. ^ Prunicki, Andrew. "Apache Thrift: Introduction". Object Computing. Archived from the original on July 23, 2011. Retrieved April 11, 2011. Using code generation, Thrift creates a set of files which can then be used for creating clients and/or servers.
  4. ^ "ThriftRequirements". Apache Software Foundation. Archived from the original on February 26, 2024. Retrieved June 22, 2024.{{cite web}}: CS1 maint: unfit URL (link)
  5. ^ Fred Potter, Using Thrift with Cappuccino Archived 2011-08-12 at the Wayback Machine, parallel48's posterously luscious blog, 10 June 2010.
  6. ^ Andrew Prunicki. "Apache Thrift: Code Generation". Object Computing. Archived from the original on July 23, 2011. Retrieved April 12, 2011.
  7. ^ Mark Slee, Aditya Agarwal, Marc Kwiatkowski, Thrift: Scalable Cross-Language Services Implementation
  8. ^ "LibraryFeatures". Apache Software Foundation. July 11, 2019. Archived from the original on May 3, 2024. Retrieved April 21, 2016.
  9. ^ a b c Andrew Prunicki. "Apache Thrift: Introduction". Object Computing. Archived from the original on July 23, 2011. Retrieved April 11, 2011.
  10. ^ Skelton, Steven (August 3, 2013). "Developer Friendly Thrift Request Logging". stevenskelton.ca. Archived from the original on January 24, 2024. Retrieved July 3, 2014.