如何在 API Spring Boot 中返回自定义值

在 API 开发中，返回自定义值是常见的需求。在 Spring Boot 中，我们可以使用 ResponseEntity 类型来实现这个功能。

1. 返回 String 类型

如果要返回一个 String 类型的结果，只需要在 Controller 中定义一个接口，然后在接口中返回一个 ResponseEntity 类型即可。下面是一个例子：

@GetMapping("/hello")
public ResponseEntity<String> hello() {
    String message = "Hello world";
    return new ResponseEntity<>(message, HttpStatus.OK);
}

在上面的例子中，我们定义了一个 GET 请求，返回了一个 String 类型的信息。在方法体中，我们定义了一个 message 变量，并将其赋为 "Hello world"。然后，我们通过 new ResponseEntity<>(message, HttpStatus.OK) 创建了一个 ResponseEntity 对象，并将其返回。

2. 返回自定义对象

如果要返回一个自定义对象，我们需要在 Controller 中定义一个接口，然后在接口中返回一个 ResponseEntity 类型。下面是一个例子：

@GetMapping("/user/{id}")
public ResponseEntity<User> getUserById(@PathVariable("id") Long id) {
    User user = userService.getUserById(id);
    return new ResponseEntity<>(user, HttpStatus.OK);
}

在上面的例子中，我们定义了一个 GET 请求，接收一个 id 参数，并返回一个 User 类型的对象。在方法体中，我们通过调用 userService 的 getUserById 方法获取 user 对象，并通过 new ResponseEntity<>(user, HttpStatus.OK) 返回 ResponseEntity 对象。

3. 返回自定义错误信息

如果我们要在 API 开发中返回自定义的错误信息，我们可以通过在 ResponseEntity 中设置 HttpStatus 状态码和错误信息来实现。下面是一个例子：

@GetMapping("/user/{id}")
public ResponseEntity<User> getUserById(@PathVariable("id") Long id) {
    User user = userService.getUserById(id);
    if (user == null) {
        return new ResponseEntity<>(HttpStatus.NOT_FOUND);
    }
    return new ResponseEntity<>(user, HttpStatus.OK);
}

在上面的例子中，如果 userService 中没有查询到 id 对应的用户，则返回一个 HttpStatus.NOT_FOUND 状态码来表明错误，并且不返回用户信息。如果查询到了，则返回 HttpStatus.OK 状态码和用户信息。

总结

在 Spring Boot 中返回自定义值非常简单，只需要在 Controller 中定义一个接口，然后在接口中返回一个 ResponseEntity 类型即可。如果要返回自定义对象或自定义错误信息，我们只需要在 ResponseEntity 中设置相应的参数即可。