java.lang.Object
- org.hibernate.cfg.Configuration
- - org.springframework.orm.hibernate5.LocalSessionFactoryBuilder

```
public class LocalSessionFactoryBuilder
extends Configuration
```
A Spring-provided extension of the standard Hibernate Configuration class, adding SpringSessionContext as a default and providing convenient ways to specify a JDBC DataSource and an application class loader.
This is designed for programmatic use, e.g. in @Bean factory methods; consider using LocalSessionFactoryBean for XML bean definition files. Typically combined with HibernateTransactionManager for declarative transactions against the SessionFactory and its JDBC DataSource.
Compatible with Hibernate 5.0/5.1 as well as 5.2/5.3/5.4, as of Spring 5.2. Set up with Hibernate 5.2+, this builder is also a convenient way to set up a JPA EntityManagerFactory since the Hibernate SessionFactory natively exposes the JPA EntityManagerFactory interface as well now.
This builder supports Hibernate 5.3/5.4 BeanContainer integration, MetadataSources from custom BootstrapServiceRegistryBuilder setup, as well as other advanced Hibernate configuration options beyond the standard JPA bootstrap contract.
从以下版本开始:
4.2
作者:
Juergen Hoeller
另请参阅:
HibernateTransactionManager, LocalSessionFactoryBean, setBeanContainer(org.springframework.beans.factory.config.ConfigurableListableBeanFactory), LocalSessionFactoryBuilder(DataSource, ResourceLoader, MetadataSources), BootstrapServiceRegistryBuilder

字段概要
- 从类继承的字段 org.hibernate.cfg.Configuration
  ARTEFACT_PROCESSING_ORDER

构造器概要

构造器
构造器	说明
`LocalSessionFactoryBuilder(DataSource dataSource)`	Create a new LocalSessionFactoryBuilder for the given DataSource.
`LocalSessionFactoryBuilder(DataSource dataSource, ClassLoader classLoader)`	Create a new LocalSessionFactoryBuilder for the given DataSource.
`LocalSessionFactoryBuilder(DataSource dataSource, ResourceLoader resourceLoader)`	Create a new LocalSessionFactoryBuilder for the given DataSource.
`LocalSessionFactoryBuilder(DataSource dataSource, ResourceLoader resourceLoader, org.hibernate.boot.MetadataSources metadataSources)`	Create a new LocalSessionFactoryBuilder for the given DataSource.

方法概要

所有方法实例方法具体方法
修饰符和类型	方法	说明
`LocalSessionFactoryBuilder`	`addAnnotatedClasses(Class<?>... annotatedClasses)`	Add the given annotated classes in a batch.
`LocalSessionFactoryBuilder`	`addPackages(String... annotatedPackages)`	Add the given annotated packages in a batch.
`SessionFactory`	`buildSessionFactory(AsyncTaskExecutor bootstrapExecutor)`	Build the Hibernate `SessionFactory` through background bootstrapping, using the given executor for a parallel initialization phase (e.g. a `SimpleAsyncTaskExecutor`).
`LocalSessionFactoryBuilder`	`scanPackages(String... packagesToScan)`	Perform Spring-based scanning for entity classes, registering them as annotated classes with this `Configuration`.
`LocalSessionFactoryBuilder`	`setBeanContainer(ConfigurableListableBeanFactory beanFactory)`	Set a Hibernate `BeanContainer` for the given Spring `ConfigurableListableBeanFactory`.
`LocalSessionFactoryBuilder`	`setCacheRegionFactory(RegionFactory cacheRegionFactory)`	Set the Hibernate `RegionFactory` to use for the SessionFactory.
`void`	`setCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver currentTenantIdentifierResolver)`	Overridden to reliably pass a `CurrentTenantIdentifierResolver` to the SessionFactory.
`LocalSessionFactoryBuilder`	`setEntityTypeFilters(TypeFilter... entityTypeFilters)`	Specify custom type filters for Spring-based scanning for entity classes.
`LocalSessionFactoryBuilder`	`setJtaTransactionManager(Object jtaTransactionManager)`	Set the Spring `JtaTransactionManager` or the JTA `TransactionManager` to be used with Hibernate, if any.
`LocalSessionFactoryBuilder`	`setMultiTenantConnectionProvider(org.hibernate.engine.jdbc.connections.spi.MultiTenantConnectionProvider multiTenantConnectionProvider)`	Set a `MultiTenantConnectionProvider` to be passed on to the SessionFactory.

从类继承的方法 org.hibernate.cfg.Configuration
add, addAnnotatedClass, addAttributeConverter, addAttributeConverter, addAttributeConverter, addAttributeConverter, addAttributeConverter, addAuxiliaryDatabaseObject, addCacheableFile, addCacheableFile, addCacheableFileStrictly, addClass, addDirectory, addDocument, addFile, addFile, addInputStream, addJar, addPackage, addProperties, addResource, addResource, addSqlFunction, addURL, addXML, buildMappings, buildSessionFactory, buildSessionFactory, configure, configure, configure, configure, configure, getCurrentTenantIdentifierResolver, getEntityNotFoundDelegate, getEntityTuplizerFactory, getInterceptor, getNamedEntityGraphs, getNamedProcedureCallMap, getNamedQueries, getNamedSQLQueries, getProperties, getProperty, getSessionFactoryObserver, getSqlFunctions, getSqlResultSetMappings, getStandardServiceRegistryBuilder, mergeProperties, registerTypeContributor, registerTypeOverride, registerTypeOverride, registerTypeOverride, reset, setEntityNotFoundDelegate, setImplicitNamingStrategy, setInterceptor, setPhysicalNamingStrategy, setProperties, setProperty, setSessionFactoryObserver, setSharedCacheMode

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - LocalSessionFactoryBuilder
```
public LocalSessionFactoryBuilder(@Nullable
                                  DataSource dataSource)
```
    Create a new LocalSessionFactoryBuilder for the given DataSource.
    参数:
    dataSource - the JDBC DataSource that the resulting Hibernate SessionFactory should be using (may be null)
  - LocalSessionFactoryBuilder
```
public LocalSessionFactoryBuilder(@Nullable
                                  DataSource dataSource,
                                  ClassLoader classLoader)
```
    Create a new LocalSessionFactoryBuilder for the given DataSource.
    参数:
    dataSource - the JDBC DataSource that the resulting Hibernate SessionFactory should be using (may be null)
    classLoader - the ClassLoader to load application classes from
  - LocalSessionFactoryBuilder
```
public LocalSessionFactoryBuilder(@Nullable
                                  DataSource dataSource,
                                  ResourceLoader resourceLoader)
```
    Create a new LocalSessionFactoryBuilder for the given DataSource.
    参数:
    dataSource - the JDBC DataSource that the resulting Hibernate SessionFactory should be using (may be null)
    resourceLoader - the ResourceLoader to load application classes from
  - LocalSessionFactoryBuilder
```
public LocalSessionFactoryBuilder(@Nullable
                                  DataSource dataSource,
                                  ResourceLoader resourceLoader,
                                  org.hibernate.boot.MetadataSources metadataSources)
```
    Create a new LocalSessionFactoryBuilder for the given DataSource.
    参数:
    dataSource - the JDBC DataSource that the resulting Hibernate SessionFactory should be using (may be null)
    resourceLoader - the ResourceLoader to load application classes from
    metadataSources - the Hibernate MetadataSources service to use (e.g. reusing an existing one)
    从以下版本开始:
    4.3
- 方法详细资料
  - setJtaTransactionManager
```
public LocalSessionFactoryBuilder setJtaTransactionManager(Object jtaTransactionManager)
```
    Set the Spring JtaTransactionManager or the JTA TransactionManager to be used with Hibernate, if any. Allows for using a Spring-managed transaction manager for Hibernate 5's session and cache synchronization, with the "hibernate.transaction.jta.platform" automatically set to it.
    A passed-in Spring JtaTransactionManager needs to contain a JTA TransactionManager reference to be usable here, except for the WebSphere case where we'll automatically set WebSphereExtendedJtaPlatform accordingly.
    Note: If this is set, the Hibernate settings should not contain a JTA platform setting to avoid meaningless double configuration.
  - setBeanContainer
```
public LocalSessionFactoryBuilder setBeanContainer(ConfigurableListableBeanFactory beanFactory)
```
    Set a Hibernate BeanContainer for the given Spring ConfigurableListableBeanFactory.
    Note: Bean container integration requires Hibernate 5.3 or higher. It enables autowiring of Hibernate attribute converters and entity listeners.
    从以下版本开始:
    5.1
    另请参阅:
    SpringBeanContainer, AvailableSettings.BEAN_CONTAINER
  - setCacheRegionFactory
```
public LocalSessionFactoryBuilder setCacheRegionFactory(RegionFactory cacheRegionFactory)
```
    Set the Hibernate RegionFactory to use for the SessionFactory. Allows for using a Spring-managed RegionFactory instance.
    Note: If this is set, the Hibernate settings should not define a cache provider to avoid meaningless double configuration.
    从以下版本开始:
    5.1
    另请参阅:
    AvailableSettings.CACHE_REGION_FACTORY
  - setMultiTenantConnectionProvider
```
public LocalSessionFactoryBuilder setMultiTenantConnectionProvider(org.hibernate.engine.jdbc.connections.spi.MultiTenantConnectionProvider multiTenantConnectionProvider)
```
    Set a MultiTenantConnectionProvider to be passed on to the SessionFactory.
    从以下版本开始:
    4.3
    另请参阅:
    AvailableSettings.MULTI_TENANT_CONNECTION_PROVIDER
  - setCurrentTenantIdentifierResolver
```
public void setCurrentTenantIdentifierResolver(CurrentTenantIdentifierResolver currentTenantIdentifierResolver)
```
    Overridden to reliably pass a CurrentTenantIdentifierResolver to the SessionFactory.
    覆盖:
    setCurrentTenantIdentifierResolver 在类中 Configuration
    从以下版本开始:
    4.3.2
    另请参阅:
    AvailableSettings.MULTI_TENANT_IDENTIFIER_RESOLVER
  - setEntityTypeFilters
```
public LocalSessionFactoryBuilder setEntityTypeFilters(TypeFilter... entityTypeFilters)
```
    Specify custom type filters for Spring-based scanning for entity classes.
    Default is to search all specified packages for classes annotated with @javax.persistence.Entity, @javax.persistence.Embeddable or @javax.persistence.MappedSuperclass.
    另请参阅:
    scanPackages(java.lang.String...)
  - addAnnotatedClasses
```
public LocalSessionFactoryBuilder addAnnotatedClasses(Class<?>... annotatedClasses)
```
    Add the given annotated classes in a batch.
    另请参阅:
    Configuration.addAnnotatedClass(java.lang.Class), scanPackages(java.lang.String...)
  - addPackages
```
public LocalSessionFactoryBuilder addPackages(String... annotatedPackages)
```
    Add the given annotated packages in a batch.
    另请参阅:
    Configuration.addPackage(java.lang.String), scanPackages(java.lang.String...)
  - scanPackages
```
public LocalSessionFactoryBuilder scanPackages(String... packagesToScan)
                                        throws HibernateException
```
    Perform Spring-based scanning for entity classes, registering them as annotated classes with this Configuration.
    参数:
    packagesToScan - one or more Java package names
    抛出:
    HibernateException - if scanning fails for any reason
  - buildSessionFactory
```
public SessionFactory buildSessionFactory(AsyncTaskExecutor bootstrapExecutor)
```
    Build the Hibernate SessionFactory through background bootstrapping, using the given executor for a parallel initialization phase (e.g. a SimpleAsyncTaskExecutor).
    SessionFactory initialization will then switch into background bootstrap mode, with a SessionFactory proxy immediately returned for injection purposes instead of waiting for Hibernate's bootstrapping to complete. However, note that the first actual call to a SessionFactory method will then block until Hibernate's bootstrapping completed, if not ready by then. For maximum benefit, make sure to avoid early SessionFactory calls in init methods of related beans, even for metadata introspection purposes.
    从以下版本开始:
    4.3
    另请参阅:
    Configuration.buildSessionFactory()

类 LocalSessionFactoryBuilder

字段概要

从类继承的字段 org.hibernate.cfg.Configuration

构造器概要

方法概要

从类继承的方法 org.hibernate.cfg.Configuration

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

构造器详细资料

LocalSessionFactoryBuilder

LocalSessionFactoryBuilder

LocalSessionFactoryBuilder

LocalSessionFactoryBuilder

方法详细资料

setJtaTransactionManager

setBeanContainer

setCacheRegionFactory

setMultiTenantConnectionProvider

setCurrentTenantIdentifierResolver

setEntityTypeFilters

addAnnotatedClasses

addPackages

scanPackages

buildSessionFactory