Spring创建用户接口：如何返回HTTP成功/错误响应消息？

我基于Spring、JPA和MySQL开发模拟自动售货机的API，其中POST接口/create-user用于将用户信息存入users表以创建新用户。需求如下：

• 检查用户名是否已存在，若存在则返回指定错误消息
• 若不存在则返回User对象

目前已实现创建成功时返回User对象，但不清楚如何返回错误消息。了解过ResponseEntity或自定义异常处理器方案，但觉得对于该简单需求过于复杂，希望找到更简便的实现方式。

期望响应格式：

• 成功响应：

{
    "username": "user",
    "password": "password",
    "role": "BUYER",
    "deposit": 0.0,
    "id": 12
}

• 失败响应（二选一即可）：

Error: username already in use.

或

{
  "error" : "Username already in use"
}

相关代码 #

User实体类

@Entity
@Table(name = "users")
public class User
{
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "id")
    private int userId;

    @NotNull
    @Column(name = "username", unique = true)
    private String username;

    @NotNull
    @Column(name = "password")
    private String password;

    @NotNull
    @Column(name = "role")
    private Role role;

    @NotNull
    @Column(name = "deposit")
    private BigDecimal deposit;

    public User() {}

    public User(String username, String password, Role role, BigDecimal deposit)
    {
        this.username = username;
        this.password = password;
        this.role = role;
        this.deposit = deposit;
    }

    public int getId()
    {
        return userId;
    }

    public String getUsername()
    {
        return username;
    }

    public void setUsername(String username)
    {
        this.username = username;
    }

    public String getPassword()
    {
        return password;
    }

    public void setPassword(String password)
    {
        this.password = password;
    }

    public Role getRole()
    {
        return role;
    }

    public void setRole(String role)
    {
        this.role = Role.valueOf(role);
    }

    public void setRole(Role role) {
        this.role = role;
    }

    public BigDecimal getDeposit()
    {
        return deposit;
    }

    public void setDeposit(BigDecimal deposit)
    {
        this.deposit = deposit;
    }
}

控制器方法

@PostMapping(value = "/create-user", consumes = {"application/json"})
public User createUser(@RequestBody User user)
{
    return userService.createUser(user);
}

UserService方法

public User createUser(User user)
{
//        if(userRepository.userExists(user.getUsername()) == 0)
    return userRepository.save(user);
}

UserRepository为继承JpaRepository的接口。

方案1：主动检查+ResponseEntity（直观可控） #

这是最直接的实现方式，代码改动少且逻辑清晰，完全满足需求：

1. 在UserRepository中添加存在性查询方法
   利用JPA的方法命名规则自动生成查询：

public interface UserRepository extends JpaRepository<User, Integer> {
    boolean existsByUsername(String username);
}

2. 修改UserService的createUser方法
   加入用户名存在性检查，存在则返回null：

public User createUser(User user) {
    if(userRepository.existsByUsername(user.getUsername())) {
        return null;
    }
    return userRepository.save(user);
}

3. 修改控制器方法返回ResponseEntity
   根据Service返回结果构造不同响应：

@PostMapping(value = "/create-user", consumes = {"application/json"})
public ResponseEntity<?> createUser(@RequestBody User user) {
    User createdUser = userService.createUser(user);
    if(createdUser == null) {
        // 返回JSON格式错误
        return ResponseEntity.badRequest().body(Map.of("error", "Username already in use"));
        // 若需要纯文本错误，替换为下面一行
        // return ResponseEntity.badRequest().body("Error: username already in use.");
    }
    return ResponseEntity.ok(createdUser);
}

方案2：利用唯一约束自动抛异常+局部捕获 #

由于username字段已添加unique = true约束，插入重复用户名时JPA会抛出DataIntegrityViolationException，可直接在控制器捕获处理：

修改控制器方法如下：

@PostMapping(value = "/create-user", consumes = {"application/json"})
public ResponseEntity<?> createUser(@RequestBody User user) {
    try {
        User createdUser = userService.createUser(user);
        return ResponseEntity.ok(createdUser);
    } catch (DataIntegrityViolationException e) {
        // 针对MySQL的错误信息判断，其他数据库需调整匹配逻辑
        if(e.getMessage().contains("users.username")) {
            return ResponseEntity.badRequest().body(Map.of("error", "Username already in use"));
        }
        // 其他数据完整性异常返回通用错误
        return ResponseEntity.badRequest().body(Map.of("error", "Data integrity error"));
    }
}

这种方式无需修改Repository和Service，利用数据库约束触发异常，代码改动极小，但缺点是不同数据库的异常信息格式可能不同，需要适配。

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