springboot JPA 启动流程与原理分析
最近在写一个轮子，准备将 jpa 的功能移植到 hbase, 实现 hbase 的对象查询功能，于是乎，开始研究 jpa 的流程和原理，经过一番折腾，终于大致明白了 jpa 是如何实现这种强大优雅的查询方式的。我把流程当中重要的部分记录下来，希望大佬多多指正。
项目依赖以及如何入门使用网上有大把的文章，介绍的很清晰，这里就不说这部分的内容了。
下面整理出我分析的一个思路，按步骤来。
1 先定义一个简单的查询接口，作为一个调试跟踪的例子, 代码如下
@Repository
public interface AccountRepository extends JpaRepository<Account, String> {
Account findByUserId(String userId);
Account findByPhone(String phone);
Account findByDeviceId(String deviceId);
}
2 service里面注入这个查询接口
@Service
public class UserServiceImpl implements UserService {
@Resource
private AccountRepository accountRepository;
@Override
public void saveDeviceId(String deviceId) {
Account account = accountRepository.findByDeviceId(deviceId);
if (account != null) {
return;
}
}
}
3 启动测试用例或者应用
4 查看注入的查询接口的是什么
图1 AccountRepository的实际类型.png
断点里面看的很清楚，注入的是一个动态代理生成的对象，实际类型是 SimpleJpaRepository.
查看这个类的类图关系，看看有什么
SimpleJpaRepository类图关系.png
这个类里面代码很多，就不贴出来了。方法涵盖了查询接口常用的数据库操作，例如 find, delete, save。
我很好奇 springboot 是怎么构造并且注入这个 SimpleJpaRepository 的......
5 搜索 这个类的引用关系, 如下图
上面的方法调用下面的.png
只有变量声明，返回类型，并没有 new 该对象，因为 spring 是使用反射创建对象的。到这里还不是很清楚，继续看看 JpaRepositoryFactory
7 查看 JpaRepositoryFactory 方法调用过程
方法调用关系.png
没有时序图，这个方法调用关系图看起来不是很清晰，将就着看吧。最终调用了 RepositoryFactorySupport
的一个方法，从方法名看出来，这里使用反射。方法里面也确实使用了反射实例化一个 SimpleJpaRepository 对象
代码图3 蓝色字体的内容刚好验证了 图1 的信息.png
到这里，你是不是还是有点懵逼，没事，现在来总结刚刚分析的内容
刚才一共出现了4个类的代码
- JpaRepositoryFactoryBean
- RepositoryFactoryBeanSupport
- JpaRepositoryFactory
- RepositoryFactorySupport
他们之间的关系是有规律的
8 查看这4个类的关系
关系如下图
把这个类图和图3，图4的代码对应起来.png
代码图4.png
看到这里，应该明白了 jpa 是如何生成一个 SimpleJpaRepository 对象被你使用的。再不明白的话，你自己搜索这个类的引用，一层一层找下去，觉得会执行到的代码打个断点，然后启动应用或者测试，就会看到，上面贴出的代码，基本上一个不漏的都会被执行到。
但是...... 到这里你是不是还不明白 SimpleJpaRepository 是如何注入到 spring 容器的，并且可以用 @Resource 来注入到应用的各个地方？
不明白是因为这个对象根本就没有注入到容器中，为什么?
刚刚有一个很重要的信息，就是 JpaRepositoryFactoryBean 是一种特殊的 bean, 实现了 FactoryBean 接口,
方法 getObject() 返回的是一个 SimpleJpaRepository 对象。这说明了实际上是 JpaRepositoryFactoryBean 本身这个类的实例注入到 spring 容器当中的。
现在的问题就是 JpaRepositoryFactoryBean 这个类如何实例化并注入到容器中
9 搜索 JpaRepositoryFactoryBean 类的引用
搜索后的调用层次是这样的，从下往上,没有列出方法的，就是对类的引用，其余是方法的调用
JpaRepositoryFactoryBean
JpaRepositoryConfigExtension.getRepositoryFactoryBeanClassName()
DefaultRepositoryConfiguration.getRepositoryFactoryBeanClassName()
RepositoryBeanDefinitionBuilder.build()
RepositoryConfigurationDelegate.registerRepositoriesIn()
AbstractRepositoryConfigurationSourceSupport.registerBeanDefinitions()
JpaRepositoriesAutoConfigureRegistrar
JpaRepositoriesAutoConfiguration
最后一个类的代码
@Configuration
@ConditionalOnBean(DataSource.class)
@ConditionalOnClass(JpaRepository.class)
@ConditionalOnMissingBean({ JpaRepositoryFactoryBean.class,JpaRepositoryConfigExtension.class })
@ConditionalOnProperty(prefix = "spring.data.jpa.repositories", name = "enabled", havingValue = "true", matchIfMissing = true)
// springboot 启动的时候会执行 @Import 注解配置的类里面的 registerBeanDefinitions() 方法
@Import(JpaRepositoriesAutoConfigureRegistrar.class)
@AutoConfigureAfter(HibernateJpaAutoConfiguration.class)
public class JpaRepositoriesAutoConfiguration {
}
到这里应该明白了吧，这个类是 springboot 启动时的一个自动配置的类，会执行 jpa 的一些配置，初始化，实例化
JpaRepositoryFactoryBean 并且注入到容器中
再次搜索这个类的引用，发现可以找到 spring 配置文件，截取一部分，可以看到， springboot 启动的时候会执行各个组件的初始化，包括 redis, mongodb......
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.ldap.LdapDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.ldap.LdapRepositoriesAutoConfiguration,\
为了验证刚刚的引用关系，在 RepositoryBeanDefinitionBuilder.build() 方法里面打断点，启动应用，看会不会执行
断点调试查看.png
确实是进入了断点，执行了刚刚分析的方法, 贴出这个方法的部分代码
class RepositoryBeanDefinitionBuilder {
public BeanDefinitionBuilder build(RepositoryConfiguration<?> configuration) {
Assert.notNull(registry, "BeanDefinitionRegistry must not be null!");
Assert.notNull(resourceLoader, "ResourceLoader must not be null!");
// configuration.getRepositoryFactoryBeanClassName() 返回的 是 JpaRepositoryFactoryBean
//准备对 JpaRepositoryFactoryBean 进行反射实例化
BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(configuration.getRepositoryFactoryBeanClassName());
// configuration.getRepositoryInterface() 在这个例子返回的是 AccountRepository
builder.addConstructorArgValue(configuration.getRepositoryInterface());
builder.addPropertyValue("queryLookupStrategyKey", configuration.getQueryLookupStrategyKey());
configuration.getRepositoryBaseClassName()//
.ifPresent(it -> builder.addPropertyValue("repositoryBaseClass", it));
return builder;
}
}
看看调用这个方法的逻辑
public class RepositoryConfigurationDelegate {
public List<BeanComponentDefinition> registerRepositoriesIn(BeanDefinitionRegistry registry,
RepositoryConfigurationExtension extension) {
// build 就是上面的方法
BeanDefinitionBuilder definitionBuilder = builder.build(configuration);
extension.postProcess(definitionBuilder, configurationSource);
// 这里已经生成了一个可以注入容器的 BeanDefinition 对象
AbstractBeanDefinition beanDefinition = definitionBuilder.getBeanDefinition();
String beanName = configurationSource.generateBeanName(beanDefinition);
beanDefinition.setAttribute(FACTORY_BEAN_OBJECT_TYPE, configuration.getRepositoryInterface());
// spring 容器中存储的是 BeanDefinition 对象，该对象封装了 对应的 bean 的信息
registry.registerBeanDefinition(beanName, beanDefinition);
}
}
你还可以在断点里面查看 栈帧 的信息，也验证了刚刚贴出的引用关系，
JVM里面的方法调用栈帧.png
到目前为止，jpa 查询接口是如何初始化的已经分析出来了，这些代码逻辑包含了各种设计模式，模型抽象，对最新的java 版本的各种特性的使用, 例如8里面的 Function, Supplier, BiFunction, 方法引用等，很值得学习。
