Sneakily Throwing Exceptions in Lambda Expressions in Java

Handling checked exceptions in lambda expressions is often frustrating. Luckily, there is a type inference rule that we can exploit…

Java 8 Type-Inference

While reading through the Java Language Specification, we can find an interesting information:

A bound of the form “throws α” is purely informational: it directs resolution to optimize the instantiation of “α” so that, if possible, it is not a checked exception type. (…) Otherwise, if the bound set contains “throws αi”, and the proper upper bounds of “αi” are, at most, Exception, Throwable, and Object, then Ti = RuntimeException. Which simply means that every “throws T” will be generously inferred to a RuntimeException.

This was originally intended to e.g. solve the ambiguous problem of inferring checked exceptions from empty lambda expression bodies.

And now, it’s possible to exploit that rule and create a util method that will allow us to rethrow checked exceptions behind compiler’s back using a little trick:

@SuppressWarnings("unchecked")
static <T extends Exception, R> R sneakyThrow(Exception t) throws T {
    throw (T) t; // ( ͡° ͜ʖ ͡°)
}

And indeed – the following works as unexpected:

sneakyThrow(new IOException());

The boundary line between checked and unchecked exceptions does not exist at runtime, so everything works normally.

Unchecked Lambda Expressions

Since it’s possible to rethrow checked exceptions as unchecked, why not use this approach for minimizing the amount of boilerplate used when dealing with aching exceptions present in lambda expressions’ bodies?

First, we’d need a functional interface that represents a function that throws an Exception:

public interface ThrowingFunction<T, R> {
    R apply(T t) throws Exception;

And now we could write an adapter method for converting it to the java.util.function.Function instance:

static <T, R> Function<T, R> unchecked(ThrowingFunction<T, R> f)

Inside the implementation, we’d simply create a new lambda that delegates the job to the old one but rethrows the exception in case it’s raised:

static <T, R> Function<T, R> unchecked(ThrowingFunction<T, R> f) {
    return t -> {
        try {
            return f.apply(t);
        } catch (Exception ex) {
            return ThrowingFunction.sneakyThrow(ex);
        }
    };
}

And now, we no longer need to try-catch exceptions in lambda expressions:

Optional.of(42)
  .map(i -> {
      try {
          return throwException(i);
      } catch (IOException e) {
          e.printStackTrace();
          return null;
      }
  });

And we can simply write:

Optional.of(42)
  .map(unchecked(ThrowingFunctionTest::throwException));

The Other Edge

As expected, Sneaky Throws is a double-edged sword.

Just because you don’t like the rules, doesn’t mean its a good idea to take the law into your own hands. Your advice is irresponsible because it places the convenience of the code writer over the far more important considerations of transparency and maintainability of the program. – Brian Goetz (source)

Besides the danger of having a leakage of exceptions, we can’t catch exceptions using their type because of javac’s “helping” hand which is a clear loss of flexibility:

try {
    sneakyThrow(new IOException());
} catch (IOException e) { // exception is never thrown in corresponding try block
    e.printStackTrace();
}

Summary

The concept of sneaky throws has been around for a couple of years but with a new Type Inference rule, it became much cleaner to execute – which can be particularly handy when dealing with exceptions and lambda expressions but it has its price.

A number of libraries utilize this approach. For example, Lombok and Vavr.

Code snippets can be found on GitHub.

You May Also Like

Log4j and MDC in Grails

Log4j provides very useful feature: MDC - mapped diagnostic context. It can be used to store data in context of current thread. It may sound scary a bit but idea is simple.

My post is based on post http://burtbeckwith.com/blog/?p=521 from Burt Beckwith's excellent blog, it's definitely worth checking if you are interested in Grails.

Short background story...


Suppose we want to do logging our brand new shopping system and we want to have in each log customer's shopping basket number. And our system can be used at once by many users who can perform many transactions, actions like adding items and so on. How can we achieve that? Of course we can add basket number in every place where we do some logging but this task would be boring and error-prone. 

Instead of this we can use MDC to store variable with basket number in map. 

In fact MDC can be treated as map of custom values for current thread that can be used by logger. 


How to do that with Grails?


Using MDC with Grails is quite simple. All we need to do is to create our own custom filter which works for given urls and puts our data in MDC.

Filters in Grails are classes in directory grails-app/conf/* which names end with *Filters.groovy postfix. We can create this class manually or use Grails command: 
grails create-filters info.rnowak.App.Basket

In result class named BasketFilters will be created in grails-app/conf/info/rnowak/UberApp.

Initially filter class looks a little bit empty:
class BasketFilters {
def filters = {
all(controller:'*', action:'*') {
before = {

}
after = { Map model ->

}
afterView = { Exception e ->

}
}
}
}
All we need to do is fill empty closures, modify filter properties and put some data into MDC.

all is the general name of our filter, as class BasketFilters (plural!) can contain many various filters. You can name it whatever you want, for this post let assume it will be named basketFilter

Another thing is change of filter parameters. According to official documentation (link) we can customize our filter in many ways. You can specify controller to be filtered, its actions, filtered urls and so on. In our example you can stay with default option where filter is applied to every action of every controller. If you are interested in filtering only some urls, use uri parameter with expression describing desired urls to be filtered.

Three closures that are already defined in template have their function and they are started in these conditions:

  • before - as name says, it is executed before filtered action takes place
  • after - similarly, it is called after the action
  • afterView - called after rendering of the actions view
Ok, so now we know what are these mysterious methods and when they are called. But what can be done within them? In official Grails docs (link again) under section 7.6.3 there is a list of properties that are available to use in filter.

With that knowledge, we can proceed to implementing filter.

Putting something into MDC in filter


What we want to do is quite easy: we want to retrieve basket number from parameters and put it into MDC in our filter:
class BasketFilters {
def filters = {
basketFilter(controller:'*', action:'*') {
before = {
MDC.put("basketNumber", params.basketNumber ?: "")
}
after = { Map model ->
MDC.remove("basketNumber")
}
}
}
}

We retrieve basket number from Grails params map and then we put in map under specified key ("basketNumber" in this case), which will be later used in logger conversion pattern. It is important to remove custom value after processing of action to avoid leaks.

So we are putting something into MDC. But how make use of it in logs?


We can refer to custom data in MDC in conversion patter using syntax: %X{key}, where key is our key we used in filter to put data, like:
def conversionPattern = "%d{yyyy-MM-dd HH:mm:ss} %-5p %t [%c{1}] %X{basketNumber} - %m%n"


And that's it :) We've put custom data in log4j MDC and successfully used it in logs to display interesting values.