快捷導(dǎo)航

SpringBoot控制器返回值處理的4個(gè)技巧分享

更新時(shí)間：2025年05月14日 08:20:28 作者：風(fēng)象南

在SpringBoot應(yīng)用開發(fā)中,控制器(Controller)的返回值處理是一個(gè)基礎(chǔ)但極其重要的環(huán)節(jié),本文將介紹SpringBoot中四種常用的控制器返回值處理技巧,有需要的可以參考下

1. 返回ResponseEntity對(duì)象

ResponseEntity是Spring框架提供的一個(gè)用于表示HTTP響應(yīng)的類，它允許開發(fā)者完全控制響應(yīng)內(nèi)容，包括狀態(tài)碼、頭信息和響應(yīng)體。

@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);
    }
}

優(yōu)勢(shì)

提供了對(duì)HTTP響應(yīng)的完全控制
可以靈活設(shè)置狀態(tài)碼、頭信息等
支持鏈?zhǔn)秸{(diào)用，代碼簡(jiǎn)潔清晰
特別適合RESTful API的開發(fā)

適用場(chǎng)景

需要精確控制HTTP狀態(tài)碼的場(chǎng)景
需要設(shè)置特定響應(yīng)頭的場(chǎng)景
RESTful API的開發(fā)

2. 使用@ResponseBody注解

使用@ResponseBody注解（或在類上使用@RestController）可以讓Spring將返回值直接序列化到HTTP響應(yīng)體中。這種方式簡(jiǎn)單直接，特別適合返回JSON或XML數(shù)據(jù)。

@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 "這是一條簡(jiǎn)單的文本消息";
    }
}

優(yōu)勢(shì)

代碼簡(jiǎn)潔，無(wú)需額外封裝
支持多種返回類型（對(duì)象、集合、基本類型等）
Spring自動(dòng)處理序列化過(guò)程

適用場(chǎng)景

前后端分離架構(gòu)
只需返回?cái)?shù)據(jù)而不關(guān)心HTTP狀態(tài)的場(chǎng)景
簡(jiǎn)單的API端點(diǎn)

3. 返回視圖和模型（傳統(tǒng)Web應(yīng)用）

在傳統(tǒng)的Web應(yīng)用中，控制器方法通常返回一個(gè)視圖名稱，并通過(guò)Model或ModelAndView傳遞數(shù)據(jù)。這種方式適合服務(wù)器端渲染的應(yīng)用。

@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";  // 返回視圖名，對(duì)應(yīng) 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";  // 重定向到用戶列表
    }
}

優(yōu)勢(shì)

適合傳統(tǒng)服務(wù)器端渲染的Web應(yīng)用
與模板引擎（如Thymeleaf、Freemarker）無(wú)縫集成
支持重定向和轉(zhuǎn)發(fā)

適用場(chǎng)景

傳統(tǒng)的Web應(yīng)用
需要服務(wù)器端渲染的頁(yè)面
管理后臺(tái)等復(fù)雜表單交互場(chǎng)景

4. 使用統(tǒng)一響應(yīng)格式封裝

在實(shí)際項(xiàng)目中，通常會(huì)定義統(tǒng)一的響應(yīng)格式，包含狀態(tài)碼、消息和數(shù)據(jù)。這種方式有助于前后端交互的一致性和規(guī)范性。

// 統(tǒng)一響應(yīng)實(shí)體類
@Data
public class ApiResponse<T> {
    private Integer code;
    private String message;
    private T data;
    private long timestamp;
    
    public static <T> ApiResponse<T> success(T data) {
        ApiResponse<T> response = new ApiResponse<>();
        response.setCode(200);
        response.setMessage("操作成功");
        response.setData(data);
        response.setTimestamp(System.currentTimeMillis());
        return response;
    }
    
    public static <T> ApiResponse<T> error(Integer code, String message) {
        ApiResponse<T> response = new ApiResponse<>();
        response.setCode(code);
        response.setMessage(message);
        response.setTimestamp(System.currentTimeMillis());
        return response;
    }
}

// 全局響應(yīng)處理（可選方式）
@RestControllerAdvice
public class GlobalResponseHandler implements ResponseBodyAdvice<Object> {
    
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        // 決定哪些方法需要處理
        return true;
    }
    
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, 
                                 MediaType selectedContentType, 
                                 Class<? extends HttpMessageConverter<?>> selectedConverterType, 
                                 ServerHttpRequest request, ServerHttpResponse response) {
        // 已經(jīng)是ApiResponse類型則不再包裝
        if (body instanceof ApiResponse) {
            return body;
        }
        // 包裝成功響應(yīng)
        return ApiResponse.success(body);
    }
}

// 控制器使用示例
@RestController
@RequestMapping("/api/v1")
public class ModernApiController {
    
    @GetMapping("/orders")
    public ApiResponse<List<Order>> getOrders() {
        List<Order> orders = orderService.findAll();
        return ApiResponse.success(orders);
    }
    
    @GetMapping("/customers/{id}")
    public ApiResponse<Customer> getCustomer(@PathVariable Long id) {
        try {
            Customer customer = customerService.findById(id);
            if (customer == null) {
                return ApiResponse.error(404, "客戶不存在");
            }
            return ApiResponse.success(customer);
        } catch (Exception e) {
            return ApiResponse.error(500, "服務(wù)器錯(cuò)誤：" + e.getMessage());
        }
    }
}

優(yōu)勢(shì)