夯实spring(六):Scope--bean的作用域详解

我会带着你远行 2024-03-23 17:19 54阅读 0赞

*  详解五种bean的sope及使用注意点
 *  自定义作用域的实现

有时候我们需要一个对象在整个应用中只有一个，有些对象希望每次使用的时候都重新创建一个，spring对我们这种需求也提供了支持，在spring中这个叫做bean的作用域，xml中定义bean的时候，可以通过scope属性指定bean的作用域

scope的值常见的有5种：

*  singleton
 *  prototype
 *  request
 *  session
 *  application

### 一，作用域 ###

#### 1，singleton ####

> 当scope的值设置为singleton的时候，整个spring容器中只会存在一个bean实例，通过容器多次查找bean的时候（调用BeanFactory的getBean方法或者bean之间注入依赖的bean对象的时候），返回的都是同一个bean对象，singleton是scope的默认值，所以spring容器中默认创建的bean对象是单例的，通常spring容器在启动的时候，会将scope为singleton的bean创建好放在容器中（有个特殊的情况，当bean的lazy被设置为true的时候，表示懒加载，那么使用的时候才会创建），用的时候直接返回。

Car类：

public class Car {
        
        private String brand;
        private Double price;
    
        public Car() {
        
            System.out.println("我是Car的无参构造方法");
        }
    }

bean.xml

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-4.3.xsd">
    
        
        <bean id="singletonCarBean" class="com.chen.Car" scope="singleton">
        </bean>
    
    </beans>

测试输出：

public class Main {
        
        public static void main(String[] args) {
        
            ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("classpath:bean.xml");
    
            System.out.println(context.getBean("singletonCarBean"));
            System.out.println(context.getBean("singletonCarBean"));
            System.out.println(context.getBean("singletonCarBean"));
        }
    }

输出，可以看到都是同一个对象：

我是Car的无参构造方法
    com.chen.Car@ff5b51f
    com.chen.Car@ff5b51f
    com.chen.Car@ff5b51f

> **单例bean使用注意**  
> 单例bean是整个应用共享的，所以需要考虑到线程安全问题,springmvc中controller默认是单例的，在controller中创建了一些变量，那么这些变量实际上就变成共享的了，controller可能会被很多线程同时访问，这些线程并发去修改controller中的共享变量，可能会出现数据错乱的问题。

#### 1，prototype ####

> scope设置为prototype类型的，表示这个bean是多例的，通过容器每次获取的bean都是不同的实例，每次获取都会重新创建一个bean实例对象。

bean.xml

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-4.3.xsd">
    
        
        <bean id="prototypeCarBean" class="com.chen.Car" scope="prototype">
        </bean>
        
    </beans>

测试输出：

public class Main {
        
        public static void main(String[] args) {
        
            ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("classpath:bean.xml");
            System.out.println(context.getBean("prototypeCarBean"));
            System.out.println(context.getBean("prototypeCarBean"));
            System.out.println(context.getBean("prototypeCarBean"));
        }
    }

输出，可以看到每次使用都是新建一个新的

我是Car的无参构造方法
    com.chen.Car@6e06451e
    我是Car的无参构造方法
    com.chen.Car@59494225
    我是Car的无参构造方法
    com.chen.Car@6e1567f1

**容器启动过程中不会去创建Car对象，都是使用的时候才会创建，3次获取prototypeCarBean得到的都是不同的实例，每次获取的时候才会去调用构造方法创建bean实例。如果这个bean比较复杂，创建时间比较长，会影响系统的性能，**

**request、session、application都是在spring web容器环境中才会有的。**

#### 3，request ####

> 当一个bean的作用域为request，表示在一次http请求中，一个bean对应一个实例；对每个http请求都会创建一个bean实例，request结束的时候，这个bean也就结束了，request作用域用在spring容器的web环境中。

#### 4，session ####

> 这个和request类似，也是用在web环境中，session级别共享的bean，每个会话会对应一个bean实例，不同的session对应不同的bean实例。

#### 5，application ####

> 全局web应用级别的作用域，也是在web环境中使用的，一个web应用程序对应一个bean实例，通常情况下和singleton效果类似的，不过也有不一样的地方，singleton是每个spring容器中只有一个bean实例，一般我们的程序只有一个spring容器，但是，一个应用程序中可以创建多个spring容器，不同的容器中可以存在同名的bean，但是sope=aplication的时候，不管应用中有多少个spring容器，这个应用中同名的bean只有一个。

### 二，自定义作用域 ###

**步骤:**

1.  实现Scope接口

package org.springframework.beans.factory.config;
    import org.springframework.beans.factory.ObjectFactory;
    import org.springframework.lang.Nullable;
    public interface Scope {
        
        /**
        * 返回当前作用域中name对应的bean对象
        * name：需要检索的bean的名称
        * objectFactory：如果name对应的bean在当前作用域中没有找到，那么可以调用这个ObjectFactory来创建这个对象
        **/
        Object get(String name, ObjectFactory<?> objectFactory);
        /**
         * 将name对应的bean从当前作用域中移除
         **/
        @Nullable
        Object remove(String name);
        /**
         * 用于注册销毁回调，如果想要销毁相应的对象,则由Spring容器注册相应的销毁回调，而由自定义作用域选择是不是要销毁相应的对象
         */
        void registerDestructionCallback(String name, Runnable callback);
        /**
         * 用于解析相应的上下文数据，比如request作用域将返回request中的属性。
         */
        @Nullable
        Object resolveContextualObject(String key);
        /**
         * 作用域的会话标识，比如session作用域将是sessionId
         */
        @Nullable
        String getConversationId();
    }

1.  将自定义的scope注册到容器
2.  使用自定义的作用域

#### 案例 ####

实现一个线程级别的bean作用域，同一个线程中同名的bean是同一个实例，不同的线程中的bean是不同的实例。

##### 1，创建ThreadScope类并实现Scope接口 #####

package com.chen;
    
    import org.springframework.beans.factory.ObjectFactory;
    import org.springframework.beans.factory.config.Scope;
    
    import java.util.HashMap;
    import java.util.Map;
    import java.util.Objects;
    
    /**
     * @Author @Chenxc
     * @Date 2023.08.03 9:30
     */
    public class ThreadScope implements Scope {
        
        public static final String THREAD_SCOPE = "thread";//@1
        private ThreadLocal<Map<String, Object>> beanMap = ThreadLocal.withInitial(()->{
          return new HashMap<>();});
        @Override
        public Object get(String s, ObjectFactory<?> objectFactory) {
        
            Object bean = beanMap.get().get(s);
            if (Objects.isNull(bean)) {
        
                bean = objectFactory.getObject();
                beanMap.get().put(s, bean);
            }
            return bean;
        }
    
        @Override
        public Object remove(String s) {
        
            return this.beanMap.get().remove(s);
        }
    
        @Override
        public void registerDestructionCallback(String s, Runnable runnable) {
        
            //bean作用域范围结束的时候调用的方法，用于bean清理
            System.out.println(s);
        }
    
        @Override
        public Object resolveContextualObject(String s) {
        
            return null;
        }
    
        @Override
        public String getConversationId() {
        
            return null;
        }
    }

#### 2，将自定义的scope注册到容器 ####

public class Main {
        
        public static void main(String[] args) throws Exception {
        
                String beanXml = "classpath:bean.xml";
                //手动创建容器
                ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(){
        
                    @Override
                    protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) {
        
                        //向容器中注册自定义的scope
                        beanFactory.registerScope(ThreadScope.THREAD_SCOPE, new ThreadScope());//向容器中注册了自定义的ThreadScope
                        super.postProcessBeanFactory(beanFactory);
                    }
                };
                //设置配置文件位置
                context.setConfigLocation(beanXml);
                //启动容器
                context.refresh();
                //使用容器获取bean
                for (int i = 0; i < 2; i++) {
        //创建了2个线程，然后在每个线程中去获取同样的bean 2次
                    new Thread(() -> {
        
                        System.out.println(Thread.currentThread() + "," + context.getBean("threadCarBean"));
                        System.out.println(Thread.currentThread() + "," + context.getBean("threadCarBean"));
                    }).start();
                    TimeUnit.SECONDS.sleep(1);
                }
       }

注意：

//向容器中注册自定义的scope
    beanFactory.registerScope(ThreadScope.THREAD_SCOPE, new ThreadScope());//向容器中注册了自定义的ThreadScope

3，在bean.xml中使用自定义Scope

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-4.3.xsd">
    
    	
        <bean id="threadCarBean" class="com.chen.Car" scope="thread"></bean>
    
    </beans>

运行上面输出:

我是Car的无参构造方法
    Thread[Thread-1,5,main],com.chen.Car@e9db358
    Thread[Thread-1,5,main],com.chen.Car@e9db358
    我是Car的无参构造方法
    Thread[Thread-2,5,main],com.chen.Car@2a0e29d5
    Thread[Thread-2,5,main],com.chen.Car@2a0e29d5

**可以看到，bean在同样的线程中获取到的是同一个bean的实例，不同的线程中bean的实例是不同的。**

#### 总结： ####

*  spring容器自带的有2种作用域，分别是singleton和prototype；还有3种分别是spring  
    web容器环境中才支持的request、session、application
 *  singleton是spring容器默认的作用域，一个spring容器中同名的bean实例只有一个，多次获取得到的是同一个bean；单例的bean需要考虑线程安全问题
 *  prototype是多例的，每次从容器中获取同名的bean，都会重新创建一个；多例bean使用的时候需要考虑创建bean对性能的影响, 一个应用中可以有多个spring容器
 *  自定义scope 3个步骤，实现Scope接口，将实现类注册到spring容器，使用自定义的sope