Spring Boot中Controller返回值处理方案

原创于 2025-06-27 13:41:39 发布 · 1k 阅读

23 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #后端

SpringBoot 专栏收录该内容

2 篇文章

订阅专栏

一、前言

在Spring Boot开发中，Controller层返回值的处理方式直接影响API的响应结构和客户端交互效率。针对不同业务场景，合理选择返回值方案能够提升代码可维护性、统一响应格式或优化性能。

本文将介绍SpringBoot中四种常用的控制器返回值处理方案。

二、四种常见的处理方案

1.返回ResponseEntity对象

ResponseEntity是Spring框架提供的一个用于表示HTTP响应的类，它允许开发者完全控制响应内容，包括状态码、头信息和响应体。

@RestController
@RequestMapping("/api/users")
public class UserController {
    
    @GetMapping("/{id}")
    public ResponseEntity<?> getUser(@PathVariable Long id) {
        try {
            User user = userService.findById(id);
            if (user == null) {
                return ResponseEntity.notFound().build();
            }
            return ResponseEntity.ok(user);
        } catch (Exception e) {
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
                .body("获取用户信息失败：" + e.getMessage());
        }
    }
    
    @PostMapping
    public ResponseEntity<User> createUser(@RequestBody User user) {
        User createdUser = userService.save(user);
        URI location = ServletUriComponentsBuilder
            .fromCurrentRequest()
            .path("/{id}")
            .buildAndExpand(createdUser.getId())
            .toUri();
        
        return ResponseEntity.created(location).body(createdUser);
    }
}

优势

提供了对HTTP响应的完全控制
可以灵活设置状态码、头信息等
支持链式调用，代码简洁清晰
特别适合RESTful API的开发

适用场景

需要精确控制HTTP状态码的场景
需要设置特定响应头的场景
RESTful API的开发

2.使用@ResponseBody注解

使用@ResponseBody注解（或在类上使用@RestController）可以让Spring将返回值直接序列化到HTTP响应体中。这种方式简单直接，特别适合返回JSON或XML数据。

@Controller
@RequestMapping("/api/products")
public class ProductController {
    
    @GetMapping("/{id}")
    @ResponseBody
    public Product getProduct(@PathVariable Long id) {
        return productService.findById(id);
    }
    
    @GetMapping("/count")
    @ResponseBody
    public Integer getProductCount() {
        return productService.count();
    }
    
    @GetMapping("/available")
    @ResponseBody
    public boolean isProductAvailable(@RequestParam String sku) {
        return productService.checkAvailability(sku);
    }
    
    @GetMapping("/message")
    @ResponseBody
    public String getMessage() {
        return "这是一条简单的文本消息";
    }
}

优势

代码简洁，无需额外封装
支持多种返回类型（对象、集合、基本类型等）
Spring自动处理序列化过程

适用场景

前后端分离架构
只需返回数据而不关心HTTP状态的场景
简单的API端点

3.返回视图和模型（传统Web应用）

在传统的Web应用中，控制器方法通常返回一个视图名称，并通过Model或ModelAndView传递数据。这种方式适合服务器端渲染的应用。

@Controller
@RequestMapping("/web")
public class WebController {
    
    @GetMapping("/users")
    public String listUsers(Model model) {
        List<User> users = userService.findAll();
        model.addAttribute("users", users);
        model.addAttribute("title", "用户列表");
        return "user/list";  // 返回视图名，对应 templates/user/list.html
    }
    
    @GetMapping("/dashboard")
    public ModelAndView dashboard() {
        ModelAndView mav = new ModelAndView("dashboard");
        mav.addObject("stats", statisticsService.getSummary());
        mav.addObject("lastLogin", new Date());
        return mav;
    }
    
    // 重定向示例
    @PostMapping("/users/save")
    public String saveUser(User user) {
        userService.save(user);
        return "redirect:/web/users";  // 重定向到用户列表
    }
}

优势

适合传统服务器端渲染的Web应用
与模板引擎（如Thymeleaf、Freemarker）无缝集成
支持重定向和转发

适用场景

传统的Web应用
需要服务器端渲染的页面
管理后台等复杂表单交互场景

4.使用统一响应格式封装（推荐）

在实际项目中，通常会定义统一的响应格式，包含状态码、消息和数据。这种方式有助于前后端交互的一致性和规范性。

import lombok.Data;

/**
 * 统一返回值工具类
 *
 * @param <T>
 */
@Data
public class Result<T> {
    private Integer code;
    private String message;
    private T data;
    private Long timestamp;

    public static <T> Result<T> success(T data) {
        Result<T> result = new Result<>();
        result.setCode(200);
        result.setMessage("操作成功");
        result.setData(data);
        result.setTimestamp(System.currentTimeMillis());
        return result;
    }

    public static <T> Result<T> error(Integer code, String message) {
        Result<T> result = new Result<>();
        result.setCode(code);
        result.setMessage(message);
        result.setTimestamp(System.currentTimeMillis());
        return result;
    }

}
################

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.*;
import org.wal.userdemo.entity.DTO.UserDTO;
import org.wal.userdemo.entity.UserEntity;
import org.wal.userdemo.service.UserService;
import org.wal.userdemo.utils.Result;

import java.util.List;

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserService userService;

    /**
     * 获取用户信息
     * @param id
     * @return
     */
    @GetMapping("/getUserById")
    public Result<UserEntity> getUserById(@RequestParam("id") Integer id) {
         try {
            UserEntity userEntity = userService.getUserById(id);
            if (userEntity == null) {
                return Result.error(404, "用户不存在");
            }
            return Result.success(userEntity);
        } catch (Exception e) {
            return Result.error(500, e.getMessage());
        }
    }
}

优势