如何优化使用@RepositoryRestResource时的错误响应信息

当然可以搞定这个问题！当使用@RepositoryRestResource时，Spring Data REST默认返回的多层嵌套异常信息确实不够友好，我们可以通过自定义异常处理逻辑，把模糊的错误信息转化为明确指出违规字段的清晰响应。下面是两种实用的方案：

方案一：全局异常处理器（简单通用） #

通过@RestControllerAdvice定义全局异常捕获器，专门处理数据完整性约束违反的情况，解析出违规字段和重复值：

import org.hibernate.exception.ConstraintViolationException;
import org.springframework.dao.DataIntegrityViolationException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.HashMap;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

@RestControllerAdvice
public class CustomRestExceptionHandler {

    // 适配PostgreSQL唯一约束错误消息的正则表达式
    private static final Pattern DUPLICATE_KEY_PATTERN = Pattern.compile("Key \\((.*?)\\)=\\((.*?)\\) already exists\\.");

    @ExceptionHandler(DataIntegrityViolationException.class)
    public ResponseEntity<Map<String, String>> handleDataIntegrityViolation(DataIntegrityViolationException ex) {
        Map<String, String> errorResponse = new HashMap<>();
        
        // 层层拆解异常，拿到Hibernate的原生约束违反异常
        if (ex.getCause() instanceof ConstraintViolationException) {
            ConstraintViolationException constraintEx = (ConstraintViolationException) ex.getCause();
            String sqlErrorMessage = constraintEx.getSQLException().getMessage();
            
            Matcher matcher = DUPLICATE_KEY_PATTERN.matcher(sqlErrorMessage);
            if (matcher.find()) {
                String violatedField = matcher.group(1);
                String invalidValue = matcher.group(2);
                errorResponse.put("error", String.format("字段【%s】的值「%s」已存在，违反唯一约束", violatedField, invalidValue));
                errorResponse.put("violatedField", violatedField);
                errorResponse.put("invalidValue", invalidValue);
            } else {
                errorResponse.put("error", "数据完整性约束违反");
                errorResponse.put("details", constraintEx.getMessage());
            }
        } else {
            errorResponse.put("error", "数据操作失败");
            errorResponse.put("details", ex.getMessage());
        }
        
        return new ResponseEntity<>(errorResponse, HttpStatus.CONFLICT);
    }
}

这个处理器会把你示例中的错误转化为类似下面的清晰响应：

{
  "error": "字段【email】的值「jhunstone0@netlog.com」已存在，违反唯一约束",
  "violatedField": "email",
  "invalidValue": "jhunstone0@netlog.com"
}

方案二：扩展Spring Data REST专属异常处理器（更贴合场景） #

如果全局处理器优先级不够（Spring Data REST有自己的异常处理链），可以直接扩展它的RepositoryRestExceptionHandler，只针对REST Repository的请求做优化：

import org.hibernate.exception.ConstraintViolationException;
import org.springframework.dao.DataIntegrityViolationException;
import org.springframework.data.rest.webmvc.RepositoryRestExceptionHandler;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;

import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

@ControllerAdvice(basePackageClasses = RepositoryRestExceptionHandler.class)
public class CustomRepositoryRestExceptionHandler extends RepositoryRestExceptionHandler {

    private static final Pattern DUPLICATE_KEY_PATTERN = Pattern.compile("Key \\((.*?)\\)=\\((.*?)\\) already exists\\.");

    @Override
    protected ResponseEntity<Object> handleDataIntegrityViolation(DataIntegrityViolationException ex, HttpServletRequest request) {
        Map<String, String> errorResponse = new HashMap<>();
        
        if (ex.getCause() instanceof ConstraintViolationException) {
            ConstraintViolationException constraintEx = (ConstraintViolationException) ex.getCause();
            String sqlMessage = constraintEx.getSQLException().getMessage();
            
            Matcher matcher = DUPLICATE_KEY_PATTERN.matcher(sqlMessage);
            if (matcher.find()) {
                String field = matcher.group(1);
                String value = matcher.group(2);
                errorResponse.put("message", String.format("字段%s的值%s已存在，请更换其他值", field, value));
                errorResponse.put("violatedField", field);
                return ResponseEntity.status(409).body(errorResponse);
            }
        }
        
        // 非重复键的情况，沿用Spring Data REST的默认处理逻辑
        return super.handleDataIntegrityViolation(ex, request);
    }
}

注意事项 #

• 数据库适配：不同数据库的约束错误消息格式不同，比如MySQL的重复键错误是Duplicate entry 'xxx' for key 'uk_xxx'，需要调整正则表达式适配。
• 更优雅的字段映射：如果约束名和字段名没有直接关联，可以通过JPA元数据（比如EntityManager获取实体的约束信息）来匹配字段，这种方式更可靠但实现稍复杂。

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