【SSM】SSM整合

SSM 整合

1. 核心问题明确

本质上说，整合就是将三层架构和框架核心API组件交给SpringIoC容器管理

1.1 第一问：SSM整合需要几个IoC容器？

两个容器，一个容器可能就够了，但是我们常见的操作是创建两个IoC容器（web容器和root容器），组件分类管理

这种做法有以下好处和目的：

1. 分离关注点：通过初始化两个容器，可以将各个层次的关注点进行分离。这种分离使得各个层次的组件能够更好地聚焦于各自的责任和功能。
2. 解耦合：各个层次组件分离装配不同的IoC容器，这样可以进行解耦。这种解耦合使得各个模块可以独立操作和测试，提高了代码的可维护性和可测试性。
3. 灵活配置：通过使用两个容器，可以为每个容器提供各自的配置，以满足不同层次和组件的特定需求。每个配置文件也更加清晰和灵活。

总的来说，初始化两个容器在SSM整合中可以实现关注点分离、解耦合、灵活配置等好处。它们各自负责不同的层次和功能，并通过合适的集成方式协同工作，提供一个高效、可维护和可扩展的应用程序架构。

1.2 第二问：每个IoC容器对应哪些类型组件？

容器名	盛放组件
web容器	web相关组件（controller,springmvc核心组件）
root容器	业务和持久层相关组件（service,aop,tx,dataSource,mybatis,mapper等）

1.3 第三问：IoC容器之间关系和调用方向？

两个无关联的 IoC 容器之间组件是无法注入的，而存在父子关系，则子容器可以单向的注入父容器的组件

结论：web容器是root容器的子容器，父子容器关系。这个在源码中可以看到。

• 父容器：root容器，盛放service、mapper、mybatis等相关组件
• 子容器：web容器，盛放controller、web相关组件

1.4 第四问：具体多少配置类以及对应容器关系？

配置类的数量不是固定的，但是至少要两个，为了方便编写，我们可以三层架构每层对应一个配置类，分别指定两个容器加载即可

配置名	对应内容	对应容器
WebJavaConfig	controller,springmvc相关	web容器
ServiceJavaConfig	service,aop,tx相关	root容器
MapperJavaConfig	mapper,datasource,mybatis相关	root容器

1.5 第五问：IoC初始化方式和配置位置？

在web项目下，我们可以选择web.xml和配置类方式进行ioc配置，推荐配置类。对于使用基于 web 的 Spring 配置的应用程序，建议这样做，如以下示例所示：

public class MyWebAppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {

	@Override
	protected Class<?>[] getRootConfigClasses() { //指定root容器对应的配置类
		return new Class[]{ServiceJavaConfig.class, MapperJavaConfig.class};
	}

	@Override
	protected Class<?>[] getServletConfigClasses() { //指定web容器对应的配置类 webioc容器的配置类
		return new Class[]{WebJavaConfig.class};
	}

	@Override
	protected String @NonNull [] getServletMappings() { //指定dispatcherServlet处理路径，通常为 /
		return new String[]{"/"};
	}
}

2. 整合配置

整合完毕后目录结构：

2.1 依赖添加

依赖清单分析

• spring
  • ioc/di
    • spring-context
    • jakarta.annotation-api
  • aop
    • spring-aspects
  • tx
    • spring-tx
    • spring-jdbc
• spring MVC
  • spring-webmvc
  • jakarta.jakartaee-web-api
  • jackson-databind
  • hibernate-validator / hibernate-validator-annotation-processor
• mybatis
  • mybatis
  • mysql
  • pagehelper
• 整合需要
  • spring-web：加载 spring 容器
  • mybatis-spring：整合 mybatis
• 其它依赖
  • logback：日志
  • lombok：方便编写
  • druid：数据库连接池

<properties>
    <spring.version>6.0.6</spring.version>
    <jakarta.annotation-api.version>2.1.1</jakarta.annotation-api.version>
    <jakarta.jakartaee-web-api.version>9.1.0</jakarta.jakartaee-web-api.version>
    <jackson-databind.version>2.15.0</jackson-databind.version>
    <hibernate-validator.version>8.0.0.Final</hibernate-validator.version>
    <mybatis.version>3.5.11</mybatis.version>
    <mysql.version>8.0.25</mysql.version>
    <pagehelper.version>5.1.11</pagehelper.version>
    <druid.version>1.2.8</druid.version>
    <mybatis-spring.version>3.0.2</mybatis-spring.version>
    <jakarta.servlet.jsp.jstl-api.version>3.0.0</jakarta.servlet.jsp.jstl-api.version>
    <logback.version>1.2.3</logback.version>
    <lombok.version>1.18.26</lombok.version>
    <maven.compiler.source>17</maven.compiler.source>
    <maven.compiler.target>17</maven.compiler.target>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
    <!-- spring ioc/di -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>jakarta.annotation</groupId>
        <artifactId>jakarta.annotation-api</artifactId>
        <version>${jakarta.annotation-api.version}</version>
    </dependency>
    <!-- spring aop -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aop</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aspects</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <!-- spring tx -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-tx</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jdbc</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <!-- spring MVC -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>jakarta.platform</groupId>
        <artifactId>jakarta.jakartaee-web-api</artifactId>
        <version>${jakarta.jakartaee-web-api.version}</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>${jackson-databind.version}</version>
    </dependency>
    <dependency>
        <groupId>org.hibernate.validator</groupId>
        <artifactId>hibernate-validator</artifactId>
        <version>${hibernate-validator.version}</version>
    </dependency>
    <dependency>
        <groupId>org.hibernate.validator</groupId>
        <artifactId>hibernate-validator-annotation-processor</artifactId>
        <version>${hibernate-validator.version}</version>
    </dependency>
    <!-- mybatis -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>${mybatis.version}</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>${mysql.version}</version>
    </dependency>
    <dependency>
        <groupId>com.github.pagehelper</groupId>
        <artifactId>pagehelper</artifactId>
        <version>${pagehelper.version}</version>
    </dependency>
    <!-- 整合特殊依赖 -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-web</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis-spring</artifactId>
        <version>${mybatis-spring.version}</version>
    </dependency>
    <!-- 日志 -->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>${logback.version}</version>
    </dependency>
    <!-- 其它依赖 -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>${druid.version}</version>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>${lombok.version}</version>
    </dependency>
</dependencies>

2.2 日志配置

位置：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.ssm.mybatis" level="DEBUG" />

</configuration>

2.3 容器初始化配置

public class MyWebAppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {
	@Override
	protected Class<?>[] getRootConfigClasses() {
		return new Class[]{ServiceJavaConfig.class, MapperJavaConfig.class};
	}

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

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

2.4 控制层配置编写

1. 实现Springmvc组件声明标准化接口WebMvcConfigurer，接口中提供了各种组件对应的方法
2. 添加配置类注解@Configuration
3. 添加mvc复合功能开关@EnableWebMvc
4. 添加controller层扫描注解
5. 开启默认处理器,支持静态资源处理

@ComponentScan("com.ssm.controller")
@EnableWebMvc
@Configuration
public class WebJavaConfig implements WebMvcConfigurer {

	@Override
	public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
		configurer.enable(); // 开启静态资源访问
	}
}

2.5 业务层配置编写(AOP / TX整合）

1. 声明@Configuration注解,代表配置类
2. 声明@ComponentScan(“com.ssm.service”)注解,进行业务组件扫描
3. 声明@EnableAspectJAutoProxy注解,开启aspect aop注解支持
4. 声明@EnableTransactionManagement注解,开启事务注解支持，同时需要指定具体的事务管理器

@EnableTransactionManagement
@EnableAspectJAutoProxy
@ComponentScan("com.ssm.service")
@Configuration
public class ServiceJavaConfig {

	@Bean
	public DataSourceTransactionManager transactionManager(DataSource dataSource){
		DataSourceTransactionManager transactionManager = new DataSourceTransactionManager();
		transactionManager.setDataSource(dataSource);
		return transactionManager;
	}

}

2.6 持久层配置编写(MyBatis整合)

主要配置mapper代理对象，连接池和mybatis核心组件配置

1. MyBatis整合思路

mybatis核心api使用回顾：

//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();

mybatis核心api介绍回顾：

• 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整合思路理解：mybatis的api实例化需要复杂的过程。

例如，自己实现sqlSessionFactory加入ioc容器：

@Bean
public SqlSessionFactory sqlSessionFactory(){
   //1.读取外部配置文件
  InputStream ips = Resources.getResourceAsStream("mybatis-config.xml");
  
  //2.创建sqlSessionFactory
  SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(ips);
  
  return sqlSessionFactory;
}

过程比较繁琐，为了提高整合效率，mybatis提供了提供封装SqlSessionFactory和Mapper实例化的逻辑的FactoryBean组件，我们只需要声明和指定少量的配置即可

SqlSessionFactoryBean源码展示(mybatis提供)：

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整合思路总结：

• 需要将SqlSessionFactory和Mapper实例加入到IoC容器
• 使用mybatis整合包提供的FactoryBean快速整合

2. 准备外部配置文件

数据库连接信息，位置：resources/jdbc.properties

jdbc.user=root
jdbc.password=root
jdbc.url=jdbc:mysql:///mybatis-example
jdbc.driver=com.mysql.cj.jdbc.Driver

3. 整合方式1（保留mybatis-config.xml）

数据库信息以及mapper扫描包设置使用Java配置类处理，mybatis其他的功能（别名、settings、插件等信息）依然在 mybatis-config.xml 配置

1. 配置文件：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.ssm.pojo"/>
    </typeAliases>

    <plugins>
        <plugin interceptor="com.github.pagehelper.PageInterceptor">
            <!-- helperDialect：分页插件会自动检测当前的数据库链接，自动选择合适的分页方式 -->
            <property name="helperDialect" value="mysql"/>
        </plugin>
    </plugins>
</configuration>

2. 配置类

package com.ssm.config;

import com.alibaba.druid.pool.DruidDataSource;
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.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 javax.sql.DataSource;
import java.util.Properties;

/**
 * @author Mr.Bear
 */
@PropertySource("classpath:jdbc.properties")
@Configuration
public class MapperJavaConfig {

	/**
	 * 数据库连接池配置
	 */
	@Bean
	public DataSource dataSource(@Value("${jdbc.user}") String user,
	                             @Value("${jdbc.password}") String password,
	                             @Value("${jdbc.url}") String url,
	                             @Value("${jdbc.driver}") String driver){
		System.out.println("driver：" + driver);
		DruidDataSource dataSource = new DruidDataSource();
		dataSource.setUsername(user);
		dataSource.setPassword(password);
		dataSource.setUrl(url);
		dataSource.setDriverClassName(driver);
		return dataSource;
	}

    /**
     * sqlSessionFactory 配置，需要sqlSessionFactory时会通过SqlSessionFactoryBean工厂的 getObject() 方法获取
     */
	@Bean
	public SqlSessionFactoryBean sqlSessionFactoryBean(DataSource dataSource) {
		SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
		sqlSessionFactoryBean.setDataSource(dataSource);
		sqlSessionFactoryBean.setConfigLocation(new ClassPathResource("mybatis-config.xml"));
		return sqlSessionFactoryBean;
	}

	/**
	 * 配置Mapper实例扫描工厂,配置 <mapper <package 对应接口和mapperxml文件所在的包
	 */
	@Bean
	public MapperScannerConfigurer mapperScannerConfigurer(){
		MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
		//设置mapper接口和xml文件所在的共同包
		mapperScannerConfigurer.setBasePackage("com.ssm.mapper");
		return mapperScannerConfigurer;
	}
}

3. mapper

public interface ScheduleMapper {
	List<Schedule> selectList(Schedule schedule);
}

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.ssm.mapper.ScheduleMapper">
    <select id="selectList" resultType="schedule">
        select * from schedule
    </select>
</mapper>

4. 整合方式2 （完全配置类，去掉mybatis-config.xml）

修改配置类中的方法：sqlSessionFactoryBean()

@Bean
public SqlSessionFactoryBean sqlSessionFactoryBean(DataSource dataSource) {
    SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
    sqlSessionFactoryBean.setDataSource(dataSource);
    // sqlSessionFactoryBean.setConfigLocation(new ClassPathResource("mybatis-config.xml"));
    // 配置 setting 标签内容
    org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration();
    configuration.setMapUnderscoreToCamelCase(true);
    configuration.setLogImpl(Slf4jImpl.class);
    configuration.setAutoMappingBehavior(AutoMappingBehavior.FULL);
    sqlSessionFactoryBean.setConfiguration(configuration);
    // 配置别名
    sqlSessionFactoryBean.setTypeAliasesPackage("com.ssm.pojo");
    // 配置插件
    PageInterceptor pageInterceptor = new PageInterceptor();
    Properties properties = new Properties();
    properties.setProperty("helperDialect", "mysql");
    pageInterceptor.setProperties(properties);
    sqlSessionFactoryBean.addPlugins(pageInterceptor);
    return sqlSessionFactoryBean;
}

2.7 其它类补充

ResultVO

@AllArgsConstructor
@NoArgsConstructor
@Data
public class ResultVO<T> {
	private int code = 200;
	private boolean flag = true;
	private T data;

	public ResultVO(T data) {
		this.data = data;
	}
}

ScheduleController

@RequestMapping("schedule")
@RestController
public class ScheduleController {

	@Autowired
	private ScheduleService scheduleServiceImpl;

	@RequestMapping("querySchedule")
	public ResultVO<List<Schedule>> querySchedule(@RequestBody(required = false) Schedule query) {
		return new ResultVO<>(scheduleServiceImpl.querySchedule(query));
	}
}

ScheduleServiceImpl

@Service
public class ScheduleServiceImpl implements ScheduleService {

	@Autowired
	private ScheduleMapper scheduleMapper;

	@Override
	public List<Schedule> querySchedule(Schedule query) {
		PageHelper.startPage(1, 2);
		return scheduleMapper.selectList(query);
	}
}

补充完整后访问：http://localhost:8080/ssm/schedule/querySchedule 即可得到查询结果