【Spring】26 Spring MVC的消息代码解析器

Spring MVC具有一种用于生成错误代码以从绑定错误中呈现错误消息的策略： MessageCodesResolver。如果你设置了 spring.mvc.message-codes-resolver-format属性为 PREFIX_ERROR_CODE或 POSTFIX_ERROR_CODE，Spring Boot会为你创建一个（参见 DefaultMessageCodesResolver.Format中的枚举）。

消息代码解析器的作用

MessageCodesResolver用于生成用于呈现错误消息的错误代码。它将错误字段的名称与错误代码结合起来，以便在用户界面中显示友好的错误信息。

示例

假设我们有一个简单的Spring MVC应用，其中包含表单验证。我们想要自定义错误消息的代码格式，以便更好地与前端界面配合。

首先，在application.properties中添加以下配置：

spring.mvc.message-codes-resolver-format=PREFIX_ERROR_CODE

然后，我们可以创建一个表单验证器，并在其中使用MessageCodesResolver生成错误代码。

import org.springframework.stereotype.Component;
import org.springframework.validation.Errors;
import org.springframework.validation.ValidationUtils;
import org.springframework.validation.Validator;

@Component
public class UserValidator implements Validator {

    @Override
    public boolean supports(Class<?> clazz) {
        return User.class.equals(clazz);
    }

    @Override
    public void validate(Object target, Errors errors) {
        ValidationUtils.rejectIfEmptyOrWhitespace(errors, "username", "error.username.empty");
        ValidationUtils.rejectIfEmptyOrWhitespace(errors, "password", "error.password.empty");
    }
}

在这个例子中，我们创建了一个名为UserValidator的表单验证器，并在validate方法中使用ValidationUtils.rejectIfEmptyOrWhitespace来验证表单字段。如果字段为空，它将会生成对应的错误代码，如error.username.empty和error.password.empty。

自定义消息代码格式

如果你想要自定义错误消息的代码格式，你可以在application.properties中设置spring.mvc.message-codes-resolver-format属性为POSTFIX_ERROR_CODE，然后修改错误代码的格式。

spring.mvc.message-codes-resolver-format=POSTFIX_ERROR_CODE

这样一来，错误代码的格式就会变成字段名加上错误代码，例如username.error.empty和password.error.empty。

通过这样的配置，我们可以灵活地自定义Spring MVC中的错误消息代码，以满足不同的业务需求。

总结

Spring MVC的MessageCodesResolver提供了生成错误消息代码的灵活策略，可以根据需要进行定制。通过示例和配置，我们了解了如何使用Spring Boot来设置和自定义消息代码解析器，并提供了一个实际的案例来说明如何实现这一点。