Config

Config 는 Processor 와 모든 JSON 작업의 동작을 커스터마이즈하는 데 사용됩니다.

Config 구조체

type Config struct {
    // ===== 캐시 설정 =====
    MaxCacheSize int           `json:"max_cache_size"` // 최대 캐시 항목 수
    CacheTTL     time.Duration `json:"cache_ttl"`      // 캐시 만료 시간
    EnableCache  bool          `json:"enable_cache"`   // 캐시 활성화 여부
    CacheResults bool          `json:"cache_results"`  // 작업 결과 캐시 여부
    CacheSharedResults bool `json:"cache_shared_results"` // 캐시 결과 공유 (방어적 딥카피 건너뛰기, 호출자는 반환된 컨테이너를 수정하면 안 됨)

    // ===== 크기 제한 =====
    MaxJSONSize  int64 `json:"max_json_size"`  // 최대 JSON 크기 (바이트)
    MaxPathDepth int   `json:"max_path_depth"` // 최대 경로 깊이
    MaxBatchSize int   `json:"max_batch_size"` // 최대 배치 작업 수

    // ===== 보안 제한 =====
    MaxNestingDepthSecurity   int   `json:"max_nesting_depth"`           // 최대 중첩 깊이
    MaxSecurityValidationSize int64 `json:"max_security_validation_size"` // 보안 검증 최대 크기
    MaxObjectKeys             int   `json:"max_object_keys"`             // 객체 최대 키 수
    MaxArrayElements          int   `json:"max_array_elements"`          // 배열 최대 요소 수
    FullSecurityScan          bool  `json:"full_security_scan"`          // 전체 보안 스캔 활성화

    // ===== 동시성 =====
    MaxConcurrency    int `json:"max_concurrency"`    // 최대 동시성 수
    ParallelThreshold int `json:"parallel_threshold"` // 병렬 처리 임계값

    // ===== 처리 옵션 =====
    EnableValidation bool `json:"enable_validation"` // 유효성 검사 활성화
    StrictMode       bool `json:"strict_mode"`       // 엄격 모드
    CreatePaths      bool `json:"create_paths"`      // 경로 자동 생성
    CleanupNulls     bool `json:"cleanup_nulls"`     // null 값 정리
    CompactArrays    bool `json:"compact_arrays"`    // 배열 압축
    ContinueOnError  bool `json:"continue_on_error"` // 배치 작업 오류 시 계속

    // ===== 입력/출력 옵션 =====
    AllowComments    bool `json:"allow_comments"`     // 주석 허용
    PreserveNumbers  bool `json:"preserve_numbers"`   // 숫자 정밀도 유지
    ValidateInput    bool `json:"validate_input"`     // 입력 검증
    ValidateFilePath bool `json:"validate_file_path"` // 파일 경로 검증
    SkipValidation   bool `json:"skip_validation"`    // 검증 건너뛰기 (신뢰된 입력)

    // ===== 인코딩 옵션 =====
    Pretty          bool            `json:"pretty"`           // 포맷팅 출력
    Indent          string          `json:"indent"`           // 들여쓰기 문자열
    Prefix          string          `json:"prefix"`           // 접두사
    EscapeHTML      bool            `json:"escape_html"`      // HTML 이스케이프
    SortKeys        bool            `json:"sort_keys"`        // 키 정렬
    ValidateUTF8    bool            `json:"validate_utf8"`    // UTF-8 검증
    MaxDepth        int             `json:"max_depth"`        // 최대 인코딩 깊이
    DisallowUnknown bool            `json:"disallow_unknown"` // 알 수 없는 필드 금지
    FloatPrecision  int             `json:"float_precision"`  // 부동소수점 정밀도 (-1 은 자동)
    FloatTruncate   bool            `json:"float_truncate"`   // 부동소수점 자르기
    DisableEscaping bool            `json:"disable_escaping"` // 이스케이프 비활성화
    EscapeUnicode   bool            `json:"escape_unicode"`   // 유니코드 이스케이프
    EscapeSlash     bool            `json:"escape_slash"`     // 슬래시 이스케이프
    EscapeNewlines  bool            `json:"escape_newlines"`  // 줄바꿈 이스케이프
    EscapeTabs      bool            `json:"escape_tabs"`      // 탭 이스케이프
    IncludeNulls    bool            `json:"include_nulls"`    // null 값 포함
    CustomEscapes   map[rune]string `json:"custom_escapes,omitempty"` // 커스텀 이스케이프 매핑

    // ===== 관측 가능성 =====
    EnableMetrics     bool `json:"enable_metrics"`      // 메트릭 수집 활성화
    EnableHealthCheck bool `json:"enable_health_check"` // 상태 확인 활성화

    // ===== 대용량 파일 처리 =====
    ChunkSize       int64 `json:"chunk_size"`       // 청크 크기
    MaxMemory       int64 `json:"max_memory"`       // 최대 메모리 사용량
    BufferSize      int   `json:"buffer_size"`      // 버퍼 크기
    SamplingEnabled bool  `json:"sampling_enabled"` // 샘플링 활성화
    SampleSize      int   `json:"sample_size"`      // 샘플 수

    // ===== JSONL 설정 =====
    JSONLBufferSize    int   `json:"jsonl_buffer_size"`     // JSONL 버퍼 크기
    JSONLMaxLineSize   int   `json:"jsonl_max_line_size"`   // JSONL 최대 줄 크기
    JSONLSkipEmpty     bool  `json:"jsonl_skip_empty"`      // 빈 줄 건너뛰기
    JSONLSkipComments  bool  `json:"jsonl_skip_comments"`   // 주석 줄 건너뛰기
    JSONLContinueOnErr bool  `json:"jsonl_continue_on_err"` // 오류 시 계속
    JSONLWorkers       int   `json:"jsonl_workers"`         // JSONL 병렬 작업 수
    JSONLChunkSize     int   `json:"jsonl_chunk_size"`      // JSONL 청크 크기
    JSONLMaxMemory     int64 `json:"jsonl_max_memory"`      // JSONL 최대 메모리

    // ===== 병합 옵션 =====
    MergeMode MergeMode `json:"merge_mode"` // 병합 전략

    // ===== 확장 포인트 (JSON 태그 없음, 직렬화되지 않음) =====
    CustomEncoder               CustomEncoder                // 커스텀 인코더
    CustomTypeEncoders          map[reflect.Type]TypeEncoder // 커스텀 타입 인코더
    CustomValidators            []Validator                  // 커스텀 검증기
    AdditionalDangerousPatterns []DangerousPattern           // 추가 위험 패턴
    DisableDefaultPatterns      bool                         // 기본 경고 수준 패턴 비활성화
    Hooks                       []Hook                       // 작업 훅
    CustomPathParser            PathParser                   // 커스텀 경로 파서
}

CacheSharedResults 계약

CacheSharedResults가 true이면, 캐시 적중 시 Get/GetFromParsed는 방어적 딥카피를 건너뛰고 캐시 값을 직접 반환합니다 (더 빠르고 할당이 적음). 이때 호출자는 반환된 map[string]any/[]any를 수정해서는 안 됩니다. 수정하면 공유 캐시가 훼손되어 이후 읽기에 영향을 줍니다. 원시 값 (bool, float64, string, json.Number, nil) 은 불변이므로 항상 안전합니다. 기본값 false는 안전한 "읽기 시 복사" 동작을 유지하며, 호출자가 결과를 읽기 전용으로 취급할 때만 활성화하세요 (예: 동일한 대형 하위 트리를 반복적으로 읽는 읽기 전용 워크로드).

확장 필드 예약 상태

CustomEncoder, CustomTypeEncoders, CustomValidators 세 필드는 현재 버전에서 선언되었지만 인코딩/작업 파이프라인에 아직 연결되지 않았습니다. 설정해도 효과가 없으며 향후 버전을 위해 예약된 인터페이스입니다. 현재 사용 가능한 인코딩 커스터마이징 방법은 json.Marshaler 또는 encoding.TextMarshaler 인터페이스를 구현하는 것입니다 (커스텀 인코더 참조). 사용 가능한 검증 방법은 ValidateSchema입니다 (검증기 참조).

설정 프리셋

DefaultConfig

시그니처: func DefaultConfig() Config

대부분의 시나리오에 적합한 기본 설정을 반환합니다.

cfg := json.DefaultConfig()
processor, err := json.New(cfg)
if err != nil {
    panic(err)
}
defer processor.Close()

기본값

필드	값	설명
MaxJSONSize	100MB	JSON 크기 제한
MaxNestingDepthSecurity	200	중첩 깊이
MaxPathDepth	50	경로 깊이
MaxSecurityValidationSize	10MB	보안 검증 크기 상한
MaxObjectKeys	100000	객체 최대 키 수
MaxArrayElements	100000	배열 최대 요소 수
MaxConcurrency	50	동시성 수
MaxBatchSize	2000	배치 작업 수
CacheTTL	5 분	캐시 만료
MaxCacheSize	128	최대 캐시 항목 수
EnableCache	true	캐시 활성화
CacheResults	true	작업 결과 캐시
CacheSharedResults	false	캐시 결과 공유 (읽기 전용 고성능)
EnableValidation	true	유효성 검사 활성화
StrictMode	false	비엄격 모드
FullSecurityScan	false	샘플링 보안 스캔 (전체 아님)
ValidateInput	true	입력 검증
ValidateFilePath	true	파일 경로 검증
CreatePaths	true	경로 자동 생성
Pretty	false	포맷팅 출력 안 함
EscapeHTML	true	HTML 이스케이프
ValidateUTF8	true	UTF-8 검증
IncludeNulls	true	null 포함
EscapeNewlines	true	줄바꿈 이스케이프
EscapeTabs	true	탭 이스케이프
FloatPrecision	-1	자동 정밀도
MaxDepth	100	인코딩 깊이
Indent	" "	기본 들여쓰기
ChunkSize	1MB	청크 크기
MaxMemory	100MB	최대 메모리
BufferSize	64KB	버퍼 크기
SamplingEnabled	true	샘플링 활성화
SampleSize	1000	샘플 수
JSONLBufferSize	64KB	JSONL 버퍼 크기
JSONLMaxLineSize	1MB	JSONL 최대 줄 크기
JSONLSkipEmpty	true	빈 줄 건너뛰기
JSONLSkipComments	false	주석 줄 건너뛰지 않음
JSONLContinueOnErr	false	오류 시 중지
JSONLWorkers	4	병렬 작업 수
JSONLChunkSize	1000	JSONL 청크 크기
JSONLMaxMemory	100MB	JSONL 최대 메모리
MergeMode	MergeUnion	통합 병합

SecurityConfig

시그니처: func SecurityConfig() Config

신뢰할 수 없는 입력 처리에 적합한 보안 설정을 반환합니다.

// 다음 시나리오에 권장:
// - 공개 API 및 웹 서비스
// - 사용자가 제출한 데이터
// - 외부 웹훅
// - 인증 엔드포인트
// - 금융 데이터 처리
cfg := json.SecurityConfig()
processor, err := json.New(cfg)
if err != nil {
    panic(err)
}
defer processor.Close()

보안 설정 특징

필드	값	설명
MaxNestingDepthSecurity	30	보수적 중첩 깊이
MaxSecurityValidationSize	10MB	보안 검증 크기
MaxObjectKeys	5000	보수적 키 수 제한
MaxArrayElements	5000	보수적 요소 제한
MaxJSONSize	10MB	보수적 크기 제한
MaxPathDepth	30	보수적 경로 깊이
FullSecurityScan	true	전체 보안 스캔
StrictMode	true	엄격 모드
EnableValidation	true	유효성 검사 활성화
EnableCache	true	캐시 활성화
MaxCacheSize	256	캐시 크기
CacheTTL	3 분	짧은 TTL

PrettyConfig

시그니처: func PrettyConfig() Config

포맷팅 출력 설정을 반환합니다.

result, err := json.EncodeWithConfig(data, json.PrettyConfig())

설정 메서드

Clone

시그니처: func (c *Config) Clone() *Config

설정의 깊은 복사본을 생성합니다.

cfg := json.DefaultConfig()
cfgCopy := cfg.Clone()
cfgCopy.EnableValidation = true // 원래 설정에 영향 없음

Validate

시그니처: func (c *Config) Validate() error

설정을 검증하고 유효하지 않은 값을 자동으로 수정합니다. 이 메서드는 Config 를 원본에서 수정하며, 유효하지 않은 필드를 해당하는 최소 유효값으로 수정합니다.

cfg := json.DefaultConfig()
cfg.MaxJSONSize = -1 // 유효하지 않은 값
if err := cfg.Validate(); err != nil {
    panic(err)
}
// MaxJSONSize 가 최소값으로 원본 수정됨

ValidateWithWarnings

시그니처: func (c *Config) ValidateWithWarnings() []ConfigWarning

설정을 검증하고 수정 경고 목록을 반환합니다.

cfg := json.DefaultConfig()
cfg.MaxJSONSize = -1
warnings := cfg.ValidateWithWarnings()
for _, w := range warnings {
    fmt.Printf("%s: %s\n", w.Field, w.Reason)
}

ConfigWarning 타입

ConfigWarning은 설정 검증 중 자동 수정된 정보를 나타냅니다.

type ConfigWarning struct {
    Field    string // 수정된 필드명
    OldValue any    // 원래 값 (유효하지 않은 값은 nil 일 수 있음)
    NewValue any    // 수정된 값
    Reason   string // 수정 사유
}

SecurityLimits 타입

SecurityLimits는 Config 의 보안 관련 제한 필드를 요약합니다.

type SecurityLimits struct {
    MaxNestingDepth           int   `json:"max_nesting_depth"`
    MaxSecurityValidationSize int64 `json:"max_security_validation_size"`
    MaxObjectKeys             int   `json:"max_object_keys"`
    MaxArrayElements          int   `json:"max_array_elements"`
    MaxJSONSize               int64 `json:"max_json_size"`
    MaxPathDepth              int   `json:"max_path_depth"`
}

AddHook

시그니처: func (c *Config) AddHook(hook Hook)

작업 훅을 추가합니다.

cfg := json.DefaultConfig()
cfg.AddHook(json.LoggingHook(slog.Default()))

AddValidator

시그니처: func (c *Config) AddValidator(validator Validator)

커스텀 검증기를 추가합니다.

cfg := json.DefaultConfig()
cfg.AddValidator(&MyValidator{})

AddDangerousPattern

시그니처: func (c *Config) AddDangerousPattern(pattern DangerousPattern)

추가 보안 패턴을 추가합니다.

cfg := json.DefaultConfig()
cfg.AddDangerousPattern(json.DangerousPattern{
    Pattern: "eval(",
    Name:    "eval-call",
    Level:   json.PatternLevelCritical,
})

사용 예제

기본 사용

cfg := json.DefaultConfig()
processor, err := json.New(cfg)
if err != nil {
    panic(err)
}
defer processor.Close()

보안 설정

// 신뢰할 수 없는 입력 처리
cfg := json.SecurityConfig()
processor, err := json.New(cfg)
if err != nil {
    panic(err)
}
defer processor.Close()

포맷팅 출력

// JSON 포맷팅
result, err := json.EncodeWithConfig(data, json.PrettyConfig())

커스텀 설정

cfg := json.DefaultConfig()

// 보안 설정
cfg.MaxJSONSize = 10 * 1024 * 1024 // 10MB
cfg.MaxNestingDepthSecurity = 50
cfg.EnableValidation = true

// 훅
cfg.Hooks = []json.Hook{json.LoggingHook(slog.Default())}

// 검증기
cfg.CustomValidators = []json.Validator{&MyValidator{}}

processor, err := json.New(cfg)
if err != nil {
    panic(err)
}
defer processor.Close()

복제와 수정

// 기본 설정을 기반으로 변형 생성
base := json.DefaultConfig()

// 변형 1: 개발 설정
devCfg := base.Clone()
devCfg.EnableMetrics = true

// 변형 2: 프로덕션 설정
prodCfg := base.Clone()
prodCfg.EnableValidation = true

설정 상수

const (
    // 크기 제한
    DefaultMaxJSONSize       = 100 * 1024 * 1024  // 100MB
    DefaultMaxNestingDepth   = 200
    DefaultMaxPathDepth      = 50
    DefaultMaxDepth          = 100                 // 인코딩/디코딩 기본 중첩 깊이 (Config.MaxDepth)
    DefaultMaxConcurrency    = 50
    DefaultMaxBatchSize      = 2000
    DefaultMaxSecuritySize   = 10 * 1024 * 1024   // 10MB
    DefaultMaxObjectKeys     = 100000
    DefaultMaxArrayElements  = 100000
    DefaultParallelThreshold = 10

    // 캐시
    DefaultCacheTTL = 5 * time.Minute
)

내부 상수

경로 검증 길이 제한 (maxPathLength) 등의 상수는 내부 구현으로 전환되어 공개 API 로 내보내지 않습니다. 관련 기본값은 Config 구조체의 필드 기본값으로 반영됩니다.

병합 모드

MergeMode는 MergeJSON 및 MergeMany 함수의 병합 전략을 제어합니다.

MergeUnion (기본값)

모든 키/요소를 병합하고, 충돌 시 덮어쓰기 값을 사용합니다.

cfg := json.DefaultConfig()
cfg.MergeMode = json.MergeUnion
result, err := json.MergeJSON(
    `{"a": 1, "b": 2}`,
    `{"b": 3, "c": 4}`,
    cfg,
)
// 결과: {"a": 1, "b": 3, "c": 4}

MergeIntersection

두 객체 모두에 존재하는 키만 유지합니다.

cfg := json.DefaultConfig()
cfg.MergeMode = json.MergeIntersection
result, err := json.MergeJSON(
    `{"a": 1, "b": 2}`,
    `{"b": 3, "c": 4}`,
    cfg,
)
// 결과: {"b": 3}

MergeDifference

기본 객체에만 존재하고 덮어쓰기 객체에 존재하지 않는 키만 유지합니다.

cfg := json.DefaultConfig()
cfg.MergeMode = json.MergeDifference
result, err := json.MergeJSON(
    `{"a": 1, "b": 2}`,
    `{"b": 3, "c": 4}`,
    cfg,
)
// 결과: {"a": 1}

보안 권장 사항

설정 항목	권장 값	설명
MaxJSONSize	10-100MB	서버 메모리에 따라 조정
MaxNestingDepthSecurity	30-50	깊은 중첩 공격 방지
MaxPathDepth	30-50	경로 복잡도 제한
EnableValidation	true	항상 활성화
FullSecurityScan	true (신뢰할 수 없는 입력)	전체 보안 스캔

Config ​

Config 구조체 ​

설정 프리셋 ​

DefaultConfig ​

SecurityConfig ​

PrettyConfig ​

설정 메서드 ​

Clone ​

Validate ​

ValidateWithWarnings ​

ConfigWarning 타입 ​

SecurityLimits 타입 ​

AddHook ​

AddValidator ​

AddDangerousPattern ​

사용 예제 ​

기본 사용 ​

보안 설정 ​

포맷팅 출력 ​

커스텀 설정 ​

복제와 수정 ​

설정 상수 ​

병합 모드 ​

MergeUnion (기본값) ​

MergeIntersection ​

MergeDifference ​

보안 권장 사항 ​

관련 문서 ​