SSM整合

SSM整合.png

微观：将学习的Spring SpringMVC Mybatis框架应用到项目中!

SpringMVC框架负责控制层
Spring 框架负责整体和业务层的声明式事务管理
MyBatis框架负责数据库访问层

宏观：Spring接管一切（将框架核心组件交给Spring进行IoC管理），代码更加简洁。

SpringMVC管理表述层、SpringMVC相关组件
Spring管理业务层、持久层、以及数据库相关（DataSource,MyBatis）的组件
使用IoC的方式管理一切所需组件

实施：通过编写配置文件，实现SpringIoC容器接管一切组件。

两个容器

web容器
- Controller
- HandlerMapping
- HandlerAdapter
- ……web相关组件
root容器
- Service
  - Service层
  - AOP相关组件
  - TX相关组件
- Mapper
  - Mapper层
  - DataSource
  - MyBatis相关组件

学过SpringIoC容器，我们知道，两个容器之间的组件无法相互引用，也就是Controller无法调用Service的内容

为了解决这个问题，在初始化SpringMVC的时候，将web容器作为root容器的子容器，呈现父子关系

这样，作为子容器中的组件controller就能正常引用父容器的组件Service了

三个配置类

为了脉络清晰，我们准备三个配置类：

WebJavaConfig.java
ServiceJavaConfig.java
MapperJavaConfig.java

最后将WebJavaConfig.java初始化web容器

将ServiceJavaConfig.java和MapperJavaConfig.java初始化进root容器中即可

我们也可以每一个功能都单独写一个配置类，AOP写一个，TX也写一个，DataSource写一个，MyBatis写一个

但是无论写多少个配置类，最后我们按照规则放到响应的两个容器中，即可正常使用了

注：如果将DataSource与MyBatis配置类写到一起会出现问题，具体看后文

配置初始化

前文提到过，通过自定义初始化类继承AbstractAnnotationConfigDispatcherServletInitializer实现类后重写方法，即可完成对两个容器的配置和初始化

具体的内容请看：

笔记 -> SSM -> SpringMVC -> WebApplicationInitializer接口（祖宗）& 用户自定义初始化类

依赖整合

spring
- ioc/di
  - spring-context
  - jakarta.annotation-api：使用@PostConstruct和@ProDestroy还有@Resource注解的所需依赖
- aop
  - spring-aspects
- tx
  - spring-tx
  - spring-jdbc：用以对tx的实现
SpringMVC
- spring-webmvc
- jakarta.jakartaee-web-api：Servlet所需依赖
- jackson-databind：JSON处理所需依赖
- 校验注解
  - hibernate-validator
  - hibernate-validator-annotation-processor
MyBatis
- mybatis
- mysql
- pagehelper：mybatis的插件，用以实现翻页功能
整合需要
- 此处需要导入spring-web以正常初始化加载spring容器，但此依赖被spring-webmvc依赖传递，所以无需重复导入
- mybatis-spring：提供MyBatis的FactoryBean
- Druid：德鲁伊连接池
- lombok：实体类的getter/setter……生成
- logback：用以处理MyBatis的日志输出
- slf4j：本来应该被logback依赖传递导入到项目中，但我一直报错，导入就好了

<dependencies>
    <!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>6.1.10</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/jakarta.annotation/jakarta.annotation-api -->
    <dependency>
        <groupId>jakarta.annotation</groupId>
        <artifactId>jakarta.annotation-api</artifactId>
        <version>3.0.0</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.springframework/spring-aspects -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aspects</artifactId>
        <version>6.1.10</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.springframework/spring-tx -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-tx</artifactId>
        <version>6.1.10</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.springframework/spring-webmvc -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>6.1.10</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/jakarta.platform/jakarta.jakartaee-web-api -->
    <dependency>
        <groupId>jakarta.platform</groupId>
        <artifactId>jakarta.jakartaee-web-api</artifactId>
        <version>10.0.0</version>
        <scope>provided</scope>
    </dependency>
    <!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>2.17.1</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator -->
    <dependency>
        <groupId>org.hibernate.validator</groupId>
        <artifactId>hibernate-validator</artifactId>
        <version>8.0.1.Final</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator-annotation-processor -->
    <dependency>
        <groupId>org.hibernate.validator</groupId>
        <artifactId>hibernate-validator-annotation-processor</artifactId>
        <version>8.0.1.Final</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.16</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/com.mysql/mysql-connector-j -->
    <dependency>
        <groupId>com.mysql</groupId>
        <artifactId>mysql-connector-j</artifactId>
        <version>8.4.0</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/com.github.pagehelper/pagehelper -->
    <dependency>
        <groupId>com.github.pagehelper</groupId>
        <artifactId>pagehelper</artifactId>
        <version>6.1.0</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis-spring -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis-spring</artifactId>
        <version>3.0.3</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/com.alibaba/druid -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>1.2.23</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.32</version>
        <scope>provided</scope>
    </dependency>
    <!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-classic -->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.5.6</version>
        <scope>test</scope>
    <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-api -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>2.0.13</version>
        </dependency>
    </dependency>

</dependencies>

logback.xml

这是一个全新的插件，用于输出日志的工具

每个公司都会提供自己的logback.xml，将其放在resources文件夹下即可

在这里，尚硅谷提供了一个logback.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="true">
    <!-- 指定日志输出的位置，ConsoleAppender表示输出到控制台 -->
    <appender name="STDOUT"
              class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!-- 日志输出的格式 -->
            <!-- 按照顺序分别是：时间、日志级别、线程名称、打印日志的类、日志主体内容、换行 -->
            <pattern>[%d{HH:mm:ss.SSS}] [%-5level] [%thread] [%logger] [%msg]%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 设置全局日志级别。日志级别按顺序分别是：TRACE、DEBUG、INFO、WARN、ERROR -->
    <!-- 指定任何一个日志级别都只打印当前级别和后面级别的日志。 -->
    <root level="DEBUG">
        <!-- 指定打印日志的appender，这里通过“STDOUT”引用了前面配置的appender -->
        <appender-ref ref="STDOUT" />
    </root>

    <!-- 根据特殊需求指定局部日志级别，可也是包名或全类名。 -->
    <logger name="com.xiaobai.mybatis" level="DEBUG" />

</configuration>

MyBatis整合

在之前，我们想要使用MyBatis的时候，需要以下的步骤来完成

//1.读取外部配置文件
InputStream ips = Resources.getResourceAsStream("mybatis-config.xml");

//2.创建sqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(ips);

//3.创建sqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
//4.获取mapper代理对象
EmpMapper empMapper = sqlSession.getMapper(EmpMapper.class);
//5.数据库方法调用
int rows = empMapper.deleteEmpById(1);
System.out.println("rows = " + rows);
//6.提交和回滚
sqlSession.commit();
sqlSession.close();

SqlSessionFactoryBuilder

这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。
因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。无需ioc容器管理！
SqlSessionFactory

一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，因此 SqlSessionFactory 的最佳作用域是应用作用域。 需要ioc容器管理！
SqlSession

每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。无需ioc容器管理！
Mapper映射器实例

映射器是一些绑定映射语句的接口。映射器接口的实例是从 SqlSession 中获得的。虽然从技术层面上来讲，任何映射器实例的最大作用域与请求它们的 SqlSession 相同。但方法作用域才是映射器实例的最合适的作用域。

从作用域的角度来说，映射器实例不应该交给ioc容器管理！

但是从使用的角度来说，业务类（service）需要注入mapper接口，所以mapper应该交给ioc容器管理！
总结
- 将SqlSessionFactory实例存储到IoC容器
- 将Mapper实例存储到IoC容器

使用mybatis-spring提供的工厂Bean

package org.mybatis.spring;

public class SqlSessionFactoryBean
    implements FactoryBean<SqlSessionFactory>, InitializingBean, ApplicationListener<ContextRefreshedEvent> {
    
   //封装了实例化流程
   public SqlSessionFactory getObject() throws Exception {
      if (this.sqlSessionFactory == null) {
        //实例化对象逻辑
        afterPropertiesSet();
      }
      //返回对象逻辑
      return this.sqlSessionFactory;
   }
   ……
}

保留mybatis-config.xml

我们可以保留此xml配置文件，但如果想要让Druid接管数据库连接池，则需要单独使用jdbc.properties

在mybatis-config.xml中不再声明jdbc四大件和扫描mapper包（mapper包的扫描由配置类接管）

使用mybatis-spring提供的SqlSessionFactoryBean直接将sqlSessionFactory对象注入到IoC容器中

import com.alibaba.druid.pool.DruidDataSource;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.mapper.MapperScannerConfigurer;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;

import javax.sql.DataSource;

/**
 * 此类为Mapper层的配置文件，可用以替换掉mybatis-config.xml
 */
@Configuration
@PropertySource("classpath:jdbc.properties") // 导入jdbc配置文件
public class MapperJavaConfig {
    /**
     * 创建Druid连接池，以@Value注解修饰形参列表的方式读取jdbc.properties文件中内容
     *
     * @param driver   驱动
     * @param url      url
     * @param username 数据库用户名
     * @param password 数据库密码
     * @return Druid连接池对象
     */
    @Bean
    public DataSource dataSource(
            @Value("${jdbc.driver}")
            String driver,
            @Value("${jdbc.url}")
            String url,
            @Value("${jdbc.username}")
            String username,
            @Value("${jdbc.password}")
            String password
    ) {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driver);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }

    /**
     * @param dataSource 从IoC容器中拿连接池对象
     * @return sqlSessionFactoryBean对象，取代sqlSessionFactory，用于生成sqlSession
     * @throws Exception
     */
    @Bean
    public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource) throws Exception {
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setDataSource(dataSource); // 将Druid连接池配置到MyBatis中
        Resource resource = new ClassPathResource("mybatis-config.xml");// 将mybatis-config.xml配置到MyBatis中
        sqlSessionFactoryBean.setConfigLocation(resource);
        return sqlSessionFactoryBean;
    }

    /**
     * 此方法扫描包，生成mapper加入IoC容器中，取代了mybatis-config.xml的扫描包步骤
     *
     * @return mapperScannerConfigurer对象到IoC容器中
     */
    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer() {
        MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
        mapperScannerConfigurer.setBasePackage("com.xiaobai.mapper");
        return mapperScannerConfigurer;
    }
}

抽取DataSource！！！*

但此配置类存在问题：如果将dataSource和mybatis的组件配置到一起，就会存在@Value注解不生效的问题

因为MyBatis组件比@Value注解先执行，就会导致DataSource四大件是空的

解决方案就是将DataSource抽出来，作为单独配置类

或者直接不适用@Value注解，不通过外部配置文件，就不用单独抽取DataSource

package com.xiaobai.config;

import com.alibaba.druid.pool.DruidDataSource;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

@Configuration
@PropertySource("classpath:jdbc.properties") // 导入jdbc配置文件
public class DataSourceJavaConfig {
    /**
     * 创建Druid连接池，以@Value注解修饰形参列表的方式读取jdbc.properties文件中内容
     *
     * @param driver   驱动
     * @param url      url
     * @param username 数据库用户名
     * @param password 数据库密码
     * @return Druid连接池对象
     */
    @Bean
    public DataSource dataSource(
            @Value("${jdbc.driver}")
            String driver,
            @Value("${jdbc.url}")
            String url,
            @Value("${jdbc.username}")
            String username,
            @Value("${jdbc.password}")
            String password
    ) {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driver);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }
}

不保留mybatis-config.xml（完全配置类）*

删除以下两行代码，改为单独配置，实现配置类替换mybatis.config.xml

1 2	`Resource resource = new ClassPathResource("mybatis-config.xml");// 将mybatis-config.xml配置到MyBatis中 sqlSessionFactoryBean.setConfigLocation(resource);`

Setting标签

注：这里的configuration是org.apache.ibatis.session.Configuration，别导错包！！！

<settings>
    <!-- 开启驼峰式映射-->
    <setting name="mapUnderscoreToCamelCase" value="true"/>
    <!-- 开启logback日志输出-->
    <setting name="logImpl" value="SLF4J"/>
    <!--开启resultMap自动映射 -->
    <setting name="autoMappingBehavior" value="FULL"/>
</settings>

org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration();
configuration.setMapUnderscoreToCamelCase(true); // 开启驼峰式映射
configuration.setLogImpl(Slf4jImpl.class); // 开启logback日志输出
configuration.setAutoMappingBehavior(AutoMappingBehavior.FULL); // 开启resultMap自动映射
sqlSessionFactoryBean.setConfiguration(configuration);

typeAliases标签

<typeAliases>
    <!-- 给实体类起别名 -->
    <package name="com.atguigu.pojo"/>
</typeAliases>

1	`sqlSessionFactoryBean.setTypeAliasesPackage("com.xiaobai.pojo"); // 给实体类起别名`

plugins标签

<plugins>
    <!--配置分页插件-->
    <plugin interceptor="com.github.pagehelper.PageInterceptor">
        <property name="helperDialect" value="mysql"/>
    </plugin>
</plugins>

// 替换plugins标签，配置分页插件
PageInterceptor pageInterceptor = new PageInterceptor();
Properties properties = new Properties();
properties.setProperty("helperDialect", "mysql");   // 准备一个properties对象
pageInterceptor.setProperties(properties);
sqlSessionFactoryBean.addPlugins(pageInterceptor);

MapperJavaConfig

package com.xiaobai.config;

import com.github.pagehelper.PageInterceptor;
import org.apache.ibatis.logging.slf4j.Slf4jImpl;
import org.apache.ibatis.session.AutoMappingBehavior;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.mapper.MapperScannerConfigurer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

import javax.sql.DataSource;
import java.util.Properties;

/**
 * 此类为Mapper层的配置文件，可用以替换掉mybatis-config.xml
 */
@Configuration
public class MapperJavaConfig {


    /**
     * @param dataSource 从IoC容器中拿连接池对象
     * @return sqlSessionFactoryBean对象，取代sqlSessionFactory，用于生成sqlSession
     * @throws Exception
     */
    @Bean
    public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource) throws Exception {
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setDataSource(dataSource); // 将Druid连接池配置到MyBatis中

        // 替换Setting标签
        org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration();
        configuration.setMapUnderscoreToCamelCase(true); // 开启驼峰式映射
        configuration.setLogImpl(Slf4jImpl.class); // 开启logback日志输出
        configuration.setAutoMappingBehavior(AutoMappingBehavior.FULL); // 开启resultMap自动映射
        sqlSessionFactoryBean.setConfiguration(configuration);

        // 替换typeAliases标签
        sqlSessionFactoryBean.setTypeAliasesPackage("com.xiaobai.pojo"); // 给实体类起别名

        // 替换plugins标签，配置分页插件
        PageInterceptor pageInterceptor = new PageInterceptor();
        Properties properties = new Properties();
        properties.setProperty("helperDialect", "mysql");   // 准备一个properties对象
        pageInterceptor.setProperties(properties);

        return sqlSessionFactoryBean;
    }

    /**
     * 此方法扫描包，生成mapper加入IoC容器中，取代了mybatis-config.xml的扫描包步骤
     *
     * @return mapperScannerConfigurer对象到IoC容器中
     */
    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer() {
        MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
        mapperScannerConfigurer.setBasePackage("com.xiaobai.mapper");
        return mapperScannerConfigurer;
    }
}

项目初始化

接下来就是将所有的配置类放到AbstractAnnotationConfigDispatcherServletInitializer

简称AACD进行初始化了（这破🪝八名字真TM的长）

import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

/**
 * springMVC的初始化类
 */
public class SpringIoCInit extends AbstractAnnotationConfigDispatcherServletInitializer {
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{DataSourceJavaConfig.class, MapperJavaConfig.class, ServiceJavaConfig.class};
    }

    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{WebJavaConfig.class};
    }

    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
}

JAVA > SSM

SSM整合

http://blog.170827.xyz/2024/06/29/SSM整合/

作者

XIAOBAI

发布于

2024年6月29日

许可协议

SSM整合-其他问题上一篇

SpringMVC-高级扩展下一篇