Les 7 annotations les plus utilisées dans Spring, l'organisation la plus puissante de l'histoire !

Avec la mise à jour et l'itération de la technologie, Java5.0 commence à prendre en charge les annotations. En tant que framework leader en Java, Spring a lentement commencé à abandonner la configuration XML depuis sa mise à jour vers la version 2.5, et davantage d'annotations sont utilisées pour contrôler le framework Spring.

Il y a tellement d'annotations au printemps que vous ne pourrez peut-être pas les utiliser même si vous utilisez Java depuis de nombreuses années. Voici un résumé des 7 annotations les plus couramment utilisées par type.

1

Notes de base

@Required

Cette annotation est utilisée sur la méthode setter du bean. Indique que cette propriété est obligatoire et doit être injectée lors de la phase de configuration, sinon BeanInitializationExcepion sera lancé.

@Autowired

Cette annotation est utilisée sur les champs, les méthodes setter et les constructeurs de beans pour déclarer explicitement les dépendances. Câblage automatique basé sur le type.

Lorsque vous utilisez cette annotation sur un champ et utilisez des attributs pour transmettre des valeurs, Spring attribuera automatiquement la valeur au champ. Cette annotation peut également être utilisée pour les propriétés privées (non recommandé), comme suit.

@Componentpublic class User {    @Autowired    private Address address;}

L'utilisation la plus courante consiste à utiliser cette annotation sur le setter, afin qu'un code personnalisé puisse être ajouté à la méthode setter. Comme suit :

<br/>

@Component
public class User {
   private Address address;
    
   @AutoWired
   public setAddress(Address address) {
      // custom code
      this.address=address;
   }
}

Lors de l'utilisation de cette annotation sur le constructeur, une chose à noter est qu'un seul constructeur dans une classe est autorisé à utiliser cette annotation.

De plus, après Spring 4.3, si une classe n'a qu'un seul constructeur, Spring injectera automatiquement les beans associés même si cette annotation n'est pas utilisée. Comme suit :

<br/>

@Component
public class User {
    private Address address;
    
    public User(Address address) {
       this.address=address;
     }
}

<bean id="user" class="xx.User"/>

@Qualifier

此注解是和@Autowired一起使用的。使用此注解可以让你对注入的过程有更多的控制。

@Qualifier可以被用在单个构造器或者方法的参数上。当上下文有几个相同类型的bean, 使用@Autowired则无法区分要绑定的bean，此时可以使用@Qualifier来指定名称。

@Component
public class User {
    @Autowired
    @Qualifier("address1")
    private Address address;
    ...
}

@Configuration

此注解用在class上来定义bean。其作用和xml配置文件相同，表示此bean是一个Spring配置。此外，此类可以使用@Bean注解来初始化定义bean。

@Configuartion
public class SpringCoreConfig {
    @Bean
    public AdminUser adminUser() {
        AdminUser adminUser = new AdminUser();
        return adminUser;
    }
}

@ComponentScan

此注解一般和@Configuration注解一起使用，指定Spring扫描注解的package。如果没有指定包，那么默认会扫描此配置类所在的package。

@Lazy

此注解使用在Spring的组件类上。默认的，Spring中Bean的依赖一开始就被创建和配置。如果想要延迟初始化一个bean，那么可以在此类上使用Lazy注解，表示此bean只有在第一次被使用的时候才会被创建和初始化。

此注解也可以使用在被@Configuration注解的类上，表示其中所有被@Bean注解的方法都会延迟初始化。

@Value

此注解使用在字段、构造器参数和方法参数上。@Value可以指定属性取值的表达式，支持通过#{}使用SpringEL来取值，也支持使用${}来将属性来源中(Properties文件、本地环境变量、系统属性等)的值注入到bean的属性中。

推荐大家看下：Java 必须掌握的 12 种 Spring 常用注解，这篇也是必看了。

此注解值的注入发生在AutowiredAnnotationBeanPostProcessor类中。

2

 Spring MVC和REST注解

@Controller

此注解使用在class上声明此类是一个Spring controller，是@Component注解的一种具体形式。

@RequestMapping

此注解可以用在class和method上，用来映射web请求到某一个handler类或者handler方法上。

当此注解用在Class上时，就创造了一个基础url，其所有的方法上的@RequestMapping都是在此url之上的。

可以使用其method属性来限制请求匹配的http method。

@Controller
@RequestMapping("/users")
public class UserController {
    @RequestMapping(method = RequestMethod.GET)
    public String getUserList() {
        return "users";
    }
}

这篇也推荐大家看下：Spring MVC常用注解。此外，Spring4.3之后引入了一系列@RequestMapping的变种。如下：

@GetMapping

@PostMapping

@PutMapping

@PatchMapping

@DeleteMapping

分别对应了相应method的RequestMapping配置。

关注微信公众号：Java技术栈，在后台回复：spring，可以获取我整理的 N 篇最新 Spring 教程，都是干货。

@CookieValue

此注解用在@RequestMapping声明的方法的参数上，可以把HTTP cookie中相应名称的cookie绑定上去。

@ReuestMapping("/cookieValue")
      public void getCookieValue(@CookieValue("JSESSIONID") String cookie){
}

cookie即http请求中name为JSESSIONID的cookie值。

@CrossOrigin

此注解用在class和method上用来支持跨域请求，是Spring 4.2后引入的。

@CrossOrigin(maxAge = 3600)
@RestController
@RequestMapping("/users")
public class AccountController {
    @CrossOrigin(origins = "http://xx.com")
    @RequestMapping("/login")
    public Result userLogin() {
        // ...
    }
}

@ExceptionHandler

此注解使用在方法级别，声明对Exception的处理逻辑。可以指定目标Exception。

@InitBinder

此注解使用在方法上，声明对WebDataBinder的初始化(绑定请求参数到JavaBean上的DataBinder)。在controller上使用此注解可以自定义请求参数的绑定。

@MatrixVariable

此注解使用在请求handler方法的参数上，Spring可以注入matrix url中相关的值。这里的矩阵变量可以出现在url中的任何地方，变量之间用;分隔。如下：

// GET /pets/42;q=11;r=22
@RequestMapping(value = "/pets/{petId}")
public void findPet(@PathVariable String petId, @MatrixVariable int q) {
    // petId == 42
    // q == 11
}

需要注意的是默认Spring mvc是不支持矩阵变量的，需要开启。

<mvc:annotation-driven enable-matrix-variables="true" />

注解配置则需要如下开启：

<br/>

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
 
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        UrlPathHelper urlPathHelper = new UrlPathHelper();
        urlPathHelper.setRemoveSemicolonContent(false);
        configurer.setUrlPathHelper(urlPathHelper);
    }
}

@PathVariable
此注解使用在请求handler方法的参数上。@RequestMapping可以定义动态路径，如:

@RequestMapping("/users/{uid}")

可以使用@PathVariable将路径中的参数绑定到请求方法参数上。

@RequestMapping("/users/{uid}")
public String execute(@PathVariable("uid") String uid){
}

关注微信公众号：Java技术栈，在后台回复：spring，可以获取我整理的 N 篇最新 Spring 系列程，都是干货。

@RequestAttribute

Cette annotation est utilisée sur les paramètres de la méthode du gestionnaire de requêtes pour lier les attributs de la requête Web (attributs de requête, qui sont les valeurs d'attribut​​mises par le serveur) aux paramètres de la méthode.

@RequestBody

Cette annotation est utilisée sur les paramètres de la méthode du gestionnaire de requêtes pour lier le mappage du corps de la requête http à ce paramètre. HttpMessageConverter est responsable de la conversion des objets en requêtes http.

@RequestHeader

Cette annotation est utilisée sur les paramètres de la méthode du gestionnaire de requêtes pour lier la valeur de l'en-tête de requête http aux paramètres.

@RequestParam

Cette annotation est utilisée sur les paramètres de la méthode du gestionnaire de requêtes pour lier la valeur du paramètre de requête http au paramètre.

@RequestPart

Cette annotation est utilisée sur les paramètres de la méthode du gestionnaire de requêtes et est utilisée pour lier plusieurs parties telles que des fichiers aux paramètres.

@ResponseBody

Cette annotation est utilisée sur la méthode du gestionnaire de requêtes. Semblable à @RequestBody, il est utilisé pour afficher l'objet de retour de la méthode directement dans la réponse http.

@ResponseStatus

Cette annotation est utilisée sur les méthodes et les classes d'exception pour déclarer le code d'état http renvoyé par cette méthode ou classe d'exception. Vous pouvez utiliser cette annotation sur le contrôleur afin que tous les @RequestMapping héritent.

@ControllerAdvice

Cette annotation est utilisée sur les classes. Comme mentionné précédemment, vous pouvez déclarer une ExceptionMethod pour chaque contrôleur.

Ici, vous pouvez utiliser @ControllerAdvice pour déclarer une classe afin de gérer uniformément toutes les méthodes @RequestMapping avec @ExceptionHandler, @InitBinder et @ModelAttribute.

@RestController

Cette annotation est utilisée sur la classe pour déclarer que ce contrôleur renvoie non pas une vue mais un objet de domaine. Il introduit également deux annotations @Controller et @ResponseBody.

@RestControllerAdvice

Cette annotation est utilisée sur la classe et introduit deux annotations @ControllerAdvice et @ResponseBody.

@SessionAttribute

Cette annotation est utilisée sur les paramètres de la méthode pour lier les attributs de la session aux paramètres.

@SessionAttributes

Cette annotation est utilisée au niveau du type et est utilisée pour stocker des objets JavaBean dans la session. Généralement utilisé avec l'annotation @ModelAttribute.如下：

@ModelAttribute("user")

public PUser getUser() {}

// controller和上面的代码在同一controller中
@Controller
@SeesionAttributes(value = "user", types = {
    User.class
})

public class UserController {}

3

 Spring Boot注解

@EnableAutoConfiguration

此注解通常被用在主应用class上，告诉Spring Boot自动基于当前包添加Bean、对bean的属性进行设置等。

@SpringBootApplication

此注解用在Spring Boot项目的应用主类上（此类需要在base package中）。

使用了此注解的类首先会让Spring Boot启动对base package以及其sub-pacakage下的类进行component scan。这篇整理的也非常全：Spring Boot 最核心的 25 个注解，建议大家看下。

此注解同时添加了以下几个注解：

@Configuration

@EnableAutoConfiguration

@ComponentScan

4

 Stereotype注解

@Component

Cette annotation est utilisée sur la classe pour déclarer un composant Spring (Bean) et l'ajouter au contexte de l'application.

@Controller

Comme mentionné précédemment

@Service

Cette annotation est utilisée sur la classe pour déclarer que cette classe est une classe de service qui effectue une logique métier, des calculs, appelle des API internes, etc. Il s'agit d'une forme spécifique d'annotation @Component.

@Repository

Cette classe permet de déclarer cette classe sur la classe d'accès à la base de données, généralement en tant que rôle DAO.

Cette annotation a la fonctionnalité de traduction automatique. Par exemple : lorsque ce composant lève une exception, il y aura un gestionnaire pour gérer l'exception sans utiliser de bloc try-catch.

5

Notes d'accès aux données

@Transactional

Cette annotation est utilisée dans la définition de l'interface, méthode d’interface, définition de classe ou méthode publique dans la classe. Il convient de noter que cette annotation n'active pas le comportement des transactions, ce sont simplement des métadonnées qui seront consommées par certaines infrastructures d'exécution.

6

 任务执行、调度注解

@Scheduled

此注解使用在方法上，声明此方法被定时调度。使用了此注解的方法返回类型需要是Void，并且不能接受任何参数。

@Scheduled(fixedDelay=1000)
public void schedule() {

}

@Scheduled(fixedRate=1000)
public void schedulg() {

}

第二个与第一个不同之处在于其不会等待上一次的任务执行结束。

@Async

此注解使用在方法上，声明此方法会在一个单独的线程中执行。不同于Scheduled注解，此注解可以接受参数。

使用此注解的方法的返回类型可以是Void也可是返回值。但是返回值的类型必须是一个Future。

7

 测试注解

@ContextConfiguration

此注解使用在Class上，声明测试使用的配置文件，此外，也可以指定加载上下文的类。

此注解一般需要搭配SpringJUnit4ClassRunner使用。

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = SpringCoreConfig.class)
public class UserServiceTest {

}

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!