知識庫 / Spring RSS 訂閱

2.5. 獲取對話 ID

現在，讓我們實現 getConversationId 方法。如果您的作用域支持對話 ID 的概念，您應該在此處返回它。否則，約定是返回 null：

@Override
public String getConversationId() {
    return "tenant";
}

2.6. 解決上下文對象

最後，讓我們實現 <em>resolveContextualObject</em> 方法。如果你的作用域支持多個上下文對象，你將會將每個對象與一個鍵值對關聯起來，並返回與提供的 <em>key</em> 參數對應的對象。否則，約定是返回 <em>null</em>。

@Override
public Object resolveContextualObject(String key) {
    return null;
}

3. 註冊自定義作用域

為了使 Spring 容器意識到你的新作用域，你需要通過在 ConfigurableBeanFactory 實例的 registerScope 方法中進行註冊。

void registerScope(String scopeName, Scope scope);

第一個參數，scopeName，用於通過其唯一名稱標識/指定一個範圍。第二個參數，scope，是您希望註冊和使用的自定義 Scope 實現的實際實例。

讓我們創建一個自定義 BeanFactoryPostProcessor 並使用 ConfigurableListableBeanFactory 註冊我們的自定義範圍：

public class TenantBeanFactoryPostProcessor implements BeanFactoryPostProcessor {

    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory factory) throws BeansException {
        factory.registerScope("tenant", new TenantScope());
    }
}

現在，讓我們編寫一個 Spring 配置類，加載我們的 BeanFactoryPostProcessor 實現：

@Configuration
public class TenantScopeConfig {

    @Bean
    public static BeanFactoryPostProcessor beanFactoryPostProcessor() {
        return new TenantBeanFactoryPostProcessor();
    }
}

4. 使用自定義作用域

現在我們已經註冊了自定義作用域，我們可以像使用任何其他作用域（除了 singleton 作用域，即默認作用域）的 bean 一樣，將其應用於我們的任何 bean — 通過使用 @Scope 註解並指定自定義作用域的名稱。

讓我們創建一個簡單的 TenantBean 類 — 我們稍後將聲明此類型的 tenant-scoped bean。

public class TenantBean {
    
    private final String name;
    
    public TenantBean(String name) {
        this.name = name;
    }

    public void sayHello() {
        System.out.println(
          String.format("Hello from %s of type %s",
          this.name, 
          this.getClass().getName()));
    }
}

請注意，我們沒有為該類使用@Component和@Scope類級別的註解。

現在，讓我們在配置類中定義一些租户範圍的Bean：

@Configuration
public class TenantBeansConfig {

    @Scope(scopeName = "tenant")
    @Bean
    public TenantBean foo() {
        return new TenantBean("foo");
    }
    
    @Scope(scopeName = "tenant")
    @Bean
    public TenantBean bar() {
        return new TenantBean("bar");
    }
}

5. 測試自定義範圍

讓我們編寫一個測試，通過加載一個 ApplicationContext，註冊我們的 Configuration 類，並檢索租户範圍的 Bean，來測試我們的自定義範圍配置。

@Test
public final void whenRegisterScopeAndBeans_thenContextContainsFooAndBar() {
    AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
    try{
        ctx.register(TenantScopeConfig.class);
        ctx.register(TenantBeansConfig.class);
        ctx.refresh();
        
        TenantBean foo = (TenantBean) ctx.getBean("foo", TenantBean.class);
        foo.sayHello();
        TenantBean bar = (TenantBean) ctx.getBean("bar", TenantBean.class);
        bar.sayHello();
        Map<String, TenantBean> foos = ctx.getBeansOfType(TenantBean.class);
        
        assertThat(foo, not(equalTo(bar)));
        assertThat(foos.size(), equalTo(2));
        assertTrue(foos.containsValue(foo));
        assertTrue(foos.containsValue(bar));

        BeanDefinition fooDefinition = ctx.getBeanDefinition("foo");
        BeanDefinition barDefinition = ctx.getBeanDefinition("bar");
        
        assertThat(fooDefinition.getScope(), equalTo("tenant"));
        assertThat(barDefinition.getScope(), equalTo("tenant"));
    }
    finally {
        ctx.close();
    }
}

以下是我們測試的輸出:

Hello from foo of type org.baeldung.customscope.TenantBean
Hello from bar of type org.baeldung.customscope.TenantBean

6. 結論

在本快速教程中，我們演示瞭如何在 Spring 中定義、註冊和使用自定義作用域。