1、@EnableJpaRepositories
@EnableJpaRepositories 是 Spring Framework 中用于启用 JPA(Java Persistence API)仓库的注解。它通常用于配置 Spring 应用程序以使用 JPA 进行数据库访问。JPA 是 Java 的持久层标准,它提供了一种标准化的方式来进行对象关系映射(ORM),使得开发者能够使用面向对象的方式来操作数据库。
在 Spring Boot 或 Spring 应用程序中,可以使用 @EnableJpaRepositories 注解来启用 JPA 仓库功能。这个注解可以在一个配置类上使用,以指示 Spring 扫描和管理 JPA 仓库接口,并自动为它们生成相应的实现。
参数
@EnableJpaRepositories 注解有一些可用的参数,用于自定义 JPA 仓库的配置。以下是一些常见的参数:
basePackages(String[] 类型):指定了要扫描的包路径,用于查找 JPA 仓库接口。例如:basePackages = {“com.example.repositories”}。
basePackageClasses(Class<?>[] 类型):指定了一个或多个类,Spring 将根据这些类所在的包来扫描 JPA 仓库接口。
includeFilters(Filter[] 类型):指定用于过滤要包含的仓库接口的过滤器,可用于更精确地选择要扫描的接口。
excludeFilters(Filter[] 类型):指定用于过滤要排除的仓库接口的过滤器,可用于排除某些接口不被扫描。
repositoryImplementationPostfix(String 类型):定义仓库接口实现类的后缀。默认情况下,Spring Data JPA 会根据接口名添加 “Impl” 后缀以寻找接口的实现类。
repositoryBaseClass(Class<?> 类型):用于指定自定义的仓库基类,该基类可以提供额外的通用方法。
namedQueriesLocation(String 类型):指定命名查询(Named Queries)的位置,默认为空。可以使用类路径的资源位置,指定一个文件夹或一个资源数组。
queryLookupStrategy(QueryLookupStrategy.Key 类型):定义查找查询的策略。可以是 QueryLookupStrategy.Key.CREATE_IF_NOT_FOUND、QueryLookupStrategy.Key.USE_DECLARED_QUERY 或 QueryLookupStrategy.Key.CREATE。
repositoryFactoryBeanClass(Class<? extends JpaRepositoryFactoryBean> 类型):自定义仓库工厂的类。
以下是一个示例
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
@SpringBootApplication
@EnableJpaRepositories(basePackages = "com.example.repositories") // 指定仓库接口所在的包路径
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
在上面的示例中,使用了 @EnableJpaRepositories 注解,将它应用在 Spring Boot 应用程序的入口类上。通过 basePackages 参数,我们指定了包含 JPA 仓库接口的包路径。这样 Spring 将会扫描这些包,并为仓库接口生成相应的实现。
请注意,@EnableJpaRepositories 并不是必须的,如果 Spring Boot 应用程序遵循约定并放置了 JPA 仓库接口于正确的包路径下,Spring Boot 会自动进行相关的配置,无需显式使用这个注解 Spring Boot 在默认情况下遵循约定大于配置的原则,特别是在处理 JPA 仓库接口时。如果将 JPA 仓库接口放置在正确的包路径下,Spring Boot 将会自动进行相关的配置,无需显式使用@EnableJpaRepositories 注解。
项目实践
例如,假设你的项目结构如下:
com
└── example
├── MyApplication.java (主应用程序类)
├── controllers
│ └── …
├── repositories
│ ├── UserRepository.java (JPA 仓库接口)
│ └── …
└── …
在这个示例中,UserRepository 是一个 JPA 仓库接口,它位于 com.example.repositories 包中。由于它位于主应用程序类所在的包的子包中,Spring Boot 将会自动扫描并为它生成相应的实现,无需额外的配置。
总之,如果Spring Boot 应用程序遵循约定并将 JPA 仓库接口放置在正确的包路径下,Spring Boot 会自动进行相关的配置,使应用能够使用 JPA 进行数据库访问。
2、 @EnableTransactionManagement
@EnableTransactionManagement 是一个Spring Framework的注解,用于启用事务管理功能在Spring应用程序中。通过使用这个注解,您可以使用Spring提供的事务管理功能来管理数据库事务。
具体而言,@EnableTransactionManagement 注解需要放置在配置类上,它会开启Spring对 @Transactional 注解的支持,使得在方法或类上添加 @Transactional 注解后,Spring能够捕获该注解并自动处理事务。
举例说明,假设您有一个 Service 类 UserService,其中包含了一些涉及到数据库操作的方法,而您希望这些方法都在单独的事务中执行。您可以按照以下步骤进行配置:
1、在配置类上添加@EnableTransactionManagement注解,启用事务管理功能。
@Configuration
@EnableTransactionManagement
public class AppConfig {
// 其他配置项...
}
2、在 Service 类的方法上添加 @Transactional 注解,以指定其需要在事务中执行。
@Service
public class UserService {
@Transactional
public void saveUser(User user) {
// 保存用户到数据库
}
@Transactional
public void deleteUser(int userId) {
// 从数据库删除用户
}
// 其他方法...
}
通过上述配置,当调用 UserService 中的被 @Transactional 注解修饰的方法时,Spring将在方法执行前开始一个新的事务,在方法执行完成后提交事务或根据需要进行回滚。这样可以确保数据库操作的一致性和完整性,同时简化了事务管理的配置过程。
请注意,配置类和Service类可以分别放置在不同的包中,只需确保 @EnableTransactionManagement 注解所在的配置类能够被Spring正确扫描到即可
3、EntityScan
@EntityScan 用来扫描和发现指定包及其子包中的Entity定义。其用法如下:
@EntityScan(basePackages = {"com.department.entities","come.employee.entities"})
如果多处使用@EntityScan,它们的basePackages 集合能覆盖所有被Repository使用的Entity即可,集合有交集也没有关系。但是如果不能覆盖被Repository使用的Entity,应用程序启动是会出错,比如:
Not a managed type: com.customer.entities.Customer
4、JPA配置类
package org.example.config;
import org.springframework.boot.autoconfigure.domain.EntityScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
import org.springframework.transaction.annotation.EnableTransactionManagement;
@Configuration
@EnableTransactionManagement(proxyTargetClass = true)
@EnableJpaRepositories(basePackages = "org.**.repository")
@EntityScan(basePackages = "org.**.domain")
public class JpaConfiguration {
@Bean
PersistenceExceptionTranslationPostProcessor persistenceExceptionTranslationPostProcessor(){
return new PersistenceExceptionTranslationPostProcessor();
}
}