Anotasi Inti Musim Semi

Artikel ini adalah bagian dari serial: • Anotasi Spring Core (artikel saat ini) • Spring Web Annotations

• Anotasi Spring Boot

• Penjadwalan Penjadwalan Musim Semi

• Anotasi Data Musim Semi

• Anotasi Spring Bean

1. Ikhtisar

Kita bisa memanfaatkan kemampuan dari mesin semi DI menggunakan penjelasan di org.springframework.beans.factory.annotation dan org.springframework.context.annotation paket.

Kami sering menyebutnya "Anotasi inti pegas" dan kami akan memeriksanya dalam tutorial ini.

2. Penjelasan Terkait DI

2.1. @Autired

Kita bisa menggunakan @Autowired untuk menandai ketergantungan yang akan diselesaikan dan disuntikkan Spring . Kita dapat menggunakan anotasi ini dengan konstruktor, penyetel, atau injeksi bidang.

Injeksi konstruktor:

class Car { Engine engine; @Autowired Car(Engine engine) { this.engine = engine; } }

Injeksi setter:

class Car { Engine engine; @Autowired void setEngine(Engine engine) { this.engine = engine; } }

Injeksi lapangan:

class Car { @Autowired Engine engine; }

@Autowired memiliki argumen boolean yang disebut diperlukan dengan nilai default true . Ini menyesuaikan perilaku Spring ketika tidak menemukan kacang yang cocok untuk dikirim. Ketika benar , pengecualian dilemparkan, jika tidak, tidak ada yang ditransfer.

Perhatikan, jika kita menggunakan injeksi konstruktor, semua argumen konstruktor bersifat wajib.

Dimulai dengan versi 4.3, kita tidak perlu menganotasi konstruktor dengan @Autowired secara eksplisit kecuali kita mendeklarasikan setidaknya dua konstruktor.

Untuk lebih jelasnya kunjungi artikel kami tentang @Autowired dan injeksi konstruktor.

2.2. @Kacang

@Bean menandai metode pabrik yang membuat instance kacang Spring:

@Bean Engine engine() { return new Engine(); }

Spring memanggil metode ini ketika contoh baru dari tipe pengembalian diperlukan.

Kacang yang dihasilkan memiliki nama yang sama dengan metode pabrik. Jika kita ingin nama itu berbeda, kita dapat melakukannya dengan nama atau nilai argumen anotasi ini (argumen nilai adalah alias untuk argumen nama ):

@Bean("engine") Engine getEngine() { return new Engine(); }

Perhatikan, bahwa semua metode yang dianotasi dengan @Bean harus berada dalam kelas @Configuration .

2.3. @Kualifikator

Kami menggunakan @Qualifier bersama dengan @Autowired untuk memberikan id kacang atau nama kacang yang ingin kami gunakan dalam situasi yang ambigu.

Misalnya, dua kacang berikut mengimplementasikan antarmuka yang sama:

class Bike implements Vehicle {} class Car implements Vehicle {}

Jika Spring perlu memasukkan Vehicle bean, itu berakhir dengan beberapa definisi yang cocok. Dalam kasus seperti itu, kami dapat memberikan nama kacang secara eksplisit menggunakan anotasi @Qualifier .

Menggunakan injeksi konstruktor:

@Autowired Biker(@Qualifier("bike") Vehicle vehicle) { this.vehicle = vehicle; }

Menggunakan injeksi penyetel:

@Autowired void setVehicle(@Qualifier("bike") Vehicle vehicle) { this.vehicle = vehicle; }

Kalau tidak:

@Autowired @Qualifier("bike") void setVehicle(Vehicle vehicle) { this.vehicle = vehicle; }

Menggunakan injeksi lapangan:

@Autowired @Qualifier("bike") Vehicle vehicle;

Untuk penjelasan lebih detail, silahkan baca artikel ini.

2.4. @Yg dibutuhkan

@ Diperlukan pada metode penyetel untuk menandai dependensi yang ingin kita isi melalui XML:

@Required void setColor(String color) { this.color = color; }

Jika tidak, BeanInitializationException akan dilempar.

2.5. @Nilai

Kita bisa menggunakan @Value untuk memasukkan nilai properti ke dalam kacang. Ini kompatibel dengan konstruktor, penyetel, dan injeksi lapangan.

Injeksi konstruktor:

Engine(@Value("8") int cylinderCount) { this.cylinderCount = cylinderCount; }

Injeksi setter:

@Autowired void setCylinderCount(@Value("8") int cylinderCount) { this.cylinderCount = cylinderCount; }

Kalau tidak:

@Value("8") void setCylinderCount(int cylinderCount) { this.cylinderCount = cylinderCount; }

Injeksi lapangan:

@Value("8") int cylinderCount;

Tentu saja, memasukkan nilai statis tidak berguna. Oleh karena itu, kita dapat menggunakan string placeholder di @value nilai-nilai kawat didefinisikan dalam sumber-sumber eksternal , misalnya, di .properties atau .yaml file.

Mari kita asumsikan file .properties berikut :

engine.fuelType=petrol

We can inject the value of engine.fuelType with the following:

@Value("${engine.fuelType}") String fuelType;

We can use @Value even with SpEL. More advanced examples can be found in our article about @Value.

2.6. @DependsOn

We can use this annotation to make Spring initialize other beans before the annotated one. Usually, this behavior is automatic, based on the explicit dependencies between beans.

We only need this annotation when the dependencies are implicit, for example, JDBC driver loading or static variable initialization.

We can use @DependsOn on the dependent class specifying the names of the dependency beans. The annotation's value argument needs an array containing the dependency bean names:

@DependsOn("engine") class Car implements Vehicle {}

Alternatively, if we define a bean with the @Bean annotation, the factory method should be annotated with @DependsOn:

@Bean @DependsOn("fuel") Engine engine() { return new Engine(); }

2.7. @Lazy

We use @Lazy when we want to initialize our bean lazily. By default, Spring creates all singleton beans eagerly at the startup/bootstrapping of the application context.

However, there are cases when we need to create a bean when we request it, not at application startup.

This annotation behaves differently depending on where we exactly place it. We can put it on:

  • a @Bean annotated bean factory method, to delay the method call (hence the bean creation)
  • a @Configuration class and all contained @Bean methods will be affected
  • a @Component class, which is not a @Configuration class, this bean will be initialized lazily
  • an @Autowired constructor, setter, or field, to load the dependency itself lazily (via proxy)

This annotation has an argument named value with the default value of true. It is useful to override the default behavior.

For example, marking beans to be eagerly loaded when the global setting is lazy, or configure specific @Bean methods to eager loading in a @Configuration class marked with @Lazy:

@Configuration @Lazy class VehicleFactoryConfig { @Bean @Lazy(false) Engine engine() { return new Engine(); } }

For further reading, please visit this article.

2.8. @Lookup

A method annotated with @Lookup tells Spring to return an instance of the method’s return type when we invoke it.

Detailed information about the annotation can be found in this article.

2.9. @Primary

Sometimes we need to define multiple beans of the same type. In these cases, the injection will be unsuccessful because Spring has no clue which bean we need.

We already saw an option to deal with this scenario: marking all the wiring points with @Qualifier and specify the name of the required bean.

However, most of the time we need a specific bean and rarely the others. We can use @Primary to simplify this case: if we mark the most frequently used bean with @Primary it will be chosen on unqualified injection points:

@Component @Primary class Car implements Vehicle {} @Component class Bike implements Vehicle {} @Component class Driver { @Autowired Vehicle vehicle; } @Component class Biker { @Autowired @Qualifier("bike") Vehicle vehicle; }

In the previous example Car is the primary vehicle. Therefore, in the Driver class, Spring injects a Car bean. Of course, in the Biker bean, the value of the field vehicle will be a Bike object because it's qualified.

2.10. @Scope

We use @Scope to define the scope of a @Component class or a @Bean definition. It can be either singleton, prototype, request, session, globalSession or some custom scope.

For example:

@Component @Scope("prototype") class Engine {}

3. Context Configuration Annotations

We can configure the application context with the annotations described in this section.

3.1. @Profile

If we want Spring to use a @Component class or a @Bean method only when a specific profile is active, we can mark it with @Profile. We can configure the name of the profile with the value argument of the annotation:

@Component @Profile("sportDay") class Bike implements Vehicle {}

You can read more about profiles in this article.

3.2. @Import

We can use specific @Configuration classes without component scanning with this annotation. We can provide those classes with @Import‘s value argument:

@Import(VehiclePartSupplier.class) class VehicleFactoryConfig {}

3.3. @ImportResource

We can import XML configurations with this annotation. We can specify the XML file locations with the locations argument, or with its alias, the value argument:

@Configuration @ImportResource("classpath:/annotations.xml") class VehicleFactoryConfig {}

3.4. @PropertySource

With this annotation, we can define property files for application settings:

@Configuration @PropertySource("classpath:/annotations.properties") class VehicleFactoryConfig {}

@PropertySource memanfaatkan fitur anotasi berulang Java 8, yang berarti kita dapat menandai kelas dengannya beberapa kali:

@Configuration @PropertySource("classpath:/annotations.properties") @PropertySource("classpath:/vehicle-factory.properties") class VehicleFactoryConfig {}

3.5. @PropertiSumber

Kita dapat menggunakan anotasi ini untuk menentukan beberapa konfigurasi @PropertySource :

@Configuration @PropertySources({ @PropertySource("classpath:/annotations.properties"), @PropertySource("classpath:/vehicle-factory.properties") }) class VehicleFactoryConfig {}

Perhatikan, karena Java 8 kita dapat mencapai hal yang sama dengan fitur anotasi berulang seperti yang dijelaskan di atas.

4. Kesimpulan

Di artikel ini, kami melihat ikhtisar anotasi inti Spring yang paling umum. Kami melihat bagaimana mengkonfigurasi kabel kacang dan konteks aplikasi, dan bagaimana menandai kelas untuk pemindaian komponen.

Seperti biasa, contoh tersedia di GitHub.

Berikutnya » Anotasi Web Musim Semi