@SneakyThrows 注解详解

@SneakyThrows 注解详解

1. 基本介绍

@SneakyThrows 是 Lombok 提供的注解，用于简化异常处理，自动生成 try-catch 代码块，将检查型异常转换为非检查型异常。

2. 使用对比

2.1 传统写法

public String readFile(String path) {
    try {
        return Files.readString(Paths.get(path));
    } catch (IOException e) {
        throw new RuntimeException(e);
    }
}

2.2 @SneakyThrows写法

@SneakyThrows
public String readFile(String path) {
    return Files.readString(Paths.get(path));
}

3. 常见应用场景

3.1 文件操作

@SneakyThrows
public byte[] readBytes(String filename) {
    return Files.readAllBytes(Paths.get(filename));
}

3.2 JSON处理

@SneakyThrows
public String toJson(Object obj) {
    return objectMapper.writeValueAsString(obj);
}

3.3 线程操作

@SneakyThrows
public void sleep(long millis) {
    Thread.sleep(millis);
}

4. 使用建议

4.1 适合使用的场景

✅ 简单的IO操作

✅ 基础的类型转换

✅ 确定不会发生异常的场景

✅ 测试代码编写

4.2 不建议使用的场景

❌ 复杂的业务逻辑

❌ 需要详细日志记录的场景

❌ 需要精确异常处理的场景

❌ 需要资源清理的场景

5. 实现原理

Lombok 在编译时将注解转换为以下代码：

public String readFile(String path) {

  try {

    return Files.readString(Paths.get(path));

  } catch (Throwable *t*) {

    throw lombokSneakyThrow(t);

  }

}

6. 最佳实践

6.1 好的示例

public class GoodExample {
    @SneakyThrows
    public byte[] readResource(String name) {
        return getClass().getResourceAsStream(name).readAllBytes();
    }
}

6.2 不好的示例

public class BadExample {
    // 不推荐：需要特殊处理的业务逻辑
    @SneakyThrows
    public void processBusinessLogic() {
        // 复杂的业务处理
        // 可能需要日志记录
        // 可能需要事务回滚
    }
}

7. 注意事项

1. 使用前确保添加 Lombok 依赖
2. 理解被处理的异常类型
3. 考虑代码可维护性
4. 不要过度使用