Comment SpringBoot réalise-t-il le changement de configuration dans différents environnements via Profile ?

SpringBoot utilise des profils pour réaliser un changement de configuration dans différents environnements, tels que des environnements de développement communs, des environnements de test et des environnements de production.

Il existe deux principaux types de fichiers de configuration couramment utilisés dans SpringBoot : les fichiers de propriétés et les fichiers yml. Pour les fichiers de propriétés, il est principalement implémenté via plusieurs fichiers de configuration de profil ; pour les fichiers yml, il est principalement implémenté via plusieurs fragments (les fragments de configuration sont divisés en trois barres horizontales dans un fichier yml).

Le profil est plus pratique à utiliser dans le travail réel. Une fois le programme SpringBoot développé, il sera finalement emballé dans un package jar pour être utilisé. Nous pouvons placer le fichier de configuration en externe et spécifier le nom du profil dans le fichier de configuration externe pour décider. lequel utiliser. Paramètres de configuration de l'environnement (environnement de développement, environnement de test, environnement de production).

1. Construire des projets

La démo de ce blog construit 2 projets SpringBoot, montrant respectivement comment utiliser les 2 profils.

Demo1 est implémenté via plusieurs fichiers de propriétés et Demo2 est implémenté via un seul fichier yml. Les résultats de la construction sont les suivants :

Pour SpringBoot, si la classe est écrite, elle se trouve sous le package ou le sous-package. où se trouve la classe de démarrage, il n'est alors pas nécessaire de configurer le package d'analyse sur la classe de démarrage, car SpringBoot analysera par défaut les annotations dans tous les fichiers de classe sous le package où se trouve la classe de démarrage et ses sous-packages. Par conséquent, pour faciliter la démonstration, les démos suivantes écriront les fichiers de classe sous le package ou le sous-package où se trouve la classe de démarrage.

La classe TestController avec le même code est écrite dans les deux démos pour fournir un accès à l'interface sans paramètre. Le résultat renvoyé est le nom du profil actuellement activé et le numéro de port configuré dans le fichier de configuration du profil, ce qui permet à tout le monde d'effectuer une démonstration. tests Lors de la vérification des résultats, vous pouvez également vérifier directement les informations imprimées dans la console IDEA pour vérifier les résultats. Le contenu spécifique de la classe TestController est répertorié ci-dessous :

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {

    @Autowired
    private Environment env;

    @RequestMapping("/getport")
    public String getPort()
    {
        StringBuilder sb = new StringBuilder();

        String[] activeProfiles = env.getActiveProfiles();
        sb.append("启动的 profile 名称为：").append(activeProfiles[0]);

        sb.append("<br/>");

        String portValue = env.getProperty("server.port");
        sb.append("启动的端口为：").append(portValue);
        return sb.toString();
    }
}

2. Méthode de configuration multi-fichiers

Le programme SpringBoot dans Demo1 utilise le fichier de propriétés comme fichier de configuration, donc la méthode de configuration multi-fichiers est utilisée pour implémenter le profil .

Le fichier de configuration de SpringBoot doit commencer par application. Pour le fichier de propriétés, la forme de dénomination du profil d'application name.properties est utilisée pour implémenter la configuration multi-environnement du profil dans Demo1, application-dev.properties et application-test. propertys sont utilisés, les trois fichiers application-pro.properties représentent les fichiers de configuration de l'environnement de développement, de l'environnement de test et de l'environnement de production. Le contenu de la configuration est le suivant Pour plus de commodité, seul le port de démarrage de SpringBoot est configuré ici pour la démonstration :

# application-dev.properties 配置内容
# 配置文件必须以 application 开头
# 后面的 dev 表示 profile 配置文件的名称
server.port=8081
# application-test.properties 配置内容
# 配置文件必须以 application 开头
# 后面的 test 表示 profile 配置文件的名称
server.port=8082
# application-pro.properties 配置内容
# 配置文件必须以 application 开头
# 后面的 pro 表示 profile 配置文件的名称
server.port=8083

Si vous souhaitez utiliser un fichier de configuration de profil spécifique qui doit être configuré dans application.properties. Nom du profil :

# application-pro.properties 配置内容
# 本 Demo 中编写了多个以 application 开头的配置文件
# 通过以下配置项指定 profile 名称，设置所要启动的配置文件
spring.profiles.active=test

Démarrez ensuite le programme SpringBoot de Demo1. Par exemple, l'exemple ci-dessus utilise le test de profil et le correspondant. le port de démarrage est 8082, donc accédez à l'interface localhost:8082/getport fournie par TestController, vous pouvez vérifier les informations de configuration du profil.

3. Méthode de configuration multi-fragment

Le programme SpringBoot dans Demo2 utilise des fichiers yml comme fichiers de configuration, donc la configuration multi-fragment est utilisée pour implémenter le profil.

Utilisez trois barres horizontales (---) pour séparer les fragments de configuration dans application.yml, comme indiqué ci-dessous :

# 本 Demo 中只编写了一个 application.yml 的配置文件
# 通过三个横杠（---）来分隔开 3 种配置文件
# 通过 spring.config.activate.on-profile 设置 profile 的名称

# 通过以下配置项指定 profile 名称，设置所要启动的配置文件
spring:
  profiles:
    active: pro
---
server:
  port: 9091

spring:
  config:
    activate:
      on-profile: dev
---
server:
  port: 9092

spring:
  config:
    activate:
      on-profile: test
---
server:
  port: 9093

spring:
  config:
    activate:
      on-profile: pro

Ensuite, démarrez le programme SpringBoot de Demo2. Par exemple, le profil utilisé dans l'exemple ci-dessus est pro, et. le port de démarrage correspondant est 9093, vous pouvez donc vérifier les informations de configuration du profil en accédant à l'interface localhost:9093/getport fournie dans TestController.

4. Utiliser des fichiers de configuration externes

Une fois le programme SpringBoot développé, il sera regroupé dans un package jar avec le fichier de configuration, ce qui rendra impossible la modification du fichier de configuration. Par conséquent, nous pouvons copier le fichier de configuration vers l'extérieur, l'assembler avec le package jar, utiliser la ligne de commande pour démarrer le programme SpringBoot et spécifier le chemin du fichier de configuration externe utilisé via le paramètre de ligne de commande (--spring.config. emplacement). La configuration du profil peut être modifiée dans le fichier de configuration externe pour changer de configuration dans différents environnements.

Nous plaçons le package jar et le fichier de configuration empaquetés par Demo1 dans le dossier d:javacodedemo1, comme le montre la figure ci-dessous :

Ensuite, exécutez la ligne de commande suivante dans ce répertoire pour démarrer le programme SpringBoot :

D:\javacode\demo1> java -jar .\demo1-0.0.1-SNAPSHOT.jar --spring.config.location=.\application.properties

En raison du profil configuré dans application.properties, le port 8082 est démarré.

Nous plaçons le package jar et le fichier de configuration empaquetés par Demo2 dans le dossier d:javacodedemo2, comme le montre la figure ci-dessous :

Ensuite, exécutez la ligne de commande suivante dans ce répertoire pour démarrer le programme SpringBoot :

D:\javacode\demo2> java -jar .\demo2-0.0.1-SNAPSHOT.jar --spring.config.location=.\application.yml

En raison du profil configuré dans application.yml est pro, le port 9093 est donc démarré.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!