Mybaits 源碼解析 （十一）----- 設計模式精妙使用：靜態代理和動態代理結合使用：@MapperScan將Mapper接口生成代理注入到Spring

時間  2019-11-12
標籤 mybaits 源碼 解析 十一 設計 模式 精妙 使用 靜態 代理 動態 結合 mapperscan mapper 接口 生成 注入 spring 欄目 MyBatis 简体版
原文   原文鏈接

上一篇文章咱們講了SqlSessionFactoryBean，經過這個FactoryBean建立SqlSessionFactory並註冊進Spring容器，這篇文章咱們就講剩下的部分，經過MapperScannerConfigurer將Mapper接口生成代理注入到Springspring

掃描Mapper接口

咱們上一篇文章介紹了掃描Mapper接口有兩種方式，一種是經過bean.xml註冊MapperScannerConfigurer對象，一種是經過@MapperScan("com.chenhao.mapper")註解的方式，以下sql

方式一：數據庫

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="com.chenhao.mapper" />
</bean>

方式二：緩存

@Configuration
@MapperScan("com.chenhao.mapper")
public class AppConfig {

@MapperScan

咱們來看看@MapperScan這個註解安全

@Import(MapperScannerRegistrar.class)
public @interface MapperScan {

MapperScan使用@Import將MapperScannerRegistrar導入。session

MapperScannerRegistrar

 1 public class MapperScannerRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {
 2   private ResourceLoader resourceLoader;
 3   @Override
 4   public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
 5     // 獲取MapperScan 註解，如@MapperScan("com.chenhao.mapper")
 6     AnnotationAttributes annoAttrs = AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(MapperScan.class.getName()));  7     // 建立路徑掃描器，下面的一大段都是將MapperScan 中的屬性設置到ClassPathMapperScanner ，作的就是一個set操做
 8     ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);  9     // this check is needed in Spring 3.1
10     if (resourceLoader != null) {
11       // 設置資源加載器，做用：掃描指定包下的class文件。
12       scanner.setResourceLoader(resourceLoader);
13     }
14     Class<? extends Annotation> annotationClass = annoAttrs.getClass("annotationClass");
15     if (!Annotation.class.equals(annotationClass)) {
16       scanner.setAnnotationClass(annotationClass);
17     }
18     Class<?> markerInterface = annoAttrs.getClass("markerInterface");
19     if (!Class.class.equals(markerInterface)) {
20       scanner.setMarkerInterface(markerInterface);
21     }
22     Class<? extends BeanNameGenerator> generatorClass = annoAttrs.getClass("nameGenerator");
23     if (!BeanNameGenerator.class.equals(generatorClass)) {
24       scanner.setBeanNameGenerator(BeanUtils.instantiateClass(generatorClass));
25     }
26     Class<? extends MapperFactoryBean> mapperFactoryBeanClass = annoAttrs.getClass("factoryBean");
27     if (!MapperFactoryBean.class.equals(mapperFactoryBeanClass)) {
28       scanner.setMapperFactoryBean(BeanUtils.instantiateClass(mapperFactoryBeanClass));
29     }
30     scanner.setSqlSessionTemplateBeanName(annoAttrs.getString("sqlSessionTemplateRef"));
31     //設置SqlSessionFactory的名稱
32     scanner.setSqlSessionFactoryBeanName(annoAttrs.getString("sqlSessionFactoryRef")); 33     List<String> basePackages = new ArrayList<String>(); 34     //獲取配置的包路徑，如com.chenhao.mapper
35     for (String pkg : annoAttrs.getStringArray("value")) { 36       if (StringUtils.hasText(pkg)) { 37  basePackages.add(pkg); 38  } 39  } 40     for (String pkg : annoAttrs.getStringArray("basePackages")) {
41       if (StringUtils.hasText(pkg)) {
42         basePackages.add(pkg);
43       }
44     }
45     for (Class<?> clazz : annoAttrs.getClassArray("basePackageClasses")) {
46       basePackages.add(ClassUtils.getPackageName(clazz));
47     }
48     // 註冊過濾器，做用：什麼類型的Mapper將會留下來。
49     scanner.registerFilters();
50     // 掃描指定包
51  scanner.doScan(StringUtils.toStringArray(basePackages)); 52   }
53 }

ClassPathMapperScanner

接着咱們來看看掃描過程 scanner.doScan(StringUtils.toStringArray(basePackages));mybatis

 1 @Override
 2 public Set<BeanDefinitionHolder> doScan(String... basePackages) {
 3     //調用父類進行掃描，並將basePackages下的class都封裝成BeanDefinitionHolder，並註冊進Spring容器的BeanDefinition
 4     Set<BeanDefinitionHolder> beanDefinitions = super.doScan(basePackages);
 5  
 6     if (beanDefinitions.isEmpty()) {
 7       logger.warn("No MyBatis mapper was found in '" + Arrays.toString(basePackages) + "' package. Please check your configuration.");
 8     } else {
 9       //繼續對beanDefinitions作處理，額外設置一些屬性
10       processBeanDefinitions(beanDefinitions);
11     }
12  
13     return beanDefinitions;
14 }
15   
16 protected Set<BeanDefinitionHolder> doScan(String... basePackages) {
17     Assert.notEmpty(basePackages, "At least one base package must be specified");
18     Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<BeanDefinitionHolder>();
19     //遍歷basePackages進行掃描
20     for (String basePackage : basePackages) {
21         //找出匹配的類
22         Set<BeanDefinition> candidates = findCandidateComponents(basePackage);
23         for (BeanDefinition candidate : candidates) {
24             ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate);
25             candidate.setScope(scopeMetadata.getScopeName());
26             String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry);
27             if (candidate instanceof AbstractBeanDefinition) {
28                 postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName);
29             }
30             if (candidate instanceof AnnotatedBeanDefinition) {
31                 AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate);
32             }
33             if (checkCandidate(beanName, candidate)) {
34                 //封裝成BeanDefinitionHolder 對象
35                 BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName);
36                 definitionHolder = AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);
37                 beanDefinitions.add(definitionHolder);
38                 //將BeanDefinition對象注入spring的BeanDefinitionMap中，後續getBean時，就是從BeanDefinitionMap獲取對應的BeanDefinition對象，取出其屬性進行實例化Bean
39                 registerBeanDefinition(definitionHolder, this.registry);
40             }
41         }
42     }
43     return beanDefinitions;
44 }

咱們重點看下第4行和第10行代碼，第4行是調用父類的doScan方法，獲取basePackages下的全部Class，並將其生成BeanDefinition，注入spring的BeanDefinitionMap中，也就是Class的描述類，在調用getBean方法時，獲取BeanDefinition進行實例化。此時，全部的Mapper接口已經被生成了BeanDefinition。接着咱們看下第10行，對生成的BeanDefinition作一些額外的處理。app

processBeanDefinitions

上面BeanDefinition已經注入進Spring容器了，接着咱們看對BeanDefinition進行哪些額外的處理ide

 1 private void processBeanDefinitions(Set<BeanDefinitionHolder> beanDefinitions) {
 2     GenericBeanDefinition definition;
 3     for (BeanDefinitionHolder holder : beanDefinitions) {
 4       definition = (GenericBeanDefinition) holder.getBeanDefinition();
 5  
 6       if (logger.isDebugEnabled()) {
 7         logger.debug("Creating MapperFactoryBean with name '" + holder.getBeanName() 
 8           + "' and '" + definition.getBeanClassName() + "' mapperInterface");
 9       }
10  
11       // 設置definition構造器的輸入參數爲definition.getBeanClassName()，這裏就是com.chenhao.mapper.UserMapper
12       // 那麼在getBean實例化時，經過反射調用構造器實例化時要將這個參數傳進去
13       definition.getConstructorArgumentValues().addGenericArgumentValue(definition.getBeanClassName())
14       // 修改definition對應的Class
15       // 看過Spring源碼的都知道，getBean()返回的就是BeanDefinitionHolder中beanClass屬性對應的實例
16       // 因此咱們後面ac.getBean(UserMapper.class)的返回值也就是MapperFactoryBean的實例
17       // 可是最終被注入到Spring容器的對象的並非MapperFactoryBean的實例，根據名字看，咱們就知道MapperFactoryBean實現了FactoryBean接口
18       // 那麼最終注入Spring容器的一定是從MapperFactoryBean的實例的getObject()方法中返回
19       definition.setBeanClass(this.mapperFactoryBean.getClass());
20  
21       definition.getPropertyValues().add("addToConfig", this.addToConfig);
22  
23       boolean explicitFactoryUsed = false;
24       if (StringUtils.hasText(this.sqlSessionFactoryBeanName)) {
25         definition.getPropertyValues().add("sqlSessionFactory", new RuntimeBeanReference(this.sqlSessionFactoryBeanName));
26         explicitFactoryUsed = true;
27       } else if (this.sqlSessionFactory != null) {
28         //往definition設置屬性值sqlSessionFactory，那麼在MapperFactoryBean實例化後，進行屬性賦值時populateBean(beanName, mbd, instanceWrapper);，會經過反射調用sqlSessionFactory的set方法進行賦值
29         //也就是在MapperFactoryBean建立實例後，要調用setSqlSessionFactory方法將sqlSessionFactory注入進MapperFactoryBean實例
30         definition.getPropertyValues().add("sqlSessionFactory", this.sqlSessionFactory);
31         explicitFactoryUsed = true;
32       }
33  
34       if (StringUtils.hasText(this.sqlSessionTemplateBeanName)) {
35         if (explicitFactoryUsed) {
36           logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
37         }
38         definition.getPropertyValues().add("sqlSessionTemplate", new RuntimeBeanReference(this.sqlSessionTemplateBeanName));
39         explicitFactoryUsed = true;
40       } else if (this.sqlSessionTemplate != null) {
41         if (explicitFactoryUsed) {
42           logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
43         }
44         definition.getPropertyValues().add("sqlSessionTemplate", this.sqlSessionTemplate);
45         explicitFactoryUsed = true;
46       }
47  
48       if (!explicitFactoryUsed) {
49         if (logger.isDebugEnabled()) {
50           logger.debug("Enabling autowire by type for MapperFactoryBean with name '" + holder.getBeanName() + "'.");
51         }
52         definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
53       }
54     }
55 }

看第19行，將definition的beanClass屬性設置爲MapperFactoryBean.class，咱們知道，在getBean的時候，會經過反射建立Bean的實例，也就是建立beanClass的實例，以下Spring的getBean的部分代碼：函數

public Object instantiate(RootBeanDefinition bd, @Nullable String beanName, BeanFactory owner) {
    // 沒有覆蓋 // 直接使用反射實例化便可
    if (!bd.hasMethodOverrides()) { // 從新檢測獲取下構造函數
        // 該構造函數是通過前面 N 多複雜過程確認的構造函數
        Constructor<?> constructorToUse;
        synchronized (bd.constructorArgumentLock) {
            // 獲取已經解析的構造函數
            constructorToUse = (Constructor<?>) bd.resolvedConstructorOrFactoryMethod;
            // 若是爲 null，從 class 中解析獲取，並設置
            if (constructorToUse == null) {
                final Class<?> clazz = bd.getBeanClass();
                if (clazz.isInterface()) {
                    throw new BeanInstantiationException(clazz, "Specified class is an interface");
                }
                try {
                    if (System.getSecurityManager() != null) {
                        constructorToUse = AccessController.doPrivileged(
                                (PrivilegedExceptionAction<Constructor<?>>) clazz::getDeclaredConstructor);
                    }
                    else {
                        //利用反射獲取構造器
                        constructorToUse = clazz.getDeclaredConstructor();
                    }
                    bd.resolvedConstructorOrFactoryMethod = constructorToUse;
                }
                catch (Throwable ex) {
                    throw new BeanInstantiationException(clazz, "No default constructor found", ex);
                }
            }
        }

        // 經過BeanUtils直接使用構造器對象實例化bean
        return BeanUtils.instantiateClass(constructorToUse);
    }
    else {
        // 生成CGLIB建立的子類對象
        return instantiateWithMethodInjection(bd, beanName, owner);
    }
}

看到沒，是經過bd.getBeanClass();從BeanDefinition中獲取beanClass屬性，而後經過反射實例化Bean，如上，全部的Mapper接口掃描封裝成的BeanDefinition的beanClass都設置成了MapperFactoryBean，咱們知道在Spring初始化的最後，會獲取全部的BeanDefinition，並經過getBean建立全部的實例注入進Spring容器，那麼意思就是說，在getBean時，建立的的全部Mapper對象是MapperFactoryBean這個對象了。

咱們看下第13行處，設置了BeanDefinition構造器參數，那麼當getBean中經過構造器建立實例時，須要將設置的構造器參數definition.getBeanClassName()，這裏就是com.chenhao.mapper.UserMapper傳進去。

還有一個點要注意，在第30行處，往BeanDefinition的PropertyValues設置了sqlSessionFactory，那麼在建立完MapperFactoryBean的實例後，會對MapperFactoryBean進行屬性賦值，也就是Spring建立Bean的這句代碼，populateBean(beanName, mbd, instanceWrapper);，這裏會經過反射調用MapperFactoryBean的setSqlSessionFactory方法將sqlSessionFactory注入進MapperFactoryBean實例，因此咱們接下來重點看的就是MapperFactoryBean這個對象了。

MapperFactoryBean

接下來咱們看最重要的一個類MapperFactoryBean

//繼承SqlSessionDaoSupport、實現FactoryBean，那麼最終注入Spring容器的對象要從getObject()中取
public class MapperFactoryBean<T> extends SqlSessionDaoSupport implements FactoryBean<T> {
    private Class<T> mapperInterface;
    private boolean addToConfig = true;

    public MapperFactoryBean() {
    }

    //構造器，咱們上一節中在BeanDefinition中已經設置了構造器輸入參數
    //因此在經過反射調用構造器實例化時，會獲取在BeanDefinition設置的構造器輸入參數
    //也就是對應得每一個Mapper接口Class
    public MapperFactoryBean(Class<T> mapperInterface) {
        this.mapperInterface = mapperInterface;
    }

    protected void checkDaoConfig() {
        super.checkDaoConfig();
        Assert.notNull(this.mapperInterface, "Property 'mapperInterface' is required");
        Configuration configuration = this.getSqlSession().getConfiguration();
        if (this.addToConfig && !configuration.hasMapper(this.mapperInterface)) {
            try {
                configuration.addMapper(this.mapperInterface);
            } catch (Exception var6) {
                this.logger.error("Error while adding the mapper '" + this.mapperInterface + "' to configuration.", var6);
                throw new IllegalArgumentException(var6);
            } finally {
                ErrorContext.instance().reset();
            }
        }

    }
    //最終注入Spring容器的就是這裏的返回對象
    public T getObject() throws Exception {
        //獲取父類setSqlSessionFactory方法中建立的SqlSessionTemplate
        //經過SqlSessionTemplate獲取mapperInterface的代理類
        //咱們例子中就是經過SqlSessionTemplate獲取com.chenhao.mapper.UserMapper的代理類
        //獲取到Mapper接口的代理類後，就把這個Mapper的代理類對象注入Spring容器
        return this.getSqlSession().getMapper(this.mapperInterface);
    }

    public Class<T> getObjectType() {
        return this.mapperInterface;
    }

    public boolean isSingleton() {
        return true;
    }

    public void setMapperInterface(Class<T> mapperInterface) {
        this.mapperInterface = mapperInterface;
    }

    public Class<T> getMapperInterface() {
        return this.mapperInterface;
    }

    public void setAddToConfig(boolean addToConfig) {
        this.addToConfig = addToConfig;
    }

    public boolean isAddToConfig() {
        return this.addToConfig;
    }
}


public abstract class SqlSessionDaoSupport extends DaoSupport {
    private SqlSession sqlSession;
    private boolean externalSqlSession;

    public SqlSessionDaoSupport() {
    }
    //還記得上一節中咱們往BeanDefinition中設置的sqlSessionFactory這個屬性嗎？
    //在實例化MapperFactoryBean後，進行屬性賦值時，就會經過反射調用setSqlSessionFactory
    public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory) {
        if (!this.externalSqlSession) {
            //建立一個SqlSessionTemplate並賦值給sqlSession
            this.sqlSession = new SqlSessionTemplate(sqlSessionFactory);
        }
    }

    public void setSqlSessionTemplate(SqlSessionTemplate sqlSessionTemplate) {
        this.sqlSession = sqlSessionTemplate;
        this.externalSqlSession = true;
    }

    public SqlSession getSqlSession() {
        return this.sqlSession;
    }

    protected void checkDaoConfig() {
        Assert.notNull(this.sqlSession, "Property 'sqlSessionFactory' or 'sqlSessionTemplate' are required");
    }
}

咱們看到MapperFactoryBean extends SqlSessionDaoSupport implements FactoryBean，那麼getBean獲取的對象是從其getObject()中獲取，而且MapperFactoryBean是一個單例，那麼其中的屬性SqlSessionTemplate對象也是一個單例，全局惟一，供全部的Mapper代理類使用。

這裏我大概講一下getBean時，這個類的過程：

一、MapperFactoryBean經過反射調用構造器實例化出一個對象，而且經過上一節中definition.getConstructorArgumentValues().addGenericArgumentValue(definition.getBeanClassName())設置的構造器參數，在構造器實例化時，傳入Mapper接口的Class,並設置爲MapperFactoryBean的mapperInterface屬性。

二、進行屬性賦值，經過上一節中definition.getPropertyValues().add("sqlSessionFactory", this.sqlSessionFactory);設置的屬性值，在populateBean屬性賦值過程當中經過反射調用setSqlSessionFactory方法，並建立SqlSessionTemplate對象設置到sqlSession屬性中。

三、因爲MapperFactoryBean實現了FactoryBean，最終註冊進Spring容器的對象是從getObject()方法中取，接着獲取SqlSessionTemplate這個SqlSession調用getMapper(this.mapperInterface);生成Mapper接口的代理對象，將Mapper接口的代理對象註冊進Spring容器

至此，全部com.chenhao.mapper中的Mapper接口都生成了代理類，並注入到Spring容器了。接着咱們就能夠在Service中直接從Spring的BeanFactory中獲取了，以下

SqlSessionTemplate

還記得咱們前面分析Mybatis源碼時，獲取的SqlSession實例是什麼嗎？咱們簡單回顧一下

/**
 * ExecutorType 指定Executor的類型，分爲三種：SIMPLE, REUSE, BATCH，默認使用的是SIMPLE
 * TransactionIsolationLevel 指定事務隔離級別，使用null,則表示使用數據庫默認的事務隔離界別
 * autoCommit 是否自動提交，傳過來的參數爲false，表示不自動提交
 */
private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
    Transaction tx = null;
    try {
        // 獲取配置中的環境信息，包括了數據源信息、事務等
        final Environment environment = configuration.getEnvironment();
        // 建立事務工廠
        final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
        // 建立事務，配置事務屬性
        tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);
        // 建立Executor，即執行器
        // 它是真正用來Java和數據庫交互操做的類，後面會展開說。
        final Executor executor = configuration.newExecutor(tx, execType);
        // 建立DefaultSqlSession對象返回，其實現了SqlSession接口
        return new DefaultSqlSession(configuration, executor, autoCommit);
    } catch (Exception e) {
        closeTransaction(tx);
        throw ExceptionFactory.wrapException("Error opening session.  Cause: " + e, e);
    } finally {
        ErrorContext.instance().reset();
    }
}

你們應該還有印象，就是上面的DefaultSqlSession，那上一節的SqlSessionTemplate是什麼鬼？？？咱們來看看

// 實現SqlSession接口，單例、線程安全，使用spring的事務管理器的sqlSession，
// 具體的SqlSession的功能，則是經過內部包含的sqlSessionProxy來來實現，這也是靜態代理的一種實現。
// 同時內部的sqlSessionProxy實現InvocationHandler接口，則是動態代理的一種實現，而線程安全也是在這裏實現的。
// 注意mybatis默認的sqlSession不是線程安全的，須要每一個線程有一個單例的對象實例。
// SqlSession的主要做用是提供SQL操做的API，執行指定的SQL語句，mapper須要依賴SqlSession來執行其方法對應的SQL。
public class SqlSessionTemplate implements SqlSession, DisposableBean {
    private final SqlSessionFactory sqlSessionFactory;
    private final ExecutorType executorType;
    // 一個代理類，因爲SqlSessionTemplate爲單例的，被全部mapper，全部線程共享，
    // 因此sqlSessionProxy要保證這些mapper中方法調用的線程安全特性：
    // sqlSessionProxy的實現方式主要爲實現了InvocationHandler接口實現了動態代理，
    // 由動態代理的知識可知，InvocationHandler的invoke方法會攔截全部mapper的全部方法調用，
    // 故這裏的實現方式是在invoke方法內部建立一個sqlSession局部變量，從而實現了每一個mapper的每一個方法調用都使用
    private final SqlSession sqlSessionProxy;
    private final PersistenceExceptionTranslator exceptionTranslator;

    public SqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
        this(sqlSessionFactory, sqlSessionFactory.getConfiguration().getDefaultExecutorType());
    }

    public SqlSessionTemplate(SqlSessionFactory sqlSessionFactory, ExecutorType executorType) {
        this(sqlSessionFactory, executorType, new MyBatisExceptionTranslator(sqlSessionFactory.getConfiguration().getEnvironment().getDataSource(), true));
    }

    public SqlSessionTemplate(SqlSessionFactory sqlSessionFactory, ExecutorType executorType, PersistenceExceptionTranslator exceptionTranslator) {
        Assert.notNull(sqlSessionFactory, "Property 'sqlSessionFactory' is required");
        Assert.notNull(executorType, "Property 'executorType' is required");
        this.sqlSessionFactory = sqlSessionFactory;
        this.executorType = executorType;
        this.exceptionTranslator = exceptionTranslator;
        this.sqlSessionProxy = (SqlSession)Proxy.newProxyInstance(SqlSessionFactory.class.getClassLoader(), new Class[]{SqlSession.class}, new SqlSessionTemplate.SqlSessionInterceptor());
    }

    public SqlSessionFactory getSqlSessionFactory() {
        return this.sqlSessionFactory;
    }

    public ExecutorType getExecutorType() {
        return this.executorType;
    }

    public PersistenceExceptionTranslator getPersistenceExceptionTranslator() {
        return this.exceptionTranslator;
    }

    public <T> T selectOne(String statement) {
        //由真實的對象sqlSessionProxy執行查詢
        return this.sqlSessionProxy.selectOne(statement);
    }

    public <T> T selectOne(String statement, Object parameter) {
        //由真實的對象sqlSessionProxy執行查詢
        return this.sqlSessionProxy.selectOne(statement, parameter);
    }

    public <K, V> Map<K, V> selectMap(String statement, String mapKey) {
        //由真實的對象sqlSessionProxy執行查詢
        return this.sqlSessionProxy.selectMap(statement, mapKey);
    }

    public <K, V> Map<K, V> selectMap(String statement, Object parameter, String mapKey) {
        //由真實的對象sqlSessionProxy執行查詢
        return this.sqlSessionProxy.selectMap(statement, parameter, mapKey);
    }

    public <K, V> Map<K, V> selectMap(String statement, Object parameter, String mapKey, RowBounds rowBounds) {
        //由真實的對象sqlSessionProxy執行查詢
        return this.sqlSessionProxy.selectMap(statement, parameter, mapKey, rowBounds);
    }

    public <T> Cursor<T> selectCursor(String statement) {
        return this.sqlSessionProxy.selectCursor(statement);
    }

    public <T> Cursor<T> selectCursor(String statement, Object parameter) {
        return this.sqlSessionProxy.selectCursor(statement, parameter);
    }

    public <T> Cursor<T> selectCursor(String statement, Object parameter, RowBounds rowBounds) {
        return this.sqlSessionProxy.selectCursor(statement, parameter, rowBounds);
    }

    public <E> List<E> selectList(String statement) {
        return this.sqlSessionProxy.selectList(statement);
    }

    public <E> List<E> selectList(String statement, Object parameter) {
        return this.sqlSessionProxy.selectList(statement, parameter);
    }

    public <E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds) {
        return this.sqlSessionProxy.selectList(statement, parameter, rowBounds);
    }

    public void select(String statement, ResultHandler handler) {
        this.sqlSessionProxy.select(statement, handler);
    }

    public void select(String statement, Object parameter, ResultHandler handler) {
        this.sqlSessionProxy.select(statement, parameter, handler);
    }

    public void select(String statement, Object parameter, RowBounds rowBounds, ResultHandler handler) {
        this.sqlSessionProxy.select(statement, parameter, rowBounds, handler);
    }

    public int insert(String statement) {
        return this.sqlSessionProxy.insert(statement);
    }

    public int insert(String statement, Object parameter) {
        return this.sqlSessionProxy.insert(statement, parameter);
    }

    public int update(String statement) {
        return this.sqlSessionProxy.update(statement);
    }

    public int update(String statement, Object parameter) {
        return this.sqlSessionProxy.update(statement, parameter);
    }

    public int delete(String statement) {
        return this.sqlSessionProxy.delete(statement);
    }

    public int delete(String statement, Object parameter) {
        return this.sqlSessionProxy.delete(statement, parameter);
    }

    public <T> T getMapper(Class<T> type) {
        return this.getConfiguration().getMapper(type, this);
    }

    public void commit() {
        throw new UnsupportedOperationException("Manual commit is not allowed over a Spring managed SqlSession");
    }

    public void commit(boolean force) {
        throw new UnsupportedOperationException("Manual commit is not allowed over a Spring managed SqlSession");
    }

    public void rollback() {
        throw new UnsupportedOperationException("Manual rollback is not allowed over a Spring managed SqlSession");
    }

    public void rollback(boolean force) {
        throw new UnsupportedOperationException("Manual rollback is not allowed over a Spring managed SqlSession");
    }

    public void close() {
        throw new UnsupportedOperationException("Manual close is not allowed over a Spring managed SqlSession");
    }

    public void clearCache() {
        this.sqlSessionProxy.clearCache();
    }

    public Configuration getConfiguration() {
        return this.sqlSessionFactory.getConfiguration();
    }

    public Connection getConnection() {
        return this.sqlSessionProxy.getConnection();
    }

    public List<BatchResult> flushStatements() {
        return this.sqlSessionProxy.flushStatements();
    }

    public void destroy() throws Exception {
    }

    private class SqlSessionInterceptor implements InvocationHandler {
        private SqlSessionInterceptor() {
        }

        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
            SqlSession sqlSession = SqlSessionUtils.getSqlSession(SqlSessionTemplate.this.sqlSessionFactory, SqlSessionTemplate.this.executorType, SqlSessionTemplate.this.exceptionTranslator);

            Object unwrapped;
            try {
                Object result = method.invoke(sqlSession, args);
                if (!SqlSessionUtils.isSqlSessionTransactional(sqlSession, SqlSessionTemplate.this.sqlSessionFactory)) {
                    sqlSession.commit(true);
                }

                unwrapped = result;
            } catch (Throwable var11) {
                unwrapped = ExceptionUtil.unwrapThrowable(var11);
                if (SqlSessionTemplate.this.exceptionTranslator != null && unwrapped instanceof PersistenceException) {
                    SqlSessionUtils.closeSqlSession(sqlSession, SqlSessionTemplate.this.sqlSessionFactory);
                    sqlSession = null;
                    Throwable translated = SqlSessionTemplate.this.exceptionTranslator.translateExceptionIfPossible((PersistenceException)unwrapped);
                    if (translated != null) {
                        unwrapped = translated;
                    }
                }

                throw (Throwable)unwrapped;
            } finally {
                if (sqlSession != null) {
                    SqlSessionUtils.closeSqlSession(sqlSession, SqlSessionTemplate.this.sqlSessionFactory);
                }

            }

            return unwrapped;
        }
    }
}

咱們看到SqlSessionTemplate實現了SqlSession接口，那麼Mapper代理類中執行全部的數據庫操做，都是經過SqlSessionTemplate來執行，如上咱們看到全部的數據庫操做都由對象sqlSessionProxy執行查詢

靜態代理的使用

SqlSessionTemplate在內部訪問數據庫時，實際上是委派給sqlSessionProxy來執行數據庫操做的，SqlSessionTemplate不是自身從新實現了一套mybatis數據庫訪問的邏輯。

SqlSessionTemplate經過靜態代理機制來提供SqlSession接口的行爲，即實現SqlSession接口來獲取SqlSession的全部方法；SqlSessionTemplate的定義以下：標準的靜態代理實現模式，即實現SqlSession接口並在內部包含一個SqlSession接口實現類引用sqlSessionProxy。那咱們就要看看sqlSessionProxy這個SqlSession，咱們先來看看SqlSessionTemplate的構造方法

 public SqlSessionTemplate(SqlSessionFactory sqlSessionFactory, ExecutorType executorType, PersistenceExceptionTranslator exceptionTranslator) {
        Assert.notNull(sqlSessionFactory, "Property 'sqlSessionFactory' is required");
        Assert.notNull(executorType, "Property 'executorType' is required");
        this.sqlSessionFactory = sqlSessionFactory;
        this.executorType = executorType;
        this.exceptionTranslator = exceptionTranslator;
        this.sqlSessionProxy = (SqlSession)Proxy.newProxyInstance(SqlSessionFactory.class.getClassLoader(), new Class[]{SqlSession.class}, new SqlSessionTemplate.SqlSessionInterceptor());
    }

動態代理的使用

不是吧，又使用了動態代理？？真夠曲折的，那咱們接着看 new SqlSessionTemplate.SqlSessionInterceptor() 這個InvocationHandler

private class SqlSessionInterceptor implements InvocationHandler {
    //很奇怪，這裏並無真實目標對象？
    private SqlSessionInterceptor() {
    }

    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        // 獲取一個sqlSession來執行proxy的method對應的SQL,
        // 每次調用都獲取建立一個sqlSession線程局部變量，故不一樣線程相互不影響，在這裏實現了SqlSessionTemplate的線程安全性
        SqlSession sqlSession = SqlSessionUtils.getSqlSession(SqlSessionTemplate.this.sqlSessionFactory, SqlSessionTemplate.this.executorType, SqlSessionTemplate.this.exceptionTranslator);

        Object unwrapped;
        try {
            //直接經過新建立的SqlSession反射調用method
            //這也就解釋了爲何不須要目標類屬性了，這裏每次都會建立一個
            Object result = method.invoke(sqlSession, args);
            // 若是當前操做沒有在一個Spring事務中，則手動commit一下
            // 若是當前業務沒有使用@Transation,那麼每次執行了Mapper接口的方法直接commit
            // 還記得咱們前面講的Mybatis的一級緩存嗎，這裏一級緩存不能起做用了，由於每執行一個Mapper的方法，sqlSession都提交了
            // sqlSession提交，會清空一級緩存
            if (!SqlSessionUtils.isSqlSessionTransactional(sqlSession, SqlSessionTemplate.this.sqlSessionFactory)) {
                sqlSession.commit(true);
            }

            unwrapped = result;
        } catch (Throwable var11) {
            unwrapped = ExceptionUtil.unwrapThrowable(var11);
            if (SqlSessionTemplate.this.exceptionTranslator != null && unwrapped instanceof PersistenceException) {
                SqlSessionUtils.closeSqlSession(sqlSession, SqlSessionTemplate.this.sqlSessionFactory);
                sqlSession = null;
                Throwable translated = SqlSessionTemplate.this.exceptionTranslator.translateExceptionIfPossible((PersistenceException)unwrapped);
                if (translated != null) {
                    unwrapped = translated;
                }
            }

            throw (Throwable)unwrapped;
        } finally {
            if (sqlSession != null) {
                SqlSessionUtils.closeSqlSession(sqlSession, SqlSessionTemplate.this.sqlSessionFactory);
            }

        }
        return unwrapped;
    }
}

這裏大概講一下Mapper代理類調用方法執行邏輯：

一、SqlSessionTemplate生成Mapper代理類時，將自己傳進去作爲Mapper代理類的屬性，調用Mapper代理類的方法時，最後會經過SqlSession類執行，也就是調用SqlSessionTemplate中的方法。

二、SqlSessionTemplate中操做數據庫的方法中又交給了sqlSessionProxy這個代理類去執行，那麼每次執行的方法都會回調其SqlSessionInterceptor這個InvocationHandler的invoke方法

三、在invoke方法中，爲每一個線程建立一個新的SqlSession，並經過反射調用SqlSession的method。這裏sqlSession是一個線程局部變量，不一樣線程相互不影響，實現了SqlSessionTemplate的線程安全性

四、若是當前操做並無在Spring事務中，那麼每次執行一個方法，都會提交，至關於數據庫的事務自動提交，Mysql的一級緩存也將不可用

接下來咱們還要看一個地方，invoke中是如何建立SqlSession的？

public static SqlSession getSqlSession(SqlSessionFactory sessionFactory, ExecutorType executorType, PersistenceExceptionTranslator exceptionTranslator) {
    Assert.notNull(sessionFactory, "No SqlSessionFactory specified");
    Assert.notNull(executorType, "No ExecutorType specified");
    //經過TransactionSynchronizationManager內部的ThreadLocal中獲取
    SqlSessionHolder holder = (SqlSessionHolder)TransactionSynchronizationManager.getResource(sessionFactory);
    SqlSession session = sessionHolder(executorType, holder);
    if(session != null) {
        return session;
    } else {
        if(LOGGER.isDebugEnabled()) {
            LOGGER.debug("Creating a new SqlSession");
        }
        //這裏咱們知道其實是建立了一個DefaultSqlSession
        session = sessionFactory.openSession(executorType);
        //將建立的SqlSession對象放入TransactionSynchronizationManager內部的ThreadLocal中
        registerSessionHolder(sessionFactory, executorType, exceptionTranslator, session);
        return session;
    }
}

經過sessionFactory.openSession(executorType)實際建立的SqlSession仍是DefaultSqlSession。若是讀過我前面Spring源碼的朋友，確定知道TransactionSynchronizationManager這個類，其內部維護了一個ThreadLocal的Map，這裏同一線程建立了SqlSession後放入ThreadLocal中，同一線程中其餘Mapper接口調用方法時，將會直接從ThreadLocal中獲取。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程