解決@Scope(「prototype「)不生效的問題

2022-06-15 10:00:17

@Scope(“prototype“)不生效

使用spring的時候，我們一般都是使用@Component實現bean的注入，這個時候我們的bean如果不指定@Scope，預設是單例模式，另外還有很多模式可用，用的最多的就是多例模式了，顧名思義就是每次使用都會建立一個新的物件，比較適用於寫一些job，比如在多執行緒環境下可以使用全域性變數之類的

建立一個測試任務，這裡在網上看到大部分都是直接@Scope(“prototype”)，這裡測試是不生效的，再加上proxyMode才行，程式碼如下

import org.springframework.beans.factory.config.ConfigurableBeanFactory;
import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Component;
@Component
@Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE, proxyMode = ScopedProxyMode.TARGET_CLASS)
public class TestAsyncClient {
    private int a = 0;
    @Async
    public void test(int a) {
        this.a = a;
        CommonAsyncJobs.list.add(this.a + "");
    }
}

測試

import cn.hutool.core.collection.CollectionUtil;
import lombok.extern.slf4j.Slf4j;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.test.context.junit4.SpringRunner;
import java.util.Set;
import java.util.Vector;
@Slf4j
@EnableAsync
@SpringBootTest
@RunWith(SpringRunner.class)
public class CommonAsyncJobs {
    @Autowired
    private TestAsyncClient testAsyncClient;
    // 多執行緒環境下，普通的list.add不適用，用Vector處理就行了，效率低，但無所謂反正測試的
    public static Vector<String> list = new Vector<>();
    @Test
    public void testAsync() throws Exception {
        // 迴圈裡面非同步處理
        int a = 100000;
        for (int i = 0; i < a; i++) {
            testAsyncClient.test(i);
        }
        System.out.println("多執行緒結果：" + list.size());
        System.out.println("單執行緒結果：" + a);
        Set<String> set = CollectionUtil.newHashSet();
        Set<String> exist = CollectionUtil.newHashSet();
        for (String s : list) {
            if (set.contains(s)) {
                exist.add(s);
            } else {
                set.add(s);
            }
        }
        // 沒重複的值，說明多執行緒環境下，全域性變數沒有問題
        System.out.println("重複的值：" + exist.size());
        System.out.println("重複的值：" + exist);
        // 單元測試內主執行緒結束會終止子執行緒任務
        Thread.sleep(Long.MAX_VALUE);
    }
}

結果

沒重複的值，說明多執行緒環境下，全域性變數沒有問題

@Scope(“prototype“)正確用法——解決Bean多例問題

1.問題，Spring管理的某個Bean需要使用多例

在使用了Spring的web工程中，除非特殊情況，我們都會選擇使用Spring的IOC功能來管理Bean，而不是用到時去new一個。

Spring管理的Bean預設是單例的（即Spring建立好Bean，需要時就拿來用，而不是每次用到時都去new，又快效能又好），但有時候單例並不滿足要求（比如Bean中不全是方法，有成員，使用單例會有執行緒安全問題，可以搜尋執行緒安全與執行緒不安全的相關文章），你上網可以很容易找到解決辦法，即使用@Scope("prototype")註解，可以通知Spring把被註解的Bean變成多例

如下所示：

import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
@RequestMapping(value = "/testScope")
public class TestScope {
 
    private String name;
    @RequestMapping(value = "/{username}",method = RequestMethod.GET)
    public void userProfile(@PathVariable("username") String username) {
        name = username;
        try {
            for(int i = 0; i < 100; i++) {
                System.out.println(Thread.currentThread().getId() + "name:" + name);
                Thread.sleep(2000);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return;
    }
}

分別傳送請求http://localhost:8043/testScope/aaa和http://localhost:8043/testScope/bbb，控制檯輸出：

34name:aaa
34name:aaa
35name:bbb
34name:bbb

（34和35是兩個執行緒的ID，每次執行都可能不同，但是兩個請求使用的執行緒的ID肯定不一樣，可以用來區分兩個請求。）可以看到第二個請求bbb開始後，將name的內容改為了“bbb”，第一個請求的name也從“aaa”改為了“bbb”。要想避免這種情況，可以使用@Scope("prototype"),註解加在TestScope這個類上。加完註解後重覆上面的請求，發現第一個請求一直輸出“aaa”，第二個請求一直輸出“bbb”，成功。

2.問題升級

多個Bean的依賴鏈中，有一個需要多例

第一節中是一個很簡單的情況，真實的Spring Web工程起碼有Controller、Service、Dao三層，假如Controller層是單例，Service層需要多例，這時候應該怎麼辦呢？

2.1一次失敗的嘗試

首先我們想到的是在Service層加註解@Scope("prototype")，如下所示：

controller類程式碼

import com.example.test.service.Order;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
@RequestMapping(value = "/testScope")
public class TestScope {
 
    @Autowired
    private Order order;
 
    private String name;
 
    @RequestMapping(value = "/{username}", method = RequestMethod.GET)
    public void userProfile(@PathVariable("username") String username) {
        name = username;
        order.setOrderNum(name);
        try {
            for (int i = 0; i < 100; i++) {
                System.out.println(
                        Thread.currentThread().getId()
                                + "name:" + name
                                + "--order:"
                                + order.getOrderNum());
                Thread.sleep(2000);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return;
    }
}

Service類程式碼

import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Service;
 
@Service
@Scope("prototype")
public class Order {
    private String orderNum;
 
    public String getOrderNum() {
        return orderNum;
    }
 
    public void setOrderNum(String orderNum) {
        this.orderNum = orderNum;
    }
 
    @Override
    public String toString() {
        return "Order{" +
                "orderNum='" + orderNum + ''' +
                '}';
    }
}

分別傳送請求http://localhost:8043/testScope/aaa和http://localhost:8043/testScope/bbb，控制檯輸出：

32name:aaa--order:aaa
32name:aaa--order:aaa
34name:bbb--order:bbb
32name:bbb--order:bbb

可以看到Controller的name和Service的orderNum都被第二個請求從“aaa”改成了“bbb”，Service並不是多例，失敗。

2.2 一次成功的嘗試

我們再次嘗試，在Controller和Service都加上@Scope("prototype")，結果成功，這裡不重複貼程式碼，讀者可以自己試試。

2.3 成功的原因（對2.1、2.2的理解）

Spring定義了多種作用域，可以基於這些作用域建立bean，包括：

單例（ Singleton）：在整個應用中，只建立bean的一個範例。
原型（ Prototype）：每次注入或者通過Spring應用上下文獲取的時候，都會建立一個新的bean範例。

對於以上說明，我們可以這樣理解：雖然Service是多例的，但是Controller是單例的。如果給一個元件加上@Scope("prototype")註解，每次請求它的範例，spring的確會給返回一個新的。問題是這個多例物件Service是被單例物件Controller依賴的。而單例服務Controller初始化的時候，多例物件Service就已經注入了；當你去使用Controller的時候，Service也不會被再次建立了（注入時建立，而注入只有一次）。

2.4 另一種成功的嘗試（基於2.3的猜想）

為了驗證2.3的猜想，我們在Controller鍾每次去請求獲取Service範例，而不是使用@Autowired注入，程式碼如下：

Controller類

import com.example.test.service.Order;
import com.example.test.utils.SpringBeanUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
@RequestMapping(value = "/testScope")
public class TestScope {
 
    private String name;
 
    @RequestMapping(value = "/{username}", method = RequestMethod.GET)
    public void userProfile(@PathVariable("username") String username) {
        name = username;
        Order order = SpringBeanUtil.getBean(Order.class);
        order.setOrderNum(name);
        try {
            for (int i = 0; i < 100; i++) {
                System.out.println(
                        Thread.currentThread().getId()
                                + "name:" + name
                                + "--order:"
                                + order.getOrderNum());
                Thread.sleep(2000);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return;
    }
}

用於獲取Spring管理的Bean的類

package com.example.test.utils;
 
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;
 
@Component
public class SpringBeanUtil implements ApplicationContextAware {
 
    /**
     * 上下文物件範例
     */
    private static ApplicationContext applicationContext;
 
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }
 
    /**
     * 獲取applicationContext
     *
     * @return
     */
    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }
 
    /**
     * 通過name獲取 Bean.
     *
     * @param name
     * @return
     */
    public static Object getBean(String name) {
        return getApplicationContext().getBean(name);
    }
 
    /**
     * 通過class獲取Bean.
     *
     * @param clazz
     * @param <T>
     * @return
     */
    public static <T> T getBean(Class<T> clazz) {
        return getApplicationContext().getBean(clazz);
    }
 
    /**
     * 通過name,以及Clazz返回指定的Bean
     *
     * @param name
     * @param clazz
     * @param <T>
     * @return
     */
    public static <T> T getBean(String name, Class<T> clazz) {
        return getApplicationContext().getBean(name, clazz);
    }
}

Order的程式碼不變。

分別傳送請求http://localhost:8043/testScope/aaa和http://localhost:8043/testScope/bbb，控制檯輸出：

31name:aaa--order:aaa
33name:bbb--order:bbb
31name:bbb--order:aaa
33name:bbb--order:bbb

可以看到，第二次請求的不會改變第一次請求的name和orderNum。問題解決。我們在2.3節中給出的的理解是對的。

3. Spring給出的解決問題的辦法（解決Bean鏈中某個Bean需要多例的問題）

雖然第二節解決了問題，但是有兩個問題：

方法一，為了一個多例，讓整個一串Bean失去了單例的優勢；
方法二，破壞IOC注入的優美展現形式，和new一樣不便於管理和修改。

Spring作為一個優秀的、用途廣、發展時間長的框架，一定有成熟的解決辦法。經過一番搜尋，我們發現，註解@Scope("prototype")（這個註解實際上也可以寫成@Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE，使用常數比手打字串不容易出錯）還有很多用法。

首先value就分為四類：

ConfigurableBeanFactory.SCOPE_PROTOTYPE，即“prototype”
ConfigurableBeanFactory.SCOPE_SINGLETON，即“singleton”
WebApplicationContext.SCOPE_REQUEST，即“request”
WebApplicationContext.SCOPE_SESSION，即“session”

他們的含義是：

singleton和prototype分別代表單例和多例；
request表示請求，即在一次http請求中，被註解的Bean都是同一個Bean，不同的請求是不同的Bean；
session表示對談，即在同一個對談中，被註解的Bean都是使用的同一個Bean，不同的對談使用不同的Bean。

使用session和request產生了一個新問題，生成controller的時候需要service作為controller的成員，但是service只在收到請求（可能是request也可能是session）時才會被範例化，controller拿不到service範例。為了解決這個問題，@Scope註解新增了一個proxyMode的屬性，有兩個值ScopedProxyMode.INTERFACES和ScopedProxyMode.TARGET_CLASS，前一個表示表示Service是一個介面，後一個表示Service是一個類。

本文遇到的問題中，將@Scope註解改成@Scope(value = WebApplicationContext.SCOPE_REQUEST, proxyMode = ScopedProxyMode.TARGET_CLASS)就可以了，這裡就不重複貼程式碼了。

問題解決。以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。

解決@Scope(「prototype「)不生效的問題

目錄

@Scope(“prototype“)不生效

@Scope(“prototype“)正確用法——解決Bean多例問題

1.問題，Spring管理的某個Bean需要使用多例

2.問題升級

3. Spring給出的解決問題的辦法（解決Bean鏈中某個Bean需要多例的問題）

熱門文章