Quel est le principe de l'assemblage automatique Java SpringBoot ?

résumé

détail

Les projets Spring traditionnels auront de nombreux fichiers de configuration. Par exemple, si nous voulons utiliser Redis, généralement en plus des packages jar dépendants correspondants, nous devons également configurer JedisConnectionFactory, JedisPoolConfig et RedisTemplate dans l'application. XML. Mais si vous utilisez SpringBoot, le système générera automatiquement ces classes en fonction du package jar dans pom.xml et les injectera dans le conteneur IOC.

La configuration est requise dans les projets Spring traditionnels

<bean id="jedisConnectionFactory" class="...JedisConnectionFactory"></bean>
<bean id="poolConfig" class="redis.clients.jedis.JedisPoolConfig"></bean>
<bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate"></bean>

Mais lors de l'utilisation de SpringBoot, en plus d'introduire le package jar correspondant dans pom, obtenez plus de 120 classes de configuration de fonctions par défaut à partir de spring-boot-autoconfigure.jar/META-INF/spring. .factories, y compris le nom complet de la classe de configuration de fonction de Redis, RedisAutoConfiguration. Généralement, une classe de configuration de fonction entoure cette fonction et est responsable de la gestion de la création de plusieurs classes fonctionnelles associées, telles que RedisAutoConfiguration, qui est responsable de la création de trois classes fonctionnelles :

JedisConnectionFactory, RedisTemplate et StringRedisTemplate

• org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,\

Une condition pour que la classe de configuration RedisAutoConfiguration prenne effet est @ConditionalOnClass : JedisConnection.class, RedisOperations.class , Jedis.class, elle ira donc au chemin de classe pour trouver le fichier de classe correspondant

@Configuration
@ConditionalOnClass({ JedisConnection.class, RedisOperations.class, Jedis.class })
@EnableConfigurationProperties(RedisProperties.class)
public class RedisAutoConfiguration {}

• Si pom.xml a un package jar correspondant, il peut correspondre à la classe de dépendance correspondante : JedisConnection.class, RedisOperations.class, Jedis Uniquement lorsque class

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

• correspond avec succès. , cette classe de configuration de fonction prendra effet et la classe de configuration de propriété par défaut @EnableConfigurationProperties(RedisProperties.class) sera injectée. Pour JedisConnectionFactory et RedisTemplate, la condition est qu'il n'y ait pas de

@ConditionalOnMissingBean(RedisConnectionFactory. class) et RedisTemplate

• @ConfigurationProperties(prefix = "spring.redis")
  public class RedisProperties {
      private int database = 0;
      private String url;
      private String host = "localhost";
      private String password;
      private int port = 6379;

  dans l'environnement IOC. La classe d'assembly par défaut finalement créée sera configurée via @ dans la classe de configuration fonctionnelle, injectée dans IOC

  • Analyse des principes et des résultats

  Grâce à diverses annotations. , SpringApplication.run (Application.class, args) lira le ressort dans spring-boot-autoconfigure.jar lors de l'exécution, le fichier de configuration contient le nom de classe de la classe de configuration de toutes les classes d'assembly automatiques, puis génère le. Classe de configuration correspondant à la fonction. Si ces classes de configuration de fonctions doivent prendre effet, elles iront dans le chemin de classe pour trouver s'il existe des classes dépendantes de cette classe (c'est-à-dire que pom .xml doit avoir un package jar avec les fonctions correspondantes), puis la classe fonctionnelle finale est générée par jugement dans la classe de configuration, et la classe de valeurs d'attribut par défaut est injectée dans la classe de configuration, et la classe fonctionnelle peut être référencée et attribuée à une valeur par défaut. Le principe de génération des classes fonctionnelles est de donner la priorité à la personnalisation. Les classes d'assemblage automatiques ne seront utilisées que lorsqu'il n'y a pas de personnalisation.

  En résumé, afin d'assembler automatiquement une classe, deux conditions doivent être remplies :

  • spring.factories possède une classe de configuration pour cette classe (une classe de configuration peut créer plusieurs classes dépendantes autour de cette fonction)
  pom.xml doit avoir le package jar correspondant

  • Le résultat de l'ensemble du processus est deux choses :

  Sur la base de divers jugements et dépendances, les classes requises par l'entreprise sont finalement générées et injecté dans Les classes générées par l'assemblage automatique dans le conteneur IOC reçoivent des valeurs d'attribut par défaut

  • annotations dépendantes

  @SpringBootApplication : L'annotation de la classe de démarrage de l'application du projet sb est en fait une combinaison de 3 annotations : @SpringBootConfiguration, @EnableAutoConfiguration, @ComponentScan, dont le second joue un rôle dans l'assemblage automatique

  • @EnableAutoConfiguration : indique la fonction de l'application SB pour démarrer l'assemblage automatique (y compris le chargement des beans correspondants dans le conteneur IOC, et selon la configuration par défaut, attribue des valeurs aux attributs)

  • @Import(EnableAutoConfigurationImportSelector.class) : Cette annotation est assez puissante et peut enregistrer de force les beans qui ne sont pas enregistrés dans l'IOC, indiquant qu'ils doivent démarrer. la fonction de configuration automatique, EnableAutoConfigurationImportSelector.class doit être introduite

  @Configuration

  • @ConditionalOnClass({ JedisConnection.class, RedisOperations.class, Jedis.class }) : indique que pour que la classe de configuration RedisAutoConfiguration fonctionne. , il doit y avoir un package jar contenant ces classes

  • @EnableConfigurationProperties(RedisProperties.class) : Indique que la configuration dans RedisProperties.class est référencée par défaut

  • @ConditionalOnMissingBean(RedisConnectionFactory.class) : C'est un très une annotation puissante. La personnalisation est prioritaire lors de la mise en œuvre de l’assemblage automatique. Indique que la JedisConnectionFactory par défaut sera utilisée uniquement si l'utilisateur n'injecte pas de manière personnalisée la classe RedisConnectionFactory.class.

  Le processus d'assemblage automatique

  • réalise la dépendance entre les classes via diverses annotations. Lorsque le conteneur démarre Application.run, il appellera la méthode selectImports de la méthode EnableAutoConfigurationImportSelector.class (en fait sa classe parent)

  • . La méthode

    selectImports finira par appeler la méthode SpringFactoriesLoader.loadFactoryNames pour obtenir une liste complète des BeanConfiguration

  • la méthodeloadFactoryNames lira FACTORIES_RESOURCE_LOCATION (c'est-à-dire spring.factories sous spring-boot-autoconfigure.jar), obtenez le nom complet ClassName de tous les beans liés à Spring, environ 120

  • la méthode selectImports continue d'appeler filter(configurations, autoConfigurationMetadata); à ce moment, elle filtrera un par un selon les conditions de ces BeanConfiguration, la chose la plus importante est @ConditionalOnClass. Cette annotation conditionnelle sera recherchée dans le chemin de classe pour voir s'il existe cette classe dépendante conditionnelle dans le package jar. Par conséquent, le package jar correspondant doit être disponible pour avoir ces classes dépendantes et générer certains beans de configuration par défaut requis par l'IOC.

  • Enfin, injectez la BeanConfiguration qualifiée dans la valeur de l'attribut dans la classe EnableConfigurationPropertie par défaut et injectez-la dans l'environnement IOC

  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!