@SneakyThrows注解-CSDN博客

本文链接：https://blog.csdn.net/Fireworkit/article/details/140502665

文章目录

@SneakyThrows简介

@SneakyThrows 注解是 Lombok 库提供的一个非常有用的注解，它主要用于简化异常处理代码。在 Java 中，当一个方法内部抛出了一个受检异常（checked exception），那么这个方法必须声明这个异常，或者在方法内部捕获并处理这个异常。然而，在某些情况下，开发者可能认为某些受检异常是不需要显式声明的，或者它们可以在方法内部被安全地忽略。这时候，@SneakyThrows 注解就可以派上用场了。
使用 @SneakyThrows 注解后，Lombok 会在编译时自动生成一个包装方法，这个方法会捕获所有受检异常，并将它们包装成 RuntimeException（如果异常已经是 RuntimeException 或其子类的，则直接抛出），然后抛出。这样，原方法就不需要声明任何受检异常了。
在说Exception之前，我们先简单聊下Error和Exception的差异
作用
@SneakyThrows就是使用该注解后不需要担心Exception的异常处理。
在说Exception之前，我们先简单聊下Error和Exception的差异
Error和Exception
Error是编译时错误和系统错误，系统错误在非特殊情况下，基本不会出现。而编译时错误，如果你使用了编译器，那么编译器会提示。
Exception则是可以被抛出的基本类型，我们需要主要关心的也是这个类。
Exception又可以根据运行时间来看，可以分为RunTimeException和其他Exception。
RunTimeException和其他Exception
其他Exception，受检查异常。可以理解为错误，必须要开发者解决以后才能编译通过，解决的方法有两种，
1：throw到上层，
2，try-catch处理。
RunTimeException：运行时异常，又称不受检查异常，不受检查，因为不受检查，所以在代码中可能会有RunTimeException时Java编译检查时不会告诉你有这个异常，但是在实际运行代码时则会暴露出来。如果不处理也会被Java处理。例如报500异常。
工作原理
当使用 @SneakyThrows 时，Lombok 会生成相应的字节码，使得已检查异常可以在没有显式 throws 声明的情况下抛出。这是通过将已检查异常包装在一个 RuntimeException 中并抛出，或者直接抛出原始异常来实现的。

使用方法

将 @SneakyThrows 注解添加到方法、构造函数或 lambda 表达式上，Lombok 会在编译时生成代码，使得已检查异常能够在不显式声明的情况下被抛出。
使用示例
假设你有一个方法，它调用了一个可能抛出 IOException 的库方法，但你不想在你的方法签名中声明这个异常：

import lombok.SneakyThrows;  
public class Example {  
  
    @SneakyThrows  
    public void readFile() {  
        // 假设 readFileFromDisk 可能抛出 IOException  
        String content = readFileFromDisk("path/to/file.txt");  
        // 处理 content  
    }  
  
    // 假设这个方法是从某个库中来的，并且声明了 IOException  
    private String readFileFromDisk(String filePath) throws IOException {  
        // 读取文件的代码  
        return "文件内容";  
    }  
}

在上面的例子中，readFile 方法使用了 @SneakyThrows 注解，因此它不需要声明 IOException。如果 readFileFromDisk 方法在运行时抛出了 IOException，那么 Lombok 生成的包装方法会捕获这个异常，并抛出一个 RuntimeException。

普通方法使用 @SneakyThrows：

import lombok.SneakyThrows;

public class Example {
    @SneakyThrows
    public void sneakyThrowMethod() {
        throw new Exception("Checked exception thrown");
    }

    public static void main(String[] args) {
        new Example().sneakyThrowMethod();
    }
}
2. 在 lambda 表达式中使用 @SneakyThrows：
import lombok.SneakyThrows;
import java.util.concurrent.Callable;

public class LambdaExample {
    public static void main(String[] args) {
        Callable<Void> callable = @SneakyThrows () -> {
            throw new Exception("Checked exception thrown from lambda");
        };

        try {
            callable.call();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

@SneakyThrows 是一个便捷的工具，用于简化异常处理的样板代码，但在使用时需要特别注意它对代码可读性和异常处理机制的影响。

注意事项

● 滥用风险：使用 @SneakyThrows 会隐藏方法可能抛出的已检查异常，可能导致调用者无法正确处理这些异常。在编写和维护代码时，应谨慎使用，以免引起潜在的问题。
● 可读性：对团队中其他成员来说，代码的可读性可能会降低，因为他们无法直接从方法签名中看出该方法可能抛出的异常。
● 使用 @SneakyThrows 时需要谨慎，因为它可能会隐藏某些重要的异常信息，使得调用者难以处理或定位问题。
● 只有在确实认为某个受检异常可以被安全地忽略或转换为运行时异常时，才应该使用 @SneakyThrows。
● @SneakyThrows 主要用于简化代码，减少样板代码，但在团队项目中使用时，需要确保团队成员都了解这一用法，以避免混淆。
● Lombok 是一个编译时注解处理器，因此使用它时，需要确保你的 IDE 支持 Lombok，并且已经正确安装和配置了 Lombok 插件。
@SneakyThrows 是 Lombok 提供的一个注解，用于简化异常处理。Lombok 是一个 Java 库，可以通过注解的方式减少样板代码。@SneakyThrows 注解允许你在不显式声明 throws 语句的情况下抛出已检查异常（checked exceptions）。