VSCode 사용자 정의 코드 스니펫 설정 가이드

소프트웨어 개발 과정에서 반복적으로 작성하게 되는 정형화된 코드 뭉치(Boilerplate)는 개발 효율을 떨어뜨리는 주된 요인 중 하나입니다. 예를 들어 자바(Java) 엔티티 클래스에서 선언하는 직렬화 버전 ID나 유닛 테스트 구조 등은 매번 직접 타이핑하기에 번거로운 작업입니다. VSCode(Visual Studio Code)의 '사용자 정의 코드 스니펫(User Snippets)' 기능을 활용하면 특정 키워드 입력만으로 복잡한 코드 구조를 즉시 생성할 수 있습니다.

1. 코드 스니펫 설정 방법

VSCode에서 스니펫을 설정하는 방법은 매우 간단합니다.

  • 명령 팔레트 실행: Ctrl + Shift + P (macOS는 Cmd + Shift + P)를 누릅니다.
  • 설정 메뉴 진입: Snippets: Configure User Snippets를 입력하고 선택합니다.
  • 언어 선택: 스니펫을 적용할 언어를 선택합니다. 예를 들어 Java 프로젝트라면 java.json을, MyBatis 환경이라면 xml.json을 선택합니다.

2. Java용 코드 스니펫 구성 예시

Java 개발 시 자주 사용되는 구문들을 java.json에 정의하여 생산성을 높일 수 있습니다. 다음은 직렬화, 테스트 코드, 컬렉션 초기화 등을 포함한 구성 예시입니다.

{
    "Serial Version UID": {
        "prefix": "svuid",
        "body": [
            "@Serial",
            "private static final long serialVersionUID = 1L;"
        ],
        "description": "직렬화 버전 ID 생성"
    },
    "JUnit Test Method": {
        "prefix": "jtest",
        "body": [
            "@Test",
            "void ${1:testCaseName}() {",
            "    // given",
            "    $2",
            "    // when",
            "",
            "    // then",
            "}"
        ],
        "description": "JUnit5 테스트 메서드 템플릿"
    },
    "ArrayList Initialization": {
        "prefix": "alist",
        "body": [
            "List<${1:String}> ${2:items} = new ArrayList<>();"
        ],
        "description": "ArrayList 객체 생성"
    },
    "Swagger Schema Annotation": {
        "prefix": "swsch",
        "body": [
            "@Schema(description = \"${1:설명}\", example = \"${2:예시}\")"
        ],
        "description": "Swagger(OpenAPI) 스키마 정의"
    },
    "Private String Field": {
        "prefix": "pstr",
        "body": [
            "private String ${1:fieldName};"
        ],
        "description": "String 타입 필드 선언"
    },
    "Private Long Field": {
        "prefix": "plong",
        "body": [
            "private Long ${1:id};"
        ],
        "description": "Long 타입 필드 선언"
    }
}

3. XML(MyBatis)용 코드 스니펫 구성 예시

MyBatis를 사용하는 환경에서는 매퍼(Mapper) 파일의 기본 구조를 매번 복사해서 붙여넣기 어렵습니다. xml.json에 다음과 같이 등록하여 사용하면 효율적입니다.

{
    "MyBatis Mapper Template": {
        "prefix": "mbmapper",
        "body": [
            "",
            "",
            "",
            "<mapper namespace=\"${1:com.example.repository.MapperInterface}\">",
            "    $0",
            "</mapper>"
        ],
        "description": "MyBatis 매퍼 XML 기본 구조"
    }
}

4. 주요 속성 및 활용 팁

  • prefix: 에디터에서 스니펫을 불러오기 위해 입력할 단어입니다.
  • body: 실제로 삽입될 코드 내용입니다. 각 줄은 배열의 요소로 작성합니다.
  • $1, $2 (Placeholders): 코드 삽입 후 커서가 위치할 지점입니다. Tab 키를 눌러 순차적으로 이동할 수 있습니다. ${1:default}와 같이 기본값을 지정할 수도 있습니다.
  • $0: 마지막으로 커서가 위치할 최종 지점을 의미합니다.

이렇게 설정한 스니펫은 코드 편집기에서 지정한 prefix를 입력하는 즉시 자동 완성 목록에 표시되며, 선택 시 미리 정의된 템플릿이 즉각적으로 코드로 치환되어 작성 시간을 획기적으로 단축시켜 줍니다.

태그: vscode java MyBatis snippets Productivity

10월 23일 12:52에 게시됨