Spring Boot Thymeleaf 表单数据绑定：深入理解与最佳实践

<form th:action="@{/login}" method="get" th:object="${loginForm}" style="max-width: 600px; margin: 0 auto;">
  <div class="m-3">
    <div class="form-group row">
      <label class="col-4 col-form-label">E-mail: </label>
      <div class="col-8">
        <input type="text" th:field="*{email}" name="q" class="form-control" required />
      </div>
    </div>
    <!-- ... other fields ... -->
    <div>
      <button type="submit" class="btn btn-primary">Log in</button>
    </div>
  </div>
</form>

@GetMapping("login")
public ModelAndView login(Model model, @RequestParam(name = "q", required = false) Optional<String> email) {
    // ... logic ...
    System.out.println(email); // 总是 Optional.empty
    // ... logic ...
}

// LoginForm.java
package com.example.demo.dto; // 示例包名

import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.AllArgsConstructor;

@Data // Lombok 注解，自动生成 getter/setter/equals/hashCode/toString
@NoArgsConstructor // Lombok 注解，生成无参构造函数
@AllArgsConstructor // Lombok 注解，生成全参构造函数
public class LoginForm {
    private String email;
    private String password;

    // 如果不使用Lombok，需要手动添加 getter 和 setter 方法
    // public String getEmail() { return email; }
    // public void setEmail(String email) { this.email = email; }
    // public String getPassword() { return password; }
    // public void setPassword(String password) { this.password = password; }
}

<!-- login-form.html -->
<form th:action="@{/login}" method="get" th:object="${loginForm}" style="max-width: 600px; margin: 0 auto;">
  <div class="m-3">

    <div class="form-group row">
      <label class="col-4 col-form-label">E-mail: </label>
      <div class="col-8">
        <!-- th:field="*{email}" 会自动生成 name="email" 和 id="email" -->
        <input type="text" th:field="*{email}" class="form-control" required />
      </div>
    </div>

    <div class="form-group row">
      <label class="col-4 col-form-label">Password: </label>
      <div class="col-8">
        <!-- th:field="*{password}" 会自动生成 name="password" 和 id="password" -->
        <input type="password" th:field="*{password}" class="form-control" required/>
      </div>
    </div>

    <div>
      <button type="submit" class="btn btn-primary">Log in</button>
    </div>
  </div>
</form>

// LoginController.java
package com.example.demo.controller; // 示例包名

import com.example.demo.dto.LoginForm;
import com.example.demo.dto.UserDto; // 假设的用户DTO
import com.example.demo.service.UserService; // 假设的用户服务

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute; // 可以使用 @ModelAttribute
import org.springframework.web.servlet.ModelAndView;

import java.util.Optional;

@Controller
public class LoginController {

    @Autowired
    private UserService userService; // 注入用户服务

    // 处理 GET 请求，用于显示登录表单
    @GetMapping("/login")
    public String showLoginForm(Model model) {
        // 渲染表单前，必须将一个 LoginForm 实例添加到 Model 中，供 th:object 绑定
        model.addAttribute("loginForm", new LoginForm());
        return "/login/login-form"; // 返回 Thymeleaf 模板名称
    }

    // 处理表单提交（这里仍然使用 GET，但通常建议使用 POST 处理表单提交）
    // Spring MVC 会自动将请求参数绑定到 loginForm 对象的属性上
    @GetMapping("/login-submit") // 建议使用不同的路径或 POST 方法来处理提交
    public ModelAndView processLogin(@ModelAttribute LoginForm loginForm, Model model) {
        Optional<UserDto> aUser;
        // 此时 loginForm 对象已经包含了用户输入的 email 和 password
        System.out.println("Received Email: " + loginForm.getEmail());
        System.out.println("Received Password: " + loginForm.getPassword());

        if (loginForm.getEmail() != null && !loginForm.getEmail().isEmpty()) {
            aUser = userService.getAUserByEmail(loginForm.getEmail());
            model.addAttribute("user", aUser.orElse(null)); // 处理 Optional 为空的情况
            return new ModelAndView("user/user-list", model.asMap());
        } else {
            // 如果 email 为空，可能需要重新显示表单并给出错误信息
            model.addAttribute("loginForm", loginForm); // 将当前表单数据传回
            model.addAttribute("errorMessage", "Email cannot be empty.");
            return new ModelAndView("/login/login-form", model.asMap());
        }
    }
}