com.baomidou.mybatisplus.spring

类 MybatisSqlSessionFactoryBean

java.lang.Object

com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean

所有已实现的接口:

java.util.EventListener, org.springframework.beans.factory.FactoryBean<org.apache.ibatis.session.SqlSessionFactory>, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

public class MybatisSqlSessionFactoryBean
extends java.lang.Object
implements org.springframework.beans.factory.FactoryBean<org.apache.ibatis.session.SqlSessionFactory>, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

拷贝类 org.mybatis.spring.SqlSessionFactoryBean 修改方法 buildSqlSessionFactory() 加载自定义 MybatisXmlConfigBuilder

作者:

hubin

构造器概要

构造器

构造器和说明
MybatisSqlSessionFactoryBean()

方法概要

方法

限定符和类型	方法和说明
void	afterPropertiesSet()
protected org.apache.ibatis.session.SqlSessionFactory	buildSqlSessionFactory() Build a SqlSessionFactory instance.
org.apache.ibatis.cache.Cache	getCache()
org.apache.ibatis.mapping.DatabaseIdProvider	getDatabaseIdProvider() Gets the DatabaseIdProvider
org.apache.ibatis.session.SqlSessionFactory	getObject()
java.lang.Class<? extends org.apache.ibatis.session.SqlSessionFactory>	getObjectType()
java.lang.Class<? extends org.apache.ibatis.io.VFS>	getVfs()
boolean	isSingleton()
void	onApplicationEvent(org.springframework.context.ApplicationEvent event)
void	setCache(org.apache.ibatis.cache.Cache cache)
void	setConfigLocation(org.springframework.core.io.Resource configLocation) Set the location of the MyBatis SqlSessionFactory config file.
void	setConfiguration(org.apache.ibatis.session.Configuration configuration) Set a customized MyBatis configuration.
void	setConfigurationProperties(java.util.Properties sqlSessionFactoryProperties) Set optional properties to be passed into the SqlSession configuration, as alternative to a &lt;properties&gt; tag in the configuration xml file.
void	setDatabaseIdProvider(org.apache.ibatis.mapping.DatabaseIdProvider databaseIdProvider) Sets the DatabaseIdProvider.
void	setDataSource(javax.sql.DataSource dataSource) Set the JDBC DataSource that this instance should manage transactions for.
void	setEnvironment(java.lang.String environment) NOTE: This class overrides any Environment you have set in the MyBatis config file.
void	setFailFast(boolean failFast) If true, a final check is done on Configuration to assure that all mapped statements are fully loaded and there is no one still pending to resolve includes.
void	setGlobalConfig(com.baomidou.mybatisplus.entity.GlobalConfiguration globalConfig)
void	setMapperLocations(org.springframework.core.io.Resource[] mapperLocations) Set locations of MyBatis mapper files that are going to be merged into the SqlSessionFactory configuration at runtime.
void	setObjectFactory(org.apache.ibatis.reflection.factory.ObjectFactory objectFactory) Sets the ObjectFactory.
void	setObjectWrapperFactory(org.apache.ibatis.reflection.wrapper.ObjectWrapperFactory objectWrapperFactory) Sets the ObjectWrapperFactory.
void	setPlugins(org.apache.ibatis.plugin.Interceptor[] plugins) Mybatis plugin list.
void	setSqlSessionFactoryBuilder(org.apache.ibatis.session.SqlSessionFactoryBuilder sqlSessionFactoryBuilder) Sets the SqlSessionFactoryBuilder to use when creating the SqlSessionFactory.
void	setTransactionFactory(org.apache.ibatis.transaction.TransactionFactory transactionFactory) Set the MyBatis TransactionFactory to use.
void	setTypeAliases(java.lang.Class<?>[] typeAliases) List of type aliases to register.
void	setTypeAliasesPackage(java.lang.String typeAliasesPackage) Packages to search for type aliases.
void	setTypeAliasesSuperType(java.lang.Class<?> typeAliasesSuperType) Super class which domain objects have to extend to have a type alias created.
void	setTypeEnumsPackage(java.lang.String typeEnumsPackage)
void	setTypeHandlers(org.apache.ibatis.type.TypeHandler<?>[] typeHandlers) Set type handlers.
void	setTypeHandlersPackage(java.lang.String typeHandlersPackage) Packages to search for type handlers.
void	setVfs(java.lang.Class<? extends org.apache.ibatis.io.VFS> vfs)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

MybatisSqlSessionFactoryBean

public MybatisSqlSessionFactoryBean()

方法详细资料

setGlobalConfig

public void setGlobalConfig(com.baomidou.mybatisplus.entity.GlobalConfiguration globalConfig)

setObjectFactory

public void setObjectFactory(org.apache.ibatis.reflection.factory.ObjectFactory objectFactory)

Sets the ObjectFactory.

参数:

objectFactory -

从以下版本开始:

1.1.2

setObjectWrapperFactory

public void setObjectWrapperFactory(org.apache.ibatis.reflection.wrapper.ObjectWrapperFactory objectWrapperFactory)

Sets the ObjectWrapperFactory.

参数:

objectWrapperFactory -

从以下版本开始:

1.1.2

getDatabaseIdProvider

public org.apache.ibatis.mapping.DatabaseIdProvider getDatabaseIdProvider()

Gets the DatabaseIdProvider

返回:

从以下版本开始:

1.1.0

setDatabaseIdProvider

public void setDatabaseIdProvider(org.apache.ibatis.mapping.DatabaseIdProvider databaseIdProvider)

Sets the DatabaseIdProvider. As of version 1.2.2 this variable is not initialized by default.

参数:

databaseIdProvider -

从以下版本开始:

1.1.0

getVfs

public java.lang.Class<? extends org.apache.ibatis.io.VFS> getVfs()

setVfs

public void setVfs(java.lang.Class<? extends org.apache.ibatis.io.VFS> vfs)

getCache

public org.apache.ibatis.cache.Cache getCache()

setCache

public void setCache(org.apache.ibatis.cache.Cache cache)

setPlugins

public void setPlugins(org.apache.ibatis.plugin.Interceptor[] plugins)

Mybatis plugin list.

参数:

plugins - list of plugins

从以下版本开始:

1.0.1

setTypeAliasesPackage

public void setTypeAliasesPackage(java.lang.String typeAliasesPackage)

Packages to search for type aliases.

参数:

typeAliasesPackage - package to scan for domain objects

从以下版本开始:

1.0.1

setTypeEnumsPackage

public void setTypeEnumsPackage(java.lang.String typeEnumsPackage)

setTypeAliasesSuperType

public void setTypeAliasesSuperType(java.lang.Class<?> typeAliasesSuperType)

Super class which domain objects have to extend to have a type alias created. No effect if there is no package to scan configured.

参数:

typeAliasesSuperType - super class for domain objects

从以下版本开始:

1.1.2

setTypeHandlersPackage

public void setTypeHandlersPackage(java.lang.String typeHandlersPackage)

Packages to search for type handlers.

参数:

typeHandlersPackage - package to scan for type handlers

从以下版本开始:

1.0.1

setTypeHandlers

public void setTypeHandlers(org.apache.ibatis.type.TypeHandler<?>[] typeHandlers)

Set type handlers. They must be annotated with MappedTypes and optionally with MappedJdbcTypes

参数:

typeHandlers - Type handler list

从以下版本开始:

1.0.1

setTypeAliases

public void setTypeAliases(java.lang.Class<?>[] typeAliases)

List of type aliases to register. They can be annotated with Alias

参数:

typeAliases - Type aliases list

从以下版本开始:

1.0.1

setFailFast

public void setFailFast(boolean failFast)

If true, a final check is done on Configuration to assure that all mapped statements are fully loaded and there is no one still pending to resolve includes. Defaults to false.

参数:

failFast - enable failFast

从以下版本开始:

1.0.1

setConfigLocation

public void setConfigLocation(org.springframework.core.io.Resource configLocation)

Set the location of the MyBatis SqlSessionFactory config file. A typical value is "WEB-INF/mybatis-configuration.xml".

setConfiguration

public void setConfiguration(org.apache.ibatis.session.Configuration configuration)

Set a customized MyBatis configuration.

参数:

configuration - MyBatis configuration

从以下版本开始:

1.3.0

setMapperLocations

public void setMapperLocations(org.springframework.core.io.Resource[] mapperLocations)

Set locations of MyBatis mapper files that are going to be merged into the SqlSessionFactory configuration at runtime.

This is an alternative to specifying "<sqlmapper>" entries in an MyBatis config file. This property being based on Spring's resource abstraction also allows for specifying resource patterns here: e.g. "classpath*:sqlmap/*-mapper.xml".

setConfigurationProperties

public void setConfigurationProperties(java.util.Properties sqlSessionFactoryProperties)

Set optional properties to be passed into the SqlSession configuration, as alternative to a <properties> tag in the configuration xml file. This will be used to resolve placeholders in the config file.

setDataSource

public void setDataSource(javax.sql.DataSource dataSource)

Set the JDBC DataSource that this instance should manage transactions for. The DataSource should match the one used by the SqlSessionFactory: for example, you could specify the same JNDI DataSource for both.

A transactional JDBC Connection for this DataSource will be provided to application code accessing this DataSource directly via DataSourceUtils or DataSourceTransactionManager.

The DataSource specified here should be the target DataSource to manage transactions for, not a TransactionAwareDataSourceProxy. Only data access code may work with TransactionAwareDataSourceProxy, while the transaction manager needs to work on the underlying target DataSource. If there's nevertheless a TransactionAwareDataSourceProxy passed in, it will be unwrapped to extract its target DataSource.

setSqlSessionFactoryBuilder

public void setSqlSessionFactoryBuilder(org.apache.ibatis.session.SqlSessionFactoryBuilder sqlSessionFactoryBuilder)

Sets the SqlSessionFactoryBuilder to use when creating the SqlSessionFactory.

This is mainly meant for testing so that mock SqlSessionFactory classes can be injected. By default, SqlSessionFactoryBuilder creates DefaultSqlSessionFactory instances.

setTransactionFactory

public void setTransactionFactory(org.apache.ibatis.transaction.TransactionFactory transactionFactory)

Set the MyBatis TransactionFactory to use. Default is SpringManagedTransactionFactory

The default SpringManagedTransactionFactory should be appropriate for all cases: be it Spring transaction management, EJB CMT or plain JTA. If there is no active transaction, SqlSession operations will execute SQL statements non-transactionally.

It is strongly recommended to use the default TransactionFactory. If not used, any attempt at getting an SqlSession through Spring's MyBatis framework will throw an exception if a transaction is active.

参数:

transactionFactory - the MyBatis TransactionFactory

另请参阅:

SpringManagedTransactionFactory

setEnvironment

public void setEnvironment(java.lang.String environment)

NOTE: This class overrides any Environment you have set in the MyBatis config file. This is used only as a placeholder name. The default value is SqlSessionFactoryBean.class.getSimpleName().

参数:

environment - the environment name

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

指定者:

afterPropertiesSet 在接口中 org.springframework.beans.factory.InitializingBean

抛出:

java.lang.Exception

buildSqlSessionFactory

protected org.apache.ibatis.session.SqlSessionFactory buildSqlSessionFactory()
                                                                      throws java.lang.Exception

Build a SqlSessionFactory instance.

The default implementation uses the standard MyBatis XMLConfigBuilder API to build a SqlSessionFactory instance based on an Reader. Since 1.3.0, it can be specified a Configuration instance directly(without config file).

返回:

SqlSessionFactory

抛出:

java.io.IOException - if loading the config file failed

java.lang.Exception

getObject

public org.apache.ibatis.session.SqlSessionFactory getObject()
                                                      throws java.lang.Exception

指定者:

getObject 在接口中 org.springframework.beans.factory.FactoryBean<org.apache.ibatis.session.SqlSessionFactory>

抛出:

java.lang.Exception

getObjectType

public java.lang.Class<? extends org.apache.ibatis.session.SqlSessionFactory> getObjectType()

指定者:

getObjectType 在接口中 org.springframework.beans.factory.FactoryBean<org.apache.ibatis.session.SqlSessionFactory>

isSingleton

public boolean isSingleton()

指定者:

isSingleton 在接口中 org.springframework.beans.factory.FactoryBean<org.apache.ibatis.session.SqlSessionFactory>

onApplicationEvent

public void onApplicationEvent(org.springframework.context.ApplicationEvent event)

指定者:

onApplicationEvent 在接口中 org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>