Spring - การกำหนดค่าตาม Java

จนถึงตอนนี้คุณได้เห็นวิธีที่เรากำหนดค่า Spring beans โดยใช้ไฟล์กำหนดค่า XML หากคุณพอใจกับการกำหนดค่า XML คุณไม่จำเป็นต้องเรียนรู้วิธีดำเนินการกับการกำหนดค่าบน Java เนื่องจากคุณจะได้ผลลัพธ์เดียวกันโดยใช้การกำหนดค่าอย่างใดอย่างหนึ่งที่มีอยู่

อ็อพชันคอนฟิกูเรชันบน Java ช่วยให้คุณสามารถเขียนคอนฟิกูเรชัน Spring ส่วนใหญ่ของคุณได้โดยไม่ต้องใช้ XML แต่ด้วยความช่วยเหลือของคำอธิบายประกอบที่ใช้ Java เพียงไม่กี่คำอธิบายในบทนี้

@Configuration & @Bean Annotations

การใส่คำอธิบายประกอบชั้นเรียนด้วย @Configurationบ่งชี้ว่าคลาสสามารถใช้โดยคอนเทนเนอร์ Spring IoC เป็นแหล่งที่มาของนิยาม bean @Beanคำอธิบายประกอบบอก Spring ว่าเมธอดที่ใส่คำอธิบายประกอบด้วย @Bean จะส่งคืนอ็อบเจ็กต์ที่ควรลงทะเบียนเป็น bean ในบริบทแอ็พพลิเคชัน Spring คลาส @Configuration ที่ง่ายที่สุดที่เป็นไปได้จะเป็นดังนี้ -

package com.tutorialspoint;
import org.springframework.context.annotation.*;

@Configuration
public class HelloWorldConfig {
   @Bean 
   public HelloWorld helloWorld(){
      return new HelloWorld();
   }
}

โค้ดด้านบนจะเทียบเท่ากับการกำหนดค่า XML ต่อไปนี้ -

<beans>
   <bean id = "helloWorld" class = "com.tutorialspoint.HelloWorld" />
</beans>

ที่นี่ชื่อเมธอดมีคำอธิบายประกอบโดย @Bean ทำงานเป็นรหัส bean และสร้างและส่งคืน bean จริง คลาสคอนฟิกูเรชันของคุณสามารถประกาศได้มากกว่าหนึ่ง @Bean เมื่อกำหนดคลาสคอนฟิกูเรชันของคุณแล้วคุณสามารถโหลดและจัดเตรียมให้กับ Spring container โดยใช้AnnotationConfigApplicationContextดังต่อไปนี้ -

public static void main(String[] args) {
   ApplicationContext ctx = new AnnotationConfigApplicationContext(HelloWorldConfig.class);
   
   HelloWorld helloWorld = ctx.getBean(HelloWorld.class);
   helloWorld.setMessage("Hello World!");
   helloWorld.getMessage();
}

คุณสามารถโหลดคลาสคอนฟิกูเรชันต่างๆได้ดังนี้ -

public static void main(String[] args) {
   AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();

   ctx.register(AppConfig.class, OtherConfig.class);
   ctx.register(AdditionalConfig.class);
   ctx.refresh();

   MyService myService = ctx.getBean(MyService.class);
   myService.doStuff();
}

ตัวอย่าง

ให้เรามี Eclipse IDE ที่ใช้งานได้และทำตามขั้นตอนต่อไปนี้เพื่อสร้างแอปพลิเคชัน Spring -

ขั้นตอน คำอธิบาย
1 สร้างโปรเจ็กต์ด้วยชื่อSpringExampleและสร้างแพ็คเกจcom.tutorialspointภายใต้ไฟล์src โฟลเดอร์ในโครงการที่สร้างขึ้น
2 เพิ่มไลบรารี Spring ที่จำเป็นโดยใช้ตัวเลือกเพิ่ม JAR ภายนอกตามที่อธิบายไว้ในบทตัวอย่าง Spring Hello World
3 เพราะคุณจะใช้คำอธิบายประกอบ Java-based เพื่อให้คุณยังต้องเพิ่มCGLIB.jarจากไดเรกทอรีการติดตั้ง Java ของคุณและASM.jarห้องสมุดซึ่งสามารถดาวน์โหลดได้จากasm.ow2.org
4 สร้างคลาส Java HelloWorldConfig , HelloWorldและMainAppภายใต้แพ็คเกจcom.tutorialspoint
5 ขั้นตอนสุดท้ายคือการสร้างเนื้อหาของไฟล์ Java และไฟล์ Bean Configuration และเรียกใช้แอปพลิเคชันตามที่อธิบายด้านล่าง

นี่คือเนื้อหาของ HelloWorldConfig.java ไฟล์

package com.tutorialspoint;
import org.springframework.context.annotation.*;

@Configuration
public class HelloWorldConfig {
   @Bean 
   public HelloWorld helloWorld(){
      return new HelloWorld();
   }
}

นี่คือเนื้อหาของ HelloWorld.java ไฟล์

package com.tutorialspoint;

public class HelloWorld {
   private String message;

   public void setMessage(String message){
      this.message  = message;
   }
   public void getMessage(){
      System.out.println("Your Message : " + message);
   }
}

ต่อไปนี้เป็นเนื้อหาของไฟล์ MainApp.java ไฟล์

package com.tutorialspoint;

import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.*;

public class MainApp {
   public static void main(String[] args) {
      ApplicationContext ctx = 
         new AnnotationConfigApplicationContext(HelloWorldConfig.class);
   
      HelloWorld helloWorld = ctx.getBean(HelloWorld.class);
      helloWorld.setMessage("Hello World!");
      helloWorld.getMessage();
   }
}

เมื่อคุณสร้างไฟล์ต้นฉบับทั้งหมดและเพิ่มไลบรารีเพิ่มเติมที่จำเป็นแล้วให้เราเรียกใช้แอปพลิเคชัน คุณควรทราบว่าไม่จำเป็นต้องมีไฟล์คอนฟิกูเรชัน หากทุกอย่างเรียบร้อยดีกับแอปพลิเคชันของคุณแอปพลิเคชันของคุณจะพิมพ์ข้อความต่อไปนี้ -

Your Message : Hello World!

การพึ่งพาการฉีดถั่ว

เมื่อ @Beans มีการพึ่งพาซึ่งกันและกันแสดงว่าการพึ่งพานั้นง่ายเพียงแค่มีวิธีการถั่วหนึ่งเรียกอีกวิธีหนึ่งดังนี้ -

package com.tutorialspoint;
import org.springframework.context.annotation.*;

@Configuration
public class AppConfig {
   @Bean
   public Foo foo() {
      return new Foo(bar());
   }
   @Bean
   public Bar bar() {
      return new Bar();
   }
}

ที่นี่ foo bean ได้รับการอ้างอิงถึงบาร์ผ่านการฉีดคอนสตรัคเตอร์ ตอนนี้ให้เราดูตัวอย่างการทำงานอื่น

ตัวอย่าง

ให้เรามี Eclipse IDE ที่ใช้งานได้และทำตามขั้นตอนต่อไปนี้เพื่อสร้างแอปพลิเคชัน Spring -

ขั้นตอน คำอธิบาย
1 สร้างโปรเจ็กต์ด้วยชื่อSpringExampleและสร้างแพ็คเกจcom.tutorialspointภายใต้ไฟล์src โฟลเดอร์ในโครงการที่สร้างขึ้น
2 เพิ่มไลบรารี Spring ที่จำเป็นโดยใช้ตัวเลือกเพิ่ม JAR ภายนอกตามที่อธิบายไว้ในบทตัวอย่าง Spring Hello World
3 เพราะคุณจะใช้คำอธิบายประกอบ Java-based เพื่อให้คุณยังต้องเพิ่มCGLIB.jarจากไดเรกทอรีการติดตั้ง Java ของคุณและASM.jarห้องสมุดซึ่งสามารถดาวน์โหลดได้จากasm.ow2.org
4 สร้างคลาส Java TextEditorConfig , TextEditor , SpellCheckerและMainAppภายใต้แพ็คเกจcom.tutorialspoint
5 ขั้นตอนสุดท้ายคือการสร้างเนื้อหาของไฟล์ Java และไฟล์ Bean Configuration และเรียกใช้แอปพลิเคชันตามที่อธิบายด้านล่าง

นี่คือเนื้อหาของ TextEditorConfig.java ไฟล์

package com.tutorialspoint;
import org.springframework.context.annotation.*;

@Configuration
public class TextEditorConfig {
   @Bean 
   public TextEditor textEditor(){
      return new TextEditor( spellChecker() );
   }

   @Bean 
   public SpellChecker spellChecker(){
      return new SpellChecker( );
   }
}

นี่คือเนื้อหาของ TextEditor.java ไฟล์

package com.tutorialspoint;

public class TextEditor {
   private SpellChecker spellChecker;

   public TextEditor(SpellChecker spellChecker){
      System.out.println("Inside TextEditor constructor." );
      this.spellChecker = spellChecker;
   }
   public void spellCheck(){
      spellChecker.checkSpelling();
   }
}

ต่อไปนี้เป็นเนื้อหาของไฟล์คลาสอื่น SpellChecker.java

package com.tutorialspoint;

public class SpellChecker {
   public SpellChecker(){
      System.out.println("Inside SpellChecker constructor." );
   }
   public void checkSpelling(){
      System.out.println("Inside checkSpelling." );
   }
}

ต่อไปนี้เป็นเนื้อหาของไฟล์ MainApp.java ไฟล์

package com.tutorialspoint;

import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.*;

public class MainApp {
   public static void main(String[] args) {
      ApplicationContext ctx = 
         new AnnotationConfigApplicationContext(TextEditorConfig.class);

      TextEditor te = ctx.getBean(TextEditor.class);
      te.spellCheck();
   }
}

เมื่อคุณสร้างไฟล์ต้นฉบับทั้งหมดและเพิ่มไลบรารีเพิ่มเติมที่จำเป็นแล้วให้เราเรียกใช้แอปพลิเคชัน คุณควรทราบว่าไม่จำเป็นต้องมีไฟล์คอนฟิกูเรชัน หากทุกอย่างเรียบร้อยดีกับแอปพลิเคชันของคุณแอปพลิเคชันของคุณจะพิมพ์ข้อความต่อไปนี้ -

Inside SpellChecker constructor.
Inside TextEditor constructor.
Inside checkSpelling.

คำอธิบายประกอบ @ นำเข้า

@Importคำอธิบายประกอบช่วยให้โหลดคำจำกัดความ @Bean จากคลาสคอนฟิกูเรชันอื่น พิจารณาคลาส ConfigA ดังนี้ -

@Configuration
public class ConfigA {
   @Bean
   public A a() {
      return new A(); 
   }
}

คุณสามารถนำเข้าการประกาศ Bean ด้านบนใน Bean Declaration อื่นได้ดังนี้ -

@Configuration
@Import(ConfigA.class)
public class ConfigB {
   @Bean
   public B b() {
      return new B(); 
   }
}

ตอนนี้แทนที่จะต้องระบุทั้ง ConfigA.class และ ConfigB.class เมื่อสร้างอินสแตนซ์บริบทต้องระบุเฉพาะ ConfigB ดังนี้ -

public static void main(String[] args) {
   ApplicationContext ctx = new AnnotationConfigApplicationContext(ConfigB.class);
   
   // now both beans A and B will be available...
   A a = ctx.getBean(A.class);
   B b = ctx.getBean(B.class);
}

การโทรกลับตลอดอายุการใช้งาน

คำอธิบายประกอบ @Bean สนับสนุนการระบุวิธีการเริ่มต้นและวิธีการเรียกกลับการทำลายโดยพลการเช่นเดียวกับแอตทริบิวต์วิธีการเริ่มต้นและวิธีการทำลายของ Spring XML บนองค์ประกอบ bean -

public class Foo {
   public void init() {
      // initialization logic
   }
   public void cleanup() {
      // destruction logic
   }
}
@Configuration
public class AppConfig {
   @Bean(initMethod = "init", destroyMethod = "cleanup" )
   public Foo foo() {
      return new Foo();
   }
}

การระบุขอบเขตของถั่ว

ขอบเขตเริ่มต้นคือ singleton แต่คุณสามารถแทนที่สิ่งนี้ได้ด้วยคำอธิบายประกอบ @Scope ดังนี้ -

@Configuration
public class AppConfig {
   @Bean
   @Scope("prototype")
   public Foo foo() {
      return new Foo();
   }
}