Lombok之@SneakyThrows的使用

今天在阅读使用了Lombok插件的项目的代码中，发现有一个方法上加了@SneakyThrows注解，在此之间没有见过这个东东，于是去学习了解一下这个注解的含义。

首先说结论，@SneakyThrows可以帮我们进行异常处理（抛出异常）

当我们写代码的时候，如果遇到了需要处理异常的情况，我们一般有以下两种方式

一种，使用try catch语句来包围有异常的代码块

例如

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()方法，每次都需要抛异常或者声明异常，繁琐又使得代码很长。

那么我们就可以使用 @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秒已过。。。");
    }

当我们编译过后的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};
}

原理如下

在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;
    }

总结

使用了@SneakyThrows注解，我们就可以不用再手动去抛出异常了，而且还可以自定义抛出异常的类型。但是我们最好在弄清楚异常的原因之后选择性的使用，因为有的时候我们会因为这个注解而忽略了在编码期间去处理异常。

Lombok之@SneakyThrows的使用

总结

悦读