-
1 # 韓劇大Zahui
-
2 # ksfzhaohui
什麼叫動態代理
可以在執行期動態建立某個介面的例項；建立的這個代理例項可以幫我們完成很多事情，常見的比如：RPC框架中透過代理類幫助我們傳送請求到遠端伺服器端，Mybatis中透過代理類幫助我們對映到xml中的statement，Spring中透過代理類實現事務的控制，日誌的列印等等；
如何實現
1.基於 JDK 實現動態代理，透過jdk提供的工具方法
Proxy.newProxyInstance
動態構建全新的代理類;2.基於CGlib 動態代理模式基於繼承被代理類生成代理子類，不用實現介面；
3.基於 Aspectj 實現動態代理，在程式編譯的時候 插入動態代理的位元組碼，不會生成全新的Class；
原始碼分析
下面以Mybatis為例子，分析一下XXXMapper是如何透過介面呼叫xml中的statement的，下面看一個常見的例項：
public class BlogMain {
public static void main(String[] args) throws IOException {
String resource = "mybatis-config-sourceCode.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
SqlSession session = sqlSessionFactory.openSession();
try {
BlogMapper mapper = session.getMapper(BlogMapper.class);
// 常規方法
System.out.println(mapper.selectBlog(101));
} finally {
session.close();
}
}
}
BlogMapper是一個介面類，我們透過
session.getMapper
的時候獲取的就是一個動態代理類，由此代理類去對映到xml中的statement；如上程式碼中使用openSession建立的一個DefaultSqlSession類，此類中包含了執行了sql的增刪改查等操作，另外還包含了getMapper方法：
此處的Configuration是關鍵，也是Mybatis的一個核心類，可以先簡單理解為就是我們的配置檔案mybatis-config.xml的一個對映類；繼續往下走：
這裡引出了MapperRegistry，所有的Mapper都在此類中註冊，透過key-value的形式存放，key對應xx.xx.xxMapper，而value存放的是Mapper的代理類，具體如類MapperRegistry程式碼所示：
可以看到每次getMapper的時候其實都是去knownMappers獲取一個MapperProxyFactory類，至於是何時往knownMappers中新增資料的，是在解析mybatis-config.xml配置檔案的時候，解析到mappers標籤的時候，如下所示：
繼續解析裡面的BlogMapper.xml，會把BlogMapper.xml中的namespace作為key，如下所示：
namespace是必填的，此值作為MapperRegistry中的knownMappers的key，而value就是此Mapper類的一個代理工廠類MapperProxyFactory，每次呼叫getMapper的時候都會newInstance一個例項，程式碼如下：
可以發現透過jdk自帶的代理類Proxy.newProxyInstance(...)建立了一個代理類，設定MapperProxy作為InvocationHandler，在例項化MapperProxy時同時傳入了一個methodCache物件，此物件是一個Map，存放的就是每個Mapper裡面的方法，這裡定義為MapperMethod；至此我們瞭解了getMapper的大致流程，下面繼續看執行方法；
當我們執行上面的mapper.selectBlog(101)時會自動觸發MapperProxy的invoke方法，此方法會幫我們對映到xml中的statement，然後執行裡面配置的sql。
回覆列表
我們先來看看Mybatis是如何實現Dao類的掃描的。
MapperScannerConfigurer.java
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
if (this.processPropertyPlaceHolders) {
processPropertyPlaceHolders();
}
ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
scanner.setAddToConfig(this.addToConfig);
scanner.setAnnotationClass(this.annotationClass);
scanner.setMarkerInterface(this.markerInterface);
scanner.setSqlSessionFactory(this.sqlSessionFactory);
scanner.setSqlSessionTemplate(this.sqlSessionTemplate);
scanner.setSqlSessionFactoryBeanName(this.sqlSessionFactoryBeanName);
scanner.setSqlSessionTemplateBeanName(this.sqlSessionTemplateBeanName);
scanner.setResourceLoader(this.applicationContext);
scanner.setBeanNameGenerator(this.nameGenerator);
scanner.registerFilters();
scanner.scan(StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS));
}
ClassPathMapperScanner是Mybatis繼承ClassPathBeanDefinitionScanner類而來的。這裡對於ClassPathMapperScanner的配置引數來源於我們在使用Mybatis時的配置而來，是不是還記得在使用Mybatis的時候要配置basePackage的引數呢？
接著我們就順著scanner.scan()方法，進入檢視一下里面的實現。
ClassPathBeanDefinitionScanner.java
public int scan(String... basePackages) {
int beanCountAtScanStart = this.registry.getBeanDefinitionCount();
doScan(basePackages);
// Register annotation config processors, if necessary.
if (this.includeAnnotationConfig) {
AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry);
}
return (this.registry.getBeanDefinitionCount() - beanCountAtScanStart);
}
這裡關鍵的程式碼是doScan(basePackages);，那麼我們在進去看一下。可能你會看到的是Spring原始碼的實現方法，但這裡Mybatis也實現了自己的一套，我們看一下Mybatis的實現。
ClassPathMapperScanner.java
public Set<BeanDefinitionHolder> doScan(String... basePackages) {
Set<BeanDefinitionHolder> beanDefinitions = super.doScan(basePackages);
if (beanDefinitions.isEmpty()) {
logger.warn("No MyBatis mapper was found in "" + Arrays.toString(basePackages) + "" package. Please check your configuration.");
} else {
for (BeanDefinitionHolder holder : beanDefinitions) {
GenericBeanDefinition definition = (GenericBeanDefinition) holder.getBeanDefinition();
if (logger.isDebugEnabled()) {
logger.debug("Creating MapperFactoryBean with name "" + holder.getBeanName()
+ "" and "" + definition.getBeanClassName() + "" mapperInterface");
}
// the mapper interface is the original class of the bean
// but, the actual class of the bean is MapperFactoryBean
definition.getPropertyValues().add("mapperInterface", definition.getBeanClassName());
definition.setBeanClass(MapperFactoryBean.class);
definition.getPropertyValues().add("addToConfig", this.addToConfig);
boolean explicitFactoryUsed = false;
if (StringUtils.hasText(this.sqlSessionFactoryBeanName)) {
definition.getPropertyValues().add("sqlSessionFactory", new RuntimeBeanReference(this.sqlSessionFactoryBeanName));
explicitFactoryUsed = true;
} else if (this.sqlSessionFactory != null) {
definition.getPropertyValues().add("sqlSessionFactory", this.sqlSessionFactory);
explicitFactoryUsed = true;
}
if (StringUtils.hasText(this.sqlSessionTemplateBeanName)) {
if (explicitFactoryUsed) {
logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
}
definition.getPropertyValues().add("sqlSessionTemplate", new RuntimeBeanReference(this.sqlSessionTemplateBeanName));
explicitFactoryUsed = true;
} else if (this.sqlSessionTemplate != null) {
if (explicitFactoryUsed) {
logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
}
definition.getPropertyValues().add("sqlSessionTemplate", this.sqlSessionTemplate);
explicitFactoryUsed = true;
}
if (!explicitFactoryUsed) {
if (logger.isDebugEnabled()) {
logger.debug("Enabling autowire by type for MapperFactoryBean with name "" + holder.getBeanName() + "".");
}
definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
}
}
}
return beanDefinitions;
}
definition.setBeanClass(MapperFactoryBean.class);這行程式碼是非常關鍵的一句，由於在Spring中存在兩種自動例項化的方式，一種是我們常用的本身的介面例項化類進行介面例項化，還有一種就是這裡的自定義例項化。而這裡的setBeanClass方法就是在BeanDefinitionHolder中進行配置。在Spring進行例項化的時候進行處理。
那麼我們在看一下MapperFactoryBean.class
MapperFactoryBean.java
public class MapperFactoryBean<T> extends SqlSessionDaoSupport implements FactoryBean<T> {
private Class<T> mapperInterface;
private boolean addToConfig = true;
/**
* Sets the mapper interface of the MyBatis mapper
*
* @param mapperInterface class of the interface
*/
public void setMapperInterface(Class<T> mapperInterface) {
this.mapperInterface = mapperInterface;
}
/**
* If addToConfig is false the mapper will not be added to MyBatis. This means
* it must have been included in mybatis-config.xml.
* <p>
* If it is true, the mapper will be added to MyBatis in the case it is not already
* registered.
* <p>
* By default addToCofig is true.
*
* @param addToConfig
*/
public void setAddToConfig(boolean addToConfig) {
this.addToConfig = addToConfig;
}
/**
* {@inheritDoc}
*/
@Override
protected void checkDaoConfig() {
super.checkDaoConfig();
notNull(this.mapperInterface, "Property "mapperInterface" is required");
Configuration configuration = getSqlSession().getConfiguration();
if (this.addToConfig && !configuration.hasMapper(this.mapperInterface)) {
try {
configuration.addMapper(this.mapperInterface);
} catch (Throwable t) {
logger.error("Error while adding the mapper "" + this.mapperInterface + "" to configuration.", t);
throw new IllegalArgumentException(t);
} finally {
ErrorContext.instance().reset();
}
}
}
/**
* {@inheritDoc}
*/
public T getObject() throws Exception {
return getSqlSession().getMapper(this.mapperInterface);
}
/**
* {@inheritDoc}
*/
public Class<T> getObjectType() {
return this.mapperInterface;
}
/**
* {@inheritDoc}
*/
public boolean isSingleton() {
return true;
}
在該類中其實現了FactoryBean介面，看過Spring原始碼的人，我相信對其都有很深的印象，其在Bean的例項化中起著很重要的作用。在該類中我們要關注的是getObject方法，我們之後將動態例項化的介面物件放到Spring例項化列表中，這裡就是入口，也是我們的起點。不過要特別說明的是mapperInterface的值是如何被賦值的，可能會有疑問，我們再來看看上面的ClassPathMapperScanner.java我們在配置MapperFactoryBean.class的上面存在一行 definition.getPropertyValues().add("mapperInterface", definition.getBeanClassName());其在之後在Spring的PostProcessorRegistrationDelegate類的populateBean方法中進行屬性配置，會將其依靠反射的方式將其注入到MapperFactoryBean.class中。
而且definition.getPropertyValues().add中新增的值是注入到MapperFactoryBean物件中去的。這一點需要說明一下。