Lombok注解：@SneakyThrows的具体介绍与使用

Posted 2022-02-27 ABin-阿斌

声明：

• 原作者：简书：lazyguy
• 原文地址：https://www.jianshu.com/u/3e698c500a89

文章目录

• 一、前言
• • 二、底层代码
  • 三、原理解析
  • 四、实际使用

一、前言

• @SneakyThrows 注解的用途得从 java 的异常设计体系说起。
• java 中我们常见的2类异常。
  • 普通 Exception 类，也就是我们常说的受检异常或者 Checked Exception。
  • RuntimeException 类，既运行时异常。
• 前者会强制要求抛出它的方法声明 throws，调用者必须显示的去处理这个异常。设计的目的是为了提醒开发者处理一些场景中必然可能存在的异常情况。比如网络异常造成 IOException。
• 但是现实，往往事与愿违。大部分情况下的异常，我们都是一路往外抛了事。（强制处理我也处理不了啊！臣妾做不到）所以渐渐的 java 程序员处理 Exception 的常见手段就是外面包一层 RuntimeException，接着往上丢。这种解决思想尤其在Spring 中到处出现。参见 《Spring in Action》

二、底层代码

• 不用 @SneakyThrows 注解写的代码

//缺点：每一次遇到这种抛异常的代码都要写一组这样的，就算是抽离出来也是不够优雅
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;
     

四、实际使用

• 在实际开发中，我们只需要在实现类上加上这个注解就完事了，就是这么简单