Spring Controller返回Game对象或JSON错误的最优实现方案咨询

嘿，你完全没必要创建空接口来处理这种场景，那反而会让代码变得冗余且不直观。Spring MVC提供了好几种更优雅的方式来实现“成功返回Game对象，失败返回错误JSON”的需求，我给你梳理几个常用的思路：

方案1：用ResponseEntity灵活控制响应（最直接的方式） #

ResponseEntity是Spring里专门用来定制HTTP响应的工具，它能让你同时指定响应状态码和响应体内容。你只需要把控制器方法的返回类型改成ResponseEntity<?>，然后根据业务逻辑返回对应的结果就行：

@RequestMapping(method = RequestMethod.POST, consumes = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<?> makeGuess(@RequestBody Guess guess){
    try {
        Game game = gameService.makeGuess(guess);
        // 游戏正常运行，返回200 OK和Game对象
        return ResponseEntity.ok(game);
    } catch (GameLostException e) { // 先假设你定义了一个游戏失败的自定义异常
        // 游戏结束，返回400 Bad Request（或者你觉得合适的状态码，比如410 Gone）和错误JSON
        return ResponseEntity.badRequest().body(Map.of("error", "You've lost"));
    }
}

这里的关键是：成功时用ResponseEntity.ok()包装Game对象，Spring会自动把它序列化为JSON；失败时返回一个包含error字段的Map，同样会被自动转成你要的{error: "You've lost"}格式。

方案2：自定义统一响应体（适合需要统一API格式的场景） #

如果你的前端希望所有API都返回相同结构的响应（不管成功失败），可以创建一个通用的响应类，把数据和错误信息都封装进去：

public class ApiResponse<T> {
    private T data;
    private String error;

    // 成功时用的构造器
    public ApiResponse(T data) {
        this.data = data;
        this.error = null;
    }

    // 失败时用的构造器
    public ApiResponse(String error) {
        this.data = null;
        this.error = error;
    }

    // 这里记得加上getter和setter，或者用Lombok的@Data注解
}

然后控制器直接返回这个类：

@RequestMapping(method = RequestMethod.POST, consumes = MediaType.APPLICATION_JSON_VALUE)
public ApiResponse<Game> makeGuess(@RequestBody Guess guess){
    Game game = gameService.makeGuess(guess);
    // 假设你的Game类里有status字段标记游戏状态，比如"LOST"表示失败
    if("LOST".equals(game.getStatus())) {
        return new ApiResponse<>("You've lost");
    }
    return new ApiResponse<>(game);
}

这样前端处理起来会很方便：成功时取data字段拿到Game对象，失败时取error字段拿到错误信息，不用处理两种不同的响应结构。

方案3：全局异常处理器（最推荐的业务异常处理方式） #

如果游戏失败是一个明确的业务异常场景，我强烈推荐用这种方式——把业务逻辑和响应处理解耦，代码会更干净：

1. 先定义一个自定义异常：

public class GameLostException extends RuntimeException {
    public GameLostException(String message) {
        super(message);
    }
}

2. 在你的gameService.makeGuess()方法里，当判断玩家输了的时候抛出这个异常：

public Game makeGuess(Guess guess) {
    // 这里是你的业务逻辑，比如统计错误次数
    if(this.incorrect >= MAX_WRONG_GUESSES) { // MAX_WRONG_GUESSES是你定义的最大错误次数
        throw new GameLostException("You've lost");
    }
    // 正常情况返回Game对象
    return this;
}

3. 创建一个全局异常处理器，专门捕获这个异常并返回错误JSON：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(GameLostException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST) // 给这个错误设置合适的HTTP状态码
    public Map<String, String> handleGameLost(GameLostException e) {
        return Map.of("error", e.getMessage());
    }
}

4. 最后你的控制器代码可以完全保持原样，不用做任何修改：

@RequestMapping(method = RequestMethod.POST, consumes = MediaType.APPLICATION_JSON_VALUE)
public Game makeGuess(@RequestBody Guess guess){
    return gameService.makeGuess(guess);
}

当gameService抛出GameLostException时，全局处理器会自动捕获它，返回你要的错误JSON和指定的状态码，控制器只需要专注于正常流程的处理就行。

总结一下 #

完全不需要创建空接口，那是多余的设计。优先考虑全局异常处理器（业务场景清晰时）或者ResponseEntity（需要灵活控制响应时），这两种方式都更符合Spring的设计理念，代码也更简洁易维护。

内容的提问来源于stack exchange，提问作者Ash_s94