10. Spring整合

2023-12-01 10:15:53 浏览数 (1)

课程学习到这里，已经对 Spring 有一个简单的认识了，Spring 有一个容器，叫做 IoC 容器，里面保存 bean。在进行企业级开发的时候，其实除了将自己写的类让 Spring 管理之外，还有一部分重要的工作就是使用第三方的技术。前面已经讲了如何管理第三方 bean 了，下面结合 IoC 和 DI，整合 2 个常用技术，进一步加深对 Spring 的使用理解。

1. Spring 整合 Mybatis 思路分析

‍

1.1 环境准备

在准备环境的过程中，我们也来回顾下 Mybatis 开发的相关内容:

  • 步骤 1:准备数据库表

Mybatis 是来操作数据库表，所以先创建一个数据库及表

代码语言：javascript复制
create database spring_db character set utf8;
use spring_db;
create table tbl_account(
    id int primary key auto_increment,
    name varchar(35),
    money double
);
  • 步骤 2:创建项目导入 jar 包

项目的 pom.xml 添加相关依赖

代码语言：javascript复制
<dependencies>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>5.2.10.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>1.1.16</version>
    </dependency>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.47</version>
    </dependency>
</dependencies>
  • 步骤 3:根据表创建模型类
代码语言：javascript复制
public class Account {
    private Integer id;
    private String name;
    private Double money;

    public Account(Integer id, String name, Double money) {
        this.id = id;
        this.name = name;
        this.money = money;
    }

    public Account() {
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Double getMoney() {
        return money;
    }

    public void setMoney(Double money) {
        this.money = money;
    }

    @Override
    public String toString() {
        return "Account{"  
                "id="   id  
                ", name='"   name   '''  
                ", money="   money  
                '}';
    }
}
  • 步骤 4:创建 Dao 接口
代码语言：javascript复制
public interface AccountDao {

    @Insert("insert into tbl_account(name,money)values(#{name},#{money})")
    void save(Account account);

    @Delete("delete from tbl_account where id = #{id} ")
    void delete(Integer id);

    @Update("update tbl_account set name = #{name} , money = #{money} where id = #{id} ")
    void update(Account account);

    @Select("select * from tbl_account")
    List<Account> findAll();

    @Select("select * from tbl_account where id = #{id} ")
    Account findById(Integer id);
}
  • 步骤 5:创建 Service 接口和实现类
代码语言：javascript复制
public interface AccountService {

    void save(Account account);

    void delete(Integer id);

    void update(Account account);

    List<Account> findAll();

    Account findById(Integer id);

}




@Service
public class AccountServiceImpl implements AccountService {

    @Autowired
    private AccountDao accountDao;

    public void save(Account account) {
        accountDao.save(account);
    }

    public void update(Account account){
        accountDao.update(account);
    }

    public void delete(Integer id) {
        accountDao.delete(id);
    }

    public Account findById(Integer id) {
        return accountDao.findById(id);
    }

    public List<Account> findAll() {
        return accountDao.findAll();
    }
}
  • 步骤 6:添加 jdbc.properties 文件

resources 目录下添加，用于配置数据库连接四要素

代码语言：javascript复制
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/spring_db?useSSL=false
jdbc.username=root
jdbc.password=root

useSSL:关闭 MySQL 的 SSL 连接

  • 步骤 7:添加 Mybatis 核心配置文件
代码语言：javascript复制
<?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>
    <!--读取外部properties配置文件-->
    <properties resource="jdbc.properties"></properties>
    <!--别名扫描的包路径-->
    <typeAliases>
        <package name="com.itheima.domain"/>
    </typeAliases>
    <!--数据源-->
    <environments default="mysql">
        <environment id="mysql">
            <transactionManager type="JDBC"></transactionManager>
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"></property>
                <property name="url" value="${jdbc.url}"></property>
                <property name="username" value="${jdbc.username}"></property>
                <property name="password" value="${jdbc.password}"></property>
            </dataSource>
        </environment>
    </environments>
    <!--映射文件扫描包路径-->
    <mappers>
        <package name="com.itheima.dao"></package>
    </mappers>
</configuration>
  • 步骤 8:编写应用程序
代码语言：javascript复制
public class App {
    public static void main(String[] args) throws IOException {
        // 1. 创建SqlSessionFactoryBuilder对象
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
        // 2. 加载SqlMapConfig.xml配置文件
        InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml.bak");
        // 3. 创建SqlSessionFactory对象
        SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
        // 4. 获取SqlSession
        SqlSession sqlSession = sqlSessionFactory.openSession();
        // 5. 执行SqlSession对象执行查询，获取结果User
        AccountDao accountDao = sqlSession.getMapper(AccountDao.class);

        Account ac = accountDao.findById(1);
        System.out.println(ac);

        // 6. 释放资源
        sqlSession.close();
    }
}
  • 步骤 9:运行程序 ​

​

1.2 整合思路分析

Mybatis 的基础环境我们已经准备好了，接下来就得分析下在上述的内容中，哪些对象可以交给 Spring 来管理?

  • Mybatis 程序核心对象分析 ​

​

‍

从图中可以获取到，真正需要交给 Spring 管理的是​SqlSessionFactory

  • 整合 Mybatis，就是将 Mybatis 用到的内容交给 Spring 管理，分析下配置文件 ​

​

说明:

  • 第一行读取外部 properties 配置文件，Spring 有提供具体的解决方案​@PropertySource​,需要交给 Spring
  • 第二行起别名包扫描，为 SqlSessionFactory 服务的，需要交给 Spring
  • 第三行主要用于做连接池，Spring 之前我们已经整合了 Druid 连接池，这块也需要交给 Spring
  • 前面三行一起都是为了创建 SqlSession 对象用的，那么用 Spring 管理 SqlSession 对象吗?回忆下 SqlSession 是由 SqlSessionFactory 创建出来的，所以只需要将 SqlSessionFactory 交给 Spring 管理即可。
  • 第四行是 Mapper 接口和映射文件[如果使用注解就没有该映射文件]，这个是在获取到 SqlSession 以后执行具体操作的时候用，所以它和 SqlSessionFactory 创建的时机都不在同一个时间，可能需要单独管理。

2. Spring 整合 Mybatis 实现

‍

前面我们已经分析了 Spring 与 Mybatis 的整合，大体需要做两件事，

第一件事是:Spring 要管理 MyBatis 中的 SqlSessionFactory

第二件事是:Spring 要管理 Mapper 接口的扫描

具体该如何实现，具体的步骤为:

< 步骤 1:项目中导入整合需要的 jar 包

代码语言：javascript复制
<dependency>
    <!--Spring操作数据库需要该jar包-->
    <groupId>org.springframework</groupId>
    <artifactId>spring-jdbc</artifactId>
    <version>5.2.10.RELEASE</version>
</dependency>
<dependency>
    <!--
        Spring与Mybatis整合的jar包
        这个jar包mybatis在前面，是Mybatis提供的
    -->
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>1.3.0</version>
</dependency>

‍

< 步骤 2:创建 Spring 的主配置类

代码语言：javascript复制
//配置类注解
@Configuration
//包扫描，主要扫描的是项目中的AccountServiceImpl类
@ComponentScan("com.north")
public class SpringConfig {
}

‍

  • 步骤 3:创建数据源的配置类

在配置类中完成数据源的创建

代码语言：javascript复制
public class JdbcConfig {
    @Value("${jdbc.driver}")
    private String driver;
    @Value("${jdbc.url}")
    private String url;
    @Value("${jdbc.username}")
    private String userName;
    @Value("${jdbc.password}")
    private String password;

    @Bean
    public DataSource dataSource(){
        DruidDataSource ds = new DruidDataSource();
        ds.setDriverClassName(driver);
        ds.setUrl(url);
        ds.setUsername(userName);
        ds.setPassword(password);
        return ds;
    }
}

‍

< 步骤 4:主配置类中读 properties 并引入数据源配置类

代码语言：javascript复制
@Configuration
@ComponentScan("com.north")
@PropertySource("classpath:jdbc.properties")
@Import({JdbcConfig.class , MybatisConfig.class})
public class SpringConfig {
}

‍

  • 步骤 5:创建 Mybatis 配置类并配置 SqlSessionFactory
代码语言：javascript复制
package com.north.config;

import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.mapper.MapperScannerConfigurer;
import org.springframework.context.annotation.Bean;

import javax.sql.DataSource;

/**
 * @Title: MybatisConfig
 * @Author North
 * @Date 2023/6/24 17:40
 */
public class MybatisConfig {
    @Bean
    public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource) {

        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        // 设置数据类型的别名扫描
        sqlSessionFactoryBean.setTypeAliasesPackage("com.north.domain");
        // 设置数据源
        sqlSessionFactoryBean.setDataSource(dataSource);
        return sqlSessionFactoryBean;
    }

    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer() {
        MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
        mapperScannerConfigurer.setBasePackage("com.north.dao");
        return mapperScannerConfigurer;
    }
}

说明:

  • 使用 SqlSessionFactoryBean 封装 SqlSessionFactory 需要的环境信息 ​

​

‍

  • SqlSessionFactoryBean 是前面我们讲解 FactoryBean 的一个子类，在该类中将 SqlSessionFactory 的创建进行了封装，简化对象的创建，我们只需要将其需要的内容设置即可。
  • 方法中有一个参数为 dataSource,当前 Spring 容器中已经创建了 Druid 数据源，类型刚好是 DataSource 类型，此时在初始化 SqlSessionFactoryBean 这个对象的时候，发现需要使用 DataSource 对象，而容器中刚好有这么一个对象，就自动加载了 DruidDataSource 对象。
  • 使用 MapperScannerConfigurer 加载 Dao 接口，创建代理对象保存到 IOC 容器中

​

​

‍

  • 这个 MapperScannerConfigurer 对象也是 MyBatis 提供的专用于整合的 jar 包中的类，用来处理原始配置文件中的 mappers 相关配置，加载数据层的 Mapper 接口类
  • MapperScannerConfigurer 有一个核心属性 basePackage，就是用来设置所扫描的包路径

‍

< 步骤 6:主配置类中引入 Mybatis 配置类

代码语言：javascript复制
package com.north.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.context.annotation.PropertySource;

/**
 * @Title: SpringConfig
 * @Author North
 * @Date 2023/6/24 17:37
 */
@Configuration
@ComponentScan("com.north")
@PropertySource("classpath:jdbc.properties")
@Import({JdbcConfig.class , MybatisConfig.class})
public class SpringConfig {
}

‍

  • 步骤 7:编写运行类

在运行类中，从 IOC 容器中获取 Service 对象，调用方法获取结果

​

​

‍

  • 步骤 8:运行程序 ​

​

支持 Spring 与 Mybatis 的整合就已经完成了，其中主要用到的两个类分别是:

  • SqlSessionFactoryBean
  • MapperScannerConfigurer

‍

3. Spring 整合 Junit

整合 Junit 与整合 Druid 和 MyBatis 差异比较大，为什么呢？Junit 是一个搞单元测试用的工具，它不是我们程序的主体，也不会参加最终程序的运行，从作用上来说就和之前的东西不一样，它不是做功能的，看做是一个辅助工具就可以了。

‍

3.1 整合 junit 步骤

‍

  • 步骤 1:引入依赖

pom.xml

代码语言：javascript复制
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
    <scope>test</scope>
</dependency>

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-test</artifactId>
    <version>5.2.10.RELEASE</version>
</dependency>

‍

  • 步骤 2:编写测试类

在 testjava 下创建一个 AccountServiceTest,这个名字任意

代码语言：javascript复制
//设置类运行器
@RunWith(SpringJUnit4ClassRunner.class)
//设置Spring环境对应的配置类
    @ContextConfiguration(classes = {SpringConfig.class}) //加载配置类
//@ContextConfiguration(locations={"classpath:applicationContext.xml"})//加载配置文件
public class AccountServiceTest {
    //支持自动装配注入bean
    @Autowired
    private AccountService accountService;
    @Test
    public void testFindById(){
        System.out.println(accountService.findById(1));

    }
    @Test
    public void testFindAll(){
        System.out.println(accountService.findAll());
    }
}

注意:

  • 单元测试，如果测试的是注解配置类，则使用​@ContextConfiguration(classes = 配置类.class)​
  • 单元测试，如果测试的是配置文件，则使用​@ContextConfiguration(locations={配置文件名,...})​
  • Junit 运行后是基于 Spring 环境运行的，所以 Spring 提供了一个专用的类运行器，这个务必要设置，这个类运行器就在 Spring 的测试专用包中提供的，导入的坐标就是这个东西​SpringJUnit4ClassRunner​
  • 上面两个配置都是固定格式，当需要测试哪个 bean 时，使用自动装配加载对应的对象，下面的工作就和以前做 Junit 单元测试完全一样了

3.2 知识点 1：@RunWith

名称

@RunWith

类型

测试类注解

位置

测试类定义上方

作用

设置 JUnit 运行器

属性

value（默认）：运行所使用的运行期

3.3 知识点 2：@ContextConfiguration

名称

@ContextConfiguration

类型

测试类注解

位置

测试类定义上方

作用

设置 JUnit 加载的 Spring 核心配置

属性

classes：核心配置类，可以使用数组的格式设定加载多个配置类 locations:配置文件，可以使用数组的格式设定加载多个配置文件名称

spring 测试 对象 管理 配置

0 人点赞