Klíče a hodnoty
Azure App Configuration ukládá konfigurační data jako klíč-hodnoty. Hodnoty klíčů představují jednoduchou a flexibilní reprezentaci nastavení aplikace, kterou používají vývojáři.
Klíče
Klíče slouží jako identifikátory pro hodnoty klíčů a používají se k ukládání a načítání odpovídajících hodnot. Běžné je uspořádat klíče do hierarchického oboru názvů pomocí oddělovače znaků, například /
nebo :
. Použijte konvenci, která je nejvhodnější pro vaši aplikaci. App Configuration zachází s klíči jako s celkem. Neanalybuje klíče, aby zjistil, jak jsou jejich názvy strukturované, ani u nich nevynucuje žádné pravidlo.
Tady je příklad názvů klíčů strukturovaných do hierarchie založené na službách komponent:
AppName:Service1:ApiEndpoint
AppName:Service2:ApiEndpoint
Použití konfiguračních dat v rámci aplikačních architektur může diktovat konkrétní schémata pojmenování pro hodnoty klíčů. Například architektura Spring Cloud v Javě definuje Environment
prostředky, které poskytují nastavení pro aplikaci Spring. Tyto prostředky jsou parametrizovány proměnnými, které zahrnují název aplikace a profil. Klíče konfiguračních dat souvisejících s Spring Cloudem obvykle začínají těmito dvěma prvky oddělenými oddělovačem.
Klíče uložené v App Configuration rozlišují velká a malá písmena v řetězcích založených na kódování Unicode. Klíče app1 a App1 jsou v App Configuration Storu odlišné. Mějte na paměti, když používáte nastavení konfigurace v rámci aplikace, protože některé architektury zpracovávají konfigurační klíče nerozlišují velká a malá písmena. K odlišení klíčů nedoporučujeme používat velká písmena.
V názvech klíčů můžete použít libovolný znak unicode s výjimkou %
. Název klíče nemůže být .
nebo ..
ani jeden z těchto klíčů. Pro hodnotu klíč-hodnota platí kombinovaný limit velikosti 10 kB. Toto omezení zahrnuje všechny znaky v klíči, jeho hodnotu a všechny přidružené volitelné atributy. V rámci tohoto limitu můžete mít pro klíče mnoho hierarchických úrovní.
Obory názvů klíče návrhu
Pro konfigurační data se používají dva obecné přístupy k pojmenování klíčů: ploché nebo hierarchické. Tyto metody jsou z hlediska využití aplikací podobné, ale hierarchické pojmenování nabízí řadu výhod:
- Čitelnější. Oddělovače v názvu hierarchického klíče fungují jako mezery ve větě. Poskytují také přirozené přestávky mezi slovy.
- Jednodušší správa. Hierarchie názvů klíčů představuje logické skupiny konfiguračních dat.
- Jednodušší použití. Je jednodušší napsat dotaz, který vzorově odpovídá klíčům v hierarchické struktuře a načte jenom část konfiguračních dat. Mnoho novějších programovacích architektur má také nativní podporu hierarchických konfiguračních dat, aby vaše aplikace využívala konkrétní sady konfigurace.
Klíče můžete uspořádat v App Configuration hierarchicky mnoha způsoby. Představte si takové klíče jako identifikátory URI. Každý hierarchický klíč je cesta k prostředku složená z jedné nebo více komponent, které jsou spojeny oddělovači. Zvolte, který znak chcete použít jako oddělovač na základě toho, co vaše aplikace, programovací jazyk nebo architektura potřebuje. Pro různé klíče v App Configuration použijte více oddělovačů.
Klávesy popisků
Hodnoty klíčů v App Configuration můžou mít volitelně atribut label. Popisky slouží k odlišení hodnot klíč-hodnota pomocí stejného klíče. Klíčová aplikace1 s popisky A a B tvoří dva samostatné klíče v App Configuration storu. Ve výchozím nastavení nemá klíč-hodnota žádný popisek. Pokud chcete explicitně odkazovat na hodnotu klíče bez popisku, použijte \0
adresu URL (zakódovanou jako %00
).
Popisek poskytuje pohodlný způsob, jak vytvořit varianty klíče. Běžným použitím popisků je zadání více prostředí pro stejný klíč:
Key = AppName:DbEndpoint & Label = Test
Key = AppName:DbEndpoint & Label = Staging
Key = AppName:DbEndpoint & Label = Production
Hodnoty klíč-hodnoty verze
Použijte popisky jako způsob, jak vytvořit více verzí klíč-hodnota. Do popisků můžete například zadat číslo verze aplikace nebo ID potvrzení Gitu, abyste identifikovali hodnoty klíče přidružené k určitému softwarovému buildu.
Poznámka
Pokud hledáte verze změn, App Configuration automaticky zachová všechny změny hodnoty klíč-hodnota, ke kterým došlo v určitém časovém období. Další informace najdete v tématu Snímek k určitému bodu v čase.
Dotazování klíč-hodnoty
Každá hodnota klíč-hodnota je jedinečně identifikována svým klíčem a popiskem, který může být \0
. Zadáním vzoru se dotazujete v úložišti App Configuration na hodnoty klíčů. Úložiště App Configuration vrátí všechny hodnoty klíče, které odpovídají vzoru, včetně odpovídajících hodnot a atributů. Ve voláních rozhraní REST API pro App Configuration použijte následující vzory klíčů:
Klíč | Popis |
---|---|
key je vynechána nebo key=* |
Odpovídá všem klíčům. |
key=abc |
Přesně odpovídá názvu abc klíče. |
key=abc* |
Odpovídá názvům klíčů, které začínají na abc . |
key=abc,xyz |
Odpovídá názvům abc klíčů nebo xyz . Omezeno na pět csv. |
Můžete také zahrnout následující vzory popisků:
Popisek | Popis |
---|---|
label je vynechána nebo label=* |
Odpovídá libovolnému popisku, který zahrnuje \0 . |
label=%00 |
Odpovídá \0 popisku. |
label=1.0.0 |
Přesně odpovídá popisku 1.0.0 . |
label=1.0.* |
Odpovídá popiskům, které začínají na 1.0. . |
label=%00,1.0.0 |
Odpovídá popiskům \0 nebo 1.0.0 , omezené na pět csv. |
Poznámka
*
, ,
a \
jsou rezervované znaky v dotazech. Pokud se v názvech nebo popiscích klíčů používá vyhrazený znak, musíte ho v dotazech utéct \{Reserved Character}
.
Hodnoty
Hodnoty přiřazené ke klíčům jsou také řetězce unicode. Pro hodnoty můžete použít všechny znaky unicode.
Použití typu obsahu
Každá hodnota klíče v App Configuration má atribut typu obsahu. Tento atribut můžete volitelně použít k ukládání informací o typu hodnoty do hodnoty klíč-hodnota, která vaší aplikaci pomůže správně ji zpracovat. Pro typ obsahu můžete použít libovolný formát. App Configuration používá typy médií (označované také jako typy MIME) pro předdefinované datové typy, jako jsou příznaky funkcí, odkazy na Key Vault a hodnoty klíč-hodnoty JSON.