aatarasoff / spring-thrift-starter

Set of cool annotations that helps you building Thrift applications with Spring Boot

Apache Thrift Starter for Spring Boot

Set of cool annotations that helps you building Thrift applications with Spring Boot.

How to connect the project

repositories {
    ...
    maven {
        url = uri("https://maven.pkg.github.com/aatarasoff/spring-thrift-starter")
        credentials {
            username = System.getenv("USERNAME")
            password = System.getenv("TOKEN")
        }
    }
}

compile 'info.developerblog.spring.thrift:spring-thrift-starter:+'

For more information, please, look the official github packages documentation.

How to use this

Server-side

Annotation @ThriftController("servlet_path") helps you building server controller for request processing

@ThriftController("/api")
public class TGreetingServiceController implements TGreetingService.Iface {

    @Override
    public String greet(TName name) throws TException {
        // your logic
    }
}

Client-side

@ThriftClient

@ThriftClient(serviceId = "registered_service", (path) = "server_handler_path") helps you with multithreaded client with full Spring Cloud support.

@ThriftClient(serviceId = "greeting-service", path = "/api")
TGreetingService.Client client;

Beans

Thrift clients can also be used as regular beans

(which can be configured through app properties)

class Service {
    @Autowired
    private TGreetingService.Client client;
}

class Service {
    private final TGreetingService.Client client;
    @Autowired
    public Service(TGreetingService.Client client) {
        this.client = client;
    }
}

@ThriftClientsMap

@ThriftClientsMap(mapperClass) annotation helps to create a string-keyed map of clients for a set of services having the same interface, allowing to define the concrete callee instance at runtime:

@ThriftClientsMap(mapperClass = SampleMapper.class)
Map<String, TGreetingService.Client> clientsMap;

Mapper class requirements:

• must extend AbstractThriftClientKeyMapper
• must be registered as a bean in the application context

Thrift Client configuration

greeting-service:                     #service name
  endpoint: http://localhost:8080/api #direct endpoint
  ribbon:                             #manually ribbon
      listOfServers: localhost:8080
  path: /service                      #general path
  connectTimeout: 1000                #default=1000
  readTimeout: 10000                  #default=30000

thrift.client.max.threads: 10         #default=8

If you use service discovery backend (as Eureka or Consul) only path maybe needed.

See tests for better understanding.

Sleuth support

Since 1.0.0 starter have supported Spring Cloud Sleuth for tracing.

Special thanks to

• @bsideup who inspired me with his project
• @lavcraft who was helping me when I've been stucked
• @driver733 for implementing the bean registration support

Enjoy!

spring-thrift-starter's Issues

Is socket client connection supported？

I want to use TSocketClient

Not so active the project is

Is there anyone apply this in production?

Still maintained?

Is this package still maintained?

We are looking into using something similar but would like to extend e.g. the collected metrics and I was curious if it made sense to trying to contribute or if simply forking might be the easier option.

Could not find org.apache.thrift:thrift:0.9.2 for windows

spring-thrift-starter/examples/test-protocol/build.gradle

Line 52 in 16853e3

def thriftVersion = '0.9.2';

For WINDOWS available version 0.9.1 - http://dl.bintray.com/bsideup/thirdparty/

spring-thrift-starter:1.5.0 does not exists in jcenter

the latest release in jcenter is 1.4.0.RELEASE

LoggingThriftMethodInterceptor exception wrapping

Hi! I see that LoggingThriftMethodInterceptor wraps any exception into a TApplicationException in afterThrowing(), TApplicationException being a checked exception. I did a small refactoring of that class and have just left this code as it was. But now it's bothering me. If my callee code results in some runtime exception, the exception chain gets ugly: SomeRuntimeException -> TApplicationException -> java.lang.reflect.UndeclaredThrowableException: null (!) -> org.apache.thrift.transport.TTransportException: HTTP Response code: 406

Maybe it's worth changing the exception type to some runtime exception subclass? The problem is, all libthrift exceptions are checked.

End-to-end forwarding "x-request-id" HTTP Header

NullPointerException in TLoadBalancerClient

Exception occurs when there is no service with such name in service registry.
Here:

HttpURLConnection iox = 
    (HttpURLConnection) new URL(this.loadBalancerClient.choose(serviceName)
        .getUri().toString() + path).openConnection();

loadBalancerClient.choose(serviceName) returns null.

https://github.com/aatarasoff/spring-thrift-starter/blob/60bab1f92fca926ade509a36961a468a62f4d3df/autoconfigure/src/main/java/info/developerblog/spring/thrift/transport/TLoadBalancerClient.java

Implement SpanInjector and SpanExtractor patterns

Migrating to Spring Boot 1.3.x

Support for new version of Spring Boot framework

New client bean registration logic doesn't work

Here you register bean with name, which is generated by getBeanName method.
But later get bean from context by simple type name.
This two names are different, that's why you don't use registered bean and anyway go to else case.
It brakes mocking client bean

Migrate from @ThriftHandler to @ThriftController notation

Add hystrix support

Add optional hystrix wrapper around thrift service calls.
It'll be great if optional toObservable() method will exists during compile time (dont know how to implement in java, analogue of mixin in groovy and scala).

Add timeouts for Thrift clients