Spring Boot注册接口的泛型响应实现问题

1. 定义泛型响应封装类 #

先创建一个通用的GenericResponse<T>类，统一包装所有响应结果，同时兼容错误消息和用户数据两种场景：

import lombok.Builder;
import lombok.Data;

@Data
@Builder
public class GenericResponse<T> {
    // 可选状态码，用于标记请求结果（如200成功、400参数错误）
    private Integer status;
    // 通用消息字段，错误时提示原因，成功时返回提示语
    private String message;
    // 泛型数据字段，成功时存放UserDto，错误时可设为null
    private T data;
}

2. 修改signup方法的返回逻辑 #

把方法返回类型改为GenericResponse<?>，然后分别处理两种返回场景：

public GenericResponse<?> signup(SignUpRequest signUpRequest){
    // 用户名已存在的错误场景
    if (usernameExists) {
        return GenericResponse.builder()
                .status(400)
                .message("Error: Username is already taken!")
                .data(null)
                .build();
    }

    // 注册成功的场景
    User user = saveUserToDatabase(signUpRequest); // 这里替换为实际保存用户的逻辑
    UserDto userDto = UserDto.builder()
            .id(user.getId())
            .username(user.getUsername())
            .build();
            
    return GenericResponse.builder()
            .status(200)
            .message("Signup successful!")
            .data(userDto)
            .build();
}

3. 控制器层的响应处理（如果是接口方法） #

如果这个signup是Controller中的接口方法，直接返回泛型响应即可，Spring会自动序列化为JSON：

@PostMapping("/signup")
public ResponseEntity<GenericResponse<?>> signup(@RequestBody SignUpRequest signUpRequest) {
    GenericResponse<?> response = userService.signup(signUpRequest);
    return ResponseEntity.status(response.getStatus()).body(response);
}

这样前端可以统一解析status判断请求结果，通过message获取提示信息，data字段在成功时拿到用户数据，错误时忽略即可。

内容的提问来源于stack exchange，提问作者Sercan Noyan Germiyanoğlu