SpringではBeanはデフォルトでシングルトンとして作成されますが、BeanScopeを利用することで様々なタイプのBeanを作成できます

prototype
- 毎回インスタンスを生成する
サーブレットコンテナが必須
- sessionhttp sessionごとに生成
- requesthttp リクエストごとに生成
  - http sessionごとに生成
  - http リクエストごとに生成

その他

https://docs.spring.io/spring-framework/docs/3.0.0.M3/reference/html/ch04s04.html

sessionとrequest

Requestスコープで使うBeanとSessionスコープで使うBeanを定義します。

public class RequestBean {
    private int counter;

    public RequestBean(){
        this.counter = 0;
    }

    public int getCounter(){
        return this.counter++;
    }
}

public class SessionBean {

    private int counter;

    public SessionBean(){
        this.counter = 0;
    }

    public  int getCounter(){
        return this.counter++;
    }
}

どちらも自身が保有するカウンターをgetの際に返却してからインクリメントします

設定クラス

この設定クラスでBeanのScopeを定義します

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.web.context.WebApplicationContext;

@Configuration
public class BeanConfig {
    @Bean
    @Scope(value = WebApplicationContext.SCOPE_REQUEST,proxyMode = ScopedProxyMode.TARGET_CLASS)
    public RequestBean requestBean(){
        return new RequestBean();
    }
    @Bean
    @Scope(value = WebApplicationContext.SCOPE_SESSION,proxyMode = ScopedProxyMode.TARGET_CLASS)
    public SessionBean sessionBean(){
        return new SessionBean();
    }
}

scopeのvalueに定数を指定していますが、文字列でも可能

利用する

@RestController
public class ScopeTestController {

    @Autowired
    private RequestBean requestBean;

    @Autowired
    private SessionBean sessionBean;

    @GetMapping("/scope")
    public String testscope(){
        String request = String.valueOf(requestBean.getCounter());
        String session = String.valueOf(sessionBean.getCounter());
        return "REQUEST : " + request + " SESSION : " + session;
    }
}

画面表示して何度か更新すると違いがわかります

全く同じ処理ですがSessionはセッションごとにインスタンスを生成しているのでカウントが加算されていますが、Requestはリクエストごとにインスタンスが生成されるので、画面をリロードするたびに新しいインスタンスが生成されています。

proxyMode

コントローラークラスはシングルトンなので、requestやsessionとは生存期間が明らかに違います。(requestなどが短い）

proxyModeをつけないとエラーになります。

Caused by: org.springframework.beans.factory.support.ScopeNotActiveException: 

Error creating bean with name &#39;requestBean&#39;: 

Scope &#39;request&#39; is not active for the current thread; 

consider defining a scoped proxy for this bean if you intend to refer to it from a singleton; nested exception is java.lang.IllegalStateException:

No thread-bound request found: 

Are you referring to request attributes outside of an actual web request,

or processing a request outside of the originally receiving thread? 

If you are actually operating within a web request and still receive this message,

 your code is probably running outside of DispatcherServlet:

  In this case, use RequestContextListener or RequestContextFilter to expose the current request.

プロクシモードについては以下のサイトに記載があります
- https://kohei.life/spring-scope/
- https://spring.pleiades.io/spring-framework/docs/current/javadoc-api/org/springframework/context/annotation/ScopedProxyMode.html

prototype

次に毎回インスタンスを生成するBeanを使ってみます。毎回というのはBeanを取得する度という意味です。

つまりシングルトンのコンポーネントなどに@Autowiredしたものは1回だけの取得になります。

同じつくりのBean化するクラスを作成します

public class PrototypeBean {
    public int count;
    public PrototypeBean(){
        this.count = 0;
    }

    public int getCount() {
        return count++;
    }
}

public class DefaultBean {
    public int count;
    public DefaultBean(){
        this.count = 0;
    }

    public int getCount() {
        return count++;
    }
}

設定クラスを定義します

@Configuration
public class BeanConfig {

    @Bean(name = "prototype")
    @Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
    public PrototypeBean prototypeBean(){
        return new PrototypeBean();
    }

    @Bean(name = "default")
    public DefaultBean defaultBean(){
        return new DefaultBean();
    }
}

これを利用します

@RestController
public class ScopeTestController {

    @Autowired
    private ConfigurableApplicationContext context;

    @GetMapping("/scope")
    public String testscope(){

        PrototypeBean prototypeBean = (PrototypeBean) context.getBean("prototype");
        DefaultBean defaultBean = (DefaultBean) context.getBean("default");

        String defCnt = String.valueOf(defaultBean.getCount());
        String proCnt = String.valueOf(prototypeBean.getCount());
        return "defaultBean : " + defCnt + " prototypeBean : " + proCnt;
    }
}

ConfigurableApplicationContextを使って両者とも毎回Beanを取得します

通常のdefaultBeanはシングルトンなので値が更新されますが、prototypeBeanは取得のたびにインスタンスが生成されているので0のままなのが確認できました。

Spring | BeanScopeを使ってみる