注解 – @RestController

注解简介

在今天的每日一注解中，我们将探讨@RestController注解。@RestController是Spring框架中的一个组合注解，方便创建RESTful Web服务。

注解定义

@RestController注解是@Controller和@ResponseBody注解的组合，用于定义RESTful控制器。以下是一个基本的示例：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class MyController {

    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, World!";
    }
}

注解详解

@RestController注解结合了@Controller和@ResponseBody的功能，使得控制器方法返回的对象会自动通过消息转换器（如Jackson）转换为JSON或XML格式，并写入HTTP响应体中。适用于创建RESTful API的控制器类。

• 用途：简化RESTful服务的创建，将方法返回值直接作为HTTP响应体返回。

使用场景

@RestController广泛用于Spring Boot和Spring MVC应用程序中，方便快速构建RESTful API。它消除了每个方法上使用@ResponseBody注解的需要，使代码更简洁。

示例代码

以下是一个使用@RestController注解的代码示例，展示了如何创建简单的RESTful API：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;

@RestController
@RequestMapping("/api/users")
public class UserController {

    private List<User> users = new ArrayList<>();

    @GetMapping
    public List<User> getAllUsers() {
        return users;
    }

    @PostMapping
    public User createUser(@RequestBody User user) {
        users.add(user);
        return user;
    }
}

// User类
public class User {
    private String name;
    private String email;

    // getters and setters
}

常见问题

问题：@RestController与@Controller有何区别？

解决方案：@RestController是@Controller和@ResponseBody的组合，适用于RESTful服务。@Controller通常用于传统的MVC模式，需要与视图解析器结合使用。

@Controller
public class MyController {
    
    @GetMapping("/view")
    public String view(Model model) {
        model.addAttribute("message", "Hello, World!");
        return "hello";
    }
}

问题：如何处理不同格式的响应？

解决方案：确保项目中包含合适的消息转换器（如Jackson用于JSON），Spring会自动处理对象到指定格式的转换。

// 在Spring Boot项目中，通常只需添加Jackson依赖即可：

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.13.3</version>
</dependency>

小结

通过今天的学习，我们了解了@RestController的基本用法和应用场景。明天我们将探讨另一个重要的Spring注解——@RequestHeader。

相关链接

• Spring 官方文档
• Spring MVC 注解驱动的控制器
• Spring Boot 官方文档

希望这个示例能帮助你更好地理解和应用@RestController注解。如果有任何问题或需要进一步的帮助，请随时告诉我。