Performance Improvements of Sub-Resource Locators in Jersey

There were many performance improvements since Jersey 2 first came out almost 2 years ago. Jakub and I decided to present some of the latest ones in our recent articles. Jakub took a look at general performance gains in Jersey in his Jersey 2 Performance. I’ll try to cover the change we introduced in Jersey 2.16 and that affected processing and performance of sub-resource locators in Jersey applications.

We’ve fought a lot of fights but the war isn’t over. We’re going to focus on performance improvements in Jersey even more.

This article is separated into three main sections:

Resources and their Methods

JAX-RS recognizes three types of methods that can be present in a resource class and invoked directly by JAX-RS: resource methods, sub-resource methods and sub-resource locators.

Resource Methods

Resource methods are methods of a resource class annotated with a request method designator (e.g. @GET, @POST, …). These are well know, widely used to handle incoming request and pretty straightforward to understand so no further explanation is required.

An example of resource method may be:

Now lets take a closer look at @Path annotation. In addition to putting it on a class you can annotate also methods with this annotation. Methods of a resource class that are annotated with @Path are either sub-resource methods or sub-resource locators.

Sub-resource methods handle a HTTP request directly whilst sub-resource locators return an object that will handle a HTTP request. The presence or absence of a request method designator (e.g. @GET) differentiates between the two.

Sub-Resource Methods

If the request method designator is present on a resource method then we’re talking about sub-resource methods. These methods are treated like a normal resource method except the method is only invoked for request URIs that match a URI template created by concatenating the URI template of the resource class with the URI template of the method.

Sub-resource methods are also pretty common and an example of such a method could be:

Sub-Resource Locators

Locators are methods used to dynamically resolve the object that will handle the request. Any returned object is treated as a resource class instance and used to either handle the request or to further resolve the object that will handle the request.  Sub-resource locators may have all the same parameters as a normal resource method except that they must not have an entity parameter.

An example of a sub-resource locator would be:

Useful? Definitely. Usable? Yes!, but slightly slow in Jersey prior to version 2.16.

The performance problems in previous versions of Jersey was caused by updating (and not caching some parts of the) Jersey’s Resource Model over and over again when a sub-resource locator was used to handle a request at runtime.

Resource Model is used when requests are processed and routed to a matching resource class and resource method. It is created and stored at the deployment time for resources registered in your application (root resources). When the base model is created Jersey does some further processing. The model is enhanced, programmatically using Model Processors, by adding new resource methods to it (e.g. HTTP OPTION methods are added to each resource class by Jersey). The last step of preparing the resource processing model for runtime is to validate it. This step is present to be sure the model is in accordance with JAX-RS expectations.

These steps are rather obvious and perfectly fine to do once, not so fine to repeat them every time a sub-resource locator is involved in handling request.

When you have a sub-resources in your application the application’s resource model is updated and information about the sub-resource class is added to it so the processing of a request is handled properly. This means that all the steps that are done for application’s resource model are done for sub-resource locator class as well.

Fortunately the sub-resource model (enhanced and validated), for classes and instances, can be created once and then reused in subsequent calls. This was the approach to improve the bad performance of sub-resource locators – we introduced a cache for sub-resource locators which made the performance similar to using normal resource methods (configuration of the cache is explained in the last section, Cache Configuration).

Performance Testing

To be able to evaluate performance gains, between three versions of Jersey (2.0, 2.15, 2.16), we created a simple Jersey application (see resource classes below) and deployed it on Grizzly HTTP container. To saturate the server with requests we had two, wrk based, clients on two other separate nodes.

We measured (on the server) the number of requests per second the server was able to process. We ran five series, each containing 20 runs, of POST, PUT and GET requests and text/plain media type. So, at the end we had 100 requests/sec measurements for each of the HTTP methods.

For the sake of this article the absolute request/sec numbers aren’t that important. Rather we focused on the difference in number of calls between tested Jersey versions and we also looked at the difference between performance of sub-resource locators and normal resource methods in Jersey 2.16.

The following two resource classes were used during testing,

for obtaining requests/sec ratio of sub-resource locator based resources, where individual request were pointed at /text/sub-class path, and

to get requests/sec comparison between sub-resource locator based requests (/text/sub-class) and normal resource method based requests (/text).

Jersey 2.0 vs. 2.15 vs. 2.16

All the results are available and accessible in the following Google Docs Spreadsheet:

Lets together take a look and compare HTTP GET, text/plain requests invoked on sub-resource locators in Jersey 2.0, 2.15 and 2.16.

As you can see the version 2.0 is the least performant one with ~2950 requests/sec. Jersey 2.15 is not much bette, ~3880 requests/sec. On the other hand, with locator caching, Jersey 2.16 was able to perform very nicely with ~24130 requests/sec.

The relative increase between

  • 2.0 and 2.16 (2946.82 vs 24126.09) is 718%
  • 2.15 and 2.16 (3880.7 vs 24126.09) is 521%.

The performance increase for POST and PUT methods are similar and you can take a look at the charts in the mentioned spreadsheet.

These number are pretty impressive but how does sub-resource locators perform against normal resource methods in Jersey 2.16?

Not bad! Normal resource methods gave us ~25100 requests per second and for sub-resource locators we got ~24130 requests per second. This is difference of ~4% in favor of normal resource methods.

To summarize the findings we were able to get huge performance gain for sub-resource locators between Jersey 2.15 and 2.16. Also, number of handled requests when using sub-resource locators are as close as possible to number of handled requests when an application use normal resource methods in Jersey 2.16.

Cache Configuration

The sub-resource locator cache is initialized for the first time in an application when a first sub-resource locator is being processed. If you don’t have locators in your application you don’t need to worry about (slightly) bigger memory footprint.

Jersey offers two eviction policies to make sure the locator cache doesn’t grow too much – cache size policy and entry age policy.

When you want to limit the size of the cache provide the desired value with the ServerProperties.SUBRESOURCE_LOCATOR_CACHE_SIZE property. The default cache size is 64 entries.

The age eviction policy can be set via property ServerProperties.SUBRESOURCE_LOCATOR_CACHE_AGE and is defined as the time (in seconds) since the last access (read) to the entry in the cache. The default value is not set. The age eviction policy can be used to lower the memory footprint when your application (or at least locator methods) is idle.

So, for example if I wanted to use cache that would contain 1000 entries at most and each entry would live for maximum of 10 minutes my application class would look like:

Programmatically created resources

Some of you may already know that besides the declarative (JAX-RS) way of writing resources Jersey provides also a programmatic way for creating them. For example, “Hello World” application may look like:

Few of you may also know that it’s possible, in addition to return resource class or resource instance, to return an instance of Resource from a sub-resource locator as well. This is useful in cases when you really need to dynamically create resources that are exposed on a certain path.

Unfortunately, caching of this kind of sub-resource locators is very limited at the moment and in many cases the performance of using them is similar to performance of sub-resource locators in version 2.15 (or lower).

However, if you use only few programmatically created resources, that are returned from locators, it’s possible to leverage caching by returning the same Jersey Resource instances for the same input parameters of a sub-resource locator:

Jersey Resource caching is not enabled by default but you can turn it on by setting ServerProperties.SUBRESOURCE_LOCATOR_CACHE_JERSEY_RESOURCE_ENABLED property to true.

 

If you have any comments or suggestions, please leave a message in the discussion below or send me a note at michal@dejavu.sk.