when use @RefreshScope on @Mapper

[polarloves]

I'm trying to get a dynamic datasource on mybatis.
while i use @RefreshScope on dao interface,an exception will occur.
the code is :
ClassPathMapperScanner ,line:196
beacuse it war RootBeanDefinition,not GenericBeanDefinition .
i can only fix it by change the source code on MapperScannerConfigurer :

  ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry) {
            @Override
            public Set<BeanDefinitionHolder> doScan(String... basePackages) {
                Set<BeanDefinitionHolder> beanDefinitions = super.doScan(basePackages);
                if (!beanDefinitions.isEmpty()) {
                    for (BeanDefinitionHolder beanDefinitionHolder : beanDefinitions) {
                        // set scope
                        beanDefinitionHolder.getBeanDefinition().setScope("refresh");
                    }
                }
                return beanDefinitions;
            }
        };

[kazuki43zoo]

Could you provide a small reproduce project?

[polarloves]

Could you provide a small reproduce project?

https://github.com/polarloves/mybatis-test

[kazuki43zoo]

@polarloves

Thanks you for providing a reproduce project!
In current implementation, mybatis-spring does not support for scanning a scoped proxy bean.
In this case, TestDao has bean scaned as "refresh" scoped proxy bean by bean definition scanner provided by Spring Framework because @RefreshScope adding.

I will consider to support scoped proxy bean at next version.

I have a one question.
Does Mapper need to be in refresh scope? If so, can you explain why?

[kazuki43zoo]

FYI:
You can prevent this error by changed to @RefreshScope(proxyMode = ScopedProxyMode.NO), but you need an attention to the scope of the component that injects the mapper.

@Mapper
@RefreshScope(proxyMode = ScopedProxyMode.NO)
public interface TestDao {
  // ...
}

[polarloves]

@polarloves
Thanks you for providing a reproduce project!
In current implementation, mybatis-spring does not support for scanning a scoped proxy bean.
In this case, TestDao has bean scaned as "refresh" scoped proxy bean by bean definition scanner provided by Spring Framework because @RefreshScope adding.
I will consider to support scoped proxy bean at next version.
I have a one question.
Does Mapper need to be in refresh scope? If so, can you explain why?

I am trying to provider two functiones on my project : "dynamic database" and "config mybatis on config center ".
for dynamic database, the database may change to another machine,I donot want to restart my project (i am lazy enough),I want change the config property on config center such as nacos, so I make the datasource dynamic ,but i found the Mapper use the old datasource,so i have to change its scope to "refresh".besides, I donnot want to use @RefreshScope annotation ,I want to change its scope by my code so that I can switch between "dynamic database" and "static database",i am tried to write a class extends MapperScannerConfigurer, but the MapperScannerConfigurer donot support a public function to change Mapper's scope.I know spring does not suggest dynamic database ,but I want to try~

for "config mybatis on config center ",i want move Mybatis-config.xml to config center,but mybatis does not support yml parser,so i write one.I think is ok.

这个老外看得懂中文吗？

[kazuki43zoo]

so I make the datasource dynamic ,but i found the Mapper use the old datasource,

Could you provide a reproduce project? I'm not familiar to Spring Cloud, can't it be resolved by making the DataSource a refresh scoped bean?

config mybatis on config center

Have you tried MyBatis Spring Boot?
It can be configure the SqlSessionFactory using spring boot configuration properties feature.

• https://github.com/mybatis/spring-boot-starter

[polarloves]

so I make the datasource dynamic ,but i found the Mapper use the old datasource,

Could you provide a reproduce project? I'm not familiar to Spring Cloud, can't it be resolved by making the DataSource a refresh scoped bean?

config mybatis on config center

Have you tried MyBatis Spring Boot?
It can be configure the SqlSessionFactory using spring boot configuration properties feature.

https://github.com/mybatis/spring-boot-starter

when use @RefrshScope on Datasource ,the bean who use Datasource must use @RefreshScope too。so mybatis should use @RefreshScope

[polarloves]

so I make the datasource dynamic ,but i found the Mapper use the old datasource,
Could you provide a reproduce project? I'm not familiar to Spring Cloud, can't it be resolved by making the DataSource a refresh scoped bean?
config mybatis on config center
Have you tried MyBatis Spring Boot?
It can be configure the SqlSessionFactory using spring boot configuration properties feature.
https://github.com/mybatis/spring-boot-starter

when use @RefrshScope on Datasource ,the bean who use Datasource must use @RefreshScope too。so mybatis should use @RefreshScope

when the envirment changed spring will create a new context,and product some new beans,the beans in old context who was in refresh scope will be replace by new beans .if some bean not in refresh scope.it will not be replaced! if i only add RefreshScope on Datasource,the Dao will not be a new one and its datasource is also old one.

[kazuki43zoo]

I think it can be resolved that creating a DataSource as scoped proxy.
If possible, please provide a small prototype project. There is possible that I can help you.

[kazuki43zoo]

@polarloves

I've created a demo application(prototype application) for this issue.

• https://github.com/kazuki43zoo/mybatis-cloud-config-demo

Could you try it and please feedback if possible. Thanks!

[kazuki43zoo]

@polarloves

You can change MyBatis's beans(SqlSessionFactory and mapper beans ) to refresh scope using 'spring.cloud.refresh.refreshable' property provided spring-cloud as follow:

spring.cloud.refresh.refreshable=org.apache.ibatis.session.SqlSessionFactory,org.mybatis.spring.mapper.MapperFactoryBean

For details and sample, please see a demo application(prototype application).

[kazuki43zoo]

See spring-projects/spring-boot#22038 about auto-configure of mybatis-spring-boot-starter is disabled when DataSource is refresh scope.

[kazuki43zoo]

@polarloves

I support to specifies the default scope on mapper scanning features(@MapperScan, MapperScannerConfigurer, <mybatis:scan />) and define scope annotation(@Scope, @RefreshScope, etc ...) at mapper interface.

For details, please see the following PR/Issue.

• Support scoped proxy on mapper scan feature #484 (available since mybatis-spring 2.0.6)
• Support configuration property for 'default-scope' provided by mybatis-spring spring-boot-starter#469 (available since mybatis-spring-boot 2.1.4)

[kazuki43zoo]

See spring-projects/spring-boot#22038 about auto-configure of mybatis-spring-boot-starter is disabled when DataSource is refresh scope.

Already fixed on 2.2.9.