코드 생성 개요

Coddy GO 여정의 객체 지향 프로그래밍 섹션에 포함된 레슨. 107개 중 84번째.

코드 생성은 런타임에 타입을 검사하는 대신 컴파일 시점에 Go 소스 코드를 생성하는 리플렉션의 대안입니다. 이 접근 방식은 반복적인 상용구 코드를 줄이면서도 타입 안전성과 더 나은 성능을 제공합니다.

Go는 코드 생성을 자동화하는 go generate 명령을 제공합니다. 소스 파일에 특수 주석 지시문을 배치하면 go generate를 실행할 때 지정된 도구가 실행됩니다.

//go:generate stringer -type=Status

type Status int

const (
    Pending Status = iota
    Active
    Completed
)

go generate ./...을 실행하면 stringer 도구가 호출되어 Status 타입에 대한 String() 메서드를 포함하는 새 파일을 생성합니다. generated 코드는 프로그램과 함께 컴파일되는 일반적인 Go 코드입니다.

Go 생태계의 일반적인 코드 생성 도구로는 열거형 문자열 메서드를 위한 stringer, 인터페이스에서 테스트 목을 생성하기 위한 mockgen, Protocol Buffer definition에서 코드를 생성하기 위한 protoc가 있습니다. 또한 많은 ORM과 API 프레임워크는 타입 안전 데이터베이스 쿼리 또는 클라이언트 코드를 생성하기 위해 generation을 사용합니다.

reflection에 비해 가장 큰 장점은 generated code가 컴파일러에 의해 검사된다는 것입니다. 오류는 runtime이 아니라 빌드 시점에 발견됩니다. 그 대가로 추가적인 빌드 단계와 저장소에서 관리해야 할 generated files가 필요합니다. 여러 타입에 걸쳐 반복적인 구현이 필요한 OOP 패턴에서는 code generation이 안전성과 편의성 사이에서 가장 균형 잡힌 선택을 제공하는 경우가 많습니다.

챌린지

쉬움

열거형과 유사한 타입을 위한 String() 메서드를 생성하는 코드 생성기를 만들어 봅시다! 이 환경에서는 실제 go generate를 실행할 수 없지만, 타입 정의를 기반으로 프로그래밍 방식으로 Go 소스 코드를 생성하여 코드 생성 도구가 수행하는 작업을 시뮬레이션합니다.

코드를 두 파일에 걸쳐 구성합니다.

generator.go: 코드 생성 로직을 작성합니다.
Name(string)과 상수 이름을 나타내는 문자열 슬라이스인 Values를 포함하며 열거형과 유사한 타입 정의를 나타내는 EnumType 구조체를 작성합니다.

Go 소스 코드로 String() 메서드를 생성하는 GenerateStringMethod(e EnumType) string 함수를 작성합니다. 생성되는 코드는 다음 패턴을 따라야 합니다.
```
func (e TypeName) String() string {
    switch e {
    case Value1:
        return "Value1"
    case Value2:
        return "Value2"
    default:
        return "Unknown"
    }
}
```
또한 iota를 사용하여 상수 선언을 생성하는 GenerateConstants(e EnumType) string 함수를 작성합니다.
```
const (
    Value1 TypeName = iota
    Value2
    Value3
)
```
마지막으로, 생성된 코드임을 나타내는 헤더 주석과 두 출력을 결합하는 GenerateFullCode(e EnumType) string을 작성합니다.
```
// Code generated by enum generator. DO NOT EDIT.

[constants]

[string method]
```
main.go: generator를 사용하여 다양한 열거형 타입의 코드를 생성합니다.
열거형 타입 이름을 읽은 다음, 값의 개수와 각 값 이름을 차례로 읽습니다. 이 정보를 generator에 전달하고 생성된 전체 코드를 출력합니다.

다음 입력이 제공됩니다.

1행: 열거형 타입 이름
2행: 값의 개수
이후 행: 각 값 이름

예를 들어 다음과 같은 입력이 주어졌다고 합시다.

Status
3
Pending
Active
Completed

출력은 다음과 같아야 합니다.

// Code generated by enum generator. DO NOT EDIT.

const (
    Pending Status = iota
    Active
    Completed
)

func (e Status) String() string {
    switch e {
    case Pending:
        return "Pending"
    case Active:
        return "Active"
    case Completed:
        return "Completed"
    default:
        return "Unknown"
    }
}

그리고 다음과 같은 입력이 주어졌다고 합시다.

Priority
2
Low
High

출력은 다음과 같아야 합니다.

// Code generated by enum generator. DO NOT EDIT.

const (
    Low Priority = iota
    High
)

func (e Priority) String() string {
    switch e {
    case Low:
        return "Low"
    case High:
        return "High"
    default:
        return "Unknown"
    }
}

이 연습에서는 stringer와 같은 도구의 핵심 개념, 즉 런타임에 reflection을 사용하는 대신 컴파일 시점에 반복적이지만 타입 안전한 코드를 생성하는 방법을 보여 줍니다. generator는 파일에 저장한 후 프로젝트의 나머지 부분과 함께 컴파일할 수 있는 유효한 Go 코드를 생성합니다.

직접 해보기

package main

import (
	"bufio"
	"fmt"
	"os"
	"strconv"
	"strings"
)

func main() {
	reader := bufio.NewReader(os.Stdin)

	// enum 타입 이름 읽기
	typeName, _ := reader.ReadString('\n')
	typeName = strings.TrimSpace(typeName)

	// 값 개수 읽기
	countStr, _ := reader.ReadString('\n')
	count, _ := strconv.Atoi(strings.TrimSpace(countStr))

	// 각 값 이름 읽기
	values := make([]string, count)
	for i := 0; i < count; i++ {
		value, _ := reader.ReadString('\n')
		values[i] = strings.TrimSpace(value)
	}

	// TODO: 읽은 데이터로 EnumType 생성

	// TODO: GenerateFullCode를 사용하여 전체 코드 생성 및 출력
}