CyberGocybergodev/env

한국어

简体中文
English
日本語
Русский

한국어

简体中文
English
日本語
Русский

테마

한국어

简体中文
English
日本語
Русский

파일 형식 ​

env 라이브러리는 다양한 구성 파일 형식을 지원합니다: .env, JSON 및 YAML.

.env 형식 ​

기본 구문 ​

bash
# 주석
KEY=value

# 값에 등호 포함
URL=https://example.com?foo=bar

# 빈 줄은 무시됨

# 잘못됨: 키에 공백 불가
# MY KEY=value

따옴표 ​

bash
# 큰따옴표: 공백 유지, 이스케이프 지원
MESSAGE="Hello World"
PATH="/usr/local/bin"

# 작은따옴표: 이스케이프 미처리 (백슬래시 시퀀스를 그대로 보존)
# 참고: 작은따옴표는 변수 확장을 막지 않음 — 확장은 따옴표 제거 후 일괄 수행
LITERAL='no escaping here: \n stays literal'

# 따옴표 없음
SIMPLE=value

# 빈 값
EMPTY=
EMPTY=""
EMPTY=''

이스케이프 문자 ​

큰따옴표에서 이스케이프 지원:

bash
# 줄바꿈
MULTILINE="line1\nline2"

# 탭
TABBED="col1\tcol2"

# 따옴표
QUOTED="He said \"Hello\""

# 백슬래시
PATH="C:\\Users\\name"

# 달러 기호
PRICE="Price: \$100"

변수 확장 ​

ExpandVariables 활성화 후 지원:

bash
# 다른 변수 참조
BASE_URL=https://api.example.com
API_URL=${BASE_URL}/v1

# 간단한 구문
URL=$BASE_URL/path

# 기본값
HOST=${HOST:-localhost}
PORT=${PORT:-8080}

# 중첩 확장
SERVICE=${CLUSTER:-default}-${REGION:-us-east}

export 구문 ​

AllowExportPrefix 활성화 후 지원:

bash
# Bash 스타일 내보내기
export KEY=value
export ANOTHER="quoted value"

YAML 스타일 ​

AllowYamlSyntax 활성화 후 지원:

bash
# YAML 스타일 키-값 쌍
KEY: value
ANOTHER: "quoted value"

여러 줄 값 ​

.env 파서는 줄 단위로 스캔하며 각 줄을 독립적으로 파싱하므로, 여러 줄에 걸친 따옴표 문자열을 지원하지 않습니다 — 큰따옴표 값은 반드시 한 줄 안에서 닫혀야 하며, 그렇지 않으면 ErrInvalidValue가 발생합니다. 줄바꿈이 필요하면 \n 이스케이프를 사용하세요 (큰따옴표 안에서만 유효하며 작은따옴표는 이스케이프를 처리하지 않음):

bash
# 큰따옴표 안의 \n은 줄바꿈 문자로 파싱됨
LINES="line1\nline2\nline3"
# 실제 값은 세 줄 텍스트: line1 / line2 / line3

# PRIVATE_KEY 등 여러 줄 인증서는 \n으로 연결 권장
PRIVATE_KEY="-----BEGIN KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...\n-----END KEY-----"

실제로 여러 줄에 걸친 문자열이 필요하다면 JSON 또는 YAML 형식을 사용하거나, 커스텀 파서로 여러 줄 지원을 확장하세요.

JSON 형식 ​

기본 구조 ​

json
{
    "APP_NAME": "my-app",
    "APP_VERSION": "1.0.0",
    "DEBUG": true,
    "PORT": 8080
}

중첩 객체 ​

중첩 객체는 평탄화됩니다:

json
{
    "database": {
        "host": "localhost",
        "port": 5432
    }
}

결과:

text
DATABASE_HOST=localhost
DATABASE_PORT=5432

배열 ​

배열은 인덱스 키로 평탄화됩니다:

json
{
    "ALLOWED_HOSTS": ["localhost", "example.com"],
    "PORTS": [80, 443, 8080]
}

결과:

text
ALLOWED_HOSTS_0=localhost
ALLOWED_HOSTS_1=example.com
PORTS_0=80
PORTS_1=443
PORTS_2=8080

배열 요소 접근

GetSlice[T] 함수 또는 점 경로를 사용하여 인덱스 키에 접근:

go
hosts := env.GetSlice[string]("ALLOWED_HOSTS")
port0 := env.GetInt("PORTS_0")  // 80

자세한 내용은 GetSlice 문서를 참조하세요.

타입 변환 옵션 ​

go
cfg := env.DefaultConfig()

// null 을 빈 문자열로 변환
cfg.JSONNullAsEmpty = true

// 숫자를 문자열로 변환
cfg.JSONNumberAsString = true

// 불리언 값을 문자열로 변환
cfg.JSONBoolAsString = true

깊이 제한 ​

go
cfg.JSONMaxDepth = 10  // 최대 중첩 깊이

YAML 형식 ​

기본 구조 ​

yaml
APP_NAME: my-app
APP_VERSION: "1.0.0"
DEBUG: true
PORT: 8080

중첩 구조 ​

yaml
database:
  host: localhost
  port: 5432
  credentials:
    user: admin
    password: secret

평탄화 결과:

text
DATABASE_HOST=localhost
DATABASE_PORT=5432
DATABASE_CREDENTIALS_USER=admin
DATABASE_CREDENTIALS_PASSWORD=secret

목록 ​

목록은 인덱스 키로 평탄화됩니다:

yaml
allowed_hosts:
  - localhost
  - example.com
  - api.example.com

결과:

text
ALLOWED_HOSTS_0=localhost
ALLOWED_HOSTS_1=example.com
ALLOWED_HOSTS_2=api.example.com

여러 줄 문자열 ​

참고

YAML 블록 스칼라 (리터럴 블록 |와 폴딩 블록 >) 는 현재 지원되지 않습니다. 파서는 |/>를 일반 스칼라 문자로 저장하며, 이후 들여쓰기된 줄은 키 - 값 파싱을 망칩니다.

줄바꿈을 유지해야 하는 값은 큰따옴표와 \n 이스케이프를 사용하세요:

yaml
description: "Line1\nLine2\nLine3"

또는 커스텀 파서로 블록 스칼라 지원을 확장하세요.

타입 변환 옵션 ​

go
cfg := env.DefaultConfig()

cfg.YAMLNullAsEmpty = true
cfg.YAMLNumberAsString = true
cfg.YAMLBoolAsString = true
cfg.YAMLMaxDepth = 10

형식 감지 ​

자동 감지 ​

go
// 확장자로 감지
format := env.DetectFormat("config.json")   // FormatJSON
format = env.DetectFormat("settings.yaml")  // FormatYAML
format = env.DetectFormat(".env")           // FormatEnv

// 일치하는 확장자가 없으면 FormatAuto 반환 (기본적으로 .env 파서 사용)
format = env.DetectFormat("config")  // FormatAuto

형식 상수 ​

go
const (
    FormatAuto  FileFormat = iota  // 자동 감지
    FormatEnv                      // .env 형식
    FormatJSON                     // JSON 형식
    FormatYAML                     // YAML 형식
)

형식 문자열 ​

go
format := env.FormatJSON
fmt.Println(format.String())  // 출력: json

모범 사례 ​

형식 선택 ​

시나리오권장 형식
간단한 구성.env
복잡한 중첩 구성JSON 또는 YAML
다른 도구와 공유JSON
가독성 우선YAML
Docker/K8s 환경.env

파일 명명 ​

bash
.env              # 기본 구성
.env.local        # 로컬 덮어쓰기 (커밋하지 않음)
.env.development  # 개발 환경
.env.staging      # 스테이징 환경
.env.production   # 프로덕션 환경
.env.test         # 테스트 환경

혼합 사용 ​

go
// 다양한 형식을 혼합하여 사용 가능
loader.LoadFiles(
    "base.env",           // 기본 구성
    "database.json",      // 데이터베이스 구성
    "secrets.yaml",       // 민감 구성
    ".env.local",         // 로컬 덮어쓰기
)

Git 무시 ​

bash
# 민감 구성 무시
.env.local
.env.*.local
.env.production
secrets.yaml

# 템플릿 유지
!.env.example

관련 문서 ​