ICode9
精准搜索请尝试： 精确搜索
首页
编程语言>
数据库
系统相关
互联网
其他分享
Python
Java
JavaScript
android
PHP
首页 > 其他分享> 文章详细

@ServeletComponentScan和@ComponentScan的区别

2019-12-03 09:02:42  阅读：282  来源： 互联网

标签：区别 ServeletComponentScan springframework ComponentScan org import com public


 

一、SpringBoot中使用Servlet
在SpringBootApplication上使用@ServletComponentScan注解后，Servlet、Filter、Listener可以直接通过@WebServlet、@WebFilter、@WebListener注解自动注册，无需其他代码。

1.在入口Application类上加入注解@ServletComponentScan

  1.   package com.hui;
  2.    
  3.   import org.springframework.boot.SpringApplication;
  4.   import org.springframework.boot.autoconfigure.SpringBootApplication;
  5.   import org.springframework.boot.web.servlet.ServletComponentScan;
  6.    
  7.   @SpringBootApplication
  8.   @ServletComponentScan
  9.   public class Application {
  10.    
  11.   public static void main(String[] args) {
  12.   SpringApplication.run(Application.class, args);
  13.   }
  14.   }


2.新建Servlet类，继承HttpServlet并且加入注解@WebServlet(name=“TestServlet”,urlPatterns="/test")

  1.   package com.hui.qiang;
  2.    
  3.   import java.io.IOException;
  4.    
  5.   import javax.servlet.ServletException;
  6.   import javax.servlet.annotation.WebServlet;
  7.   import javax.servlet.http.HttpServlet;
  8.   import javax.servlet.http.HttpServletRequest;
  9.   import javax.servlet.http.HttpServletResponse;
  10.    
  11.   @WebServlet(name="TestServlet",urlPatterns="/test")
  12.   public class TestServlet extends HttpServlet {
  13.    
  14.   private static final long serialVersionUID = 1L;
  15.    
  16.   @Override
  17.   protected void doGet(HttpServletRequest req, HttpServletResponse resp)
  18.   throws ServletException, IOException {
  19.   System.out.println("doGet");
  20.   }
  21.   }


3.之后运行代码，在浏览器地址栏输入http://localhost:8080/test，若看到控制台打印doGet，则表示Servlet创建成功。
注意：
(1)如果不加@ServletComponentScan注解则会报404即找不到页面，控制台也扫描不到我们配置的servlet：/test，即无法被映射
(2)如果Application类和Servlet类不在同一包下，则@ServletComponentScan需要添加相应的路径，如Application类在包com.hui.xiao下，则写为@ServletComponentScan(“com.hui.xiao”)或@ServletComponentScan(“com.hui”)

å¨è¿éæå¥å¾çæè¿°

å¨è¿éæå¥å¾çæè¿°

二、Spring, Spring Boot中的@ComponentScan注解用法介绍
@ComponentScan
如果你理解了ComponentScan，你就理解了Spring.
Spring是一个依赖注入(dependency injection)框架。所有的内容都是关于bean的定义及其依赖关系。
定义Spring Beans的第一步是使用正确的注解-@Component或@Service或@Repository.
但是，Spring不知道你定义了某个bean除非它知道从哪里可以找到这个bean.
ComponentScan做的事情就是告诉Spring从哪里找到bean

由你来定义哪些包需要被扫描。一旦你指定了，Spring将会将在被指定的包及其下级的包(sub packages)中寻找bean
下面分别介绍在Spring Boot项目和非Spring Boot项目（如简单的JSP/Servlet或者Spring MVC应用）中如何定义ComponentScan

注：@ComponentScan的不同写法
1.@ComponentScan({“com.xiao.hui”,“com.xiao.qiang”})或@ComponentScan(basePackages = {“com.xiao.hui”,“com.xiao.qiang”})
2.@ComponentScan(“com.xiao”)或@ComponentScan(value = “com.xiao”)或@ComponentScan(basePackages = { “com.xiao” })
3.@ComponentScan(basePackageClasses＝要扫描类.class所在位置的包) 意思是要扫描哪个类所在的包，如@ComponentScan(basePackageClasses＝hehe.class)，这种写法不如上面的那种写法好有局限性

Spring Boot项目
总结：
1.SpringBoot在写启动类的时候如果不使用@ComponentScan指明对象扫描范围，默认指扫描当前启动类所在的包里的对象，如果你的其他包都在使用了@SpringBootApplication注解的主类所在的包及其下级包，则你什么都不用做，SpringBoot会自动帮你把其他包都扫描了。为了方便，我一般都把主类放在了所有类的上一级包中，如项目所有的class文件都放在了包com.beauty的下级包中，则把spring boot的主类放在包com.beauty下。
2.如果当前启动类没有包，则在启动时会报错：Your ApplicationContext is unlikely to start due to a @ComponentScan of the default package错误，因为启动类不能直接放在main/java文件夹下，必须要建一个包把它放进去或者使用@ComponentScan指明要扫描的包。
3.如果你有一些bean所在的包，不在主类的包及其下级包，那么你需要手动加上@ComponentScan注解并指定那个bean所在的包。

举个栗子，看下面定义的类：

  1.   package com.xiao.qiang.qianming;
  2.    
  3.   import org.springframework.boot.SpringApplication;
  4.   import org.springframework.boot.autoconfigure.SpringBootApplication;
  5.   import org.springframework.context.ApplicationContext;
  6.   import org.springframework.context.ConfigurableApplicationContext;
  7.    
  8.   @SpringBootApplication
  9.   public class SpringbootApplication {
  10.    
  11.   public static void main(String[] args) {
  12.   ApplicationContext applicationContext =
  13.   SpringApplication.run(SpringbootApplication.class, args);
  14.    
  15.   for (String name : applicationContext.getBeanDefinitionNames()) {
  16.   System.out.println(name);
  17.   }
  18.   }
  19.   }


类SpringbootApplication在com.xiao.qiang.qianming包下，这个类使用了@SpringBootApplication注解，该注解定义了Spring将自动扫描包com.xiao.qiang.qianming及其子包下的bean
如果你项目中所有的类都定义在上面的包及其子包下，那你不需要做任何事。
但假如你一个类定义在包com.xiao.hui下，则你需要将这个新包也纳入扫描的范围,有两个方案可以达到这个目的。

方案1
定义@ComponentScan(“com.xiao”)，这么做扫描的范围扩大到整个父包com.xiao

  1.   @ComponentScan("com.xiao")
  2.   @SpringBootApplication
  3.   public class SpringbootIn10StepsApplication {


方案2
定义分别扫描两个包

  1.   @ComponentScan({"com.xiao.hui","com.xiao.qiang"})
  2.   @SpringBootApplication
  3.   public class SpringbootIn10StepsApplication {


非Spring Boot项目
在非Spring Boot项目中，我们必须显式地使用@ComponentScan注解定义被扫描的包,可以通过XML文件在应用上下文中定义或在Java代码中对应用上下文定义

Java代码方式：

  1.   @ComponentScan({"com.xiao.package1","com.xiao.package2"})
  2.   @Configuration
  3.   public class SpringConfiguration {


注：@Configuration 和@ComponentScan注解背后会做什么呢?
其实很简单,@ComponentScan告诉Spring 哪个packages 的用注解标识的类 会被spring自动扫描并且装入bean容器。
例如，如果你有个类用@Controller注解标识了，那么，如果不加上@ComponentScan，自动扫描该controller，那么该Controller就不会被spring扫描到，更不会装入spring容器中，因此你配置的这个Controller也没有意义。
类上的注解@Configuration 是最新的用注解配置spring，也就是说这是个配置文件，和原来xml配置是等效的，只不过现在用java代码进行配置了 加上一个@Configuration注解就行了，是不是很方便，不需要那么繁琐的xml配置了，这样基于注解的配置，可读性也大大增高了。

XML文件方式：
<context:component-scan base-package=“com.xiao.package1, com.xiao.package2” />
 

三、使用@ComponentScan自动扫描组件实例
包扫描会扫描只要标注了@Controller,@Service,@Repository,@Component这四个注解都会被扫描到容器中。
1、@Controller 控制器（注入服务）
用于标注控制层，相当于struts中的action层
2、@Service 服务（注入dao）
用于标注服务层，主要用来进行业务的逻辑处理
3、@Repository（实现dao访问）
用于标注数据访问层，也可以说用于标注数据访问组件，即DAO组件.
4、@Component （把普通pojo实例化到spring容器中，相当于配置文件中的 ）
泛指各种组件，就是说当我们的类不属于各种归类的时候（不属于@Controller、@Services等的时候），我们就可以使用@Component来标注这个类。
案例：<context:component-scan base-package=”com.*”>
上面的这个例子是引入Component组件的例子，其中base-package表示为需要扫描的所有子包。
有一篇不错的文章（Spring注解详解）：https://blog.csdn.net/xyh820/article/details/7303330/

å¨è¿éæå¥å¾çæè¿°
新增控制层的java类：TestController和HelloController

  1.   import org.springframework.stereotype.Controller;
  2.    
  3.   @Controller
  4.   public class TestController {
  5.    
  6.   }

 

  1.   import org.springframework.web.bind.annotation.RequestMapping;
  2.   import org.springframework.web.bind.annotation.RequestMethod;
  3.   import org.springframework.web.bind.annotation.RestController;
  4.    
  5.   @RestController
  6.   public class HelloController {
  7.   @RequestMapping(value="/hello", method = RequestMethod.GET)
  8.   public String hello() {
  9.   return "Hello, Spring Boot";
  10.   }
  11.   }


新建一个业务逻辑层类：TestService

  1.   import org.springframework.stereotype.Service;
  2.    
  3.   @Service
  4.   public class TestService {
  5.    
  6.   }


新建一个数据库连接Dao类：TestDao

  1.   import org.springframework.stereotype.Repository;
  2.    
  3.   @Repository
  4.   public class TestDao {
  5.    
  6.   }


新建一个Person：

  1.   public class Person {
  2.   public Person(String string, int i) {
  3.   }
  4.   }


主方法测试：
spring boot：

  1.   import org.springframework.boot.SpringApplication;
  2.   import org.springframework.boot.autoconfigure.SpringBootApplication;
  3.   import org.springframework.context.ApplicationContext;
  4.   import org.springframework.context.annotation.ComponentScan;
  5.    
  6.   @SpringBootApplication
  7.   @ComponentScan(value = "com.hui")
  8.   public class Application {
  9.    
  10.   public static void main(String[] args) {
  11.   ApplicationContext applicationContext =
  12.   SpringApplication.run(Application.class, args);
  13.    
  14.   for (String name : applicationContext.getBeanDefinitionNames()) {
  15.   System.out.println(name);
  16.   }
  17.   }
  18.   }


非spring boot：

  1.   import org.springframework.context.ApplicationContext;
  2.   import org.springframework.context.annotation.AnnotationConfigApplicationContext;
  3.   import org.springframework.context.annotation.Bean;
  4.   import org.springframework.context.annotation.ComponentScan;
  5.   import org.springframework.context.annotation.Configuration;
  6.    
  7.   import com.hui.entity.Person;
  8.    
  9.   @Configuration
  10.   @ComponentScan(value = "com.hui")
  11.   public class ComponentTest {
  12.    
  13.   @Bean
  14.   public Person getPerson() {
  15.   return new Person("百度好帅", 10000);
  16.   }
  17.    
  18.   public static void main(String[] args) {
  19.   @SuppressWarnings("resource")
  20.   ApplicationContext applicationContext =
  21.   new AnnotationConfigApplicationContext(ComponentTest.class);
  22.   String[] beanNames = applicationContext.getBeanDefinitionNames();
  23.   for (String bean : beanNames) {
  24.   System.out.println(bean);
  25.   }
  26.   }
  27.   }


运行Application:
控制台扫描到了/hello，即映射成功

å¨è¿éæå¥å¾çæè¿°

å¨è¿éæå¥å¾çæè¿°
把Application注释掉运行ComponentTest：

å¨è¿éæå¥å¾çæè¿°
参考：
https://blog.csdn.net/Lamb_IT/article/details/80918704
https://jingyan.baidu.com/article/7908e85cc6930daf481ad2b6.html

标签：区别,ServeletComponentScan,springframework,ComponentScan,org,import,com,public
来源： https://www.cnblogs.com/zhoading/p/11974622.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

关于我们 | 联系我们 | 留言反馈

专注分享技术，共同学习，共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有