Juergen Hoeller
13 years ago
2 changed files with 368 additions and 96 deletions
@ -0,0 +1,186 @@
@@ -0,0 +1,186 @@
|
||||
/* |
||||
* Copyright 2002-2011 the original author or authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
*/ |
||||
|
||||
package org.springframework.orm.hibernate4; |
||||
|
||||
import java.io.IOException; |
||||
import java.lang.reflect.Method; |
||||
import javax.persistence.Embeddable; |
||||
import javax.persistence.Entity; |
||||
import javax.persistence.MappedSuperclass; |
||||
import javax.sql.DataSource; |
||||
|
||||
import org.hibernate.HibernateException; |
||||
import org.hibernate.MappingException; |
||||
import org.hibernate.SessionFactory; |
||||
import org.hibernate.cfg.Configuration; |
||||
import org.hibernate.cfg.Environment; |
||||
|
||||
import org.springframework.core.io.Resource; |
||||
import org.springframework.core.io.ResourceLoader; |
||||
import org.springframework.core.io.support.PathMatchingResourcePatternResolver; |
||||
import org.springframework.core.io.support.ResourcePatternResolver; |
||||
import org.springframework.core.io.support.ResourcePatternUtils; |
||||
import org.springframework.core.type.classreading.CachingMetadataReaderFactory; |
||||
import org.springframework.core.type.classreading.MetadataReader; |
||||
import org.springframework.core.type.classreading.MetadataReaderFactory; |
||||
import org.springframework.core.type.filter.AnnotationTypeFilter; |
||||
import org.springframework.core.type.filter.TypeFilter; |
||||
import org.springframework.util.ClassUtils; |
||||
import org.springframework.util.ReflectionUtils; |
||||
|
||||
/** |
||||
* A Spring-provided extension of the standard Hibernate {@link Configuration} class, |
||||
* adding {@link SpringSessionContext} as a default and providing convenient ways |
||||
* to specify a DataSource and an application class loader. |
||||
* |
||||
* <p>This is designed for programmatic use, e.g. in <code>@Bean</code> factory methods. |
||||
* Consider using {@link LocalSessionFactoryBean} for XML bean definition files. |
||||
* |
||||
* @author Juergen Hoeller |
||||
* @since 3.1 |
||||
* @see LocalSessionFactoryBean |
||||
*/ |
||||
public class LocalSessionFactoryBuilder extends Configuration { |
||||
|
||||
private static final String RESOURCE_PATTERN = "/**/*.class"; |
||||
|
||||
private static final TypeFilter[] ENTITY_TYPE_FILTERS = new TypeFilter[] { |
||||
new AnnotationTypeFilter(Entity.class, false), |
||||
new AnnotationTypeFilter(Embeddable.class, false), |
||||
new AnnotationTypeFilter(MappedSuperclass.class, false)}; |
||||
|
||||
private static final Method addAnnotatedClassMethod = |
||||
ClassUtils.getMethodIfAvailable(Configuration.class, "addAnnotatedClass", Class.class); |
||||
|
||||
private static final Method addPackageMethod = |
||||
ClassUtils.getMethodIfAvailable(Configuration.class, "addPackage", String.class); |
||||
|
||||
|
||||
private final ResourcePatternResolver resourcePatternResolver; |
||||
|
||||
|
||||
/** |
||||
* Create a new LocalSessionFactoryBuilder for the given DataSource. |
||||
* @param dataSource the JDBC DataSource that the resulting Hibernate SessionFactory should be using |
||||
*/ |
||||
public LocalSessionFactoryBuilder(DataSource dataSource) { |
||||
this(dataSource, new PathMatchingResourcePatternResolver()); |
||||
} |
||||
|
||||
/** |
||||
* Create a new LocalSessionFactoryBuilder for the given DataSource. |
||||
* @param dataSource the JDBC DataSource that the resulting Hibernate SessionFactory should be using |
||||
* @param classLoader the ClassLoader to load application classes from |
||||
*/ |
||||
public LocalSessionFactoryBuilder(DataSource dataSource, ClassLoader classLoader) { |
||||
this(dataSource, new PathMatchingResourcePatternResolver(classLoader)); |
||||
} |
||||
|
||||
/** |
||||
* Create a new LocalSessionFactoryBuilder for the given DataSource. |
||||
* @param dataSource the JDBC DataSource that the resulting Hibernate SessionFactory should be using |
||||
* @param classLoader the ResourceLoader to load application classes from |
||||
*/ |
||||
public LocalSessionFactoryBuilder(DataSource dataSource, ResourceLoader resourceLoader) { |
||||
getProperties().put(Environment.CURRENT_SESSION_CONTEXT_CLASS, SpringSessionContext.class.getName()); |
||||
getProperties().put(Environment.DATASOURCE, dataSource); |
||||
getProperties().put("hibernate.classLoader.application", resourceLoader.getClassLoader()); |
||||
this.resourcePatternResolver = ResourcePatternUtils.getResourcePatternResolver(resourceLoader); |
||||
} |
||||
|
||||
|
||||
/** |
||||
* Add the given annotated classes in a batch. |
||||
* @see #addAnnotatedClass |
||||
* @see #scanPackages |
||||
*/ |
||||
public LocalSessionFactoryBuilder addAnnotatedClasses(Class... annotatedClasses) { |
||||
for (Class<?> annotatedClass : annotatedClasses) { |
||||
ReflectionUtils.invokeMethod(addAnnotatedClassMethod, this, annotatedClass); |
||||
} |
||||
return this; |
||||
} |
||||
|
||||
/** |
||||
* Add the given annotated packages in a batch. |
||||
* @see #addPackage |
||||
* @see #scanPackages |
||||
*/ |
||||
public LocalSessionFactoryBuilder addPackages(String... annotatedPackages) { |
||||
for (String annotatedPackage :annotatedPackages) { |
||||
ReflectionUtils.invokeMethod(addPackageMethod, this, annotatedPackage); |
||||
} |
||||
return this; |
||||
} |
||||
|
||||
/** |
||||
* Perform Spring-based scanning for entity classes, registering them |
||||
* as annotated classes with this <code>Configuration</code>. |
||||
* @param packagesToScan one or more Java package names |
||||
* @throws HibernateException if scanning fails for any reason |
||||
*/ |
||||
public LocalSessionFactoryBuilder scanPackages(String... packagesToScan) throws HibernateException { |
||||
try { |
||||
for (String pkg : packagesToScan) { |
||||
String pattern = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX + |
||||
ClassUtils.convertClassNameToResourcePath(pkg) + RESOURCE_PATTERN; |
||||
Resource[] resources = this.resourcePatternResolver.getResources(pattern); |
||||
MetadataReaderFactory readerFactory = new CachingMetadataReaderFactory(this.resourcePatternResolver); |
||||
for (Resource resource : resources) { |
||||
if (resource.isReadable()) { |
||||
MetadataReader reader = readerFactory.getMetadataReader(resource); |
||||
String className = reader.getClassMetadata().getClassName(); |
||||
if (matchesFilter(reader, readerFactory)) { |
||||
addAnnotatedClasses(this.resourcePatternResolver.getClassLoader().loadClass(className)); |
||||
} |
||||
} |
||||
} |
||||
} |
||||
return this; |
||||
} |
||||
catch (IOException ex) { |
||||
throw new MappingException("Failed to scan classpath for unlisted classes", ex); |
||||
} |
||||
catch (ClassNotFoundException ex) { |
||||
throw new MappingException("Failed to load annotated classes from classpath", ex); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Check whether any of the configured entity type filters matches |
||||
* the current class descriptor contained in the metadata reader. |
||||
*/ |
||||
private boolean matchesFilter(MetadataReader reader, MetadataReaderFactory readerFactory) throws IOException { |
||||
for (TypeFilter filter : ENTITY_TYPE_FILTERS) { |
||||
if (filter.match(reader, readerFactory)) { |
||||
return true; |
||||
} |
||||
} |
||||
return false; |
||||
} |
||||
|
||||
|
||||
/** |
||||
* Build the <code>SessionFactory</code>. |
||||
*/ |
||||
@Override |
||||
@SuppressWarnings("deprecation") |
||||
public SessionFactory buildSessionFactory() throws HibernateException { |
||||
return super.buildSessionFactory(); |
||||
} |
||||
|
||||
} |
||||
Loading…
Reference in new issue