Spring Assert utility explained

The org.springframework.util.Assert class in Spring is a small but powerful utility used to validate method arguments and state at runtime. It helps you fail fast by throwing an IllegalArgumentException (or IllegalStateException) when a condition is not met 🚨

It’s mainly used for:

• Validating constructor arguments
• Checking method parameters
• Ensuring application state correctness

It is similar in concept to Objects.requireNonNull() but much more expressive.

---

📌 Why Use Assert?

Instead of writing:

if (user == null) {
    throw new IllegalArgumentException("User must not be null");
}

You can write:

Assert.notNull(user, "User must not be null");

Cleaner, readable, and consistent across the codebase ✨

---

🔹 Commonly Used Methods in Assert

---

1️⃣ notNull()

Ensures an object is not null.

import org.springframework.util.Assert;

public class UserService {

    public void processUser(String username) {
        Assert.notNull(username, "Username must not be null");
        System.out.println("Processing: " + username);
    }
}

If username is null → throws IllegalArgumentException.

---

2️⃣ hasText()

Checks that a String contains non-whitespace text.

Assert.hasText(name, "Name must not be empty");

Fails for:

• null
• ""
• " "

Very useful in controllers or service validation.

---

3️⃣ hasLength()

Checks if a string is not null and not empty (but allows whitespace).

Assert.hasLength(password, "Password must not be empty");

---

4️⃣ isTrue()

Validates a boolean expression.

Assert.isTrue(age >= 18, "Age must be at least 18");

If false → throws IllegalArgumentException.

---

5️⃣ notEmpty()

For collections, maps, or arrays.

Assert.notEmpty(users, "User list must not be empty");

Works for:

• Collection
• Map
• Array

---

6️⃣ noNullElements()

Ensures collection/array contains no null values.

Assert.noNullElements(userArray, "User array must not contain null elements");

---

7️⃣ state()

Used to validate object state (throws IllegalStateException instead).

Assert.state(connection.isOpen(), "Connection must be open");

Difference:

• isTrue() → IllegalArgumentException
• state() → IllegalStateException

---

📌 Real Spring Example (Constructor Validation)

import org.springframework.stereotype.Service;
import org.springframework.util.Assert;

@Service
public class PaymentService {

    private final String provider;

    public PaymentService(String provider) {
        Assert.hasText(provider, "Provider must not be empty");
        this.provider = provider;
    }
}

This ensures the bean is never created with invalid data ⚡

---

🧠 When Should You Use It?

✅ In service layer
✅ In constructors
✅ In configuration classes
❌ Not for user input validation in controllers (use Bean Validation instead: @NotNull, @NotBlank)

---

⚖️ Assert vs Bean Validation

Feature	Assert	Bean Validation
Purpose	Developer checks	User input validation
Exception	Runtime exception	Validation errors
Layer	Service/internal	Controller/DTO

---

🎯 Best Practice

Use Assert for defensive programming inside your application logic.

Use @Valid + @NotNull for request validation.

---

🚀 Summary

The Spring Assert class:

• Helps validate arguments quickly
• Improves readability
• Encourages fail-fast design
• Reduces boilerplate if checks

It’s small, simple, and very useful in clean Spring applications 💡