[Java] String.matches() 대신 Pattern을 사용하자

🤔  String.matches()는 어떻게 구현되어 있을까?

---

    // String.java
    public boolean matches(String regex) {
	return Pattern.matches(regex, this);
    }

 

자바에서 String 클래스의 matches() 메서드에서 내부적으로 Pattern 클래스의 matches 메서드를 호출하고 있는 것을 볼 수 있다. 그렇다면 Pattern의 matches() 메서드는 어떤 방식으로 정규식과 문자열의 매칭 여부를 확인할까?

    // Pattern.java
    public static boolean matches(String regex, CharSequence input) {
        Pattern p = Pattern.compile(regex);
        Matcher m = p.matcher(input);
        return m.matches();
    }

 

Pattern 클래스에서는 입력된 정규식(regex)을 컴파일하여 새로운 Pattern 인스턴스를 생성하고, 해당 인스턴스에서 비교할 문자열을 입력받아 Matcher 클래스의 인스턴스를 또 만들고 매칭 결과를 반환하는 방식이다.

🥔  String.matches()의 문제점

---

package blackjack.domain.participant;

import blackjack.exception.NonAlphabeticNameException;

public class Name {
    private static final String NAME_FORMAT = "^[a-zA-Z가-힣]*$";

    private final String value;

    public Name(String value) {
        validateIsAlphabetic(value);
        this.value = value;
    }

    private void validateIsAlphabetic(String name) {
        if (!name.matches(NAME_FORMAT)) {
            throw new NonAlphabeticNameException();
        }
    }
}

 

나는 블랙잭 미션을 구현하면서 위와 같은 코드를 작성했는데, String 클래스의 구현에 따라 validateIsAlphabetic()이라는 메서드가 다음과 같은 코드와 같이 동작하는 것을 알 수 있다.

    private void validateIsAlphabetic(String name) {
        Pattern p = Pattern.compile(NAME_FORMAT);
        Matcher m = p.matcher(name);
        if (!m.matches()) {
            throw new NonAlphabeticNameException();
        }
    }

 

문제가 없어 보이지만, 불필요한 Pattern 인스턴스가 계속 생성되고 있다. name은 사용자 입력에 따라 바뀌는 값이라 Matcher 인스턴스의 생성은 피할 수 없지만, Pattern의 경우에는 NAME_FORMAT이라는 상수를 사용하기 때문에 여러 번 생성할 필요가 없다.

📌  불필요한 객체 생성을 줄이는 방법

String.matches()의 문제점을 파악했으니, 이를 개선하는 방법에 대해 알아보자. 거창하게 방법이라고 부르기도 애매하지만, 아래와 같이 문자열 정규식 대신 Pattern을 상수로 가지고 있도록 코드를 수정하면 된다.

package blackjack.domain.participant;

import blackjack.exception.NonAlphabeticNameException;

import java.util.regex.Pattern;

public class Name {
    private static final Pattern NAME_PATTERN = Pattern.compile("^[a-zA-Z가-힣]*$");

    private final String value;

    public Name(String value) {
        validateIsAlphabetic(value);
        this.value = value;
    }

    private void validateIsAlphabetic(String name) {
        if (!NAME_PATTERN.matcher(name).matches()) {
            throw new NonAlphabeticNameException(name);
        }
    }
}

 

🧐  String.matches()과 Pattern 사용 시의 성능 차이

---

두 코드의 성능 차이를 알아보기 위해 다음과 같은 테스트를 작성했다.

import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

import java.util.regex.Pattern;
import static org.junit.jupiter.api.Assertions.assertTrue;

public class StringTest {
    private static final String NAME_FORMAT = "^[a-zA-Z가-힣]*$";
    private static final Pattern NAME_PATTERN = Pattern.compile(NAME_FORMAT);

    @DisplayName("String.matches()로 문자열을 비교한다.")
    @Test
    void stringMatchesTest() {
        assertTrue(() -> "hello".matches(NAME_FORMAT));
    }

    @DisplayName("Pattern.matcher()로 문자열을 비교한다.")
    @Test
    void patternMatcherTest() {
        assertTrue(() -> NAME_PATTERN.matcher("hello").matches());
    }
}

 

 

당연하게도 내부적으로 Pattern 인스턴스를 생성하는 과정을 추가적으로 거치는 첫 번째 경우가 실행 시간이 조금 더 긴 것을 확인할 수 있다. 자주 실행되지 않는 경우라면 가독성을 택해서 String.matches()를 사용하는 방법도 나쁘지 않다고 생각한다.

import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

import java.util.regex.Pattern;

public class StringTest {
    private static final int loop = 100_000_000;
    private static final String NAME_FORMAT = "^[a-zA-Z가-힣]*$";
    private static final Pattern NAME_PATTERN = Pattern.compile(NAME_FORMAT);

    @DisplayName("String.matches()로 문자열을 비교한다.")
    @Test
    void stringMatchesTest() {
        for (int i = 0; i < loop; i++) {
            "hello".matches(NAME_FORMAT);
        }
    }

    @DisplayName("Pattern.matcher()로 문자열을 비교한다.")
    @Test
    void patternMatcherTest() {
        for (int i = 0; i < loop; i++) {
            NAME_PATTERN.matcher("hello").matches();
        }
    }
}

 

그러나 위와 같이 실행 횟수가 많이 늘어난다면 다음과 같은 결과를 얻게 된다.

 

📌  결론

---

Java에서 정규 표현식을 사용하는 상황이 온다면 되도록 Pattern을 상수화하자. 이건 단순히 하나의 예시일뿐이고 실제로도 굉장히 다양한 케이스로 이런 사소한 부분들을 놓칠 수 있으니, Java의 코드 내부 구현에 대한 공부가 많이 필요할 것 같다.