史上最も強力な組織 Spring で最もよく使用される 7 つのアノテーション!-＆＃＆チュートリアル-php.cn

テクノロジーの更新と反復により、Java5.0 はアノテーションをサポートし始めました。 Java の主要なフレームワークである Spring は、バージョン 2.5 に更新されて以来、徐々に XML 構成を放棄し始めており、Spring フレームワークを制御するために使用されるアノテーションが増えています。

Spring にはアノテーションが多すぎて、長年 Java に取り組んできたとしても使いこなせないかもしれません。ここでは、最もよく使用される 7 つのアノテーションをタイプ別にまとめています。

コアノート

@Required

このアノテーションは、Bean の setter メソッドで使用されます。このプロパティが必須であり、構成フェーズ中に挿入する必要があることを示します。そうでない場合は、BeanInitializationExcepion がスローされます。

@Autowired

このアノテーションは、Bean のフィールド、セッターメソッド、およびコンストラクターメソッドで依存関係を明示的に宣言するために使用されます。タイプに基づいた自動配線。

このアノテーションをフィールドで使用し、属性を使用して値を渡すと、Spring は自動的にフィールドに値を割り当てます。このアノテーションは、次のようにプライベートプロパティにも使用できます (非推奨)。

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

ログイン後にコピー

最も一般的な使用法は、セッターメソッドにカスタムコードを追加できるように、セッターでこのアノテーションを使用することです。

<br/>

ログイン後にコピー

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

ログイン後にコピー

このアノテーションをコンストラクターで使用する場合、注意すべき点の 1 つは、クラス内の 1 つのコンストラクターのみがこのアノテーションを使用できるということです。。

さらに、Spring 4.3 以降では、このアノテーションが使用されない場合でも、クラスにコンストラクターが 1 つしかない場合、 Spring は関連する Bean も自動的に挿入します。次のように:

<br/>

ログイン後にコピー

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

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

ログイン後にコピー

@修飾子

此注解是和@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类中。

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

このアノテーションはリクエストハンドラーメソッドのパラメータで使用され、Web リクエスト内の属性 (リクエスト属性。サーバーによって設定される属性値です) をバインドするために使用されます。 ) をメソッドパラメータに追加します。

@RequestBody

このアノテーションは、リクエストハンドラーメソッドのパラメーターで使用され、リクエストの本文を変更します。 http リクエストマップはこのパラメータにバインドされています。 HttpMessageConverter は、オブジェクトを http リクエストに変換する役割を果たします。

@RequestHeader

このアノテーションは、リクエストハンドラーメソッドのパラメータで使用され、http リクエストヘッダーを追加します。値はパラメータにバインドされます。

@RequestParam

このアノテーションはリクエストハンドラーメソッドのパラメーターで使用され、リクエストハンドラーメソッドのパラメーターを変更するために使用されます。 http リクエストパラメータ。値はパラメータにバインドされます。

@RequestPart

このアノテーションは、リクエストハンドラーメソッドのパラメーターで使用され、ファイルの転送と同様にマルチパートはパラメータにバインドされます。

@ResponseBody

このアノテーションはリクエストハンドラーメソッドで使用されます。 @RequestBody と同様に、メソッドの戻りオブジェクトを http レスポンスに直接出力するために使用されます。

@ResponseStatus

このアノテーションは、メソッドおよび例外クラスで返される内容を宣言するためにメソッドおよび例外クラスで使用されます。 httpステータスコード。このアノテーションをコントローラーで使用すると、すべての @RequestMapping が継承されます。

@ControllerAdvice

このアノテーションはクラスで使用されます。前述したように、コントローラーごとに ExceptionMethod を宣言できます。

ここでは、@ControllerAdvice を使用して、@ExceptionHandler、@InitBinder、および @ModelAttribute を含むすべての @RequestMapping メソッドを均一に処理するクラスを宣言できます。

@RestController

このアノテーションは、このコントローラーがビューではなく、ドメインオブジェクト。また、2 つのアノテーション @Controller と @ResponseBody も導入されています。

@RestControllerAdvice

このアノテーションはクラスで使用され、2 つのアノテーション @ControllerAdvice と @ResponseBody が導入されます。

@SessionAttribute

このアノテーションは、セッション内の属性をバインドするメソッドのパラメーターで使用されます。パラメータに。

@SessionAttributes

このアノテーションは型レベルで使用され、JavaBean オブジェクトをセッションに格納するために使用されます。。通常は @ModelAttribute アノテーションと一緒に使用されます。如下：

@ModelAttribute("user")

public PUser getUser() {}

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

public class UserController {}

ログイン後にコピー

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

Stereotype注解

@Component

このアノテーションは、Spring コンポーネント (Bean) を宣言して追加するためにクラスで使用されます。アプリケーションコンテキストに。

@Controller

前述のとおり

@Service

このアノテーションは上記のクラスで使用されます、このクラスがビジネスロジック、計算、内部 API の呼び出しなどを実行するサービスクラスであることを宣言します。これは @Component アノテーションの特定の形式です。

@Repository

このクラスは、通常は DAO ロールとして、データベースにアクセスするクラスでこのクラスを宣言するために使用されます。

このアノテーションには自動変換の機能があり、たとえば、このコンポーネントが例外をスローした場合、try-catch ブロックを使用せずに例外を処理するハンドラーが存在します。

データアクセスの注釈

# #@Transactional

このアノテーションは、インターフェイス定義、インターフェイス内のメソッド、クラス定義、またはクラス内のパブリックメソッドで使用されます。このアノテーションはトランザクション動作をアクティブ化するものではなく、ランタイムインフラストラクチャによって消費される単なるメタデータであることに注意してください。

任务执行、调度注解

@Scheduled

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

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

}

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

}

ログイン後にコピー

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

@Async

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

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

测试注解

@ContextConfiguration

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

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

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

}

ログイン後にコピー

以上が史上最も強力な組織 Spring で最もよく使用される 7 つのアノテーション!の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。