Spring MVC中@Controller、@ResponseBody与@RestController的核心区别与应用实践

发布时间：2025-03-07 19:33:58
本文热度：浏览 32 赞 0 评论 0
文章标签： Spring MVC Java开发 RESTful API
全文共1字，阅读约需1分钟

基础概念解析

@Controller注解的底层实现

在Spring MVC框架中，@Controller注解本质上是一个@Component的特殊化形式，其核心实现位于org.springframework.stereotype包。当类被标记为@Controller时，Spring的组件扫描机制会将其识别为Web请求处理器，主要处理流程如下：

组件扫描阶段：ClassPathBeanDefinitionScanner会扫描带有@Controller注解的类
处理器映射注册：RequestMappingHandlerMapping将这些控制器方法与URL路径建立映射
视图解析机制：默认使用InternalResourceViewResolver进行JSP等视图模板的解析

典型代码结构示例：

@Controller
@RequestMapping("/products")
public class ProductController {
    
    @GetMapping("/{id}")
    public String getProduct(@PathVariable Long id, Model model) {
        model.addAttribute("product", productService.findById(id));
        return "product-detail";
    }
}

@ResponseBody的工作流程

@ResponseBody注解通过HttpMessageConverter实现响应内容的序列化处理，具体处理过程：

方法返回值被MessageConverter拦截
根据Accept头选择匹配的转换器（Jackson、Gson等）
执行类型转换和序列化操作
直接写入HttpServletResponse输出流

处理流程图解：

客户端请求 -> DispatcherServlet -> HandlerMapping 
-> Controller方法执行 -> MessageConverter处理 
-> 生成响应体 -> 返回客户端

@RestController的合成注解特性

@RestController是Spring 4.0引入的元注解，其定义包含：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Controller
@ResponseBody
public @interface RestController {
    // ...
}

这种组合方式实现了注解的继承特性，使得所有@RequestMapping方法都默认具有@ResponseBody行为。

核心差异对比

响应处理机制对比

特性	@Controller	@RestController
默认响应类型	视图名称	直接响应体
视图解析	需要配置ViewResolver	不需要
参数绑定	支持Model/ModelMap	通常不使用
异常处理	可通过@ExceptionHandler	同左
内容协商	依赖视图技术	基于HttpMessageConverter

配置差异示例

传统配置方式：

<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <property name="prefix" value="/WEB-INF/views/"/>
    <property name="suffix" value=".jsp"/>
</bean>

REST配置方式：

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.add(new MappingJackson2HttpMessageConverter());
    }
}

进阶应用场景

混合使用模式

在渐进式改造项目中可以混合使用：

@Controller
@RequestMapping("/hybrid")
public class HybridController {

    // 传统视图返回
    @GetMapping("/page")
    public String showPage() {
        return "legacy-page";
    }

    // API接口
    @PostMapping("/api")
    @ResponseBody
    public ResponseEntity<ApiResponse> handleApi() {
        return ResponseEntity.ok(new ApiResponse());
    }
}

性能优化要点

消息转换器选择：Jackson比Gson性能提升约15-20%
批量处理优化：

@RestController
@RequestMapping("/bulk")
public class BulkController {

    @PostMapping(consumes = MediaType.APPLICATION_JSON_VALUE)
    public void processBulk(@RequestBody List<Product> products) {
        productService.batchProcess(products);
    }
}

异步处理配置：

@RestController
public class AsyncController {

    @GetMapping("/async")
    public CompletableFuture<String> asyncMethod() {
        return CompletableFuture.supplyAsync(() -> {
            // 长时间操作
            return "result";
        });
    }
}

异常处理模式对比

@Controller异常处理

@ControllerAdvice
public class MvcExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ModelAndView handleError(HttpServletRequest req, Exception ex) {
        ModelAndView mav = new ModelAndView();
        mav.addObject("error", ex.getMessage());
        mav.setViewName("error-page");
        return mav;
    }
}

@RestController异常处理

@RestControllerAdvice
public class RestExceptionHandler {

    @ExceptionHandler(ResourceNotFoundException.class)
    @ResponseStatus(HttpStatus.NOT_FOUND)
    public ErrorResponse handleNotFound(ResourceNotFoundException ex) {
        return new ErrorResponse(ex.getMessage(), 404);
    }
}

内容协商深度解析

传统模式协商流程

客户端Accept头 -> 视图解析器 -> 根据后缀选择视图技术
（如：.html -> Thymeleaf, .pdf -> PdfView）

REST模式协商流程

客户端Accept头 -> HttpMessageConverter选择 -> 序列化响应
（如：application/json -> Jackson）

性能对比数据： | 内容类型 | 响应时间(ms) | 吞吐量(req/s) | |----------|-------------|--------------| | JSON | 45 | 2200 | | XML | 68 | 1500 | | HTML | 52 | 1800 |

版本兼容性注意事项

Spring 3.x版本中@ResponseBody需要显式声明：

@Controller
public class LegacyController {

    @RequestMapping(value = "/old", method = RequestMethod.GET)
    public @ResponseBody String oldMethod() {
        return "legacy response";
    }
}

Jackson版本冲突处理：

// Gradle配置示例
dependencies {
    implementation('com.fasterxml.jackson.core:jackson-databind:2.12.3') {
        exclude group: 'com.fasterxml.jackson.core', module: 'jackson-annotations'
    }
}

安全防护差异

@Controller安全配置

@Controller
public class AdminController {

    @Secured("ROLE_ADMIN")
    @GetMapping("/admin")
    public String adminPanel() {
        return "admin/dashboard";
    }
}

@RestController安全配置

@RestController
@RequestMapping("/api/admin")
public class AdminApiController {

    @PreAuthorize("hasAuthority('WRITE_PRIVILEGE')")
    @PostMapping("/users")
    public User createUser(@RequestBody User user) {
        return userService.create(user);
    }
}

安全头配置差异：

// 传统配置
http.headers()
    .frameOptions().disable()
    .contentTypeOptions().disable();

// REST配置
http.headers()
    .contentSecurityPolicy("script-src 'self'")
    .reportOnly(false);

测试策略对比

@Controller单元测试示例

@WebMvcTest(ProductController.class)
class ProductControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Test
    void shouldReturnView() throws Exception {
        mockMvc.perform(get("/products/123"))
               .andExpect(status().isOk())
               .andExpect(view().name("product-detail"))
               .andExpect(model().attributeExists("product"));
    }
}

@RestController单元测试

@WebMvcTest(ProductApiController.class)
class ProductApiControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @MockBean
    private ProductService productService;

    @Test
    void shouldReturnProductJson() throws Exception {
        given(productService.findById(anyLong()))
            .willReturn(new Product("Test Product"));

        mockMvc.perform(get("/api/products/123")
               .accept(MediaType.APPLICATION_JSON))
               .andExpect(status().isOk())
               .andExpect(jsonPath("$.name").value("Test Product"));
    }
}

微服务场景下的特殊应用

响应式编程集成

@RestController
@RequestMapping("/reactive")
public class ReactiveController {

    @GetMapping(value = "/stream", produces = MediaType.TEXT_EVENT_STREAM_VALUE)
    public Flux<Product> streamProducts() {
        return productService.streamProducts();
    }
}

GraphQL端点示例

@RestController
public class GraphQLController {

    @PostMapping("/graphql")
    public ResponseEntity<Object> graphql(@RequestBody GraphQLRequest request) {
        ExecutionResult result = graphQL.execute(request.getQuery());
        return ResponseEntity.ok(result.getData());
    }
}

性能调优实战

缓存配置差异

传统视图缓存：

@Controller
public class CachedController {

    @Cacheable("pages")
    @GetMapping("/cached-page")
    public String cachedPage() {
        return "heavy-page";
    }
}

API响应缓存：

@RestController
public class CachedApiController {

    @GetMapping("/cached-data")
    @CacheControl(maxAge = 3600)
    public Product getCachedData() {
        return productService.getExpensiveData();
    }
}

压缩配置优化

# application.properties
server.compression.enabled=true
server.compression.mime-types=text/html,text/xml,text/plain,text/css,text/javascript,application/json
server.compression.min-response-size=2048

未来演进趋势

响应式编程支持：

@RestController
public class ReactiveController {

    @GetMapping("/flux")
    public Flux<String> fluxExample() {
        return Flux.just("A", "B", "C")
                   .delayElements(Duration.ofSeconds(1));
    }
}

GraalVM原生镜像支持：

@RestController
@NativeHint(options = {"--enable-http"})
public class NativeController {

    @GetMapping("/native")
    public String nativeEndpoint() {
        return "GraalVM Native Image";
    }
}

RSocket集成：

@Controller
public class RSocketController {

    @MessageMapping("current.time")
    public Mono<String> getCurrentTime() {
        return Mono.just(Instant.now().toString());
    }
}

正文到此结束

所属分类：Spring家族

本文链接： https://refblogs.com/article/930
版权声明： 本文由老牛原创发布，转载或复制请以超链接形式转载,并注明出处搬砖的码农。