在视图中显示或不显示Spring验证错误消息的原因。

Question

我尝试创建了一个验证注解：

@Size(min = 6, message = "至少需要6个字符")
private String name;

现在，当我使用带有以下参数的方法（该方法标注了 POST）时：

@Valid LoginDetails loginDetails

当验证失败（在表单中输入的字符少于6个）时，错误消息并未显示。但是，如果我将参数改为：

@Valid @ModelAttribute("logindetails") LoginDetails loginDetails

此时错误消息就会被显示出来。我想了解为什么会发生这种情况。

以下是可重现此问题的最小代码示例：

package com.example.validationspring;

import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;

public class LoginDetails {

    @NotNull(message = "用户名不能为空")
    @Size(min = 6, message = "用户名至少需要6个字符")
    private String userName;

    // 标准的getter和setter方法
    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }
}

package com.example.validationspring;

import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.*;
import org.springframework.ui.Model;
import jakarta.validation.Valid;

@Controller
@RequestMapping("/login")
public class LoginController {

    @GetMapping
    public String showLoginForm(Model model) {
        model.addAttribute("logindetails", new LoginDetails());
        return "loginpage";
    }

    @PostMapping
    public String submitLoginForm(@Valid @ModelAttribute("logindetails") LoginDetails loginDetails, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            return "loginpage";  // 如果有错误，则再次显示带有验证消息的表单
        }
        // 处理数据并重定向（假设验证已通过）
        return "redirect:/success";
    }
}

josh3736 · Answer

差异是因为模型属性的名称。如果你不指定模型属性的名称，Spring MVC 将会根据声明的属性类型内部推断其名称。在你的例子中，默认情况下它会被推断为 loginDetails（与实际使用的 logindetails 不同）。

换句话说，以下代码是等效的：

@Valid @ModelAttribute("loginDetails") LoginDetails login

@Valid @ModelAttribute LoginDetails login

@Valid LoginDetails login

请注意：在上述情况下，模板中使用的属性名称需要是 loginDetails。

我建议的解决方案如下——简洁且一致：

@Valid LoginDetails loginDetails

th:object="${loginDetails}"

Noldorin · Answer

在Spring MVC中处理表单提交和验证时，你定义控制器方法参数的方式极大地影响了框架如何将请求参数绑定到表单支持对象以及如何处理验证。让我们比较一下你提到的两种情况来理解其中的区别。

场景1： 使用 @ModelAttribute("logindetails") LoginDetails loginDetails

当你用 @ModelAttribute("logindetails") 注解一个方法参数时，你正在向Spring MVC提供明确的指令来处理传入的表单数据并将其绑定到模型中。

绑定：Spring MVC会将请求参数绑定到由 logindetails 标识的 LoginDetails 实例（模型属性）的字段上。该实例要么从模型中检索（如果它已经存在，例如在你的代码中，在 GET 请求处理方法中添加了它），要么如果没有在模型中则创建一个新的实例。
验证：当你在 @ModelAttribute 后面使用 @Valid 时，Spring会应用在 LoginDetails 类中定义的验证约束到填充了请求数据的实例上。如果有任何约束违规（如字段太短、太长或不应为 null 时却为空），这些违规会被捕获并报告。
错误处理：如果验证失败，错误会被附加到模型中指定名称为 logindetails 的 LoginDetails 实例上。当你返回视图名称（如 loginpage）时，Spring确保渲染视图时同一个带有错误的 LoginDetails 实例可在模型中获取。这意味着Thymeleaf页面可以使用 th:errors 或等价的方法访问和显示验证错误。

场景2： 使用 LoginDetails loginDetails（不带 @ModelAttribute）

在这种情况下，你没有向Spring MVC提供关于如何根据模型处理传入表单数据的具体指令。以下是发生的情况：

绑定：Spring MVC仍然尝试将请求参数绑定到 LoginDetails 实例的字段上。然而，这个实例并没有与模型中的特定名称进行明确关联。它只是一个被填充并在方法作用域内使用的参数。
验证：你仍可以使用 @Valid 将验证约束应用到 LoginDetails 实例上。如果有违规，它们会被捕获。

错误处理：这里是主要区别所在。如果验证失败，虽然错误被捕获，但它们可能不会自动附加到视图可访问的命名模型属性上。这是因为你没有明确告诉Spring MVC使用具有名称的模型属性。当你返回视图名称（本例中是 loginpage）时，你需要确保手动将包含错误的 LoginDetails 实例添加回模型，否则视图将无法访问它，也就无法显示错误。你可以通过修改 if 语句体来手动添加：

   if(bindingResult.hasErrors()) {
       model.addAttribute("logindetails", loginDetails);
       model.addAttribute(BindingResult.MODEL_KEY_PREFIX + "logindetails", bindingResult);
       return "loginpage";
   }

验证失败时的详细对比：

ModelAttribute 绑定：使用 @ModelAttribute("logindetails") 时，框架清楚地知道 logindetails 是一个命名的模型属性。它确保渲染视图时使用的实例包含了验证错误。你的表单可以显示错误，因为 th:errors 标签查找的是模型中相同的 logindetails 实例。
未使用 ModelAttribute 绑定：如果不使用 @ModelAttribute，loginDetails 参数与模型之间的联系就不那么明确了。如果你在返回视图之前没有手动将包含错误的 loginDetails 添加回模型，视图可能无法访问这些错误。相反，它可能会访问一个新的无错误的 LoginDetails 实例。

Sam Saffron · Answer

Mar-Z 提供的根本原因正确无误。然而，由于需要进一步解释，请参考以下内容。

正如 Spring 框架文档中ModelAttribute部分所述：

小提示

使用 @ModelAttribute 是可选的。 默认情况下，任何不被 BeanUtils#isSimpleProperty 判断为简单值类型且未被其他参数解析器解析的参数 都会被视为隐式的 @ModelAttribute。

因此，即使在没有显式声明 @ModelAttribute 的情况下，Spring 仍然会将其作为隐式属性来处理。

但这里有一个需要注意的地方。

如果你查看关于如何应用默认名称的源代码，你会发现：

绑定到的模型属性名称。
默认的模型属性名称是根据声明的属性类型（即方法参数类型或方法返回类型）推断得出的，基于非限定类名：例如，对于类 "mypackage.OrderAddress" 使用 "orderAddress"，对于 "List" 使用 "orderAddressList"。

你的问题之所以出现，是因为你在多个地方（Thymeleaf 模板和代码中）使用了名为 logindetails 的模型名称。而类的实际名称是 LoginDetails。因此，在没有显式声明 @ModelAttribute 的情况下，Spring 将使用一个名为 loginDetails 的隐式模型属性