SpringBoot常用注解 @RestController 和 @ControllerAdvice

SpringBoot常用注解 @RestController 和 @ControllerAdvice

@RestControllerAdvice@ControllerAdvice 都是 Spring Framework 提供的用于全局控制器增强的注解,但它们的主要区别在于它们分别用于 RESTful API 应用和传统的 Web MVC 应用。

1. @RestControllerAdvice

  • 功能@RestControllerAdvice 主要用于 RESTful API 应用程序,它组合了 @ControllerAdvice@ResponseBody 注解,用于全局处理异常、数据绑定和全局数据预处理。它的异常处理方法返回的是带有数据的响应体,通常用于返回 JSON 格式的错误信息。

  • 用法:使用 @RestControllerAdvice 注解的类中可以定义 @ExceptionHandler@InitBinder@ModelAttribute 方法,用于捕获全局异常、初始化数据绑定器以及在所有 @RequestMapping 方法执行之前添加全局数据模型。以下是一个简单的用法示例:

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(Exception ex) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Internal Server Error");
    }
    // 其他方法如 @InitBinder 和 @ModelAttribute
}

@RestControllerAdvice 注解可以传递几种不同类型的参数,以便于定义全局的异常处理、数据绑定和数据模型。

  1. BasePackages 或 Value: 用于指定需要扫描的包路径,让 @RestControllerAdvice 仅作用于指定的包下的 Controller。可以使用 basePackagesvalue 属性进行配置。示例如下:
@RestControllerAdvice(basePackages = "com.example.controllers")
public class GlobalExceptionHandler {
    // 异常处理、数据绑定和数据模型方法
}
  1. AssignableTypes: 用于指定要适用于哪些类型或接口的控制器。这允许你只针对特定类型的 Controller 进行全局配置。示例如下:
@RestControllerAdvice(assignableTypes = {UserController.class, ProductController.class})
public class GlobalExceptionHandler {
    // 异常处理、数据绑定和数据模型方法
}
  1. Annotations: 用于指定只对带有特定注解的 Controller 进行全局配置。例如,如果你只想针对带有 @RestController 注解的 Controller 进行配置,可以使用 annotations 属性。示例如下:
@RestControllerAdvice(annotations = RestController.class)
public class GlobalExceptionHandler {
    // 异常处理、数据绑定和数据模型方法
}

通过这些参数的灵活使用,你可以对特定的 Controller 或者一组 Controller 进行全局配置,而不是将全局配置应用于整个应用程序的所有 Controller。这有助于提高灵活性并允许更细粒度的控制。

2. @ControllerAdvice

  • 功能@ControllerAdvice 用于传统的 Spring MVC 应用程序,它是 Spring 提供的用于全局控制器的增强功能的注解。它可以用于处理全局异常、数据绑定和全局数据预处理。

  • 用法:使用 @ControllerAdvice 注解的类中同样可以定义 @ExceptionHandler@InitBinder@ModelAttribute 方法。通常在非 RESTful API 的应用程序中使用,返回的视图类型可以是 HTML 页面或其他视图技术所需的内容。

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ControllerAdvice;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public String handleException(Exception ex) {
        // 返回视图名或重定向地址等
        return "errorPage";
    }
    // 其他方法如 @InitBinder 和 @ModelAttribute
}

@ControllerAdvice 注解是用于全局控制器的增强,用于处理全局异常、数据绑定以及全局数据预处理。它可以传递以下参数:

  1. BasePackages 或 Value: 用于指定需要扫描的包路径,让 @ControllerAdvice 仅作用于指定的包下的 Controller。可以使用 basePackagesvalue 属性进行配置。示例如下:
@ControllerAdvice(basePackages = "com.example.controllers")
public class GlobalControllerAdvice {
    // 异常处理、数据绑定和数据模型方法
}
  1. AssignableTypes: 用于指定要适用于哪些类型或接口的控制器。这允许你只针对特定类型的 Controller 进行全局配置。示例如下:
@ControllerAdvice(assignableTypes = {UserController.class, ProductController.class})
public class GlobalControllerAdvice {
    // 异常处理、数据绑定和数据模型方法
}
  1. Annotations: 用于指定只对带有特定注解的 Controller 进行全局配置。例如,如果你只想针对带有 @Controller 注解的 Controller 进行配置,可以使用 annotations 属性。示例如下:
@ControllerAdvice(annotations = Controller.class)
public class GlobalControllerAdvice {
    // 异常处理、数据绑定和数据模型方法
}

这些参数的使用方式与 @RestControllerAdvice 类似,通过使用这些参数,你可以对特定的 Controller 或一组 Controller 进行全局配置,而不是将全局配置应用于整个应用程序的所有 Controller。这种灵活性有助于提高控制器增强的精细度和可配置性。

全局异常处理案例代码

@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {

    @ExceptionHandler(BusinessException.class)
    public BaseResponse<?> businessExceptionHandler(BusinessException e) {
        log.error("BusinessException", e);
        return ResultUtils.error(e.getCode(), e.getMessage());
    }

    @ExceptionHandler(RuntimeException.class)
    public BaseResponse<?> runtimeExceptionHandler(RuntimeException e) {
        log.error("RuntimeException", e);
        return ResultUtils.error(ErrorCode.SYSTEM_ERROR, "系统错误");
    }
}

总结

总的来说,@RestControllerAdvice 用于 RESTful API,返回的是带有数据的响应体;而 @ControllerAdvice 则用于传统的 Spring MVC 应用,用于处理视图的返回(如 HTML 页面)。

选择使用哪个取决于你的应用类型和处理需求,RESTful API 通常会使用 @RestControllerAdvice,而传统的 Web MVC 应用则会使用 @ControllerAdvice

### Spring Boot 常用注解列表及其用途 #### @SpringBootApplication 此注解用于标记应用程序的入口类,集成了`@Configuration`, `@EnableAutoConfiguration` `@ComponentScan` 的功能。这使得该类不仅作为配置类存在,还启用了自动配置机制以及组件扫描[^2]。 ```java @SpringBootApplication public class MyApplication { public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` #### @ControllerAdvice常用来处理全局异常或提供跨控制器的方法。可以集中管理所有控制器中的公共行为,比如统一响应格式化、错误页面定制等操作[^1]。 #### @RestController 简化RESTful Web服务开发过程的一个便捷注解,相当于`@Controller`加上`@ResponseBody`的效果,意味着返回的对象会直接被序列化成JSON或其他形式的数据发送给客户端而不是视图名称。 #### @RequestMapping 映射HTTP请求至相应的处理器方法上,支持GET/POST等多种类型的HTTP动作,并允许指定URL模式匹配规则。通过它可以灵活控制路由逻辑。 #### @GetMapping/@PostMapping 这两个都是@RequestMapping的特例,分别对应于GETPOST两种最常见的HTTP方法,使代码更加直观易读。 #### @Autowired 实现依赖注入的核心手段之一,在声明属性时使用可让框架自动寻找合适的bean并完成赋值工作;也可以放在构造函数参数位置以强制性地装配必需的合作对象实例。 #### @Service 一般应用于业务层(Service Layer),表明此类负责执行某些特定领域内的核心业务流程,便于分层架构设计下的职责分离原则实施。 #### @Repository 标注数据访问层(Repository/DAL)上的持久化组件,有助于捕获JPA/Hibernate等相关技术引发的数据存取异常并将它们转换为spring通用的形式以便更好地管理传播。 #### @Entity 实体类专用标签,告知ORM工具哪些Java Bean应该映射到数据库表结构中去,同时还可以配合其他元数据定义字段约束条件、关联关系等内容。 #### @Transactional 确保事务边界清晰明了,当加在某个方法上面时表示整个调用期间要么全部成功提交更改,一旦发生任何意外情况则回滚之前所做的所有变更,从而保障系统的ACID特性。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

xwhking

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值