Mybatis MapperScanner Configrer自動スキャンMapperインターフェース生成プロキシをSpringに注入する方法
前言
Mybatis MapperScanner Configrer自動スキャンは、Mapperインターフェース生成エージェントをSpring Mybatisに注入し、Springと統合するときにMapper FactoryBenを配置してMapperインターフェースのプロキシを生成することができます。
たとえば:
上の配置には大きな欠点があります。システムには多くのプロファイルがある場合、マニュアルで作成する必要があります。
SpringのXMLプロファイルにすべてのマッパーを登録する必要はありません。反対に、MapperScanner Configrerを使用してもいいです。これはクラスパスの下のマッパーを探して、自動的にそれらをMapper FactoryBenに作成します。
MapperScanner Configrerを作成するには、Springの構成に下記のコードを追加することができます。
なお、Sql Session FactoryまたはSql Session Templateを指定する必要はありません。MapperScanner CofigrerはMapper FactoryBenを作成し、その後自動的に組み立てられます。しかし、もしあなたが一つ以上のDataSourceを使ったら、自動組立は無効になるかもしれません。この場合、sql Session Factory BeanNameまたはsql Session TemplateBenName属性を使って正しいbean名前を設定して使用することができます。これはどのように構成されているのか、beanの名前が必要であって、beanの引用ではないので、value属性はここで通常のrefに置き換えられます。
発見されたマッパーは、Spring対自動検出コンポーネント(Springマニュアルの3.14.4を参照)のデフォルトの命名ポリシーを使用して命名される。つまり、注釈が見つからなければ、マッパーの非大文字の非完全限定クラス名を使用する。ただし、@ComponentまたはJSR-330の@Namedコメントが見つかったら、名前を取得します。注意してください。org.springframe ewark.stereotype.component、javax.inject.Named(JSE 6を使うと)またはあなた自身のコメント(間違いなく自己注)に設定できます。このようなコメントはジェネレータと名称提供器として使用されます。
続いてMapperScanner Configrer種類のソースコードを見てみましょう。自動スキャンはどのように行われていますか?
以上はこの文章の全部の内容です。本文の内容は皆さんの学習や仕事に対して一定の参考学習価値を持ってほしいです。ありがとうございます。
Mybatis MapperScanner Configrer自動スキャンは、Mapperインターフェース生成エージェントをSpring Mybatisに注入し、Springと統合するときにMapper FactoryBenを配置してMapperインターフェースのプロキシを生成することができます。
たとえば:
<bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
<property name="mapperInterface" value="com.bijian.study.dao" />
<property name="sqlSessionFactory" ref="sqlSessionFactory" />
</bean>
Mapper FactoryBenが作成したエージェントはUserMapperインターフェースを実現し、アプリケーションに注入します。プロキシは実行環境において作成されているので、指定されたマッパーは特定の実装クラスではなくインターフェースでなければなりません。上の配置には大きな欠点があります。システムには多くのプロファイルがある場合、マニュアルで作成する必要があります。
SpringのXMLプロファイルにすべてのマッパーを登録する必要はありません。反対に、MapperScanner Configrerを使用してもいいです。これはクラスパスの下のマッパーを探して、自動的にそれらをMapper FactoryBenに作成します。
MapperScanner Configrerを作成するには、Springの構成に下記のコードを追加することができます。
<bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
<property name="mapperInterface" value="com.bijian.study.dao" />
<property name="sqlSessionFactory" ref="sqlSessionFactory" />
</bean>
basePackage属性は、マッパーインターフェースファイルのための基本的なパケットパスを設定します。セミコロンまたはコンマを使用して、複数のパケットパスをセパレータとして設定できます。各マッパーは、指定されたパケットパスの中で再帰的に検索される。なお、Sql Session FactoryまたはSql Session Templateを指定する必要はありません。MapperScanner CofigrerはMapper FactoryBenを作成し、その後自動的に組み立てられます。しかし、もしあなたが一つ以上のDataSourceを使ったら、自動組立は無効になるかもしれません。この場合、sql Session Factory BeanNameまたはsql Session TemplateBenName属性を使って正しいbean名前を設定して使用することができます。これはどのように構成されているのか、beanの名前が必要であって、beanの引用ではないので、value属性はここで通常のrefに置き換えられます。
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
全体構成は以下の通りです。
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource" />
<property name="mapperLocations" value="classpath*:**/*Dao*.xml"></property>
</bean>
<!-- dao -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.bijian.study.dao" />
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
</bean>
MapperScanner Configrerはフィルタリングが指定された作成インターフェースまたは注釈によってマッパーを作成することをサポートします。annotationClass属性は、探している注釈名を指定しています。マーカーInterface属性は探している父インターフェースを指定しました。両方が指定されている場合、インターフェースに追加されたマッパーは2つの基準に一致します。デフォルトでは、これらの2つの属性はnullであるので、ベースパケットで与えられたすべてのインターフェースはマッパーとしてローディングされてもよい。発見されたマッパーは、Spring対自動検出コンポーネント(Springマニュアルの3.14.4を参照)のデフォルトの命名ポリシーを使用して命名される。つまり、注釈が見つからなければ、マッパーの非大文字の非完全限定クラス名を使用する。ただし、@ComponentまたはJSR-330の@Namedコメントが見つかったら、名前を取得します。注意してください。org.springframe ewark.stereotype.component、javax.inject.Named(JSE 6を使うと)またはあなた自身のコメント(間違いなく自己注)に設定できます。このようなコメントはジェネレータと名称提供器として使用されます。
続いてMapperScanner Configrer種類のソースコードを見てみましょう。自動スキャンはどのように行われていますか?
/**
* {@inheritDoc}
*
* @since 1.0.2
*/
@Override
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
if (this.processPropertyPlaceHolders) {
processPropertyPlaceHolders();
}
ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
scanner.setAddToConfig(this.addToConfig);
scanner.setAnnotationClass(this.annotationClass);
scanner.setMarkerInterface(this.markerInterface);
scanner.setSqlSessionFactory(this.sqlSessionFactory);
scanner.setSqlSessionTemplate(this.sqlSessionTemplate);
scanner.setSqlSessionFactoryBeanName(this.sqlSessionFactoryBeanName);
scanner.setSqlSessionTemplateBeanName(this.sqlSessionTemplateBeanName);
scanner.setResourceLoader(this.applicationContext);
scanner.setBeanNameGenerator(this.nameGenerator);
scanner.registerFilters();
scanner.scan(StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS));
}
MapperインターフェースをMapper FactoryBeanのコードに変換してscanner.scan方法で追跡してみましょう。
/**
* Perform a scan within the specified base packages.
* @param basePackages the packages to check for annotated classes
* @return number of beans registered
*/
public int scan(String... basePackages) {
int beanCountAtScanStart = this.registry.getBeanDefinitionCount();
doScan(basePackages);
// Register annotation config processors, if necessary.
if (this.includeAnnotationConfig) {
AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry);
}
return (this.registry.getBeanDefinitionCount() - beanCountAtScanStart);
}
/**
* Perform a scan within the specified base packages,
* returning the registered bean definitions.
* <p>This method does <i>not</i> register an annotation config processor
* but rather leaves this up to the caller.
* @param basePackages the packages to check for annotated classes
* @return set of beans registered if any for tooling registration purposes (never {@code null})
*/
protected Set<BeanDefinitionHolder> doScan(String... basePackages) {
Assert.notEmpty(basePackages, "At least one base package must be specified");
Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<BeanDefinitionHolder>();
for (String basePackage : basePackages) {
Set<BeanDefinition> candidates = findCandidateComponents(basePackage);
for (BeanDefinition candidate : candidates) {
ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate);
candidate.setScope(scopeMetadata.getScopeName());
String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry);
if (candidate instanceof AbstractBeanDefinition) {
postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName);
}
if (candidate instanceof AnnotatedBeanDefinition) {
AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate);
}
if (checkCandidate(beanName, candidate)) {
BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName);
definitionHolder = AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);
beanDefinitions.add(definitionHolder);
registerBeanDefinition(definitionHolder, this.registry);
}
}
}
return beanDefinitions;
}
締め括りをつける以上はこの文章の全部の内容です。本文の内容は皆さんの学習や仕事に対して一定の参考学習価値を持ってほしいです。ありがとうございます。