title

프리코스 관련한 유틸 소스는 여기에 업로드하고 있다. 필요하면 참고하도록 하자.

최근에 내가 작성하는 코드들이 함수형 프로그래밍을 지향하는 것을 보면서, 나중에 비동기적인 작업들을 처리할 때 완전 헤매지는 않겠다 싶다가도, Java에서 람다는 별도의 익명 클래스의 함수로 선언되어 사용되기 때문에 스레드 메모리 덤프로 저수준 디버깅을 시도할 때 큰 방해가 된다는 이야기도 들어서 조심스럽기도 하다. (Kotlin으로 넘어가야 할 때인가?)

이번 유틸리티 작업에서 얻은 것은 크게 세 가지이다. 첫째는 javadocs에 대한 지식이 하나 늘었다는 것, 둘째는 '이 편하고 좋은 걸 왜 진작 안 하고 있었지?' 라는 깨달음, 그리고 마지막은 지속적으로 관리되는 소스의 발전 가능성이다.

javadocs

유틸리티에 대한 설명을 자세히 작성하려다보니 javadocs 문법에 자연스럽게 관심이 갔다. 기존에 외부 라이브러리를 뜯어보면 @see, {@link} 또는 <pre>와 {@code}의 조합을 볼 수 있었는데, 이번에 우연히 {@snippet}도 알게 되었다.¹

'한 달 후에 다시 보더라도 이해하고 사용할 수 있도록' 작성하려 노력했는데 생각보다 쉽지 않다. IDE에서 보면 좀 더 깔끔해보이긴 하는데, 장황하게 쓸만큼 대단한 내용이 필요한 기능은 아니지만, 그렇다고 줄글만 남겨두자니 처음의 목표에 부합하지 않아서 고민을 많이 했다. 보통 오픈소스 라이브러리를 보면 활용 예제 하나씩은 꼭 갖추고 있어서 나도 간단히 작성해봤다. gist 소스 링크 ²

유틸리티화

어마어마하게 거대한 오픈소스 생태계는 이미 우리 삶 깊은 곳까지 침투한 지 오래다. 작은 유틸리티 소스조차 그 파급력은 거대할 수 있다는 사실. 1. kik-left-pad-and-npm 2. wiki/Npm_left-pad_incident 작은 함수들이 맞물려 거대한 시스템을 구성하는 멋진 경우도 있지만, 결국 적재적소에 알아서 잘 사용하는 것이 참 어려운 일인 것 같다. 타인의 라이브러리를 사용할 때는 더욱.

그런 점에서 내가 나만의 유틸리티 클래스를 만들고 관리하는 것은 개인의 생산성 측면에서 매우 효과적이라고 생각한다. 딱 나 정도의 수준을 가진 사람이 만든 이 코드는, 내가 이해할 수 있는 기능을 내가 사용하기 편한 방식으로 잘 구현해두었으니까.

내가 작성한 Parser는 기존 String.split에서 허용하는 trailingDelimiter에 대한 검사를 포함해서 보다 엄격한 형식 검사를 수행하되, parse() 메서드의 오버로딩으로 데이터의 변환 흐름이 유연하게 이어질 수 있도록 신경썼다.

package example.util;

import java.util.List;
import java.util.regex.Pattern;

/**
 * 주어진 구분자를 기준으로 순서를 지키며 토큰을 분할합니다.
 * <pre>{@code
 * var parser = new Parser(',');
 * console.printLine("경주할 자동차 이름을 입력하세요.(이름은 쉼표(,) 기준으로 구분)");
 * var carNames = parser.parse(console.readLine());
 * }</pre>
 * 2개 이상의 구분자도 사용할 수 있습니다. 각각의 구분자를 나열해서 생성하세요.
 * {@snippet :new Parser(',', ':').parse("1,2:3"); // {1, 2, 3} // @highlight regex="'.'" }
 */
public final class Parser {
    private final Pattern pattern;

    public Parser(int... delimiter) {
        String quotes = java.util.Arrays.stream(delimiter)
                .mapToObj(Parser::toRegexQuote)
                .collect(java.util.stream.Collectors.joining());
        pattern = Pattern.compile(String.format("[%s]", quotes));
    }

    private static String toRegexQuote(int c) {
        return Pattern.quote(Character.toString(c));
    }

    public List<String> parse(String input) {
        if (input.isEmpty()) {
            return List.of();
        }
        checkTrailingDelimiter(input);
        return List.of(pattern.split(input));
    }

    public <T> List<T> parse(String input, java.util.function.Function<String, T> converter) {
        return parse(input).stream().map(converter).toList();
    }

    private void checkTrailingDelimiter(String input) throws IllegalArgumentException {
        var s = String.valueOf(input.charAt(input.length() - 1));
        if (pattern.matcher(s).matches()) {
            throw new IllegalArgumentException();
        }
    }
}

지속적인 관리 및 개발

바꿀 일이 없을거라 생각했던 곳을 변경할 일이 생기고, 완벽하다고 생각한 코드에 결점이 보이는 때가 생긴다.

내가 ValueRules라는 유틸을 작성하게 된 계기는, 자주 필요하게 되는 특정한 검증 패턴들을 '딸깍'해서 해결하고 싶다는 얄팍한 마음 때문이었다. 조건문과 try-catch 함수를 만들면 되는데 그게 귀찮았나보다 😂 하지만 막상 작업을 시작하니 아이디어가 샘솟아, 제네릭과 함수형 인자를 활용해서 모든 타입을 지원하도록 구현했다.

초기 아이디어는 그냥 RuntimeException을 상속하는 커스텀 예외를 던지는 것이었는데, 막상 제네릭으로 만들고보니 유틸이라 null 검사도 해야할 것 같고, Objects.requireNonNull을 활용해서 NullPointerExceptio도 던지도록 만들었다. 당시에는 이렇게 하면 사용자 입장에서 두 개를 구분해서 처리할 수 있으니 좋을 것 같다고 생각했다.

@FunctionalInterface
public interface CanValidate<T> {
	void validate(T value) throws NullPointerException, InvalidValueException;
}

public record OfString(java.util.function.Predicate<String> assertion) implements CanValidate<String> {
	@Override
	public void validate(String value) throws NullPointerException, InvalidValueException {
	java.util.Objects.requireNonNull(value);
	InvalidValueException.throwsIf(assertion.test(value), this.getClass());
	}
}

하지만 막상 실제로 사용해보니 불편한 점이 느껴졌다. 컨트롤러 수준에서 값의 검증 실패에 따른 예외를 IllegalArgumentException으로 고정하고 catch해서 재수행하고 있었다보니 다른 예외에는 catch 구문을 추가해야만 했다. 편하려고 사용하는 유틸이 오히려 catch 구문을 길게 만든 것이다. 그래서 예외를 custom 예외 하나로 통합하고, checkedException으로 바꿨다. 나는 이런 방식이 더 편하게 느껴졌다.

public record Stock(String name, int price, int quantity) {
    private static final ValueRules.OfInteger priceRule = new ValueRules.OfIntegerinteger -> integer >= 100 && integer % 10 == 0);

    public Stock {
        try {
            ValueRules.OF_NON_BLANK.validate(name);
            priceRule.validate(price);
            ValueRules.OF_POSITIVE.validate(quantity);
        } catch (InvalidValueException e) {
            throw GlobalExceptions.INVALID_ARGUMENTS.exception();
        }
    }
}

Java API 대다수는 사용자에게 try-catch를 강제하지 않도록 런타임 예외를 많이 사용한다. 최근에는 Reflection API 정도에서만 checkedException을 본 것 같다. 그래서 더욱 커스텀 유틸이 중요하게 느껴진다. 코드가 분명하게 잘못된 것이 아니라면, 허용된 자유 안에서 내가 추구하는 방향의 코드를 사용하는 것은 생산성 향상에 큰 도움이 될테니까.

Footnotes

1. 현재 프로젝트의 소스에 대한 참조를 자동으로 링크로 만들고, 외부 파일에 작성한 코드 내용을 다양한 방식으로 불러오고, 불러온 후에도 강조하는 등의 수정을 쉽게 할 수 있도록 지원한다. 자세한 내용은 설명을 참고하자. ↩

2. 중간에 {@snippet}과 함께 사용할 수 있는 code-snippet 폴더를 활용해서 코드를 region 별로 가져오는 식으로 문서를 작성했었는데, 괜히 파일이 분리되는 것도 좋지 않은 것 같아서 다시 하나로 합쳤다. ↩