SpringBoot RESTful 风格入门讲解

什么是 RESTful 风格

RESTful 是一种 Web 架构风格，用于开发 Web API。它基于 HTTP 协议，使用 HTTP 中的 GET、POST、PUT、DELETE 等方法，并使用 URL 作为资源的唯一标识，返回 JSON 或 XML 格式的数据。通过 RESTful 风格可以实现 Web API 的统一设计，易于使用和维护。

SpringBoot 实现 RESTful 风格

SpringBoot 提供了对 RESTful 风格的良好支持，可以轻松实现基于 HTTP 协议的 Web API。以下是实现 RESTful 风格的步骤：

1. 配置依赖

在 SpringBoot 项目中，需要添加下面的依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

这个依赖包含了 SpringMVC 和 Tomcat 等组件，可以用于搭建 Web 服务器和处理 HTTP 请求。

1. 创建 RESTful Controller

在 SpringBoot 项目中，可以使用 @RestController 注解创建 RESTful 风格的 Controller 类。

@RestController
public class UserController {

    @GetMapping("/users")
    public List<User> getUsers() {
        // 获取用户列表的逻辑代码
        return userList;
    }

    @GetMapping("/users/{id}")
    public User getUserById(@PathVariable int id) {
        // 获取用户信息的逻辑代码
        return user;
    }

    @PostMapping("/users")
    public User addUser(@RequestBody User user) {
        // 添加用户的逻辑代码
        return user;
    }

    @PutMapping("/users/{id}")
    public User updateUser(@PathVariable int id, @RequestBody User user) {
        // 更新用户信息的逻辑代码
        return user;
    }

    @DeleteMapping("/users/{id}")
    public void deleteUser(@PathVariable int id) {
        // 删除用户的逻辑代码
    }
}

这个类中的 @GetMapping、@PostMapping、@PutMapping、@DeleteMapping 注解分别对应 HTTP 中的 GET、POST、PUT、DELETE 方法，并且可以带有路径参数。方法中的 @RequestBody 注解表示请求体中的数据映射为参数，@PathVariable 注解表示路径参数映射为参数。

1. 配置响应格式

在 SpringBoot 项目中，可以使用 @RestControllerAdvice 注解、@ExceptionHandler 注解和 ResponseEntity 类型等组件来配置响应格式。

示例 1：统一异常处理

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(Exception e) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(e.getMessage());
    }
}

这个类中的 @RestControllerAdvice 注解表示该类处理所有 RestController 中的异常。其中 @ExceptionHandler 注解处理特定异常，使用 ResponseEntity 类型来返回 HTTP 响应。

示例 2：自定义格式

public class Result {
    private int code;
    private String msg;
    private Object data;

    // getter 和 setter 方法省略
}

@RestController
public class UserController {

    @GetMapping("/users")
    public Result getUsers() {
        // 获取用户列表的逻辑代码
        return new Result(0, "success", userList);
    }
}

这个示例中，定义了一个返回格式为 {code: 0, msg: "success", data: {...}} 的 Result 类型，并在 UserController 中的 getUsers 方法中返回该类型的对象。通过自定义格式，可以解决 API 的统一性和易用性问题。

示例说明

下面是两个示例：

1. 获取用户列表

请求方式：GET

请求路径：/users

请求参数：无

响应格式：

{
    "code": 0,
    "msg": "success",
    "data": [
        {"id": 1, "name": "张三"},
        {"id": 2, "name": "李四"},
        {"id": 3, "name": "王五"}
    ]
}

示例代码：

@RestController
public class UserController {

    @GetMapping("/users")
    public List<User> getUsers() {
        List<User> userList = new ArrayList<User>();
        userList.add(new User(1, "张三"));
        userList.add(new User(2, "李四"));
        userList.add(new User(3, "王五"));
        return userList;
    }
}

1. 添加用户

请求方式：POST

请求路径：/users

请求参数：

{
    "name": "赵六"
}

响应格式：

{
    "code": 0,
    "msg": "success",
    "data": {"id": 4, "name": "赵六"}
}

示例代码：

@RestController
public class UserController {

    @PostMapping("/users")
    public User addUser(@RequestBody User user) {
        int userId = // 添加用户的逻辑代码
        user.setId(userId);
        return user;
    }
}