[PowerShell] 59. 매개변수 검증(Validate 속성군)

개요

매개변수 검증 속성은 함수 본문이 실행되기도 전에 잘못된 입력을 걸러내는 선언적 규칙이다. 58장의 [CmdletBinding()]이 함수를 cmdlet처럼 보이게 만드는 뼈대였다면, 이 장의 Validate* 속성들은 26장에서 다룬 -WhatIf처럼 함수 안에 if 문을 직접 쓰지 않고도 “이 값은 받아들일 수 없다"를 PowerShell 엔진이 대신 판단하게 만든다.

정신 모델은 “함수 본문에 도달하는 시점에는 이미 입력값이 유효하다고 신뢰할 수 있어야 한다"는 것이다. 검증을 매개변수 선언에 몰아두면, 함수 본문은 오직 “정상적인 값으로 무엇을 할지"에만 집중할 수 있다.

사용법

1
2
3
4
5

param (
    [Parameter(Mandatory)]
    [ValidateSet("Low", "Average", "High")]
    [string]$Detail
)

종류

예시

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

function Set-Priority {
    param (
        [Parameter(Mandatory)]
        [ValidateSet("Low", "Average", "High")]
        [string]$Detail
    )
    "우선순위: $Detail"
}
Set-Priority -Detail Medium    # 오류 — 목록에 없는 값

function Set-RetryCount {
    param (
        [Parameter(Mandatory)]
        [ValidateRange(0, 10)]
        [int]$Attempts
    )
    "재시도 횟수: $Attempts"
}
Set-RetryCount -Attempts 15     # 오류 — 범위 초과

function Set-TicketId {
    param (
        [Parameter(Mandatory)]
        [ValidatePattern("^[0-9]{4}$")]
        [string]$TicketId
    )
    "티켓: $TicketId"
}

function New-Event {
    param (
        [Parameter(Mandatory)]
        [ValidateScript(
            { $_ -ge (Get-Date) },
            ErrorMessage = "{0}은(는) 미래 날짜가 아닙니다."
        )]
        [datetime]$EventDate
    )
    "행사 예정일: $EventDate"
}

function Get-Server {
    param (
        [Parameter(Mandatory)]
        [ValidateCount(1, 5)]
        [string[]]$ComputerName
    )
    $ComputerName
}

주의사항·함정

검증은 사용자가 입력한 값에만 적용되고, 기본값이나 스크립트 내부의 대입에는 적용되지 않는다고 오해하기 쉽다: 실제로는 반대다 — ValidateSet 같은 속성이 붙은 변수는 함수 호출 시점의 인자뿐 아니라, 함수 내부에서 그 변수에 값을 다시 대입할 때도 똑같이 검사한다. [ValidateSet("hello","world")] [string]$Message로 선언된 변수에 함수 안에서 $Message = "bye"를 대입하면 런타임에 오류가 난다는 점을 놓치면, “왜 내가 직접 넣은 값인데 검증에 걸리지?“라는 혼란에 빠지기 쉽다.

ValidateScript는 $null 값을 검증할 수 없다: 매개변수에 $null을 넘기면 ValidateScript의 스크립트 블록 자체가 그 값을 판단할 방법이 없어 오류가 난다. $null을 허용하면서 검증도 하고 싶다면 AllowNull과 ValidateScript를 함께 쓰되, 스크립트 블록 안에서 $null 여부를 먼저 명시적으로 처리해야 한다.

ValidateNotNull과 ValidateNotNullOrEmpty를 혼동하기 쉽다: [string] 타입 매개변수에 ValidateNotNull만 붙이면, $null이 문자열 타입으로 변환되는 과정에서 자동으로 빈 문자열("")로 바뀌어 버려 검증이 실질적으로 아무 효과가 없다. 문자열 매개변수에서 빈 값까지 막고 싶다면 반드시 ValidateNotNullOrEmpty를 써야 한다.

이식성: Bash·CMD 스크립트에서는 매개변수 검증을 if [ -z "$1" ]처럼 함수 본문 맨 앞에 수작업으로 작성해야 하고, 이런 검증 코드가 실제 로직과 뒤섞여 가독성을 해치기 쉽다. PowerShell의 선언적 검증 속성은 “무엇을 받을 것인가"와 “받은 값으로 무엇을 할 것인가"를 문법적으로 분리해 준다는 점에서 근본적으로 다른 접근이다.

Reference

• about_Functions_Advanced_Parameters - PowerShell | Microsoft Learn