Mybatisソース分析-どのようにdaoカテゴリのための代理オブジェクトの生成
13918 ワード
Mybatis入門、シンプルなデモ
上記のdemoでは、daoインターフェースを定義しましたが、クラスを実現していません。直接インターフェースを呼び出す方法で、mapperのsqlを実行できます。これはどうやってできますか?
Mybatisソース分析——mapper.xml解析
この記事では、mapper.xmlに対応するdao類がconfigrationのMapperRegistryのMapに追加され、Mapper ProxyFactory>>knownMappersに、keyはクラスのフルネームであり、valueは対応するプロキシオブジェクトであると分析しています。
入り口はここです。xmlのプロファイルでは、スキャンの設定パスの下のdaoクラスを起動するように構成されています。
はい、ここに来て、dao類は実はmapper FactoryBeanと結合されていることが分かります。では、mapper FactoryBeanがどのように代理人を生み出すのかを見てみましょう。
Mapper FactoryBenはFactoryBeanを実現しました。getObjectを見に来ました。
次のページではSql Sessionがどのようにsqlを実行しているかを分析します。
前の章 Mybatisソース分析——プロファイル解析の類図
次の章 Mybatisソース分析——どのようにsqlを実行しますか?
上記のdemoでは、daoインターフェースを定義しましたが、クラスを実現していません。直接インターフェースを呼び出す方法で、mapperのsqlを実行できます。これはどうやってできますか?
Mybatisソース分析——mapper.xml解析
この記事では、mapper.xmlに対応するdao類がconfigrationのMapperRegistryのMapに追加され、Mapper ProxyFactory>>knownMappersに、keyはクラスのフルネームであり、valueは対応するプロキシオブジェクトであると分析しています。
入り口はここです。xmlのプロファイルでは、スキャンの設定パスの下のdaoクラスを起動するように構成されています。
MapperScanner Configrer類を見てみます。ビーンDefinitionRegistryPostProcessorを実現しました。対応するpostProcess BenDefinitionRegistry方法を見つけました。次の通りです。 @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));
}
processPropertyPlace Holders()方法は配置解析です。ポイントはClass PathMapperScanner.scan方法です。Class PathMapperScannerはClass PathBeanDefinitionScannerに引き継がれます。scan方法を見ると、これはClass PathBeanDefinitionScanner.scanです。次の通りです。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);
}
doScanを見てください。ここでコールしたのはクラスパスPathMapperScanner.doScanです。以下の通りです。 @Override
public Set doScan(String... basePackages) {
Set beanDefinitions = super.doScan(basePackages);
if (beanDefinitions.isEmpty()) {
logger.warn("No MyBatis mapper was found in '" + Arrays.toString(basePackages) + "' package. Please check your configuration.");
} else {
processBeanDefinitions(beanDefinitions);
}
return beanDefinitions;
}
そして、まず親のクラス、つまりClass PathBeanDefinitionScanner.doScaanの方法を呼び出しました。protected Set doScan(String... basePackages) {
Assert.notEmpty(basePackages, "At least one base package must be specified");
Set beanDefinitions = new LinkedHashSet();
for (String basePackage : basePackages) {
Set 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;
}
ここはfindCandendidateComponentsを通じて(basePackage);設定されたパッケージパスのクラスを見つけて、ビーンDefinitionにパッケージ化し、再度ビーンDefinitionHolderを形成し、レジスターBenDefinitionを通して再パッケージ化します。容器に登録すると、次のようになります。 protected void registerBeanDefinition(BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry) {
BeanDefinitionReaderUtils.registerBeanDefinition(definitionHolder, registry);
}
public static void registerBeanDefinition(
BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
throws BeanDefinitionStoreException {
// Register bean definition under primary name.
String beanName = definitionHolder.getBeanName();
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
// Register aliases for bean name, if any.
String[] aliases = definitionHolder.getAliases();
if (aliases != null) {
for (String alias : aliases) {
registry.registerAlias(beanName, alias);
}
}
}
登録完了後、Setに戻り、Class PathMapperScanner.doScann方法に戻り、processBenDefinitionsを通じて。戻ってきたbeanDefinitionsに対して加工処理を行います。private void processBeanDefinitions(Set beanDefinitions) {
GenericBeanDefinition definition;
for (BeanDefinitionHolder holder : beanDefinitions) {
definition = (GenericBeanDefinition) holder.getBeanDefinition();
if (logger.isDebugEnabled()) {
logger.debug("Creating MapperFactoryBean with name '" + holder.getBeanName()
+ "' and '" + definition.getBeanClassName() + "' mapperInterface");
}
// the mapper interface is the original class of the bean
// but, the actual class of the bean is MapperFactoryBean
definition.getConstructorArgumentValues().addGenericArgumentValue(definition.getBeanClassName()); // issue #59
definition.setBeanClass(this.mapperFactoryBean.getClass());
definition.getPropertyValues().add("addToConfig", this.addToConfig);
boolean explicitFactoryUsed = false;
if (StringUtils.hasText(this.sqlSessionFactoryBeanName)) {
definition.getPropertyValues().add("sqlSessionFactory", new RuntimeBeanReference(this.sqlSessionFactoryBeanName));
explicitFactoryUsed = true;
} else if (this.sqlSessionFactory != null) {
definition.getPropertyValues().add("sqlSessionFactory", this.sqlSessionFactory);
explicitFactoryUsed = true;
}
if (StringUtils.hasText(this.sqlSessionTemplateBeanName)) {
if (explicitFactoryUsed) {
logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
}
definition.getPropertyValues().add("sqlSessionTemplate", new RuntimeBeanReference(this.sqlSessionTemplateBeanName));
explicitFactoryUsed = true;
} else if (this.sqlSessionTemplate != null) {
if (explicitFactoryUsed) {
logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
}
definition.getPropertyValues().add("sqlSessionTemplate", this.sqlSessionTemplate);
explicitFactoryUsed = true;
}
if (!explicitFactoryUsed) {
if (logger.isDebugEnabled()) {
logger.debug("Enabling autowire by type for MapperFactoryBean with name '" + holder.getBeanName() + "'.");
}
definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
}
}
}
ここではdefinitions.set BeanClassを通じて(this.mapper FactoryBeans.get Class);ビーンを結びつけた実際の対象はMapper FactoryBeanである。definition.getPropertyValues().add("sql Session Factory",this.sql Session Factory);sql Session Factoryをバインドしました。もし私たちがsql Session Templateを配置したら、ここでも紐付けされます。definitions.get ProptyValues().add(「sql Session Template」、this.sql Session Template);definitions.set Autowiremodeを通して;beanを検索する方式を設定しました。はい、ここに来て、dao類は実はmapper FactoryBeanと結合されていることが分かります。では、mapper FactoryBeanがどのように代理人を生み出すのかを見てみましょう。
Mapper FactoryBenはFactoryBeanを実現しました。getObjectを見に来ました。
@Override
public T getObject() throws Exception {
return getSqlSession().getMapper(this.mapperInterface);
}
public SqlSession getSqlSession() {
return this.sqlSession;
}
public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory) {
if (!this.externalSqlSession) {
this.sqlSession = new SqlSessionTemplate(sqlSessionFactory);
}
}
public void setSqlSessionTemplate(SqlSessionTemplate sqlSessionTemplate) {
this.sqlSession = sqlSessionTemplate;
this.externalSqlSession = true;
}
get Sql Session()は、その親からのSql Session DaoSupportであり、Sql Session Templateの例が戻ってくることが見られます。get Mapperの方法は以下の通りです。 @Override
public T getMapper(Class type) {
return getConfiguration().getMapper(type, this);
}
public T getMapper(Class type, SqlSession sqlSession) {
return mapperRegistry.getMapper(type, sqlSession);
}
@SuppressWarnings("unchecked")
public T getMapper(Class type, SqlSession sqlSession) {
final MapperProxyFactory mapperProxyFactory = (MapperProxyFactory) knownMappers.get(type);
if (mapperProxyFactory == null) {
throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
}
try {
return mapperProxyFactory.newInstance(sqlSession);
} catch (Exception e) {
throw new BindingException("Error getting mapper instance. Cause: " + e, e);
}
}
最後にMapperRegistryのget Mapperに来ました。ここでknown Mappersから代理人を取り出して、mapper ProxyFactory.newInstance(sql Session);次のとおりです public T newInstance(SqlSession sqlSession) {
final MapperProxy mapperProxy = new MapperProxy(sqlSession, mapperInterface, methodCache);
return newInstance(mapperProxy);
}
@SuppressWarnings("unchecked")
protected T newInstance(MapperProxy mapperProxy) {
return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] { mapperInterface }, mapperProxy);
}
はい、ここに来てもう明らかになりました。ここではjavaの動的エージェントを使ってインスタンスオブジェクトを生成します。またMapperProxyを見に来ました。InvocationHandlerを引き継いでいます。以下の通りです。 @Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
try {
if (Object.class.equals(method.getDeclaringClass())) {
return method.invoke(this, args);
} else if (isDefaultMethod(method)) {
return invokeDefaultMethod(proxy, method, args);
}
} catch (Throwable t) {
throw ExceptionUtil.unwrapThrowable(t);
}
final MapperMethod mapperMethod = cachedMapperMethod(method);
return mapperMethod.execute(sqlSession, args);
}
private MapperMethod cachedMapperMethod(Method method) {
MapperMethod mapperMethod = methodCache.get(method);
if (mapperMethod == null) {
mapperMethod = new MapperMethod(mapperInterface, method, sqlSession.getConfiguration());
methodCache.put(method, mapperMethod);
}
return mapperMethod;
}
ここではMapperMethodを封止してキャッシュしています。最終的にはMapperMethod.executeメソッドを呼び出して実行します。public Object execute(SqlSession sqlSession, Object[] args) {
Object result;
switch (command.getType()) {
case INSERT: {
Object param = method.convertArgsToSqlCommandParam(args);
result = rowCountResult(sqlSession.insert(command.getName(), param));
break;
}
case UPDATE: {
Object param = method.convertArgsToSqlCommandParam(args);
result = rowCountResult(sqlSession.update(command.getName(), param));
break;
}
case DELETE: {
Object param = method.convertArgsToSqlCommandParam(args);
result = rowCountResult(sqlSession.delete(command.getName(), param));
break;
}
case SELECT:
if (method.returnsVoid() && method.hasResultHandler()) {
executeWithResultHandler(sqlSession, args);
result = null;
} else if (method.returnsMany()) {
result = executeForMany(sqlSession, args);
} else if (method.returnsMap()) {
result = executeForMap(sqlSession, args);
} else if (method.returnsCursor()) {
result = executeForCursor(sqlSession, args);
} else {
Object param = method.convertArgsToSqlCommandParam(args);
result = sqlSession.selectOne(command.getName(), param);
}
break;
case FLUSH:
result = sqlSession.flushStatements();
break;
default:
throw new BindingException("Unknown execution method for: " + command.getName());
}
if (result == null && method.getReturnType().isPrimitive() && !method.returnsVoid()) {
throw new BindingException("Mapper method '" + command.getName()
+ " attempted to return null from a method with a primitive return type (" + method.getReturnType() + ").");
}
return result;
}
はい、ここで終わります。ここでのSql Sessionの例はSql Session Templateであることが明らかになった。次のページではSql Sessionがどのようにsqlを実行しているかを分析します。
前の章 Mybatisソース分析——プロファイル解析の類図
次の章 Mybatisソース分析——どのようにsqlを実行しますか?