首页 > 软件编程 > java > Lombok注解@SneakyThrows

Lombok注解-@SneakyThrows的使用

2022-08-27 11:47:04 作者：lazyguy

这篇文章主要介绍了Lombok注解-@SneakyThrows的使用，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

Lombok注解@SneakyThrows

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

java中我们常见的2类异常。

1.普通Exception类,也就是我们常说的受检异常或者Checked Exception。
2.RuntimeException类，既运行时异常。

前者会强制要求抛出它的方法声明throws，调用者必须显示的去处理这个异常。设计的目的是为了提醒开发者处理一些场景中必然可能存在的异常情况。比如网络异常造成IOException。

但是现实，往往事与愿违。大部分情况下的异常，我们都是一路往外抛了事。（强制处理我也处理不了啊！臣妾做不到）所以渐渐的java程序员处理Exception的常见手段就是外面包一层RuntimeException，接着往上丢。这种解决思想尤其在Spring中到处出现。

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

lombok注解@SneakyThrows探索及与try catch、throws Exception区别

我在一个开源项目中看到了lombok注解@SneakyThrows，于是探索实践了一下，有些事情还是要自己操作一下，不然还真的不知道！！

以前就看到项目里有@SneakyThrows注解，一直没去管他和手动try catch还有往上抛异常有什么区别？

先说一下结论，赶时间的朋友看了就可以走了哈！！

我们发现，@SneakyThrows注解在编译的时候自动帮我们try catch，使用@SneakyThrows是为了让代码更加简洁，加快我们的开发效率！！所以还是推荐使用@SneakyThrows来解决异常问题，当然如果是已知异常还是自己手动throw。

导入 Maven

<!--Lombok-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <scope>provided</scope>
</dependency>

方法测试

public class SneakyTest {
    public static void main(String[] args) {
        exceptionTest();
    }
    public static void exceptionTest(){
        // 模拟一个异常
        FileInputStream fis = new FileInputStream(new File("test.txt"));
    }
}

此时Idea提醒我们要捕获异常，不然无法通过编译，给出我们三种解决方案，也就是我们本次要探究的目的！！

在这里插入图片描述

我们先第一种方式：

public class SneakyTest {
    public static void main(String[] args) throws FileNotFoundException {
        exceptionTest();
    }
    public static void exceptionTest() throws FileNotFoundException {
        // 模拟一个异常
        FileInputStream fis = new FileInputStream(new File("D:\\test.txt"));
    }
}

我们看到我们往上级抛，上级也需要抛，这种一直抛还是要有人处理，所以我们不建议这样！

第二种方式：

public class SneakyTest {
    public static void main(String[] args) {
        exceptionTest();
    }
    public static void exceptionTest(){
        // 模拟一个异常
        try {
            FileInputStream fis = new FileInputStream(new File("D:\\test.txt"));
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        }
    }
}

我们在本方法内处理，这样就不需要调用者处理了！！

第三种方式：

也是小编一直疑惑的，为啥会有这个注解，有什么优点吗？？

先看解决方式，我们在编译一下看看究竟怎么解决的异常！！

public class SneakyTest {
    public static void main(String[] args) {
        exceptionTest();
    }
    @SneakyThrows
    public static void exceptionTest(){
        // 模拟一个异常
        FileInputStream fis = new FileInputStream(new File("D:\\test.txt"));;
    }
}

我们编译一下看一下，下面是class文件

public class SneakyTest {
    public SneakyTest() {
    }
    public static void main(String[] args) {
        exceptionTest();
    }
    public static void exceptionTest() {
        try {
            new FileInputStream(new File("D:\\test.txt"));
        } catch (Throwable var1) {
            throw var1;
        }
    }
}

我们发现，这个注解自动帮我们try catch，使用@SneakyThrows是为了让代码更加简洁，加快我们的开发效率！！

这样我们就测试完成了，主要介绍了@SneakyThrows到底帮我们解决了什么问题，我们为什么要使用@SneakyThrows。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

Lombok注解-@SneakyThrows的使用