วิธีสแกนหลายเส้นทางโดยใช้คำอธิบายประกอบ @ComponentScan

ฉันใช้ Spring 3.1 และบูตแอปพลิเคชันโดยใช้แอตทริบิวต์@Configurationand@ComponentScan

เริ่มต้นจริงด้วย

new AnnotationConfigApplicationContext(MyRootConfigurationClass.class);

คลาส Configuration นี้มีคำอธิบายประกอบ

@Configuration
@ComponentScan("com.my.package")
public class MyRootConfigurationClass

และใช้งานได้ดี อย่างไรก็ตามฉันต้องการเจาะจงมากขึ้นเกี่ยวกับแพ็คเกจที่ฉันสแกนดังนั้นฉันจึงลอง

@Configuration
@ComponentScan("com.my.package.first,com.my.package.second")
public class MyRootConfigurationClass

อย่างไรก็ตามสิ่งนี้ล้มเหลวโดยมีข้อผิดพลาดบอกฉันว่าไม่พบส่วนประกอบที่ระบุโดยใช้@Componentคำอธิบายประกอบ

วิธีที่ถูกต้องในการทำสิ่งที่ฉันต้องการคืออะไร?

ขอบคุณ

@ComponentScanใช้อาร์เรย์สตริงเช่นนี้:

@ComponentScan({"com.my.package.first","com.my.package.second"})

เมื่อคุณระบุชื่อแพ็กเกจหลายชื่อในสตริงเดียว Spring จะตีความว่าชื่อแพ็กเกจนี้เป็นชื่อแพ็กเกจเดียวจึงไม่พบ

มีทางเลือกประเภท อื่นที่ปลอดภัยในการระบุตำแหน่งแพคเกจฐานเป็นสตริง ดู API ที่นี่แต่ฉันได้แสดงไว้ด้านล่าง:

@ComponentScan(basePackageClasses = {ExampleController.class, ExampleModel.class, ExmapleView.class})

การใช้ตัวระบุbasePackageClassesกับการอ้างอิงคลาสของคุณจะบอกให้ Spring สแกนแพ็กเกจเหล่านั้น (เช่นเดียวกับทางเลือกที่กล่าวถึง) แต่วิธีนี้ทั้งปลอดภัยและเพิ่มการรองรับ IDEสำหรับการอ้างอิงในอนาคตซึ่งเป็นข้อดีอย่างมากในหนังสือของฉัน

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

IMO ฉันไม่ชอบคลาสเครื่องหมาย(แต่อีกครั้งพวกมันค่อนข้างเหมือนกับคลาสข้อมูลแพ็คเกจ)แต่ประเภทความปลอดภัยการรองรับ IDE และการลดจำนวนแพ็คเกจพื้นฐานที่จำเป็นสำหรับการสแกนนี้ลงอย่างมาก คือไม่ต้องสงสัยเลยว่าเป็นตัวเลือกที่ดีกว่ามาก

ระบุชื่อแพ็กเกจของคุณแยกกันโดยต้องใช้String[]สำหรับชื่อแพ็กเกจ

แทนสิ่งนี้:

@ComponentScan("com.my.package.first,com.my.package.second")

ใช้สิ่งนี้:

@ComponentScan({"com.my.package.first","com.my.package.second"})

อีกวิธีหนึ่งในการทำเช่นนี้คือการใช้basePackagesฟิลด์ ซึ่งเป็นฟิลด์ภายในคำอธิบายประกอบ ComponentScan

@ComponentScan(basePackages={"com.firstpackage","com.secondpackage"})

หากคุณดูคำอธิบายประกอบ ComponentScan .class จากไฟล์ jar คุณจะเห็นฟิลด์ basePackages ที่ใช้ในอาร์เรย์ของสตริง

public @interface ComponentScan {
String[] basePackages() default {};
}

หรือคุณสามารถพูดถึงชั้นเรียนอย่างชัดเจน ซึ่งใช้เวลาในอาร์เรย์ของคลาส

Class<?>[]  basePackageClasses

คุณใช้ ComponentScan เพื่อสแกนหลายแพ็คเกจโดยใช้ไฟล์

@ComponentScan({"com.my.package.first","com.my.package.second"})

ตรวจสอบให้แน่ใจว่าคุณได้เพิ่มการอ้างอิงนี้ใน pom.xml ของคุณ

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

คุณยังสามารถใช้คำอธิบายประกอบ @ComponentScans:

@ComponentScans(value = { @ComponentScan("com.my.package.first"),
                          @ComponentScan("com.my.package.second") })

ฉันใช้:

@ComponentScan(basePackages = {"com.package1","com.package2","com.package3", "com.packagen"})