Question

我一直试图弄清楚弹簧表单提交的最佳实践是什么，以及实现该目标的最小样板是什么。

我认为以下是最佳实践特征

启用验证并在验证失败时保留表单值
禁用表单重新提交 F5 （即使用重定向）
防止模型值显示在重定向（model.clear()）

到目前为止，我已经想出了这个。

@Controller
@RequestMapping("/")
public class MyModelController {

    @ModelAttribute("myModel")
    public MyModel myModel() {
        return new MyModel();
    }

    @GetMapping
    public String showPage() {
        return "thepage";
    }

    @PostMapping
    public String doAction(
            @Valid @ModelAttribute("myModel") MyModel myModel,
            BindingResult bindingResult,
            Map<String, Object> model,
            RedirectAttributes redirectAttrs) throws Exception {
        model.clear();
        if (bindingResult.hasErrors()) {
            redirectAttrs.addFlashAttribute("org.springframework.validation.BindingResult.myModel", bindingResult);
            redirectAttrs.addFlashAttribute("myModel", myModel);
        } else {
            // service logic
        }
        return "redirect:/thepage";
    }
}

有没有办法用 less 样板代码执行此操作，或者这是实现此目的所需的最少代码量？

Answer 1

首先，我不会违反Post/Redirect/Get (PRG)模式，这意味着我只会在表单成功发布时重定向。

其次，我会彻底摆脱BindingResult风格。这对于简单的情况很好，但是一旦你需要更复杂的通知来从服务/域/业务逻辑到达用户，事情就会变得多毛。此外，您的服务不太可重复使用。

我要做的是将绑定的DTO直接传递给服务，这将验证DTO并在出现错误/警告时发出通知。这样，您可以将业务逻辑验证与 JSR 303：Bean Validation 结合起来。为此，您可以使用服务中的Notification Pattern。

遵循通知模式，您需要一个通用的通知包装器：

public class Notification<T> {
    private List<String> errors = new ArrayList<>();
    private T model; // model for which the notifications apply

    public Notification<T> pushError(String message) {
        this.errors.add(message);
        return this;
    }

    public boolean hasErrors() {
        return !this.errors.isEmpty();
    }

    public void clearErrors() {
        this.errors.clear();
    }

    public String getFirstError() {
        if (!hasErrors()) {
            return "";
        }
        return errors.get(0);
    }

    public List<String> getAllErrors() {
        return this.errors;
    }

    public T getModel() {
        return model;
    }

    public void setModel(T model) {
        this.model = model;
    }
}

您的服务将是：

public Notification<MyModel> addMyModel(MyModelDTO myModelDTO){
    Notification<MyModel> notification = new Notification();
    //if(JSR 303 bean validation errors) -> notification.pushError(...); return notification;
    //if(business logic violations) -> notification.pushError(...); return notification;
    return notification;
}

然后你的控制器会是这样的：

Notification<MyModel> addAction = service.addMyModel(myModelDTO);
if (addAction.hasErrors()) {
    model.addAttribute("myModel", addAction.getModel());
    model.addAttribute("notifications", addAction.getAllErrors());
    return "myModelView"; // no redirect if errors
} 
redirectAttrs.addFlashAttribute("success", "My Model was added successfully");
return "redirect:/thepage";

虽然hasErrors()检查仍然存在，但此解决方案更具可扩展性，因为您的服务可以通过新的业务规则通知继续发展。

我将保持很短的另一种方法是从您的服务中提取自定义RuntimeException，此自定义RuntimeException可以包含必要的消息/模型，并使用@ControllerAdvice要捕获此通用异常，从异常中提取模型和消息并将它们放入模型中。这样，您的控制器只会将绑定的DTO转发给服务。

Answer 2

根据@isah的答案，如果重定向仅在成功验证后发生，则代码可以简化为：

@Controller
@RequestMapping("/")
public class MyModelController {

    @ModelAttribute("myModel")
    public MyModel myModel() {
        return new MyModel();
    }

    @GetMapping
    public String showPage() {
        return "thepage";
    }

    @PostMapping
    public String doAction(
            @Valid @ModelAttribute("myModel") MyModel myModel,
            BindingResult bindingResult,
            RedirectAttributes redirectAttrs) throws Exception {
        if (bindingResult.hasErrors()) {
            return "thepage";
        }
        // service logic
        redirectAttrs.addFlashAttribute("success", "My Model was added successfully");
        return "redirect:/thepage";
    }
}

Answer 3

一种可能的方法是将Archetype用于Web表单，而不是创建简单的项目，您可以选择从现有的Web表单原型创建项目。它将为您提供足够的肉鸡板代码。您也可以制作自己的原型。查看此链接以深入了解原型。 Link To Archetypes in Java Spring

弹簧表单提交与minum样板

3 个答案: