Spring标签之Bean @Scope

2021-10-12 15:03:32

@Bean 的用法

@Bean是一个方法级别上的注解，主要用在@Configuration注解的类里，也可以用在@Component注解的类里。添加的bean的id为方法名

定义bean

下面是@Configuration里的一个例子

@Configuration

public class AppConfig {

    @Bean

    public TransferService transferService() {

        return new TransferServiceImpl();

    }

}

这个配置就等同于之前在xml里的配置

<beans>

    <bean id="transferService" class="com.acme.TransferServiceImpl"/>

</beans>

bean的依赖

@bean 也可以依赖其他任意数量的bean，如果TransferService 依赖 AccountRepository，我们可以通过方法参数实现这个依赖

@Configuration

public class AppConfig {

    @Bean

    public TransferService transferService(AccountRepository accountRepository) {

        return new TransferServiceImpl(accountRepository);

    }

}

接受生命周期的回调

任何使用@Bean定义的bean，也可以执行生命周期的回调函数，类似@PostConstruct and @PreDestroy的方法。用法如下

public class Foo {

    public void init() {

        // initialization logic

    }

}

public class Bar {

    public void cleanup() {

        // destruction logic

    }

}

@Configuration

public class AppConfig {

    @Bean(initMethod = "init")

    public Foo foo() {

        return new Foo();

    }

    @Bean(destroyMethod = "cleanup")

    public Bar bar() {

        return new Bar();

    }

}

默认使用javaConfig配置的bean，如果存在close或者shutdown方法，则在bean销毁时会自动执行该方法，如果你不想执行该方法，则添加@Bean(destroyMethod="")来防止出发销毁方法

指定bean的scope

使用@Scope注解

你能够使用@Scope注解来指定使用@Bean定义的bean

【Bean的Scope】
Scope 描述的是Spring 容器如何新建Bean 的实例的。Spring 的Scope 有以下几种，通过@Scope 注解来实现。

1. Singleton ：一个Spring 容器中只有一个Bean 的实例，此为Spring 的默认配置，全容器共享一个实例。
2. Prototype ：每次调用新建一个Bean 的实例。
3. Request: Web 项目中，给每一个http request 新建一个Bean 实例。
4. Session: Web 项目中，给每一个http session 新建一个Bean 实例。
5. Global Session ：这个只在portal 应用中有用，给每一个global http session 新建一个Bean
实例。
6. 在Spring Batch 中还有一个Scope 是使用@StepScope

如果希望在启动的时候加载以后不在加载，使用单例模式，就是

@Scope("Singleton") 或者 @Scope,因为默认情况下就是单例的；

@Configuration

public class MyConfiguration {

    @Bean

    @Scope("prototype")

    public Encryptor encryptor() {

        // ...

    }

}

@Scope and scoped-proxy

spring提供了scope的代理，可以设置@Scope的属性proxyMode来指定，默认是ScopedProxyMode.NO，你可以指定为默认是ScopedProxyMode.INTERFACES或者默认是ScopedProxyMode.TARGET_CLASS。
以下是一个demo，好像用到了（没看懂这块）

// an HTTP Session-scoped bean exposed as a proxy

@Bean

@SessionScope

public UserPreferences userPreferences() {

    return new UserPreferences();

}

@Bean

public Service userService() {

    UserService service = new SimpleUserService();

    // a reference to the proxied userPreferences bean

    service.setUserPreferences(userPreferences());

    return service;

}

自定义bean的命名

默认情况下bean的名称和方法名称相同，你也可以使用name属性来指定

@Configuration

public class AppConfig {

    @Bean(name = "myFoo")

    public Foo foo() {

        return new Foo();

    }

}

bean的别名

bean的命名支持别名，使用方法如下

@Configuration

public class AppConfig {

    @Bean(name = { "dataSource", "subsystemA-dataSource", "subsystemB-dataSource" })

    public DataSource dataSource() {

        // instantiate, configure and return DataSource bean...

    }

}

bean的描述

有时候提供bean的详细信息也是很有用的，bean的描述可以使用 @Description来提供

@Configuration

public class AppConfig {

    @Bean

    @Description("Provides a basic example of a bean")

    public Foo foo() {

        return new Foo();

    }

}


参考：spring @Bean注解的使用
参考：04-SpringBoot——Spring常用配置-Bean的Scope

码农公寓