[Java] 문자 이스케이스 처리하기 (feat.html)

 

자바/스프링부트 환경에서 html 템플릿을 다루던 중 내부 문자열에서 특수 문자를 사용하는 부분에서 에러가 발생했다. 

문제가 된 특수문자는 &(ampersand) 였다. 해당 기호가 포함된 문자열을 파싱하지 못했고 html 의 이스케이프 문자로 별도 처리가 필요하단 걸 알게 됐다.

이스케이프 문자란 HTML 문서에서 특별한 의미를 가지는 문자를 표현하기 위해 사용되는 특수 문자를 의미한다. 이스케이프 문자를 사용하면 특정 문자가 HTML 태그나 엔티티로 인식되지 않고 텍스트 그 자체로 표현할 수 있다.

 

가장 일반적으로 사용되는 HTML 이스케이프 문자는 다음과 같다:

 

• &lt; : < 기호를 텍스트로 표현할 때 사용
• &gt; : > 기호를 텍스트로 표현할 때 사용
• & : & 기호를 텍스트로 표현할 때 사용
• &quot; : " 기호를 텍스트로 표현할 때 사용
• &apos; : ' 기호를 텍스트로 표현할 때 사용

 

아래 표는 별도로 처리가 필요한 Escape 문자의 예시다.

 

문자	대체 문자
!
'	'
"	"
&	&
<	&lt;
>	&gt;

 

 

Java code

해당 메서드는 이스케이프 문자 처리가 필요한 String 을 인자로 받는다. 

예시로 몇가지의 이스케이프 문자(&, <, >, \) 만 하드코딩하여 replace 했다.

public String htmlEscape(String parameters) {
    return parameters.replaceAll("&", "&")
            .replaceAll("<", "&lt;")
            .replaceAll(">", "&gt;")
            .replaceAll("\"", "&quot;");
}

 

 

개선된 Code (Feat. chat GPT)

sonarlint 에서 replaceAll 은 매번 새로운 String 객체를 생성하기 때문에 문자열이 길 경우 성능 이슈 가능성이 존재한다고 경고를 줬다.

조언에 따라 String 의 replaceAll 대신 StringBuilder 를 사용하여 코드를 개선했다.

while 문 내부에서는 치환해야 할 문자의 인덱스 범위를 찾아 Escape 문자로 replace 한다.

이렇게 되면 StringBuilder의 replace 메서드를 사용하여 매번 새로운 String 을 생성하지 않 불필요한 객체 생성을 방지할 수 있다.

private String htmlEscape(String parameters) {
    Map<String, String> map = new HashMap<>();
    map.put("&", "&amp;");
    map.put("<", "&lt;");
    map.put(">", "&gt;");
    map.put("\"", "&quot;");

    StringBuilder result = new StringBuilder(parameters);
    for (Map.Entry<String, String> entry : map.entrySet()) {
        int start = result.indexOf(entry.getKey());
        while (start != -1) {
            result.replace(start, start + entry.getKey().length(), entry.getValue());
            start = result.indexOf(entry.getKey(), start + entry.getValue().length());
        }
    }
    return result.toString();
}

 

 

 

개선할 점

위 코드에서는 몇 가지의 특수 문자만 하드코딩하여 이스케이프 문자로 치환했다.

만약 하드코딩된 문자 이외의 특수 문자가 들어오는 경우라면 당연히 에러가 발생한다.

하드코딩 방식이 아닌 더 많은 케이스의 특수 문자를 처리할 수 있는 방법이 없는지 고민해봐야겠다.