一文读懂SpringBoot统一封装返回前端结果集方法

2024-01-16 13:56:30

写在前面

SpringBoot是一个非常流行的Java框架，它简化了应用程序的开发过程。Spring Boot提供了很多开箱即用的特性，其中就包括RESTful API的支持。RESTful API是一种常用的应用程序编程接口（API），它允许应用程序在不同系统之间交换数据。

一、RESTful API简介

RESTful API是一种基于HTTP协议的应用程序编程接口。它使用HTTP请求和响应来交换数据。RESTful API通常使用JSON格式来表示数据。JSON是一种轻量级的数据交换格式，它非常适合在Web应用程序中使用。

二、SpringBoot中使用RESTful API

SpringBoot中使用RESTful API非常简单。只需要使用@RestController注解来标识一个控制器，然后使用@RequestMapping注解来映射HTTP请求到控制器的方法。

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

    @GetMapping("/{id}")
    public User getUserById(@PathVariable("id") Long id) {
        return userService.getUserById(id);
    }

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

    @PutMapping("/{id}")
    public User updateUser(@PathVariable("id") Long id, @RequestBody User user) {
        return userService.updateUser(id, user);
    }

    @DeleteMapping("/{id}")
    public void deleteUser(@PathVariable("id") Long id) {
        userService.deleteUser(id);
    }
}

上面代码定义了一个名为UserController的控制器，它负责处理与用户相关的HTTP请求。@RequestMapping("/api/users")注解将这个控制器映射到/api/users这个路径。@GetMapping("/{id}")注解将GET /api/users/{id}这个HTTP请求映射到getUserById()方法。@PostMapping注解将POST /api/users这个HTTP请求映射到createUser()方法。@PutMapping("/{id}")注解将PUT /api/users/{id}这个HTTP请求映射到updateUser()方法。@DeleteMapping("/{id}")注解将DELETE /api/users/{id}这个HTTP请求映射到deleteUser()方法。

三、统一返回结果

在实际项目开发过程中，我们经常需要将返回给前端的数据进行统一封装。这样可以使我们的代码更加简洁，也更易于维护。

SpringBoot中提供了很多方法可以帮助我们统一返回结果。最常用的方法就是使用ResponseEntity类。

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

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

    @PostMapping
    public ResponseEntity<User> createUser(@RequestBody User user) {
        User newUser = userService.createUser(user);
        return ResponseEntity.created(URI.create("/api/users/" + newUser.getId())).body(newUser);
    }

    @PutMapping("/{id}")
    public ResponseEntity<User> updateUser(@PathVariable("id") Long id, @RequestBody User user) {
        User updatedUser = userService.updateUser(id, user);
        return ResponseEntity.ok(updatedUser);
    }

    @DeleteMapping("/{id}")
    public ResponseEntity<Void> deleteUser(@PathVariable("id") Long id) {
        userService.deleteUser(id);
        return ResponseEntity.noContent().build();
    }
}