Replace messy string concatenation with clean, readable text blocks

TL;DR: You can eliminate verbose string concatenation and escape sequences by using text blocks for multi-line content.

Problems Addressed 😔

• Poor code readability
• Excessive escape sequences
• String concatenation complexity
• Maintenance difficulties
• Code verbosity
• Translation Problems
• Indentation issues
• Complex formatting
• No, Speed is seldom a real problem unless you are a premature optimizator

Related Code Smells 💨

Code Smell 295 - String Concatenation

Maxi Contieri ・ Mar 24

#webdev #programming #beginners #r

Code Smell 04 - String Abusers

Maxi Contieri ・ Oct 23 '20

#codenewbie #tutorial #codequality #learning

Code Smell 03 - Functions Are Too Long

Maxi Contieri ・ Oct 22 '20

#codenewbie #beginners #programming #100daysofcode

Code Smell 121 - String Validations

Maxi Contieri ・ Mar 13 '22

Code Smell 236 - Unwrapped Lines

Maxi Contieri ・ Dec 28 '23

#webdev #programming #beginners #rust

Code Smell 122 - Primitive Obsession

Maxi Contieri ・ Mar 17 '22

#oop #webdev #tutorial #beginners

Code Smell 66 - Shotgun Surgery

Maxi Contieri ・ Apr 5 '21

#codenewbie #tutorial #oop #webdev

Code Smell 46 - Repeated Code

Maxi Contieri ・ Dec 8 '20

#oop #codenewbie #tutorial #webdev

Code Smell 243 - Concatenated Properties

Maxi Contieri ・ Mar 15 '24

Steps 👣

1. Identify multi-line string concatenations or strings with excessive escape sequences
2. Replace opening quote and concatenation operators with triple quotes (""")
3. Remove escape sequences for quotes and newlines
4. Adjust indentation to match your code style
5. Add .strip() for single-line regex patterns or when trailing newlines cause issues

Sample Code 💻

Before 🚨

public class QueryBuilder { public String buildEmployeeQuery() { String sql = "SELECT emp.employee_id, " + "emp.first_name, emp.last_name, " + " dept.department_name, " + "emp.salary " + "FROM employees emp " + "JOIN departments dept ON " + "emp.department_id = " + "dept.department_id " + "WHERE emp.salary > ? " + " AND dept.location = ? " + "ORDER BY emp.salary DESC"; return sql; } public String buildJsonPayload(String name, int age) { String json = "{\n" + " \"name\": \"" + name + "\",\n" + " \"age\": " + age + ",\n" + " \"address\": {\n" + " \"street\": " + "\"123 Main St\",\n" + " \"city\": \"New York\"\n" + " }\n" + "}"; return json; } } 

After 👉

public class QueryBuilder { public String buildEmployeeQuery() { // 1. Identify multi-line string concatenations or strings  // with excessive escape sequences // 2. Replace opening quote and concatenation operators  // with triple quotes (""") // 3. Remove escape sequences for quotes and newlines // 4. Adjust indentation to match your code style // 5. Add .strip() for single-line regex patterns or // when trailing newlines cause issues // protip: If you put a known prefix  // after the string delimiter // many IDEs will adjust the syntax highlighter and linter // in this case SQL String sql = """SQL SELECT emp.employee_id, emp.first_name, emp.last_name, dept.department_name, emp.salary FROM employees emp JOIN departments dept ON emp.department_id = dept.department_id WHERE emp.salary > ? AND dept.location = ? ORDER BY emp.salary DESC """; return sql; } public String buildJsonPayload(String name, int age) { // 1. Identified concatenation with escape sequences // 2. Replaced with text block using """ // 3. Removed \" and \n escapes // 4. Preserved natural indentation // 5. No .strip() needed here // protip: If you put a known prefix  // after the string delimiter // many IDEs will adjust the syntax highlighter and linter // in this case json5  String json = """json5 { "name": "%s", "age": %d, "address": { "street": "123 Main St", "city": "New York" } } """.formatted(name, age); return json; } } 

Type 📝

[X] Semi-Automatic

Safety 🛡️

This refactoring is safe.

It does not change the runtime behavior of strings; it only cleans up syntax and formatting.

You follow compilation rules carefully to avoid errors.

Why is the Code Better? ✨

You reduce code noise caused by concatenations and escape sequences.

The multi-line strings become easier to read and maintain. Indentation and formatting are preserved without manual adjustments, making your code more natural and less error-prone.

How Does it Improve the Bijection? 🗺️

You make the code closer to the real-world representation of the string content, preserving layout and format as seen by the developer.

This enhances the one-to-one mapping between intent and code, minimizing translation errors from concept to implementation.

Limitations ⚠️

Some languages still lack multi-line string mechanisms.

Examples of languages with full support:

Refactor with AI 🤖

Suggested Prompt: 1. Identify multi-line string concatenations or strings with excessive escape sequences2. Replace opening quote and concatenation operators with triple quotes (""")3. Remove escape sequences for quotes and newlines4. Adjust indentation to match your code style5. Add .strip() for single-line regex patterns or when trailing newlines cause issues

Tags 🏷️

• Standards

Level 🔋

[X] Beginner

Related Refactorings 🔄

Refactoring 025 - Decompose Regular Expressions

Maxi Contieri ・ Mar 31

#webdev #programming #javascript #beginners

Refactoring 002 - Extract Method

Maxi Contieri ・ Nov 25 '21

#refactoring #oop #webdev #codenewbie

See also 📚

Java sdk

This article is part of the Refactoring Series.

How to Improve your Code With easy Refactorings

Maxi Contieri ・ Oct 24 '22

#webdev #beginners #programming #tutorial