SSM整合之使用配置類替換xml配置檔案(2)

Evan1024發表於2024-03-03
SSMXML

SSM整合就是將MVC三層架構和框架核心API元件交給SpringIoC容器管理！
一般需要配置兩個IoC容器進行三層架構元件管理。

容器名 盛放元件
web容器 web相關元件（controller,springmvc核心元件）
root容器 業務和持久層相關元件（service,aop,tx,dataSource,mybatis,mapper等）

web容器是root容器的子容器，父子容器關係。
父容器：root容器，盛放service、mapper、mybatis等相關元件
子容器：web容器，盛放controller、web相關元件

根據MVC三層架構配置三個配置類：

配置名 對應內容 對應容器
SpringMvcConfig controller,springmvc相關 web容器
SpringConfig service,aop,tx相關 root容器
MapperConfig mapper,datasource,mybatis相關 root容器

配置演示

控制層配置(SpringMVC)

主要配置Web工程的controller層配置

@Configurable
@ComponentScan(basePackages = {"com.evan.controller","com.evan.exceptionhandler"})
@EnableWebMvc
public class SpringMvcConfig implements WebMvcConfigurer {

    //開啟靜態資源訪問
    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

    //檢視解析器
    @Override
    public void configureViewResolvers(ViewResolverRegistry registry) {
        registry.jsp("/WEB-INF/views","jsp");
    }

    //配置檢視控制器
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/")
                .setStatusCode(HttpStatusCode.valueOf(200))
                .setViewName("index");
    }
}

業務層元件配置(Spring)

主要配置service,註解aop和宣告事務相關配置

@Configurable
@ComponentScan(basePackages = {"com.evan.service"})
@EnableAspectJAutoProxy
@EnableTransactionManagement
public class SpringConfig {

    //配置事務管理器
    @Bean
    public TransactionManager transactionManager(DataSource dataSource) {
        DataSourceTransactionManager transactionManager = new DataSourceTransactionManager();
        transactionManager.setDataSource(dataSource);
        return transactionManager;
    }

}

持久層配置(MyBatis)

主要配置mapper代理物件，連線池和mybatis核心元件配置

外部資料庫連線配置檔案

jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.username=root
jdbc.password=******
jdbc.url=jdbc://mysql://localhost:3306/dbtest1?serverTimezone=GMT%2B8&characterEncoding=utf-8
配置方式1(保留mybatis-config.xml)

依然保留mybatis的外部配置檔案（xml）, 但是資料庫連線資訊交給Druid連線池配置！
缺點：依然需要mybatis-config.xml檔案，進行xml檔案解析，效率偏低！
mybatis-config.xml

資料庫資訊以及mapper掃描包設定使用Java配置類處理！
mybatis其他的功能（別名、settings、外掛等資訊）依然在mybatis-config.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>
    <settings>
        <!-- 開啟駝峰式對映-->
        <setting name="mapUnderscoreToCamelCase" value="true"/>
        <!-- 開啟logback日誌輸出-->
        <setting name="logImpl" value="SLF4J"/>
        <!--開啟resultMap自動對映 -->
        <setting name="autoMappingBehavior" value="FULL"/>
    </settings>

    <typeAliases>
        <!-- 給實體類起別名 -->
        <package name="com.evan.bean"/>
    </typeAliases>

    <plugins>
        <plugin interceptor="com.github.pagehelper.PageInterceptor">
            <!--
                helperDialect：分頁外掛會自動檢測當前的資料庫連結，自動選擇合適的分頁方式。
                你可以配置helperDialect屬性來指定分頁外掛使用哪種方言。配置時，可以使用下面的縮寫值：
                oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012,derby
                （完整內容看 PageAutoDialect） 特別注意：使用 SqlServer2012 資料庫時，
                https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md#%E5%A6%82%E4%BD%95%E9%85%8D%E7%BD%AE%E6%95%B0%E6%8D%AE%E5%BA%93%E6%96%B9%E8%A8%80
             -->
            <property name="helperDialect" value="mysql"/>
        </plugin>
    </plugins>
</configuration>

持久層配置類

/**
 * @Author: lisong
 * @CreateTime: 2024-03-03 18:41 星期日
 * @Description:
 */
@Configurable
public class MyBatisConfig {

    //配置用於建立SqlSessionFactory的工廠bean
    @Bean
    public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource) {
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        // 設定資料來源
        sqlSessionFactoryBean.setDataSource(dataSource);
        // 設定MyBatis配置檔案的路徑
        Resource resource = new ClassPathResource("mybatis-config.xml");
        sqlSessionFactoryBean.setMapperLocations(resource);
        //設定實體類物件別名
        sqlSessionFactoryBean.setTypeAliasesPackage("com.evan.bean");
        return sqlSessionFactoryBean;
    }

    /**
     * 配置mapper介面的掃描配置
     * 由mybatis-spring提供，可以將指定包下所有的mapper介面建立動態代理
     * 並將這些動態代理作為IOC容器的bean管理
     * @return
     */
    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer() {
        MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
        //設定mapper介面和xml檔案所在的共同包
        mapperScannerConfigurer.setBasePackage("com.evan.mapper");
        return mapperScannerConfigurer;
    }
}

說明：
在Spring配置類中新增了sqlSessionFactoryBean、mapperScannerConfigurer和datasource配置方法時，可能會導致@Value註解讀取不到值為null的問題。
這是因為SqlSessionFactoryBean和MapperScannerConfigurer是基於MyBatis框架的配置，它們的初始化順序可能會導致屬性注入的問題。
SqlSessionFactoryBean和MapperScannerConfigurer在配置類中通常是用來配置MyBatis相關的Bean，例如資料來源、事務管理器、Mapper掃描等。這些配置類通常在@Configuration註解下定義，並且使用@Value註解來注入屬性值。
當配置類被載入時，Spring容器會首先處理Bean的定義和初始化，其中包括sqlSessionFactoryBean和mapperScannerConfigurer的初始化。在這個過程中，如果@Value註解所在的Bean還沒有被完全初始化，可能會導致注入的屬性值為null。
解決方案：
分成兩個配置類獨立配置，互不影響，資料庫提取一個配置類，mybatis提取一個配置類即可解決！

資料庫配置類

@Configurable
@PropertySource("classpath:jdbc.properties")
public class DataSourceConfig {

    @Value("${jdbc.url}")
    private String url;
    @Value("${jdbc.driver}")
    private String driver;
    @Value("${jdbc.username}")
    private String username;
    @Value("${jdbc.password}")
    private String password;

    //配置資料來源
    @Bean
    public DataSource dataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driver);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }
}
配置方式2(完全配置類，去掉mybatis-config.xml)

不在保留mybatis的外部配置檔案（xml）, 所有配置資訊（settings、外掛、別名等）全部在宣告SqlSessionFactoryBean的程式碼中指定！資料庫資訊依然使用DruidDataSource例項替代！
優勢：全部配置類，避免了XML檔案解析效率低問題！
mapper配置類

@Configurable
public class MapperConfig {

    //配置用於建立SqlSessionFactory的工廠bean
    @Bean
    public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource) {
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setDataSource(dataSource);
        //Resource resource = new ClassPathResource("mybatis-config.xml");
        //sqlSessionFactoryBean.setMapperLocations(resource);

        //全域性配置項,不要導錯包
        //org.apache.ibatis.session.Configuration
        Configuration configuration = new Configuration();
        //開啟駝峰式對映
        configuration.setMapUnderscoreToCamelCase(true);
        //開啟logback日誌輸出
        configuration.setLogImpl(Slf4jImpl.class);
        //開啟resultMap自動對映
        configuration.setAutoMappingBehavior(AutoMappingBehavior.FULL);
        sqlSessionFactoryBean.setConfiguration(configuration);

        //實體類物件別名設定
        sqlSessionFactoryBean.setTypeAliasesPackage("com.evan.bean");

        //分頁外掛配置
        PageInterceptor pageInterceptor = getPageInterceptor();
        sqlSessionFactoryBean.addPlugins(pageInterceptor);
        return sqlSessionFactoryBean;
    }

    //分頁外掛配置資訊
    private static PageInterceptor getPageInterceptor() {
        PageInterceptor pageInterceptor = new PageInterceptor();
        Properties properties = new Properties();
        /*
        helperDialect：分頁外掛會自動檢測當前的資料庫連結，自動選擇合適的分頁方式。
        你可以配置helperDialect屬性來指定分頁外掛使用哪種方言。配置時，可以使用下面的縮寫值：
        oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012,derby
        （完整內容看 PageAutoDialect） 特別注意：使用 SqlServer2012 資料庫時，
        https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md#%E5%A6%82%E4%BD%95%E9%85%8D%E7%BD%AE%E6%95%B0%E6%8D%AE%E5%BA%93%E6%96%B9%E8%A8%80
        */
        properties.setProperty("helperDialect","mysql");
        pageInterceptor.setProperties(properties);
        return pageInterceptor;
    }

    //配置Mapper例項掃描工廠,配置掃描package需要介面和mapper.xml檔案同一個包
    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer() {
        MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
        //設定mapper介面和xml檔案所在的共同包
        mapperScannerConfigurer.setBasePackage("com.evan.mapper");
        return mapperScannerConfigurer;
    }
}

配置web專案初始化類

public class WebInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {

    //指定root IoC容器的配置類
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{SpringConfig.class, MyBatisConfig.class, DataSourceConfig.class};
    }

    //指定web IoC容器的配置類
    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }

    //DispatcherServlet請求分發的匹配路徑
    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
}

圖解配置類和容器配置:
image

相關文章