String Template - Learn Java by Examples

String templates in Java 25 introduce a cleaner, more efficient, and safer way to work with strings. They allow embedding expressions inside strings without relying on concatenation or external APIs. Using string templates can lead to code that is easier to understand and maintain.

Here’s how you can write cleaner and more efficient code with string templates in Java 25:

1. Basics of String Templates

String templates allow you to define a string that contains placeholders for expressions. These placeholders are evaluated at runtime. In Java 25, this is done using the STR.""" syntax (or StringTemplate API).

Example:

String name = "John";
int age = 30;

String greeting = STR."""
    Hello, my name is \{name} and I am \{age} years old.
    """;
System.out.println(greeting);

Output:

Hello, my name is John and I am 30 years old.

2. Key Features

Dynamic Expressions
You can embed any expression within the \{} placeholders inside the template.

int x = 10;
int y = 20;

String result = STR."""
    Sum of x and y is \{x + y}.
    """;
System.out.println(result);

Multiline Support
String templates natively support multiline strings and formatting, making it easier to work with larger templates.
```
String paragraph = STR."""
    This is a multiline
    string template with
    expressions like \{"Java " + 25}.
    """;
```

3. Benefits Over Traditional String Handling

a. Eliminates Boilerplate

Previously, concatenating variables into strings required explicit concatenation or String.format(). This is no longer needed.

// Before Java 25 - verbose
String name = "Alice";
String message = "Hello, " + name + "!";
// or
String message = String.format("Hello, %s!", name);

// Java 25
String message = STR."Hello, \{name}!";

b. Improved Readability

String templates allow templates to resemble the final output, improving readability.

c. Type-Safe

String templates are type-safe, ensuring that runtime errors related to improper formatting are minimized.

4. Compatibility with Existing APIs

String templates can simplify working with APIs like SQL or HTML without extensive external libraries.

Example (SQL):

String tableName = "users";
String query = STR."""
    SELECT * FROM \{tableName}
    WHERE age > 18
    ORDER BY name;
    """;
System.out.println(query);

Example (HTML):

String title = "Welcome";
String template = STR."""
    <html>
        <head><title>\{title}</title></head>
        <body><h1>Hello, \{title}</h1></body>
    </html>
    """;
System.out.println(template);

5. Advanced Use Cases

a. Use with External Formatting Libraries

String templates integrate well with JSON or XML serialization/deserialization.

Example (JSON):

String username = "john_doe";
int userID = 123;

String json = STR."""
    {{
        "username": "\{username}",
        "id": \{userID}
    }}
    """;
System.out.println(json);

b. Avoid Code Injection

String templates are safer, as they encourage proper escaping of user-provided data when combined with API interactions such as SQL or HTML. Proper escaping ensures no code injection vulnerabilities.

6. Custom Formatters

String templates in Java 25 can leverage custom formatters for advanced needs. This allows developers to define how specific types (like dates or numbers) are formatted in the string.

Custom formatting is achieved by extending the template processor.

Example: Formatting a date into a readable format:

import java.time.LocalDate;

LocalDate today = LocalDate.now();

String message = STR."""
   Today's date is \{today.toString()}.
   """;
System.out.println(message);

To include formatting logic, custom processors can modify such outputs.

7. Example: Building APIs with Readable Responses

Here’s an example of using string templates for building responses in web APIs:

public String buildUserResponse(String username, String email) {
    return STR."""
        {
            "username": "\{username}",
            "email": "\{email}"
        }
        """;
}

// Usage
String response = buildUserResponse("alice", "[email protected]");
System.out.println(response);

8. Combining String Templates with Switch Expressions

Java 25 also brings improvements to switch expressions, which can combine well with string templates.

int code = 404;

String message = STR."""
    Status: \{
        switch (code) {
            case 200 -> "Success";
            case 404 -> "Not Found";
            case 500 -> "Server Error";
            default -> "Unknown";
        }
    }
    """;
System.out.println(message);

Summary: Cleaner Code with String Templates

Readability: Cleaner and less verbose syntax.
Efficiency: Reduces reliance on external formatting libraries or manual concatenation.
Safety: Minimized risk of runtime errors and injection vulnerabilities.
Integration: Seamlessly used with existing APIs and libraries.

Adopting Java 25 string templates improves the workflow significantly, making your apps cleaner and less error-prone.

Tag Archives: String Template

How to Write Cleaner Code with String Templates in Java