[Java DeepDive] - String (2) 내장 함수

📎 String (2) - 내장 함수

안녕하세요, 지난 시간에는 String - 문자열 생성 관련해서 살펴보았는데요, 이번에는 String 클래스에 존재하는 메서드들 중 일부 메서드들에 대해 내부 코드를 살펴보겠습니다.

(예제 코드는 깃허브에서 확인하실 수 있으며, 버전은 Java 11을 사용했습니다.)

 

 

String 클래스 내의 메서드들은 위 사진처럼 굉장히 많이 존재하는데요, 개인적으로 자주 사용하는 메서드들에 대해 정리해 보겠습니다.

 

· String.length()

    @Stable
    private final byte[] value;
    
    ...
    
    static final boolean COMPACT_STRINGS;

    static {
        COMPACT_STRINGS = true;
    }
    
    ...

    public int length() {
        return value.length >> coder();
    }

    byte coder() {
        return COMPACT_STRINGS ? coder : UTF16;
    }

String 클래스의 length() 메서드는 coder() 메서드의 결괏값에 대해 시프트 연산을 적용합니다.

 

coder() 메서드는 COMPACT_STRINGS 값이 true이므로(최초 static 블록에 true로 설정) coder를 리턴하고, 값은 0입니다.

 

결국엔 value.length의 값을 리턴하는데요, value는 byte 배열 타입으로 문자열의 각 문자를 아스키코드의 표에 따라 10진수의 값으로 디코딩하여 배열에 저장을 합니다.

 

 

· String.isEmpty()

    public boolean isEmpty() {
        return value.length == 0;
    }

isEmpty() 메서드는 단순히 byte 배열인 value의 length가 0인지 아닌지를 비교합니다.

 

 

· String.charAt(int index)

    public char charAt(int index) {
        if (isLatin1()) {
            return StringLatin1.charAt(value, index);
        } else {
            return StringUTF16.charAt(value, index);
        }
    }
    
    
final class StringLatin1 {

    public static char charAt(byte[] value, int index) {
        if (index < 0 || index >= value.length) {
            throw new StringIndexOutOfBoundsException(index);
        }
        return (char)(value[index] & 0xff);
    }

charAt() 메서드는 StringLatin1 혹은 StringUTF16 클래스의 charAt(byte[] value, int index) 메서드를 호출합니다.

(아래에서 살펴볼 대부분의 메서드들도 Latin1 혹은 UTF16에 따라 코드들이 다른데 아래는 전부 Latin1 기준 코드입니다.)

 

내부 적으로는 StringLatin1 클래스가 호출이 되고, index의 유효성 검증을 한 후 16진수인 0xff와 and 연산(&)의 결괏값을 리턴합니다.
(0xff와 & 연산은 부호 때문에 사용을 하는데, 자세한 건 포스팅을 참고해 주세요 :)

    private static void printByte() {
        System.out.println((byte) 127); // 127
        System.out.println((byte) 128); // -128
        System.out.println((byte) 255); // -1
        System.out.println((byte) 257); // 1

        System.out.println((byte) 128 & 0xff); // 128
        System.out.println((byte) 255 & 0xff); // 255
    }

 

 

· String.compareTo(String anotherString)

    public int compareTo(String anotherString) {
        byte v1[] = value;
        byte v2[] = anotherString.value;
        if (coder() == anotherString.coder()) {
            return isLatin1() ? StringLatin1.compareTo(v1, v2)
                              : StringUTF16.compareTo(v1, v2);
        }
        return isLatin1() ? StringLatin1.compareToUTF16(v1, v2)
                          : StringUTF16.compareToLatin1(v1, v2);
     }
     
    // StringLatin1.java
    @HotSpotIntrinsicCandidate
    public static int compareTo(byte[] value, byte[] other) {
        int len1 = value.length;
        int len2 = other.length;
        return compareTo(value, other, len1, len2);
    }

    public static int compareTo(byte[] value, byte[] other, int len1, int len2) {
        int lim = Math.min(len1, len2);
        for (int k = 0; k < lim; k++) {
            if (value[k] != other[k]) {
                return getChar(value, k) - getChar(other, k);
            }
        }
        return len1 - len2;
    }

compareTo() 메서드의 경우 문자열 상태에 따라 결괏값이 달라지는데요, 비교할 두 문자열의 길이와 문자의 바이트 값 등을 비교합니다.

 

두 문자열의 바이트 값을 비교하면서 바이트가 다르다면, 두 바이트의 차이 값을 리턴합니다.

예를 들어 아래의 코드에서는 두 번째 문자인 r, 1 이 다르므로 두 바이트 값의 차이인 65를 리턴합니다.

(1의 아스키코드는 49, r의 아스키코드는 114 입니다.)

String str1 = "original";
String str2 = "o1r2iginal";
return str1.compareTo(str2);

 

아래의 케이스는 두 문자열이 모두 동일하기 때문에 두 문자열의 길이 차인 0을 리턴합니다.

String str1 = "original";
String str2 = "original";
return str1.compareTo(str2);

 

아래는 original까지는 모든 문자가 동일하기 때문에, 두 문자열의 길이 차인 -4를 리턴합니다.

(str1이 기준이기에 길이 차이가 음수입니다.)

String str1 = "original";
String str2 = "original1234";
return str1.compareTo(str2);

 

 

· String.startsWith(String prefix, int toffset)

toffset 부터 시작해서 prefix와 문자열이 동일한지를 비교합니다.

위에서 to는 시작 지점을 나타내는 인덱스이고, 핵심은 while 내부인데요 기본 문자열(ta)와 비교 문자열(pa)가 일치하는지를 비교하여 결괏값을 반환합니다.

 

 

· String.endsWith(String prefix)

    public boolean endsWith(String suffix) {
        return startsWith(suffix, length() - suffix.length());
    }

 

endsWith() 메서드는 위에서 살펴본 startsWith() 메서드를 호출하는데, 두 번째 인자에 비교를 시작할 index 값을 구하여 호출합니다.

 

 

· String.indexOf(String str)

indexOf() 메서드는 여러 개 존재합니다.

주로 사용하는 메서드는 String 타입을 하나만 받는 메서드이므로, 해당 코드를 살펴보겠습니다.

 

    private static void indexOf() {
        String str = "original";

        System.out.println(str.indexOf("o")); // 0
        System.out.println(str.indexOf("r")); // 1
        System.out.println(str.indexOf("k")); // -1
    }

str 문자열과 매개변수의 문자가 일치할경우 인덱스를 리턴하고, 없을경우 -1을 리턴합니다.

 

 

· String.contains(CharSequence s)

contains() 메서드는 위에서 살펴보았던 indexOf() 메서드를 활용하고 있습니다.

 

 

· String.replace(char oldChar, char newChar)

replace() 메서드는 oldChar 문자를 newChar 문자로 변경하는데요, 아래 사진의 주석에 나와있듯이 모든 문자에 대해 변경을 합니다.

String.java

StringLatin1.java

replace() 메서드의 경우 buf라는 새로운 byte 배열을 생성한 후 기존 값을 복사하고, while 문을 반복하면서 변경할 문자의 경우 새로운 문자로 값을 저장한 후 String 객체를 생성하여 리턴합니다.

 

LATIN1의 값은 0으로 String 생성자에서 coder 값에 설정됩니다.

 

 

· String.repeat(int count)

repeat() 메서드의 경우 네이밍 그대로 주어진 문자열을 이어붙이는 기능을 하는 메서드인데요, 해당 메서드는 Java 11 버전부터 사용이 가능합니다.

빨간색 네모 박스를 기준으로 위 부분은 파라미터의 유효성 검증, 문자열의 길이 등에 대한 검증을 하는 부분입니다.

OOM이 발생할 수 있는 검증 부분은 count, len 길이를 비교하여 String의 최대 사이즈와 비교를 하고 있습니다.

 

실제로 문자열을 이어붙이는 로직은 byte array인 multiple 배열을 생성하고, 첫 len만큼 복사한 뒤 for문을 돌면서 이후 부분을 System.arrayCopy() 메서드를 호출하여 복사를 하고 있습니다.

    private static void repeat() {
        String str = "ab";

        str = str.repeat(3);

        System.out.println(str); // ababab
    }

 

 

마무리

이상으로 String 클래스에 존재하는 일부 메서드들에 대해 살펴보았습니다.

 

내부 코드는 대부분 바이트를 기준으로 연산이 진행되고, 복사의 경우 System 클래스의 arrayCopy() 메서드를 사용하고 있습니다.

Java 11을 기준으로 String 클래스의 코드는 대략 3300라인 인데요, 여기엔 굉장히 많고 친절하게 주석이 작성되어 있어서 함수의 기능을 파악하는데 많은 도움이 되는 것 같습니다.

(자세하진 않지만, 코드보다 주석이 더 많은 느낌입니다.. 😂)

 

 

참조

• https://namu.wiki/w/%EC%95%84%EC%8A%A4%ED%82%A4%20%EC%BD%94%EB%93%9C
• https://coding-factory.tistory.com/521
• http://younghwannam.blogspot.com/2017/02/javabyte-0xff.html