Init Binder

@InitBinder adalah fitur dalam Spring MVC yang berfungsi sebagai "pengolah data awal" sebelum input dari user dimasukkan ke dalam objek Java.

Berikut poin-poin utamanya:

• Pembersih Data (Sanitasi): Paling sering digunakan untuk memotong spasi kosong di awal/akhir input teks secara otomatis (trimming).
• Konverter Format: Mengatur bagaimana format tertentu (seperti format tanggal dd-mm-yyyy) harus dibaca dan diubah menjadi objek Java.
• Keamanan Data: Bisa membatasi field mana saja yang boleh diterima dari form (menggunakan setAllowedFields) untuk mencegah peretasan data.
• Waktu Eksekusi: Berjalan sebelum proses @Valid atau pengisian data ke model dimulai.
• Cakupan: Jika ditaruh di dalam Controller, hanya berlaku untuk Controller itu. Jika di @ControllerAdvice, berlaku untuk seluruh aplikasi.

Analogi: @InitBinder seperti saringan yang memastikan air (data) yang masuk ke dalam wadah (objek) sudah bersih dan sesuai standar sebelum digunakan.

Contoh:

// menambahkan initbinder, method ini akan selalu dieksekusi sebelum controller dipanggil
// method ini akan convert trim input string dan menghapus setiap spasi / string kosong 
@InitBinder
public void initBinder(WebDataBinder dataBinder) {
	StringTrimmerEditor trimmerEditor = new StringTrimmerEditor(true);
	dataBinder.registerCustomEditor(String.class, trimmerEditor);
}

1️⃣ Membuat Class Object

• Membuat Class Model POJO Person.java, dan menambahkan anotation validation pada field-nya:

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

public class Person {
	
	@NotBlank(message = "Is Required")
	private String firstName;
	
	@NotNull(message = "Is Required")
	@Size(min = 1, message = "Min 1 char")
	private String lastName;

	public String getFirstName() {
		return firstName;
	}

	public void setFirstName(String firstName) {
		this.firstName = firstName;
	}

	public String getLastName() {
		return lastName;
	}

	public void setLastName(String lastName) {
		this.lastName = lastName;
	}
}

• Class model di atas akan di mapping dan properties-nya akan di-binding ke dalam element HTML.

2️⃣ Membuat Controller

• Membuat Controller PersonController.java:

import java.beans.PropertyEditorSupport;

import org.springframework.beans.propertyeditors.StringTrimmerEditor;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PostMapping;

import com.timposulabs.model.Person;

import jakarta.validation.Valid;

@Controller
public class PersonController {
	
	// menambahkan initbinder, method ini akan selalu dieksekusi sebelum controller dipanggil
	// method ini akan convert trim input string dan menghapus setiap spasi / string kosong 
	@InitBinder
	public void initBinder(WebDataBinder dataBinder) {
		StringTrimmerEditor trimmerEditor = new StringTrimmerEditor(true);
		dataBinder.registerCustomEditor(String.class, trimmerEditor);
	}
	
	// initbinder mengubah string menjadi uppercase
	@InitBinder
	public void initBinderUpper(WebDataBinder dataBinder) {
		dataBinder.registerCustomEditor(String.class, new PropertyEditorSupport() {
			@Override
			public void setAsText(String text) throws IllegalArgumentException {
				setValue(text != null ? text.toUpperCase() : null);
			}
		});
	}

	@GetMapping("/")
	public String showForm(Model model) {
		model.addAttribute("person", new Person());
		return "person-form";
	}
	
	@PostMapping("/process")
	public String processForm(
			@Valid @ModelAttribute("person") Person person,
			BindingResult bindingResult) {
		
		System.out.println("Lastname: " + person.getLastName());
		
		if (bindingResult.hasErrors()) {
			return "person-form";
		} else {
			return "person-confirm";
		}
	}
}

Penjelasan:

Method @InitBinder adalah mekanisme pre-processing yang memanipulasi data String dari form sebelum data tersebut masuk ke dalam objek Person.

1. InitBinder Pertama: Trimming (Pembersihan Spasi)

@InitBinder
public void initBinder(WebDataBinder dataBinder) {
    StringTrimmerEditor trimmerEditor = new StringTrimmerEditor(true);
    dataBinder.registerCustomEditor(String.class, trimmerEditor);
}

• Fungsi: Menghapus spasi di awal dan di akhir input teks secara otomatis.
• StringTrimmerEditor(true): Parameter true berarti jika pengguna hanya menginput spasi (misal: " "), maka Spring akan mengubahnya menjadi null.
• Kegunaan: Sangat penting jika Anda menggunakan validasi @NotNull atau @NotBlank, agar input yang hanya berisi spasi tetap dianggap kosong dan memicu pesan error.

2. InitBinder Kedua: Uppercase (Konversi Huruf Kapital)

@InitBinder
public void initBinderUpper(WebDataBinder dataBinder) {
    dataBinder.registerCustomEditor(String.class, new PropertyEditorSupport() {
        @Override
        public void setAsText(String text) throws IllegalArgumentException {
            setValue(text != null ? text.toUpperCase() : null);
        }
    });
}

• Fungsi: Mengubah semua input teks yang masuk menjadi HURUF KAPITAL.
• PropertyEditorSupport: Digunakan untuk membuat aturan konversi kustom.
• setAsText: Method ini mencegat teks yang diketik user, lalu text.toUpperCase() mengubahnya menjadi kapital sebelum disimpan ke dalam variabel objek Java melalui setValue().

3️⃣ Membuat View

1. View form person-form.html.

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
	<head>
		<title>Belajar Spring MVC</title>
		<style>
			.error {color: red;}
		</style>
	</head>
	<body>
		<h3>Person Data</h3>
		<form th:action="@{/process}" th:object="${person}" method="post">
			First Name (*): <input type="text" th:field="*{firstName}" />
			
			<span th:if="${#fields.hasErrors('firstName')}" 
				  th:errors="*{firstName}"
				  class="error"></span>
			<br />
			<br />
			Last Name (*): <input type="text" th:field="*{lastName}" />
			
			<span th:if="${#fields.hasErrors('lastName')}" 
				  th:errors="*{lastName}"
				  class="error"></span>
			<br />
			<br />
			<input type="submit" value="Submit" />
		</form>
	</body>
</html>

2. View person-confirm.html.

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
	<head>
		<title>Belajar Spring MVC</title>
	</head>
	<body>
		<h3>Person Confirmation</h3>
		The person is: <span th:text="${person.firstName} + ' ' + ${person.lastName}"></span>
	</body>
</html>

info

Source Code: https://github.com/TimposuLabs/belajar-springboot-mvc/tree/main/12-belajar-spring-mvc-init-binder