기능 플래그 결정

📘

기능 플래그는 SDK 버전 2.0.0 이상인 경우 사용 가능합니다.

기능 플래그를 사용하시는 경우 의존성 추가 시 SDK 버전을 2.0.0 이상으로 적용하시기 바랍니다.

기능 플래그는 켜짐(on) 상태와 꺼짐(off) 상태가 있습니다. 각 상태에 따라 다른 기능을 설정하게 됩니다.
기능 플래그를 적용한 기능에 어떤 사용자가 접근할 경우 켜짐 혹은 꺼짐 상태를 받을 수 있어야 합니다. 이 상태 결정을 핵클 SDK를 통해 진행할 수 있습니다.

isFeatureOn

isFeatureOn() 메소드에 기능 키를 전달하면 사용자에 대한 상태 결과를 전달받을 수 있습니다. 이후 상태에 따른 로직을 구현합니다.

아래 예제 코드에서는 기능 키 42를 전달하고 있습니다.

// 기능 키가 42인 기능 플래그에서 사용자의 상태를 결정합니다.
// 결정하지 못하는 상황인 경우 false(꺼짐 상태)를 반환합니다.
let isFeatureOn: Bool = hackleApp.isFeatureOn(featureKey: 42)

if isFeatureOn {
    // ON 기능
} else {
    // OFF 기능
}
// 기능 키가 42인 기능 플래그에서 사용자의 상태를 결정합니다.
// 결정하지 못하는 상황인 경우 false(꺼짐 상태)를 반환합니다.
bool isFeatureOn = [hackleApp isFeatureOnFeatureKey:@42];

if (isFeatureOn) {
    // ON 기능      
} else {
    // OFF 기능
}

featureFlagDetail

featureFlagDetail() 메소드는 isFeatureOn() 메소드와 동일하게 동작하고 추가로 상태 결정에 대한 사유를 같이 제공합니다. 수동할당이 잘 되고 있는지 알아보거나 설정한 트래픽 할당 대비 결과 비중이 이상하다고 여길 때 유용하게 활용할 수 있습니다.

파라미터로 기능 키를 전달해야 합니다. 아래 예제 코드의 경우 기능 키 42를 전달하고 있습니다.

// 상태 결정 상세
let decision: FeatureFlagDecision = hackleApp.featureFlagDetail(featureKey: 42)

// 기능 on/off 여부
let isFeatureOn: Bool = decision.isOn

// 상태 결정 사유
let reason: String = decision.reason
// 상태 결정 상세
FeatureFlagDecision *decision = [hackleApp featureFlagDetailWithFeatureKey:@42];

// 기능 on/off 여부
bool isFeatureOn = [decision isOn];

// 상태 결정 사유
NSString *reason = [decision reason];

상태 결정 사유는 SDK_NOT_READY 와 같은 형태로 받게 됩니다. 자세한 내용은 아래 표를 참고해주세요.

사유설명분배 결과
SDK_NOT_READYSDK 사용 준비가 되지 않았습니다.
(예: 잘못된 SDK 키로 초기화 시도)
기본 상태(꺼짐/off)
FEATURE_FLAG_NOT_FOUND전달한 기능 키에 대한 기능 플래그를 찾을 수 없습니다.
기능 키가 잘못되었거나 해당 기능 플래그가 보관 상태일 수 있습니다.
기본 상태(꺼짐/off)
FEATURE_FLAG_INACTIVE기능 플래그가 꺼짐 상태입니다기본 상태(꺼짐/off)
INDIVIDUAL_TARGET_MATCH개별 타겟팅에 매치 되었습니다.개별 타겟팅으로 설정한 상태
TARGET_RULE_MATCH사용자 타겟팅에 매치 되었습니다.사용자 타겟팅으로 설정한 상태
DEFAULT_RULE개별 타겟팅, 사용자 타겟팅 중 어디에도 매치 되지 않았습니다.기본 룰로 설정한 상태
EXCEPTION알 수 없는 오류가 발생했습니다.기본 상태(꺼짐/off)

기능 플래그 파라미터

  • featureFlagDetail() 메소드를 통해 상태 결정에 대한 파라미터 값도 같이 제공받을 수 있습니다.
  • featureFlagDetail() 메소드를 통해 전달받은 FeatureFlagDecision 인스턴스에는 전체 파라미터 설정 정보가 담긴 ParameterConfig 객체가 존재합니다.
  • 핵클의 기능 플래그 화면에서 설정한 파라미터 값이 key, value 형태로 존재하기 때문에, 설정한 파라미터 유형에 따라 아래 메소드를 사용하여 설정한 파라미터 값을 받아 활용할 수 있습니다.
  • 기능 플래그의 파라미터 설정화면에서 값을 유동적으로 변경할 수 있습니다.

📘

파라미터 설정은 SDK 버전 2.9.0 이상인 경우 사용 가능합니다.

getString

  • STRING, JSON 유형으로 설정된 parameter값을 반환합니다.
  • 상태 결정에 따라 False 또는 True에 설정된 값을 반환합니다.
let decision: FeatureFlagDecision = hackleApp.featureFlagDetail(featureKey: 42)
let config: ParameterConfig = decision.config

let strValue: String = decision.getString(forKey: "parameter_key_string_type", defaultValue: "defaultValue")
let strValueInConfig: String = config.getString(forKey: "parameter_key_string_type", defaultValue: "defaultValue")

let jsonValue: String = decision.getString(forKey: "parameter_key_json_type", defaultValue: "defaultValue")
let jsonValueInConfig: String = config.getString(forKey: "parameter_key_json_type", defaultValue: "defaultValue")
FeatureFlagDecision *decision = [[Hackle app] featureFlagDetailWithFeatureKey:@42];

NSString *stringValue = [decision getStringForKey:@"string" defaultValue:@"defaultValue"];

NSString *jsonValue = [decision getStringForKey:@"parameter_key_json_type" defaultValue:@"defaultValue"];

getInt

  • Number 유형으로 설정된 parameter 값을 Int 타입으로 반환합니다.
  • 상태 결정에 따라 False 또는 True에 설정된 값을 반환합니다.
let decision: FeatureFlagDecision = hackleApp.featureFlagDetail(featureKey: 42)
let config: ParameterConfig = decision.config

let intValue: Int = decision.getInt(forKey: "parameter_key_number_type", defaultValue: 0)
let intValueInConfig: Int = config.getInt(forKey: "parameter_key_number_type", defaultValue: 0)
FeatureFlagDecision *decision = [[Hackle app] featureFlagDetailWithFeatureKey:@42];

int intValue = [decision getIntForKey:@"parameter_key_number_type" defaultValue:@0];

getDouble

  • Number 유형으로 설정된 parameter 값을 Double 타입으로 반환합니다.
  • 상태 결정에 따라 False 또는 True에 설정된 값을 반환합니다.
let decision: FeatureFlagDecision = hackleApp.featureFlagDetail(featureKey: 42)
let config: ParameterConfig = decision.config

let doubleValue: Double = decision.getDouble(forKey: "parameter_key_number_type", defaultValue: 0.0)
let doubleValueInConfig: Double = config.getDouble(forKey: "parameter_key_number_type", defaultValue: 0.0)
FeatureFlagDecision *decision = [[Hackle app] featureFlagDetailWithFeatureKey:@42];

double doubleValue = [decision getDoubleForKey:@"parameter_key_number_type" defaultValue:0.0];

getBool

  • Bool 유형으로 설정된 parameter값을 반환합니다.
  • 상태 결정에 따라 False 또는 True에 설정된 값을 반환합니다.
let decision: FeatureFlagDecision = hackleApp.featureFlagDetail(featureKey: 42)
let config: ParameterConfig = decision.config

let boolValue: Bool = decision.getBool(forKey: "parameter_key_boolean_type", defaultValue: false)
let boolValueInConfig: Bool = config.getBool(forKey: "parameter_key_boolean_type", defaultValue: false)
FeatureFlagDecision *decision = [[Hackle app] featureFlagDetailWithFeatureKey:@42];

bool boolValue = [decision getBoolForKey:@"parameter_key_boolean_type" defaultValue:false];