作者：小傅哥
部落格：https://bugstack.cn - 彙總系列原創專題文章
沉澱、分享、成長，讓自己和他人都能有所收穫！?
一、前言介紹
一個知識點的學習過程基本分為；執行helloworld、熟練使用api、原始碼分析、核心專家。在分析mybaits以及mybatis-spring原始碼之前，我也只是簡單的使用，因為它好用。但是他是怎麼做的多半是憑自己的經驗去分析，但始終覺得這樣的感覺缺少點什麼，在幾次夙興夜寐，靡有朝矣之後決定徹底的研究一下，之後在去仿照著寫一版核心功能。依次來補全自己的技術棧的空缺。在現在技術知識像爆炸一樣迸發，而我們多半又忙於工作業務開發。就像一個不會修車的老司機，只能一腳油門，一腳剎車的奔波。車速很快，但經不起壞，累覺不愛。好！為了解決這樣問題，也為了錢程似錦（形容錢多的想家裡的棉布一樣），努力！
開動之前先慶祝下我的iPhone4s又活了，還是那麼好用(嗯！有點卡)；
二、以往章節
關於mybaits & spring 原始碼分析以及demo功能的章節彙總，可以通過下列內容進行系統的學習，同時以下章節會有部分內容涉及到demo版本的mybaits；
- 原始碼分析 | Mybatis介面沒有實現類為什麼可以執行增刪改查
- 原始碼分析 | 像盜墓一樣分析Spring是怎麼初始化xml並註冊bean的
- 原始碼分析 | 基於jdbc實現一個Demo版的Mybatis
三、一碟小菜類代理
往往從最簡單的內容才有抓手。先看一個介面到實現類的使用，在將這部分內容轉換為代理類。
1. 定義一個 IUserDao 介面並實現這個介面類
public interface IUserDao {
String queryUserInfo();
}
public class UserDao implements IUserDao {
@Override
public String queryUserInfo() {
return "實現類";
}
}
2. new() 方式例項化
IUserDao userDao = new UserDao();
userDao.queryUserInfo();
這是最簡單的也是最常用的使用方式，new 個物件。
3. proxy 方式例項化
ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
Class<?>[] classes = {IUserDao.class};
InvocationHandler handler = (proxy, method, args) -> "你被代理了 " + method.getName();
IUserDao userDao = (IUserDao) Proxy.newProxyInstance(classLoader, classes, handler);
String res = userDao.queryUserInfo();
logger.info("測試結果：{}", res);
- Proxy.newProxyInstance 代理類例項化方式，對應傳入類的引數即可
- ClassLoader，是這個類載入器，我們可以獲取當前執行緒的類載入器
- InvocationHandler 是代理後實際操作方法執行的內容，在這裡可以新增自己業務場景需要的邏輯，在這裡我們只返回方法名
測試結果：
23:20:18.841 [main] INFO org.itstack.demo.test.ApiTest - 測試結果：你被代理了 queryUserInfo
Process finished with exit code 0
四、盛宴來自Bean工廠
在使用Spring的時候，我們會採用註冊或配置檔案的方式，將我們的類交給Spring管理。例如；
<bean id="userDao" class="org.itstack.demo.UserDao" scope="singleton"/>
UserDao是介面IUserDao的實現類，通過上面配置，就可以例項化一個類供我們使用，但如果IUserDao沒有實現類或者我們希望去動態改變他的實現類比如掛載到別的地方(像mybaits一樣)，並且是由spring bean工廠管理的，該怎麼做呢？
1. FactoryBean的使用
FactoryBean 在spring起到著二當家的地位，它將近有70多個小弟(實現它的介面定義)，那麼它有三個方法；
- T getObject() throws Exception; 返回bean例項物件
- Class<?> getObjectType(); 返回例項類型別
- boolean isSingleton(); 判斷是否單例，單例會放到Spring容器中單例項快取池中
那麼我們現在就將上面用到的代理類交給spring的FactoryBean進行管理，程式碼如下；
ProxyBeanFactory.java & bean工廠實現類
public class ProxyBeanFactory implements FactoryBean<IUserDao> {
@Override
public IUserDao getObject() throws Exception {
ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
Class<?>[] classes = {IUserDao.class};
InvocationHandler handler = (proxy, method, args) -> "你被代理了 " + method.getName();
return (IUserDao) Proxy.newProxyInstance(classLoader, classes, handler);
}
@Override
public Class<?> getObjectType() {
return IUserDao.class;
}
@Override
public boolean isSingleton() {
return true;
}
}
spring-config.xml & 配置bean類資訊
<bean id="userDao" class="org.itstack.demo.bean.ProxyBeanFactory"/>
ApiTest.test_IUserDao() & 單元測試
@Test
public void test_IUserDao() {
BeanFactory beanFactory = new ClassPathXmlApplicationContext("spring-config.xml");
IUserDao userDao = beanFactory.getBean("userDao", IUserDao.class);
String res = userDao.queryUserInfo();
logger.info("測試結果：{}", res);
}
測試結果：
一月 20, 2020 23:43:35 上午 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
資訊: Loading XML bean definitions from class path resource [spring-config.xml]
23:43:35.440 [main] INFO org.itstack.demo.test.ApiTest - 測試結果：你被代理了 queryUserInfo
Process finished with exit code 0
咋樣，神奇不！你的介面都不需要實現類，就被安排的明明白白的。記住這個方法FactoryBean和動態代理。
2. BeanDefinitionRegistryPostProcessor 類註冊
你是否有懷疑過你媳婦把你錢沒收了之後都存放到哪去了，為啥你每次get都那麼費勁，像垃圾回收了一樣，不可達。
好嘞，媳婦那就別想了，研究下你的bean都被註冊到哪了就可以了。在spring的bean管理中，所有的bean最終都會被註冊到類DefaultListableBeanFactory中，接下來我們就主動註冊一個被我們代理了的bean。
RegisterBeanFactory.java & 註冊bean的實現類
public class RegisterBeanFactory implements BeanDefinitionRegistryPostProcessor {
@Override
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
GenericBeanDefinition beanDefinition = new GenericBeanDefinition();
beanDefinition.setBeanClass(ProxyBeanFactory.class);
BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(beanDefinition, "userDao");
registry.registerBeanDefinition(definitionHolder.getBeanName(), definitionHolder.getBeanDefinition());
}
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
// left intentionally blank
}
}
- 這裡包含4塊主要內容，分別是；
- 實現BeanDefinitionRegistryPostProcessor.postProcessBeanDefinitionRegistry方法，獲取bean註冊物件
- 定義bean，GenericBeanDefinition，這裡主要設定了我們的代理類工廠。我們已經測試過他獲取一個代理類
- 建立bean定義處理類，BeanDefinitionHolder，這裡需要的主要引數；定義bean、bean名稱
- 最後將我們自己的bean註冊到spring容器中去，registry.registerBeanDefinition()
spring-config.xml & 配置bean類資訊
<bean id="userDao" class="org.itstack.demo.bean.RegisterBeanFactory"/>
ApiTest.test_IUserDao() & 單元測試
@Test
public void test_IUserDao() {
BeanFactory beanFactory = new ClassPathXmlApplicationContext("spring-config.xml");
IUserDao userDao = beanFactory.getBean("userDao", IUserDao.class);
String res = userDao.queryUserInfo();
logger.info("測試結果：{}", res);
}
測試結果：
資訊: Loading XML bean definitions from class path resource [spring-config.xml]
一月 20, 2020 23:42:29 上午 org.springframework.beans.factory.support.DefaultListableBeanFactory registerBeanDefinition
資訊: Overriding bean definition for bean 'userDao' with a different definition: replacing [Generic bean: class [org.itstack.demo.bean.RegisterBeanFactory]; scope=; abstract=false; lazyInit=false; autowireMode=1; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null; defined in class path resource [spring-config.xml]] with [Generic bean: class [org.itstack.demo.bean.ProxyBeanFactory]; scope=; abstract=false; lazyInit=false; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null]
23:42:29.754 [main] INFO org.itstack.demo.test.ApiTest - 測試結果：你被代理了 queryUserInfo
Process finished with exit code 0
納尼？是不有一種滿腦子都是騷操作的感覺，自己註冊的bean自己知道在哪了，咋回事了。
五、老闆郎上主食呀(mybaits-spring)
如果通過上面的知識點；代理類、bean工廠、bean註冊，將我們一個沒有實現類的介面安排的明明白白，讓他執行啥就執行啥，那麼你是否可以想到，這個沒有實現類的介面，可以通過我們的折騰，去呼叫到我們的mybaits呢！
如下圖，通過mybatis使用的配置，我們可以看到資料來源DataSource交給SqlSessionFactoryBean，SqlSessionFactoryBean例項化出的SqlSessionFactory，再交給MapperScannerConfigurer。而我們要實現的就是MapperScannerConfigurer這部分；
1. 需要實現哪些核心類
為了更易理解也更易於對照，我們將實現mybatis-spring中的流程核心類，如下；
- MapperFactoryBean ｛給每一個沒有實現類的介面都代理一個這樣的類，用於運算元據庫執行crud｝
- MapperScannerConfigurer ｛掃描包下介面類，免去配置。這樣是上圖中核心配置類｝
- SimpleMetadataReader ｛這個類完全和mybaits-spring中的類一樣，為了解析class檔案。如果你對類載入處理很好奇，可以閱讀我的《用java實現jvm虛擬機器》｝
- SqlSessionFactoryBean {這個類核心內容就一件事，將我們寫的demo版的mybaits結合進來}
在分析之前先看下我們實現主食是怎麼食用的，如下；
<bean id="sqlSessionFactory" class="org.itstack.demo.like.spring.SqlSessionFactoryBean">
<property name="resource" value="spring/mybatis-config-datasource.xml"/>
</bean>
<bean class="org.itstack.demo.like.spring.MapperScannerConfigurer">
<!-- 注入sqlSessionFactory -->
<property name="sqlSessionFactory" ref="sqlSessionFactory"/>
<!-- 給出需要掃描Dao介面包 -->
<property name="basePackage" value="org.itstack.demo.dao"/>
</bean>
2. (類介紹)SqlSessionFactoryBean
這類本身比較簡單，主要實現了FactoryBean
SqlSessionFactoryBean.java
public class SqlSessionFactoryBean implements FactoryBean<SqlSessionFactory>, InitializingBean {
private String resource;
private SqlSessionFactory sqlSessionFactory;
@Override
public void afterPropertiesSet() throws Exception {
try (Reader reader = Resources.getResourceAsReader(resource)) {
this.sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
} catch (Exception e) {
e.printStackTrace();
}
}
@Override
public SqlSessionFactory getObject() throws Exception {
return sqlSessionFactory;
}
@Override
public Class<?> getObjectType() {
return sqlSessionFactory.getClass();
}
@Override
public boolean isSingleton() {
return true;
}
public void setResource(String resource) {
this.resource = resource;
}
}
- 實現InitializingBean主要用於載入mybatis相關內容；解析xml、構造SqlSession、連結資料庫等
- FactoryBean，這個類我們介紹過，主要三個方法；getObject()、getObjectType()、isSingleton()
3. (類介紹)MapperScannerConfigurer
這類的內容看上去可能有點多，但是核心事情也就是將我們的dao層介面掃描、註冊
public class MapperScannerConfigurer implements BeanDefinitionRegistryPostProcessor {
private String basePackage;
private SqlSessionFactory sqlSessionFactory;
@Override
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
try {
// classpath*:org/itstack/demo/dao/**/*.class
String packageSearchPath = "classpath*:" + basePackage.replace('.', '/') + "/**/*.class";
ResourcePatternResolver resourcePatternResolver = new PathMatchingResourcePatternResolver();
Resource[] resources = resourcePatternResolver.getResources(packageSearchPath);
for (Resource resource : resources) {
MetadataReader metadataReader = new SimpleMetadataReader(resource, ClassUtils.getDefaultClassLoader());
ScannedGenericBeanDefinition beanDefinition = new ScannedGenericBeanDefinition(metadataReader);
String beanName = Introspector.decapitalize(ClassUtils.getShortName(beanDefinition.getBeanClassName()));
beanDefinition.setResource(resource);
beanDefinition.setSource(resource);
beanDefinition.setScope("singleton");
beanDefinition.getConstructorArgumentValues().addGenericArgumentValue(beanDefinition.getBeanClassName());
beanDefinition.getConstructorArgumentValues().addGenericArgumentValue(sqlSessionFactory);
beanDefinition.setBeanClass(MapperFactoryBean.class);
BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(beanDefinition, beanName);
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
}
} catch (IOException e) {
e.printStackTrace();
}
}
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
// left intentionally blank
}
public void setBasePackage(String basePackage) {
this.basePackage = basePackage;
}
public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory) {
this.sqlSessionFactory = sqlSessionFactory;
}
}
- 類的掃描註冊，classpath:org/itstack/demo/dao/**/.class，解析calss檔案獲取資源資訊；Resource[] resources = resourcePatternResolver.getResources(packageSearchPath);
- 遍歷Resource，這裡就你的class資訊，用於註冊bean。ScannedGenericBeanDefinition
- 這裡有一點，bean的定義設定時候，是把beanDefinition.setBeanClass(MapperFactoryBean.class);設定進去的。同時在前面給他設定了構造引數。（細細品味）
- 最後執行註冊registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
4. (類介紹)MapperFactoryBean
這個類就非常有意思了，因為你所有的dao介面類，實際就是他。他這裡幫你執行你對sql的所有操作的分發處理。為了更加簡化清晰，目前這裡只實現了查詢部分，在mybatis-spring原始碼中分別對select、update、insert、delete、其他等做了操作。
public class MapperFactoryBean<T> implements FactoryBean<T> {
private Class<T> mapperInterface;
private SqlSessionFactory sqlSessionFactory;
public MapperFactoryBean(Class<T> mapperInterface, SqlSessionFactory sqlSessionFactory) {
this.mapperInterface = mapperInterface;
this.sqlSessionFactory = sqlSessionFactory;
}
@Override
public T getObject() throws Exception {
InvocationHandler handler = (proxy, method, args) -> {
System.out.println("你被代理了，執行SQL操作！" + method.getName());
try {
SqlSession session = sqlSessionFactory.openSession();
try {
return session.selectOne(mapperInterface.getName() + "." + method.getName(), args[0]);
} finally {
session.close();
}
} catch (Exception e) {
e.printStackTrace();
}
return method.getReturnType().newInstance();
};
return (T) Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(), new Class[]{mapperInterface}, handler);
}
@Override
public Class<?> getObjectType() {
return mapperInterface;
}
@Override
public boolean isSingleton() {
return true;
}
}
-
T getObject()，中是一個java代理類的實現，這個代理類物件會被掛到你的注入中。真正呼叫方法內容時會執行到代理類的實現部分，也就是“你被代理了，執行SQL操作！”
-
InvocationHandler，代理類的實現部分非常簡單，主要開啟SqlSession，並通過固定的key；“org.itstack.demo.dao.IUserDao.queryUserInfoById”執行SQL操作；
session.selectOne(mapperInterface.getName() + "." + method.getName(), args[0]);
<mapper namespace="org.itstack.demo.dao.IUserDao"> <select id="queryUserInfoById" parameterType="java.lang.Long" resultType="org.itstack.demo.po.User"> SELECT id, name, age, createTime, updateTime FROM user where id = #{id} </select> </mapper> -
最終返回了執行結果，關於查詢到結果資訊會反射操作成物件類，這部分內容可以遇到demo版本的mybatis
六、酒倒滿走一個
好！到這一切開發內容就完成了，測試走一個。
mybatis-config-datasource.xml & 資料來源配置
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://127.0.0.1:3306/itstack_demo_ddd?useUnicode=true"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="mapper/User_Mapper.xml"/>
<mapper resource="mapper/School_Mapper.xml"/>
</mappers>
</configuration>
test-config.xml & 配置xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:aop="http://www.springframework.org/schema/aop"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.0.xsd"
default-autowire="byName">
<context:component-scan base-package="org.itstack"/>
<aop:aspectj-autoproxy/>
<bean id="sqlSessionFactory" class="org.itstack.demo.like.spring.SqlSessionFactoryBean">
<property name="resource" value="spring/mybatis-config-datasource.xml"/>
</bean>
<bean class="org.itstack.demo.like.spring.MapperScannerConfigurer">
<!-- 注入sqlSessionFactory -->
<property name="sqlSessionFactory" ref="sqlSessionFactory"/>
<!-- 給出需要掃描Dao介面包 -->
<property name="basePackage" value="org.itstack.demo.dao"/>
</bean>
</beans>
SpringTest.java & 單元測試
public class SpringTest {
private Logger logger = LoggerFactory.getLogger(SpringTest.class);
@Test
public void test_ClassPathXmlApplicationContext() {
BeanFactory beanFactory = new ClassPathXmlApplicationContext("test-config.xml");
IUserDao userDao = beanFactory.getBean("IUserDao", IUserDao.class);
User user = userDao.queryUserInfoById(1L);
logger.info("測試結果：{}", JSON.toJSONString(user));
}
}
測試結果；
一月 20, 2020 23:51:43 上午 org.springframework.context.support.ClassPathXmlApplicationContext prepareRefresh
資訊: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@30b8a058: startup date [Mon Jan 20 23:51:43 CST 2020]; root of context hierarchy
一月 20, 2020 23:51:43 上午 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
資訊: Loading XML bean definitions from class path resource [test-config.xml]
你被代理了，執行SQL操作！queryUserInfoById
2020-01-20 23:51:45.592 [main] INFO org.itstack.demo.SpringTest[26] - 測試結果：{"age":18,"createTime":1576944000000,"id":1,"name":"水水","updateTime":1576944000000}
Process finished with exit code 0
酒乾熱火笑紅塵，春秋幾載年輪，不問。回首皆是Spring！Gun！變心！你被代理了！
七、綜上總結
- 通過這些核心關鍵類的實現；SqlSessionFactoryBean、MapperScannerConfigurer、SqlSessionFactoryBean，我們將spring與mybaits集合起來使用，解決了沒有實現類的介面怎麼處理資料庫CRUD操作
- 那麼這個知識點可以用到哪裡，不要只想著面試！在我們業務開發中是不會有很多其他資料來源操作，比如ES、Hadoop、資料中心等等，包括自建。那麼我們就可以做成一套統一資料來源處理服務，以優化服務開發效率
- 由於這次工程類是在itstack-demo-code-mybatis中繼續開發，如果需要獲取原始碼可以關注公眾號：bugstack蟲洞棧，回覆：原始碼分析