@SneakyThrows注解

刺骨的言语ヽ痛彻心扉 2023-10-11 16:31 5阅读 0赞

`@SneakyThrows`注解的用途得从Java的异常设计体系说起

Java中常见的两类异常：

1.  Exception类，也就是常说的受检异常或者Checked Exception，即编译时异常。
2.  RuntimeException类，既运行时异常。

前者会强制要求抛出它的方法声明`throws`，调用者必须显示的去处理这个异常。常见的运行时异常`NullPointerException`。

设计的目的是为了提醒开发者处理一些场景中必然可能存在的异常情况。比如网络异常造成`IOException`。

但是现实，往往事与愿违。大部分情况下的异常，我们都是一路往外抛了事。所以渐渐的Java程序员处理Exception的常见手段就是外面包一层RuntimeException，接着往上丢。

try {
        
    
    } catch(Exception e) {
        
      throw new RuntimeException(e);
    }

Lombok的@SneakyThrows就是为了消除这样的模板代码，使用注解后不需要担心`Exception`的处理

import lombok.SneakyThrows;
    
    public class SneakyThrowsExample implements Runnable {
        
      @SneakyThrows(UnsupportedEncodingException.class)
      public String utf8ToString(byte[] bytes) {
        
        return new String(bytes, "UTF-8");
      }
      
      @SneakyThrows
      public void run() {
        
        throw new Throwable();
      }
    }

真正生成的代码：

import lombok.Lombok;
    
    public class SneakyThrowsExample implements Runnable {
        
      public String utf8ToString(byte[] bytes) {
        
        try {
        
          return new String(bytes, "UTF-8");
        } catch (UnsupportedEncodingException e) {
        
          throw Lombok.sneakyThrow(e);
        }
      }
      
      public void run() {
        
        try {
        
          throw new Throwable();
        } catch (Throwable t) {
        
          throw Lombok.sneakyThrow(t);
        }
      }
    }

显然魔法藏在`Lombok.sneakyThrow(t);`中，可能大家都会以为这个方法就是`new RuntimeException()`之类的，然而事实并非如此。阅读代码可以看出整个方法其实最核心的逻辑是`throw (T)t;`，利用泛型将我们传入的`Throwable`强转为`RuntimeException`。虽然事实上我们不是`RuntimeException`。但是没关系，因为JVM并不关心这个。泛型最后存储为字节码时并没有泛型的信息。这样写只是为了骗过`javac`编译器。

public static RuntimeException sneakyThrow(Throwable t) {
        
        if (t == null) throw new NullPointerException("t");
        return Lombok.<RuntimeException>sneakyThrow0(t);
    }
    
    private static <T extends Throwable> T sneakyThrow0(Throwable t) throws T {
        
        throw (T)t;
    }