SpringBoot 如何使用 @ExceptionHandler 注解进行局部异常处理

简介: SpringBoot 如何使用 @ExceptionHandler 注解进行局部异常处理

SpringBoot 如何使用 @ExceptionHandler 注解进行局部异常处理


介绍


在开发 Web 应用程序时,异常处理是非常重要的一部分。SpringBoot 提供了多种方式来处理异常,其中之一是使用 @ExceptionHandler 注解进行局部异常处理。使用 @ExceptionHandler 注解,我们可以在 Controller 层或方法级别上处理异常,而不用在整个应用程序中处理。


在本文中,我们将介绍 SpringBoot 中的 @ExceptionHandler 注解,演示如何使用它进行局部异常处理。


image.png


@ExceptionHandler 注解


@ExceptionHandler 注解是 SpringFramework 提供的一个注解,用于处理控制器中出现的异常。当在控制器方法中抛出异常时,SpringBoot 会查找带有 @ExceptionHandler 注解的方法,并调用它来处理异常。


下面是一个简单的例子:


@RestController
public class UserController {
    @GetMapping("/users/{id}")
    public User getUser(@PathVariable int id) {
        User user = userRepository.findById(id);
        if (user == null) {
            throw new UserNotFoundException("User not found");
        }
        return user;
    }
    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<ErrorResponse> handleUserNotFoundException(UserNotFoundException ex) {
        ErrorResponse error = new ErrorResponse(HttpStatus.NOT_FOUND.value(), ex.getMessage());
        return new ResponseEntity<>(error, HttpStatus.NOT_FOUND);
    }
}

在上面的代码中,我们定义了一个 UserController 类,并实现了一个 getUser 方法。如果用户不存在,则抛出 UserNotFoundException 异常。然后,我们使用 @ExceptionHandler 注解定义了一个 handleUserNotFoundException 方法,用于处理 UserNotFoundException 异常。在该方法中,我们创建了一个 ErrorResponse 对象,包含了错误响应的状态码和消息,然后将其封装在 ResponseEntity 对象中返回。


如何使用 @ExceptionHandler 注解进行局部异常处理


要使用 @ExceptionHandler 注解进行局部异常处理,请按照以下步骤操作:


第 1 步:定义自定义异常

在代码中定义自定义异常,继承自 Exception 或 RuntimeException 类。例如:


public class UserNotFoundException extends RuntimeException {
    public UserNotFoundException(String message) {
        super(message);
    }
}

在上面的代码中,我们定义了一个名为 UserNotFoundException 的自定义异常,它继承自 RuntimeException 类。


第 2 步:抛出异常

在控制器方法中抛出自定义异常。例如:

@GetMapping("/users/{id}")
public User getUser(@PathVariable int id) {
    User user = userRepository.findById(id);
    if (user == null) {
        throw new UserNotFoundException("User not found");
    }
    return user;
}

在上面的代码中,如果用户不存在,则抛出 UserNotFoundException 异常。


第 3 步:处理异常

使用 @ExceptionHandler 注解定义一个方法,用于处理自定义异常。例如:


@ExceptionHandler(UserNotFoundException.class)
public ResponseEntity<ErrorResponse> handleUserNotFoundException(UserNotFoundException ex) {
    ErrorResponse error = new ErrorResponse(HttpStatus.NOT_FOUND.value(), ex.getMessage());
    return new ResponseEntity<>(error, HttpStatus.NOT_FOUND);
}

在上面的代码中,我们使用 @ExceptionHandler(UserNotFoundException.class) 注解定义了一个方法 handleUserNotFoundException,用于处理 UserNotFoundException 异常。在该方法中,我们创建了一个 ErrorResponse 对象,包含了错误响应的状态码和消息,然后将其封装在 ResponseEntity 对象中返回。


示例


以下是一个完整的示例:


UserController.java


@RestController
public class UserController {
    @Autowired
    private UserRepository userRepository;
    @GetMapping("/users/{id}")
    public User getUser(@PathVariable int id) {
        User user = userRepository.findById(id);
        if (user == null) {
            throw new UserNotFoundException("User not found");
        }
        return user;
    }
    @PostMapping("/users")
    public User createUser(@RequestBody User user) {
        userRepository.save(user);
        return user;
    }
    @PutMapping("/users/{id}")
    public User updateUser(@PathVariable int id, @RequestBody User user) {
        User existingUser = userRepository.findById(id);
        if (existingUser == null) {
            throw new UserNotFoundException("User not found");
        }
        existingUser.setName(user.getName());
        existingUser.setAge(user.getAge());
        userRepository.save(existingUser);
        return existingUser;
    }
    @DeleteMapping("/users/{id}")
    public void deleteUser(@PathVariable int id) {
        UseruserRepository.deleteById(id);
    }
    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<ErrorResponse> handleUserNotFoundException(UserNotFoundException ex) {
        ErrorResponse error = new ErrorResponse(HttpStatus.NOT_FOUND.value(), ex.getMessage());
        return new ResponseEntity<>(error, HttpStatus.NOT_FOUND);
    }
}

UserNotFoundException.java


public class UserNotFoundException extends RuntimeException {
    public UserNotFoundException(String message) {
        super(message);
    }
}

ErrorResponse.java


public class ErrorResponse {
    private int status;
    private String message;
    public ErrorResponse(int status, String message) {
        this.status = status;
        this.message = message;
    }
    public int getStatus() {
        return status;
    }
    public String getMessage() {
        return message;
    }
}

在上面的代码中,我们定义了一个 UserController 类,实现了 getUser、createUser、updateUser 和 deleteUser 方法。如果用户不存在,则抛出 UserNotFoundException 异常。然后,我们使用 @ExceptionHandler 注解定义了一个 handleUserNotFoundException 方法,用于处理 UserNotFoundException 异常。在该方法中,我们创建了一个 ErrorResponse 对象,包含了错误响应的状态码和消息,然后将其封装在 ResponseEntity 对象中返回。


原理


当控制器方法抛出异常时,SpringBoot 会在控制器类中查找带有 @ExceptionHandler 注解的方法,并调用它来处理异常。@ExceptionHandler 注解的方法必须具有以下特征:


  • 方法必须是 public、没有返回值,并且具有一个参数,该参数类型为抛出的异常类型。
  • 方法必须使用 @ExceptionHandler 注解进行注解,该注解的参数为抛出的异常类型。


当控制器方法抛出异常时,SpringBoot 将异常传递给带有 @ExceptionHandler 注解的方法。该方法将处理异常,并返回一个 ResponseEntity 对象,该对象包含错误响应的状态码和消息。


总结


在本文中,我们介绍了 SpringBoot 中的 @ExceptionHandler 注解,演示了如何使用它进行局部异常处理。使用 @ExceptionHandler 注解,我们可以在 Controller 层或方法级别上处理异常。当控制器方法抛出异常时,SpringBoot 会查找带有 @ExceptionHandler 注解的方法,并调用它来处理异常。要使用 @ExceptionHandler 注解进行局部异常处理,需要定义自定义异常、抛出异常和处理异常。


相关文章
|
17天前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
36 0
|
2月前
|
Java Spring
在使用Spring的`@Value`注解注入属性值时,有一些特殊字符需要注意
【10月更文挑战第9天】在使用Spring的`@Value`注解注入属性值时,需注意一些特殊字符的正确处理方法,包括空格、引号、反斜杠、新行、制表符、逗号、大括号、$、百分号及其他特殊字符。通过适当包裹或转义,确保这些字符能被正确解析和注入。
|
24天前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
45 4
SpringBoot必须掌握的常用注解!
|
2天前
|
前端开发 Java Spring
探索Spring MVC:@Controller注解的全面解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序的基石之一。它不仅简化了控制器的定义,还提供了一种优雅的方式来处理HTTP请求。本文将全面解析`@Controller`注解,包括其定义、用法、以及在Spring MVC中的作用。
17 2
|
26天前
|
存储 缓存 Java
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
81 2
|
26天前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
36 1
|
2月前
|
架构师 Java 开发者
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
在40岁老架构师尼恩的读者交流群中,近期多位读者成功获得了知名互联网企业的面试机会,如得物、阿里、滴滴等。然而,面对“Spring Boot自动装配机制”等核心面试题,部分读者因准备不足而未能顺利通过。为此,尼恩团队将系统化梳理和总结这一主题,帮助大家全面提升技术水平,让面试官“爱到不能自已”。
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
|
20天前
|
存储 安全 Java
springboot当中ConfigurationProperties注解作用跟数据库存入有啥区别
`@ConfigurationProperties`注解和数据库存储配置信息各有优劣,适用于不同的应用场景。`@ConfigurationProperties`提供了类型安全和模块化的配置管理方式,适合静态和简单配置。而数据库存储配置信息提供了动态更新和集中管理的能力,适合需要频繁变化和集中管理的配置需求。在实际项目中,可以根据具体需求选择合适的配置管理方式,或者结合使用这两种方式,实现灵活高效的配置管理。
13 0
|
2月前
|
XML Java 数据库
Spring boot的最全注解
Spring boot的最全注解
|
2月前
|
存储 Java 数据管理
强大!用 @Audited 注解增强 Spring Boot 应用,打造健壮的数据审计功能
本文深入介绍了如何在Spring Boot应用中使用`@Audited`注解和`spring-data-envers`实现数据审计功能,涵盖从添加依赖、配置实体类到查询审计数据的具体步骤,助力开发人员构建更加透明、合规的应用系统。
下一篇
无影云桌面