手寫MyBatis起步依賴

spring-boot起步依賴

  • 自動整合第三方組件 與 spring/springMVC框架
  • 起步依賴本質(zhì)就是 利用spring spi機制，將組件的配置類，有spring框架在符合條件時，自動完成配置類的實例化。
  • 然后在配置類中使用JavaConfig方式（編寫代碼的方式），完成對組件的配置（故：組件配置類編寫時，可以參考xml方式配置，進行實例化一些bean對象，并給bean設(shè)置對應(yīng)的屬性值）

spring spi機制

  • Java中自帶了所謂SPI機制，按照約定去META-INF/services目錄里找各個接口的配置文件，找到接口的實現(xiàn)類，然后使用當(dāng)前線程上線文類加載器定位到實現(xiàn)類加載器，通過其加載實現(xiàn)類，然后再反射newInstance得到實現(xiàn)類的實例。
  • Spring里也有類似的SPI，思路與上面類似，從classpath下所有jar包的META-INF/spring.factories 配置文件中加載標(biāo)識為EnableAutoConfiguration的配置類，然后將其中定義的bean注入到Spring容器。

起步依賴基本原理

  • 通過MEAT-INF/spring.factories文件，配置自己的 自動裝配類。
  • spring在啟動過程中，會自動掃描spring.factories文件，并將里面配置的自動裝配類進行實例化到spring容器中。
  • 通過自動裝配類中的 @Configuration注解 + @Bean注解（注解在自動裝配類里面的方法上），將組件需要交給Spring容器管理的Bean對象，注入到Spring容器中。
  • 當(dāng)組件的關(guān)鍵Bean對象注入到Spring容器中后，后續(xù)代碼中可以直接使用。

spring-boot起步依賴約定

  1. 命名規(guī)則：
  • 官方提供：spring-boot-starter-xxx，如：spring-boot-starter-web
  • 第三方提供：xxx-spring-boot-starter，如：mybatis-spring-boot-starter

示例

  • 以配置MyBatis與spring框架為例。寫一個自己的MyBatis起步依賴。

起步依賴項目（selfmybatis-spring-boot-starter）

  1. 新建一個springboot項目，并添加：MyBatis、MyBatis與spring支持、Druid數(shù)據(jù)庫連接池、spring事務(wù)依賴
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.6</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>self.mybatis</groupId>
    <artifactId>selfmybatis-spring-boot-starter</artifactId>
    <version>1.0.1</version>
    <name>selfmybatis-spring-boot-starter</name>
    <description>Demo project for Spring Boot Starter</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

        <!-- spring-jdbc spring事務(wù) -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>5.2.18.RELEASE</version>
        </dependency>

        <!-- mybatis-spring Spring集成MyBatis依賴 -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>2.0.6</version>
        </dependency>
        <!-- mybatis依賴 -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.7</version>
        </dependency>
        <!-- druid 阿里巴巴數(shù)據(jù)庫連接池 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.9</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>
  1. 編寫加載application.properties配置信息的類
package self.mybatis.config;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "self.datasource")
@Data
public class SelfMyBatisProperties {
    private String url;
    private String user;
    private String pwd;
    private int maxActive = 5;
    private String mapperLocations;
    private String basePackage;
}
  1. 編寫自動裝配類
package self.mybatis.config;

import com.alibaba.druid.pool.DruidDataSource;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.mapper.MapperScannerConfigurer;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;

import java.io.IOException;

// 表示該類，是一個配置類
@Configuration
// 當(dāng)classpath下存在SqlSessionFactory.class文件時，才進入實例化該配置自動裝配類
@ConditionalOnClass(SqlSessionFactory.class)
// 將SelfMyBatisProperties配置類，啟用進來。
@EnableConfigurationProperties(SelfMyBatisProperties.class)
public class SelfMyBatisAutoConfiguration {
  
    // 配置Druid數(shù)據(jù)庫連接池
    @Bean(name = "dataSource", initMethod = "init", destroyMethod = "close")
    public DruidDataSource dataSource(SelfMyBatisProperties properties) {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setUrl(properties.getUrl());
        dataSource.setUsername(properties.getUser());
        dataSource.setPassword(properties.getPwd());
        dataSource.setMaxActive(properties.getMaxActive());
        return dataSource;
    }
    
    // 配置SqlSessionFactoryBean對象
    @Bean(name = "sessionFactory")
    public SqlSessionFactoryBean sessionFactory(DruidDataSource dataSource, SelfMyBatisProperties properties) {
        SqlSessionFactoryBean sessionFactoryBean = new SqlSessionFactoryBean();
        sessionFactoryBean.setDataSource(dataSource);

        // 配置MyBatis的mappers路徑
        PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        try {
            Resource[] resources = resolver.getResources(properties.getMapperLocations());
            sessionFactoryBean.setMapperLocations(resources);
        } catch (IOException e) {
            e.printStackTrace();
        }

        // 配置MyBatis的日志輸出類
        org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration();
        configuration.setLogImpl(org.apache.ibatis.logging.stdout.StdOutImpl.class);
        sessionFactoryBean.setConfiguration(configuration);

        return sessionFactoryBean;
    }
  
    // 配置Dao接口文件掃描配置，這個也可不配置，使用@MapperScan注解完成。
    // @MapperScan注解，在使用該起步依賴的項目中的啟動類上或配置類上即可。
    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer(Environment env) {
        MapperScannerConfigurer configurer = new MapperScannerConfigurer();
        // 這里使用spring的Environment來獲取配置，不知道為啥，這里通過SelfMyBatisProperties這個配置類，讀取不到配置信息。
        // 網(wǎng)上說：因為這個MapperScannerConfigurer類加載早于SelfMyBatisProperties配置類注入。
        configurer.setBasePackage(env.getProperty("self.datasource.base-package"));
        configurer.setSqlSessionFactoryBeanName("sessionFactory");
        return configurer;
    }

    // 配置 Spring的事務(wù)管理器
    @Bean
    public DataSourceTransactionManager dataSourceTransactionManager(DruidDataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }
}
  1. 在src/main/resources/META-INF目錄下，配置spring.factories文件，將SelfMyBatisAutoConfiguration作為自動裝配類。(META-INF目錄自己建一個就可以）
org.springframework.boot.autoconfigure.EnableAutoConfiguration=self.mybatis.config.SelfMyBatisAutoConfiguration

測試起步依賴項目（新建另一個spring-boot項目）

  1. 新建一個用來測試起步依賴的項目，并在pom中加入需要的依賴
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.6</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>test.springboot.thymeleaf</groupId>
    <artifactId>springboot-thymeleaf</artifactId>
    <version>1.0.1</version>
    <name>springboot-thymeleaf</name>
    <description>Test Self MyBatis Starter for Spring Boot</description>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
         <!-- 注釋掉官方提供的起步依賴 -->
        <!--<dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
          </dependency>-->
        <!-- mysql連接驅(qū)動 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>self.mybatis</groupId>
            <artifactId>selfmybatis-spring-boot-starter</artifactId>
            <version>1.0.1</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>test/springboot/thymeleaf/dao/**/*.xml</include>
                </includes>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                </includes>
            </resource>
        </resources>
    </build>
</project>
  1. 在application.properties中添加self.datasource配置項
#官方MyBatis配置（注釋掉）
#mybatis.mapper-locations=classpath:/gk/springboot/thymeleaf/dao/mapper/**/*.xml
#mybatis.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
##使用Druid數(shù)據(jù)庫連接池
#spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
#spring.datasource.url=jdbc:mysql://localhost:3306/book
#spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

#自定義self配置信息
gk.datasource.base-package=gk.springboot.thymeleaf.dao
gk.datasource.driver-name=com.mysql.cj.jdbc.Driver
gk.datasource.mapper-locations=classpath:/self/springboot/thymeleaf/dao/mapper/**/*.xml
gk.datasource.max-active=5
gk.datasource.pwd=root
gk.datasource.url=jdbc:mysql://localhost:3306/book
gk.datasource.user=root

  1. 寫代碼，測試?？礈y試結(jié)果


    測試結(jié)果圖

問題

  • MapperScannerConfigurer這個Bean創(chuàng)建方法里，讀取的SelfMyBatisProperties配置信息全是null？有哪位大神留言解答一下。謝謝
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容