Utiliser les variables d'environnement dans AppSettings avec .NET Core
L'utilisation des variables d'environnement dans vos applications .NET Core est une pratique courante pour gérer les configurations sensibles ou variables, telles que les chaînes de connexion, les clés API et les URL de service. Cela vous permet de séparer les paramètres de votre application de votre code source, ce qui facilite le déploiement et la maintenance.
Pourquoi utiliser les variables d'environnement ?
Avantages clés:
- Sécurité: Les informations sensibles ne sont pas stockées dans le code source, ce qui les rend moins vulnérables aux fuites.
- Flexibilité: Vous pouvez facilement modifier les paramètres de configuration sans avoir à reconstruire ou à re-déployer l'application.
- Déploiement: Les variables d'environnement peuvent être définies à l'exécution, ce qui permet d'utiliser des configurations différentes pour différents environnements (développement, test, production).
Comment utiliser les variables d'environnement dans AppSettings.json ?
- Définition des variables d'environnement:
Vous pouvez définir des variables d'environnement à l'aide de différentes méthodes, telles que :
- Variable d'environnement système: Pour le système d'exploitation, via le panneau de configuration ou la ligne de commande.
- Variable d'environnement d'application: Pour les environnements d'exécution spécifiques, via des outils d'orchestration (Kubernetes, Docker, etc.).
- Utilisation dans AppSettings.json:
Utilisez le symbole %variable_name% pour faire référence à une variable d'environnement dans votre fichier appsettings.json.
{
"ConnectionStrings": {
"DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=MyDatabase;Trusted_Connection=True;MultipleActiveResultSets=true"
},
"MyApiSettings": {
"ApiKey": "%API_KEY%",
"BaseUrl": "%BASE_URL%"
}
}
- Accès aux valeurs dans le code:
Utilisez IConfiguration pour accéder aux valeurs des variables d'environnement.
public class MyService
{
private readonly IConfiguration _configuration;
public MyService(IConfiguration configuration)
{
_configuration = configuration;
}
public string GetApiKey()
{
return _configuration["MyApiSettings:ApiKey"];
}
public string GetBaseUrl()
{
return _configuration["MyApiSettings:BaseUrl"];
}
}
Bonnes pratiques
- Utilisez des noms de variables d'environnement significatifs et cohérents.
- Divisez vos paramètres en sections logiques dans
appsettings.json. - Utilisez des variables d'environnement pour les paramètres sensibles ou spécifiques à l'environnement.
- Assurez-vous de définir les variables d'environnement avant de lancer votre application.
En utilisant les variables d'environnement avec .NET Core, vous pouvez gérer efficacement les configurations de votre application et garantir un déploiement et une maintenance flexibles et sécurisés.