Lombok之@SneakyThrows

前言

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

 

 

 

Throwable是Error和Exception的父类，用来定义所有可以作为异常被抛出来的类。

Error和Exception区分：

Error是编译时错误和系统错误，系统错误在除特殊情况下，都不需要你来关心，基本不会出现。而编译时错误，如果你使用了编译器，那么编译器会提示。

Exception则是可以被抛出的基本类型，我们需要主要关心的也是这个类。

Exception又分为RunTimeException和其他Exception。

RunTimeException和其他Exception区分：

其他Exception，受检查异常。可以理解为错误，必须要开发者解决以后才能编译通过，解决的方法有两种，

1. throw到上层，
2. try-catch处理。

RunTimeException：运行时异常，又称不受检查异常，不受检查，因为不受检查，所以在代码中可能会有RunTimeException时Java编译检查时不会告诉你有这个异常，但是在实际运行代码时则会暴露出来，比如经典的1/0，空指针等。如果不处理也会被Java自己处理。

 

Lombok之@SneakyThrows

以往异常捕获

何为SneakyThrows？从字面理解就是“偷偷摸摸的抛出”。对的，就是这个意思。

该注解属于Lombok，它的作用为减少程序的异常捕获。

我们现在写代码，如果遇到异常，通常需要try catch，或者直接throws抛给上一层。

例如：

    public static void main(String[] args) {
        Class clz = null;
        try {
            clz = Class.forName("com.woshild.derek_ld.lombok.SneakyThrowsTest");
            System.out.println(clz.getName());
            Thread.sleep(3000);
            System.out.println("3秒已过。。。");
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }

 

    public static void main(String[] args) throws ClassNotFoundException, InterruptedException {
        Class clz = Class.forName("com.woshild.derek_ld.lombok.SneakyThrowsTest");
        System.out.println(clz.getName());

        Thread.sleep(3000);
        System.out.println("3秒已过。。。");
    }

 

以上两种情况都是日常几乎每天都要写的。比如Thread.sleep的异常，每次都需要捕获或抛出。很是烦躁。

再或者有时程序里有异常处理较多的时候，直接catch Exception e ，简单直接粗暴的捕获异常。

但如此这般，依然有些麻烦。

初见@SneakyThrows

今天突然发现这个注解@SneakyThrows，先看看他是如何用的。

    @SneakyThrows
    public static void main(String[] args) {
        Class clz = Class.forName("com.woshild.derek_ld.lombok.SneakyThrowsTest");
        System.out.println(clz.getName());

        Thread.sleep(3000);
        System.out.println("3秒已过。。。");
    }

 

看到没有，直接在方法上面加上@SneakyThrows即可，再也不需要处理异常了，是不是很香？

再来看看生成的class文件长什么样。

    public static void main(String[] args) {
        try {
            Class clz = Class.forName("com.woshild.derek_ld.lombok.SneakyThrowsTest");
            System.out.println(clz.getName());
            Thread.sleep(3000L);
            System.out.println("3秒已过。。。");
        } catch (Throwable var2) {
            throw var2;
        }
    }

 

看，@SneakyThrows直接把捕获异常的代码嵌入到了class文件里。

也就是说，并不是我们忽略了异常，而是类似于Lombok的@Data注解，在编译时就已经把处理的代码嵌入到了class内。

当然，我们也可以自定义需要@SneakyThrows处理的异常，比如例子中，我只需要他帮我处理Thread.sleep的异常，关于Class.forName的异常我需要额外做处理。可以这么做：

    @SneakyThrows(InterruptedException.class)
    public static void main(String[] args) {
        Class clz = null;
        try {
            clz = Class.forName("com.woshild.derek_ld.lombok.SneakyThrowsTest");
            System.out.println(clz.getName());
        } catch (ClassNotFoundException e) {
            //todo: ...
            log.error("[com.woshild.derek_ld.lombok.SneakyThrowsTest] class not found.", e);
        }

        Thread.sleep(3000);
        System.out.println("3秒已过。。。");
    }

 

在看一下@SneakyThrows注解的定义：

@Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
@Retention(RetentionPolicy.SOURCE)
public @interface SneakyThrows {
    Class<? extends Throwable>[] value() default {Throwable.class};
}

• 它可用于方法和构造器。

• value是Class<? extends Throwable>[]，是Throwable异常的子类数组。

 

原理

摘自网文

显然魔法 藏在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;
    }

 

 

总结

• 此注解虽神奇，但慎用。因为一旦用了，如果你的代码遇到了异常，那么在编码阶段你是无法感知的。
• 如果你的代码里没有异常，然而却声明了该注解，反而会引起不必要的误会。