[swift] Swift Sourcery와 클린 코드 원칙의 연동

16 Nov 2023

swift

Swift는 강력한 프로그래밍 언어로서, 클린 코드 작성을 위한 다양한 기능과 도구들이 제공됩니다. 그 중 하나는 Swift Sourcery입니다. 이 글에서는 Swift Sourcery를 사용하여 클린 코드 원칙을 적용하는 방법에 대해 알아보겠습니다.

Swift Sourcery란?

Swift Sourcery는 소스 코드를 기반으로 코드를 생성하는 코드 생성 도구입니다. Sourcery는 템플릿과 소스 코드를 이용하여 새로운 코드를 생성할 수 있습니다. 그리고 이를 활용하여 반복적인 작업, boilerplate 코드 생성 등을 자동화할 수 있습니다.

클린 코드 원칙과의 연동

클린 코드의 핵심 원칙 중 하나는 “반복하지 말라”는 원칙입니다. 반복적인 작업이나 boilerplate 코드는 코드의 가독성을 낮출뿐만 아니라 유지보수에도 부정적인 영향을 미칠 수 있습니다.

Swift Sourcery를 사용하면, 코드 생성을 통해 반복적인 작업과 boilerplate 코드를 자동화할 수 있습니다. 예를 들어, 자주 사용되는 모델 객체를 생성할 때, 반복적으로 속성을 정의하고 초기화하는 작업을 Sourcery를 사용하여 자동으로 생성할 수 있습니다.

또한, Swift Sourcery는 코드 생성을 위한 템플릿을 작성할 때, 클린 코드 원칙을 준수할 수 있습니다. 템플릿을 작성할 때 코드의 일관성과 가독성을 유지하는 것이 중요합니다. 변수, 함수 이름을 명확하게 작성하고, 주석을 제공하여 코드의 이해를 돕는 등의 작업을 수행할 수 있습니다.

사용 예시

아래는 Swift Sourcery를 사용하여 클린 코드 원칙을 적용하는 간단한 예시입니다.

모델 객체 생성하기

// 소스 코드

{% for object in objects %}
struct {{ object.name }} {
    {% for property in object.properties %}
    var {{ property.name }}: {{ property.type }}
    {% endfor %}
    
    init({% for property in object.properties %}{{ property.name }}: {{ property.type }}, {% endfor %}) {
        {% for property in object.properties %}
        self.{{ property.name }} = {{ property.name }}
        {% endfor %}
    }
}
{% endfor %}

// 템플릿
{% for object in objects %}
struct {{ object.name }} {
    {% for property in object.properties %}
    var {{ property.name }}: {{ property.type }}
    {% endfor %}
    
    init({% for property in object.properties %}{{ property.name }}: {{ property.type }}, {% endfor %}) {
        {% for property in object.properties %}
        self.{{ property.name }} = {{ property.name }}
        {% endfor %}
    }
}
{% endfor %}

코드 생성하기

Swift Sourcery를 실행하면, 템플릿과 소스 코드를 기반으로 새로운 코드가 생성됩니다. 위의 예시에서는 모델 객체를 생성하는 소스 코드를 템플릿과 함께 사용하여 코드를 생성합니다.

이렇게 생성된 코드를 이용하여 반복적인 작업과 boilerplate 코드를 줄일 수 있습니다.

결론

Swift Sourcery를 사용하여 클린 코드 원칙을 적용하는 방법에 대해 알아보았습니다. 코드 생성을 통해 반복적인 작업과 boilerplate 코드를 자동화하고, 템플릿을 작성할 때 클린 코드 원칙을 준수하는 것이 중요합니다. 이를 통해 가독성이 높은 코드를 작성하고 유지보수성을 개선할 수 있습니다.

더 자세한 내용은 Swift Sourcery 공식 문서를 참고해주세요.