23. 如何在Spring Boot中配置RESTful Web服务？如何处理不同的HTTP请求方法和状态码？

在Spring Boot中，配置RESTful Web服务是非常简单和直观的。Spring Boot通过Spring MVC框架的支持，提供了对RESTful API开发的强大支持。以下是如何在Spring Boot中配置RESTful Web服务，以及如何处理不同的HTTP请求方法和状态码的详细说明。

1. 配置Spring Boot项目

1.1 创建Spring Boot项目

首先，使用Spring Initializr或者手动创建一个Spring Boot项目。确保项目中包含spring-boot-starter-web依赖，它是用于构建Web应用和RESTful服务的基础。

Maven依赖：

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

1.2 启动类

Spring Boot应用的主类通常使用@SpringBootApplication注解来标识，并包含main方法以启动Spring Boot应用。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

2. 创建RESTful控制器

2.1 定义一个基本的REST控制器

在Spring Boot中，使用@RestController注解来定义RESTful控制器。该注解是@Controller和@ResponseBody的组合注解，表示该控制器的所有方法默认返回JSON格式的响应。

import org.springframework.web.bind.annotation.*;

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

    // GET请求：获取用户列表
    @GetMapping
    public List<User> getAllUsers() {
        // 返回用户列表
        return List.of(new User(1L, "John Doe"), new User(2L, "Jane Doe"));
    }

    // GET请求：根据ID获取用户
    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        // 根据ID返回用户
        return new User(id, "John Doe");
    }

    // POST请求：创建新用户
    @PostMapping
    public User createUser(@RequestBody User user) {
        // 创建并返回新用户
        return user;
    }

    // PUT请求：更新用户信息
    @PutMapping("/{id}")
    public User updateUser(@PathVariable Long id, @RequestBody User user) {
        // 更新用户信息
        user.setId(id);
        return user;
    }

    // DELETE请求：删除用户
    @DeleteMapping("/{id}")
    public void deleteUser(@PathVariable Long id) {
        // 删除用户
        System.out.println("User with id " + id + " deleted");
    }
}

2.2 路由和请求映射

• @RequestMapping：用来定义控制器类的基础URL路径，例如/api/users。
• @GetMapping：处理GET请求，用于获取资源。
• @PostMapping：处理POST请求，用于创建资源。
• @PutMapping：处理PUT请求，用于更新资源。
• @DeleteMapping：处理DELETE请求，用于删除资源。
• @PathVariable：用于获取URL路径中的动态参数。
• @RequestBody：用于从HTTP请求体中获取数据并自动转换为Java对象。

3. 处理HTTP状态码

Spring Boot允许你轻松地处理和设置HTTP状态码，以确保API遵循RESTful规范。可以通过ResponseEntity类来精确控制返回的状态码和响应体。

3.1 返回不同的HTTP状态码

• 返回200 OK：默认情况下，所有成功的请求会返回200 OK状态码。

@GetMapping("/{id}")
public ResponseEntity<User> getUserById(@PathVariable Long id) {
    User user = new User(id, "John Doe");
    return ResponseEntity.ok(user);  // 返回200 OK
}

• 返回201 Created：用于创建资源成功后的响应。

@PostMapping
public ResponseEntity<User> createUser(@RequestBody User user) {
    // 创建用户逻辑
    return ResponseEntity.status(HttpStatus.CREATED).body(user);  // 返回201 Created
}

• 返回204 No Content：用于成功处理但不需要返回数据的响应。

@DeleteMapping("/{id}")
public ResponseEntity<Void> deleteUser(@PathVariable Long id) {
    // 删除用户逻辑
    return ResponseEntity.noContent().build();  // 返回204 No Content
}

• 返回404 Not Found：用于处理找不到资源的情况。

@GetMapping("/{id}")
public ResponseEntity<User> getUserById(@PathVariable Long id) {
    User user = findUserById(id);
    if (user == null) {
        return ResponseEntity.notFound().build();  // 返回404 Not Found
    }
    return ResponseEntity.ok(user);
}

3.2 处理异常并返回状态码

通过使用@ExceptionHandler注解，可以捕获和处理控制器中的异常，并返回相应的HTTP状态码。

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<String> handleUserNotFoundException(UserNotFoundException ex) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(ex.getMessage());
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleGeneralException(Exception ex) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Internal Server Error");
    }
}

4. 使用ResponseEntity构建复杂响应

ResponseEntity是Spring框架提供的一个类，用于表示HTTP响应，包括状态码、响应体和响应头。通过使用ResponseEntity，你可以构建更加复杂和灵活的HTTP响应。

@GetMapping("/{id}")
public ResponseEntity<User> getUserById(@PathVariable Long id) {
    User user = findUserById(id);
    if (user == null) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND)
                             .header("Custom-Header", "User Not Found")
                             .body(null);
    }
    return ResponseEntity.ok()
                         .header("Custom-Header", "User Found")
                         .body(user);
}

• ResponseEntity.ok()：返回200 OK状态码。
• ResponseEntity.status(HttpStatus.CREATED)：指定返回的状态码。
• header(String name, String value)：设置响应头。
• body(Object body)：设置响应体。

5. 总结

在Spring Boot中配置和使用RESTful Web服务非常方便，通过使用Spring MVC提供的注解可以轻松处理不同的HTTP请求方法。你可以使用@RestController、@RequestMapping、@GetMapping、@PostMapping等注解来定义RESTful API的路由，并通过ResponseEntity精确控制HTTP状态码和响应体。此外，使用异常处理和全局异常捕获可以帮助你更好地处理错误和返回合适的HTTP状态码，使你的API更加健壮和一致。