@InitBinder 注解业务应用案例

InitBinder注解，用于初始化 WebDataBinder。这通常在业务控制器中使用，以便在数据绑定到模型对象之前对请求参数进行预处理，例如格式化日期或自定义属性编辑器。

业务场景：

假设你正在开发一个在线预订系统，用户需要输入日期和其他信息来预订服务。你希望确保所有接收到的日期参数都符合特定的格式，并且在用户没有输入日期时提供一个默认值。

1. 创建自定义属性编辑器：

import java.beans.PropertyEditorSupport;
import java.text.ParseException;
import java.util.Date;

public class DatePropertyEditor extends PropertyEditorSupport {
    private final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");

    @Override
    public void setAsText(String text) throws IllegalArgumentException {
        try {
            setValue(dateFormat.parse(text));
        } catch (ParseException e) {
            throw new IllegalArgumentException("Invalid date format: " + text, e);
        }
    }
}

2. 使用 @InitBinder 注解初始化 WebDataBinder：

import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.stereotype.Controller;

@Controller
public class BookingController {

    @InitBinder
    public void initBinder(WebDataBinder binder) {
        // 注册自定义属性编辑器
        binder.registerCustomEditor(Date.class, new DatePropertyEditor());
    }

    // 控制器的其他方法...
}

在这个控制器中，@InitBinder 注解的 initBinder 方法用于注册一个自定义的 DatePropertyEditor，它将被用来解析和格式化日期参数。

3. 控制器处理预订请求：

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;

@PostMapping("/booking")
public String handleBooking(@RequestParam("bookingDate") Date bookingDate, BookingForm bookingForm) {
    // 使用 bookingDate 和 bookingForm 中的数据来处理预订逻辑
    // 由于使用了 @InitBinder，bookingDate 已经被格式化为期望的 Date 类型
    return "bookingConfirmation";
}

4. 表单 HTML：

<form action="/booking" method="post">
    <label for="bookingDate">Booking Date:</label>
    <input type="text" id="bookingDate" name="bookingDate" required>
    <button type="submit">Book Now</button>
</form>

总结：

• @InitBinder 允许开发者在数据绑定到模型之前对请求参数进行预处理，提高了数据的准确性和应用程序的健壮性。
• 使用自定义属性编辑器，可以自定义如何处理特定类型的数据，例如日期、货币或电话号码。
• 通过集中初始化 WebDataBinder，可以简化控制器代码，避免在每个方法中重复相同的初始化逻辑。