Anotações do Framework Spring

Este documento descreve várias anotações disponíveis no Spring ‘Framework’, organizadas por módulos em ordem alfabética.

Índice

• Spring Beans 6.0.12
• Spring Boot 3.1.4
• Spring Cloud AWS 3.0.2
• Spring Cloud Openfeign 4.0.4
• Spring Context 6.0.12
• Spring Core 6.0.12
• Spring Data JPA 3.1.5
• Spring Messaging 6.0.12
• Spring Test 6.0.12
• Spring Web 6.0.12
• Spring JMS 6.0.12

Spring-beans

${\color{yellow}@ Autowired}$ : @Autowired é usada em Spring ‘Framework’ para indicar que uma dependência deve ser automaticamente injetada. Ela pode ser usada em construtores, campos, métodos ou parâmetros.

Parâmetros:

• required: valor booleano que define se a dependência anotada é obrigatória ou opcional.

${\color{yellow}@Configurable}$ : @Configurable é usada para marcar uma classe como elegível para configuração controlada pelo Spring.

Parâmetros:

• value: O nome da definição de bean que serve como modelo de configuração. Esse valor permite especificar o nome da definição de bean que deve ser usada para configurar a classe.
• autowire: Define se as dependências devem ser injetadas via autowiring. Por padrão, autowire é definido como Autowire.NO, o que significa que as dependências não serão injetadas automaticamente. Você pode definir isso como Autowire.BY_TYPE ou Autowire.BY_NAME se desejar realizar a injeção automática de dependências.
• dependencyCheck: Define se a verificação de dependências deve ser executada para objetos configurados. Se definido como true, o contêiner Spring verificará se todas as dependências estão satisfeitas. O padrão é false.
• preConstruction: Define se as dependências devem ser injetadas antes da construção do objeto. Se definido como true, as dependências serão injetadas antes que o construtor seja chamado. O padrão é false.

${\color{yellow}@Lookup}$ : @Lookup é usada para criar métodos de pesquisa que permitem obter instâncias de beans gerenciados pelo Spring.

Parâmetros:

• value: Esse atributo permite sugerir o nome do bean de destino a ser pesquisado. Se não for especificado, o bean de destino será resolvido com base na declaração do tipo de retorno do método anotado.

${\color{yellow}@Qualifier}$ : @Qualifier é usada como um qualificador para beans candidatos durante a injeção de dependência.

Parâmetros:

• value: Atributo que permite especificar um valor que será usado para qualificar um bean durante a injeção de dependência.

${\color{yellow}@ Value}$ : @Value é usada para indicar um valor padrão ou expressão para um campo, método ou parâmetro de método/constructor anotado. Geralmente, essa anotação é usada para injetar valores por meio de expressões baseadas em SpEL.

Parâmetros:

• value: Usado para especificar a expressão real do valor que será injetado.

Spring-boot

${\color{yellow}@ AutoConfiguration}$ : @AutoConfiguration é uma anotação do Spring Boot que permite configurar explicitamente o nome do bean associado a uma classe de autoconfiguração e especificar classes que devem ser aplicadas antes ou depois dela. Isso ajuda a controlar a ordem de configuração automática no contexto do aplicativo.

Parâmetros:

• value: Define explicitamente o nome do bean associado à classe @AutoConfiguration. Se não for especificado, um nome de bean será gerado automaticamente.
• before: Especifica as classes de autoconfiguração que ainda não devem ser aplicadas antes da classe @AutoConfiguration.
• beforeName: Define os nomes das classes de autoconfiguração que ainda não devem ser aplicadas antes da classe @AutoConfiguration.
• after: Especifica as classes de autoconfiguração que já devem ter sido aplicadas antes da classe @AutoConfiguration.
• afterName: Define os nomes das classes de autoconfiguração que já devem ter sido aplicadas antes da classe @AutoConfiguration.

${\color{yellow}@ AutoConfigureAfter}$ : @AutoConfigureAfter é uma anotação do Spring Boot que especifica classes de autoconfiguração que devem ser aplicadas depois de uma determinada classe de autoconfiguração, controlando a ordem de configuração automática.

Parâmetros:

• value: Especifica as classes de autoconfiguração que devem ser aplicadas antes da classe anotada, controlando a ordem de configuração automática.
• name: Define os nomes das classes de autoconfiguração que devem ser aplicadas antes da classe anotada, também controlando a ordem de configuração automática. Esta opção foi adicionada na versão 1.2.2 do Spring Boot.

${\color{yellow}@ AutoConfigureBefore}$ : @AutoConfigureBefore é uma anotação do Spring Boot que especifica classes de autoconfiguração que devem ser aplicadas antes de uma determinada classe de autoconfiguração, controlando a ordem de configuração automática.

Parâmetros:

• value: Especifica as classes de autoconfiguração que devem ser aplicadas antes da classe anotada, controlando a ordem de configuração automática.
• name: Define os nomes das classes de autoconfiguração que devem ser aplicadas antes da classe anotada, também controlando a ordem de configuração automática. Esta opção foi adicionada na versão 1.2.2 do Spring Boot.

${\color{yellow}@ AutoConfigureOrder}$ : @AutoConfigureOrder é uma anotação do Spring Boot que permite especificar a ordem de prioridade de classes de configuração automática, controlando a sequência de configuração durante a inicialização do aplicativo.

Parâmetros:

• value: permite definir a prioridade de configuração automática, onde o padrão é 0. Esse valor determina a ordem de execução das classes de configuração automática durante a inicialização do aplicativo Spring Boot. Quanto menor o valor, maior a prioridade.

${\color{yellow}@ AutoConfigurationPackage}$ : @AutoConfigurationPackage é uma anotação do Spring Boot que escaneia e registra automaticamente pacotes para configuração automática no contexto do aplicativo. Ela identifica o pacote da classe anotada e escaneia outros pacotes a partir dele.

Parâmetros:

• basePackages: Path de pacotes do projeto para verificar propriedades de configuração.
• basePackageClasses: Alternativa ("Type-safe") especificando os pacotes para verificar as propriedades de configuração. O pacote de cada classe especificada será verificado.

${\color{yellow}@BatchDataSource}$ : @BatchDataSource é uma anotação do Spring Boot usada para configurar um DataSource específico para o processamento de lotes em aplicações Spring Batch, permitindo o isolamento dos recursos de banco de dados para tarefas de lote.

${\color{yellow}@ConditionalOnBean}$ : @ConditionalOnBean é uma anotação do Spring Boot que condiciona a ativação de um componente somente se um determinado bean estiver presente no contexto da aplicação. Isso permite controlar a inicialização de componentes com base na existência de outros beans.

Parâmetros:

• value: Especifica as classes de beans cuja presença no contexto da aplicação será verificada para a condição.
• type: Especifica os nomes de classes de beans cuja presença no contexto da aplicação será verificada.
• annotation: Especifica os tipos de anotações de classe que decoram os beans a serem verificados.
• name: Especifica os nomes de beans cuja presença no contexto da aplicação será verificada.
• search: Define a estratégia de pesquisa para determinar se o contexto de aplicação hierárquico (contexto pai) deve ser considerado.
• parameterizedContainer: Especifica classes adicionais que podem conter tipos de beans específicos nos seus parâmetros genéricos.

${\color{yellow}@ConditionalOnClass}$ : @ConditionalOnClass é uma anotação do Spring Boot que condiciona a ativação de um componente somente se uma ou mais classes especificadas estiverem presentes no classpath da aplicação. Isso permite controlar a inicialização de componentes com base na disponibilidade de classes.

Parâmetros:

• value: Especifica as classes cuja presença no classpath é necessária para ativar a condição.
• name: Especifica os nomes de classes cuja presença no classpath é necessária.

${\color{yellow}@ConditionalOnCloudPlatform}$ : @ConditionalOnCloudPlatform é uma anotação do Spring Boot que condiciona a ativação de um componente com base na plataforma em nuvem especificada, permitindo configurar componentes para diferentes ambientes de nuvem, como AWS, Google Cloud ou Azure.

Parâmetros:

• value: Especifica a plataforma em nuvem esperada para ativar a condição.

${\color{yellow}@ConditionalOnDefaultWebSecurity}$ : @ConditionalOnDefaultWebSecurity é uma anotação de condição usada no Spring Boot para ativar uma configuração específica de segurança web padrão quando nenhum outro mecanismo de segurança personalizado é configurado na aplicação. Isso fornece uma configuração de segurança web básica, como autenticação de formulário, se nenhum outro mecanismo de segurança estiver presente.

${\color{yellow}@ConditionalOnEnabledResourceChain}$ : @ConditionalOnEnabledResourceChain é uma anotação de condição usada no Spring Boot para verificar se a cadeia de recursos (Resource Chain) está habilitada na aplicação, permitindo a personalização de recursos, como arquivos estáticos e cache, em aplicativos da web. Isso permite a configuração avançada de recursos, como otimização de cache e versão de recursos.

${\color{yellow}@ConditionalOnExpression}$ : @ConditionalOnExpression é uma anotação do Spring Boot que condiciona a ativação de um componente com base numa expressão SpEL (Spring Expression Language) avaliada em tempo de execução, permitindo ativar componentes com base em regras lógicas definidas na expressão.

Parâmetros:

• value: Especifica a expressão SpEL a ser avaliada em tempo de execução. Se a expressão retornar true, a condição é ativada. Caso contrário, a condição é desativada. O valor padrão é "true".

${\color{yellow}@ConditionalOnGraphQLSchema}$ : @ConditionalOnGraphQLSchema é uma anotação no Spring Boot que permite condicionar o carregamento de configurações com base na presença de um esquema GraphQL na aplicação, garantindo que as configurações sejam aplicadas somente quando o esquema estiver disponível.

${\color{yellow}@ConditionalOnJava}$ : @ConditionalOnJava é uma anotação do Spring Boot que condiciona a ativação de um componente com base na versão da plataforma Java, permitindo que os componentes sejam ativados apenas quando a versão Java especificada estiver presente.

Parâmetros:

• range: Configura se o valor especificado em value() é considerado um limite superior exclusivo ou um limite inferior inclusivo. O padrão é Range.EQUAL_OR_NEWER (igual ou mais recente).
• value: Especifica a versão da plataforma Java a ser verificada.

${\color{yellow}@ConditionalOnJndi}$ : @ConditionalOnJndi é uma anotação do Spring Boot que condiciona a ativação de um componente com base na disponibilidade de um recurso JNDI (Java Naming and Directory Interface), permitindo que componentes sejam ativados apenas quando o recurso JNDI especificado estiver disponível.

Parâmetros:

• value: Especifica os locais JNDI em que pelo menos um deve existir para ativar a condição. Se nenhum local for especificado, a condição será ativada apenas com base na presença de um InitialContext.

${\color{yellow}@ConditionalOnMissingBean}$ : _@Condit