Kulcsok és értékek
Azure App Configuration kulcsértékekként tárolja a konfigurációs adatokat. A kulcsértékek a fejlesztők által használt alkalmazásbeállítások egyszerű és rugalmas ábrázolása.
Kulcsok
A kulcsok azonosítóként szolgálnak a kulcsértékekhez, és a megfelelő értékek tárolására és lekérésére szolgálnak. Gyakori eljárás, hogy a kulcsokat hierarchikus névtérbe rendezi egy karakterelválasztó használatával, például /
vagy :
. Az alkalmazáshoz leginkább illő konvenciót használjon. App Configuration a kulcsokat egészként kezeli. Nem elemzi a kulcsokat, hogy megállapítsa, hogyan vannak strukturálva a nevük, és nem kényszeríti ki rajtuk a szabályokat.
Íme egy példa az összetevők szolgáltatásain alapuló hierarchiába strukturált kulcsnevekre:
AppName:Service1:ApiEndpoint
AppName:Service2:ApiEndpoint
A konfigurációs adatok alkalmazás-keretrendszereken belüli használata meghatározott elnevezési sémákat diktálhat a kulcsértékekhez. A Java Spring Cloud-keretrendszere például olyan erőforrásokat határoz meg Environment
, amelyek a Spring-alkalmazások beállításait biztosítják. Ezeket az erőforrásokat olyan változók paraméterezik, amelyek tartalmazzák az alkalmazás nevét és profilját. A Spring Cloudhoz kapcsolódó konfigurációs adatok kulcsai általában a két elválasztóval elválasztott elemből indulnak ki.
A App Configuration tárolt kulcsok megkülönböztetik a kis- és nagybetűket, unicode-alapú sztringeket. Az app1 és az App1 kulcsok különbözőek egy App Configuration áruházban. Ezt tartsa szem előtt, amikor konfigurációs beállításokat használ egy alkalmazáson belül, mert egyes keretrendszerek nem érzéketlenül kezelik a konfigurációs kulcsokat. A kulcsok megkülönböztetéséhez nem javasoljuk az eset használatát.
A kulcsnevekben bármilyen Unicode-karaktert használhat, kivéve a következőt %
: . A kulcsnév nem lehet .
vagy ..
egyik sem. Kulcsérték esetén 10 KB-os kombinált méretkorlát van érvényben. Ez a korlát a kulcs összes karakterét, értékét és az összes társított választható attribútumot tartalmazza. Ezen a korláton belül számos hierarchikus szinttel rendelkezhet a kulcsokhoz.
Kulcsnévterek tervezése
Az elnevezési kulcsok két általános megközelítését használjuk a konfigurációs adatokhoz: egybesimított vagy hierarchikus. Ezek a módszerek alkalmazáshasználati szempontból hasonlóak, de a hierarchikus elnevezés számos előnnyel jár:
- Könnyebben olvasható. A hierarchikus kulcsnevek elválasztó karakterei szóközökként működnek egy mondatban. Természetes szüneteket is biztosítanak a szavak között.
- Könnyebben kezelhető. A kulcsnév-hierarchia a konfigurációs adatok logikai csoportjait jelöli.
- Könnyebben használható. Egyszerűbb olyan lekérdezést írni, amely egy hierarchikus struktúrában lévő kulcsokkal egyezik, és csak a konfigurációs adatok egy részét kéri le. Emellett számos újabb programozási keretrendszer natív támogatást nyújt a hierarchikus konfigurációs adatokhoz, így az alkalmazás bizonyos konfigurációkészleteket használhat.
A kulcsokat többféleképpen is rendszerezheti App Configuration hierarchikusan. Az ilyen kulcsokat URI-knak nevezzük. Minden hierarchikus kulcs egy erőforrásútvonal , amely egy vagy több összetevőből áll, amelyeket elválasztók kötnek össze. Válassza ki, hogy milyen karaktert használjon elválasztóként az alkalmazás, a programozási nyelv vagy a keretrendszer igényei alapján. Használjon több elválasztójelet a App Configuration különböző kulcsaihoz.
Címkekulcsok
A kulcsértékek App Configuration is rendelkezhetnek címkeattribútummal. A címkék az azonos kulccsal rendelkező kulcsértékek megkülönböztetésére szolgálnak. A kulcsalkalmazás1A és B címkével két külön kulcsot alkot egy App Configuration áruházban. Alapértelmezés szerint egy kulcs-értéknek nincs címkéje. Ha címke nélküli kulcs-értékre szeretne explicit módon hivatkozni, használja \0
a (kódolt %00
URL-címet).
A Label kényelmes módot kínál a kulcsok változatainak létrehozására. A címkék gyakori használata, ha több környezetet ad meg ugyanahhoz a kulcshoz:
Key = AppName:DbEndpoint & Label = Test
Key = AppName:DbEndpoint & Label = Staging
Key = AppName:DbEndpoint & Label = Production
Verziókulcs-értékek
Címkék használata kulcsértékek több verziójának létrehozásához. Például beírhat egy alkalmazásverziószámot vagy egy Git-véglegesítési azonosítót a címkékbe egy adott szoftver buildhez társított kulcsértékek azonosításához.
Megjegyzés
Ha változásverziókat keres, App Configuration automatikusan megtartja az elmúlt időszakban bekövetkezett kulcs-érték összes módosítását. További információ: Időponthoz kötött pillanatkép.
Kulcsértékek lekérdezése
Minden kulcsértéket egyedileg azonosít a kulcs, valamint egy címkét, amely lehet \0
. Minta megadásával lekérdezhet egy App Configuration tárolót a kulcsértékekhez. A App Configuration tároló az összes olyan kulcsértéket visszaadja, amely megfelel a mintának, beleértve a hozzájuk tartozó értékeket és attribútumokat is. Használja az alábbi kulcsmintákat a REST API-hívásokban a App Configuration:
Kulcs | Leírás |
---|---|
key ki van hagyva, vagy key=* |
Megfelel az összes kulcsnak. |
key=abc |
Pontosan egyezik a kulcs nevével abc . |
key=abc* |
Megegyezik a kezdő kulcsnevekkel abc . |
key=abc,xyz |
A vagy a kulcsneveknek abc xyz felel meg. Legfeljebb öt CSV-hez. |
A következő címkemintákat is felveheti:
Címke | Description |
---|---|
label ki van hagyva, vagy label=* |
Megfelel minden címkének, amely tartalmazza a következőt: \0 . |
label=%00 |
Megegyezik a \0 címkével. |
label=1.0.0 |
Pontosan egyezik a címkével 1.0.0 . |
label=1.0.* |
A címkével kezdődő címkéket 1.0. egyezik meg. |
label=%00,1.0.0 |
A vagy a címkét \0 1.0.0 öt CSV-nek felel meg. |
Megjegyzés
*
, ,
, és \
a lekérdezések fenntartott karakterei. Ha a kulcsnevekben vagy címkékben fenntartott karaktert használ, a lekérdezések használatával \{Reserved Character}
meg kell szabadulnia.
Értékek
A kulcsokhoz rendelt értékek unicode-sztringek is. Az értékekhez az összes Unicode-karaktert használhatja.
Tartalomtípus használata
A App Configuration minden kulcsértéke rendelkezik tartalomtípus-attribútummal. Ezt az attribútumot használhatja az érték típusára vonatkozó információk kulcs-értékben való tárolására, amely segít az alkalmazásnak a megfelelő feldolgozásában. A tartalomtípushoz bármilyen formátumot használhat. App Configuration médiatípusokat (más néven MIME-típusokat) használ a beépített adattípusokhoz, például funkciójelölőkhöz, Key Vault hivatkozásokhoz és JSON-kulcsértékekhez.