Spring项目整合Mybatis/Junit

旧城等待， 2024-04-01 09:58 113阅读 0赞

## 1. Spring整合Mybatis思路分析 ##

### 1.1 环境准备 ###

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

#### 步骤1:准备数据库表 ####

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

CREATE TABLE `user` (
      `user_id` mediumint(8) unsigned NOT NULL AUTO_INCREMENT,
      `email` varchar(60) NOT NULL DEFAULT '',
      `user_name` varchar(60) NOT NULL DEFAULT '',
      `branch_name` varchar(30) DEFAULT NULL,
      PRIMARY KEY (`user_id`) USING BTREE,
      KEY `idx_platform_user_id_name` (`user_name`) USING BTREE,
      KEY `idx_platform_user_email` (`email`) USING BTREE
    ) ENGINE=InnoDB AUTO_INCREMENT=146 DEFAULT CHARSET=utf8;

#### 步骤2:创建项目导入jar包 ####

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

#### 步骤3:根据表创建模型类 ####

public class User implements Serializable {
        
        private Integer userId;
        private String email;
        private String userName;
        private String branchName;
    
        public Integer getUserId() {
        
            return userId;
        }
    
        public void setUserId(Integer userId) {
        
            this.userId = userId;
        }
    
        public String getEmail() {
        
            return email;
        }
    
        public void setEmail(String email) {
        
            this.email = email;
        }
    
        public String getUserName() {
        
            return userName;
        }
    
        public void setUserName(String userName) {
        
            this.userName = userName;
        }
    
        public String getBranchName() {
        
            return branchName;
        }
    
        public void setBranchName(String branchName) {
        
            this.branchName = branchName;
        }
    
        @Override
        public String toString() {
        
            return "User{" +
                    "userId=" + userId +
                    ", email='" + email + '\'' +
                    ", userName='" + userName + '\'' +
                    ", branchName='" + branchName + '\'' +
                    '}';
        }
    }

#### 步骤4:创建Dao接口 ####

public interface UserDao {
        
    
        @Select("select * from platform_user")
        List<User> findAll();
    
        @Select("select * from platform_user where user_id = #{id}")
        User findById(Integer id);
    
    
    }

#### 步骤5:创建Service接口和实现类 ####

public interface UserService {
        
    
        List<User> findAll();
    
        User findById(Integer id);
    
    }
    
    @Service
    public class UserServiceImpl implements UserService {
        
    
        @Autowired
        private UserDao userDao;
    
        public List<User> findAll() {
        
            return userDao.findAll();
        }
    
        public User findById(Integer id) {
        
            return userDao.findById(id);
        }
    }

#### 步骤6:添加jdbc.properties文件 ####

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

jdbc.driver=com.mysql.jdbc.Driver
    jdbc.url=jdbc:mysql://localhost:3306/mybatis?useSSL=false
    jdbc.username=root
    jdbc.password=root

useSSL:关闭MySQL的SSL连接

#### 步骤7:添加Mybatis核心配置文件 ####

<?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 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:编写应用程序 ####

public class SpringJdbc {
        
        public static void main(String[] args) throws IOException {
        
            
            // 1. 创建SqlSessionFactoryBuilder对象
            SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
            
            // 2. jdbcConfig.xml配置文件
            InputStream inputStream = Resources.getResourceAsStream("jdbcConfig.xml");
            
            // 3. 创建SqlSessionFactory对象
            SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
            
            // 4. 获取SqlSession
            SqlSession sqlSession = sqlSessionFactory.openSession();
            
            // 5. 执行SqlSession对象执行查询，获取结果User
            UserDao userDao = sqlSession.getMapper(UserDao.class);
    
            User user = userDao.findById(8);
            System.out.println(user);
    
            // 6. 释放资源
            sqlSession.close();
        }
    }

#### 步骤9:运行程序 ####

![在这里插入图片描述][ab2501d8cf454f63816361fc1fe52f3d.png_pic_center]

### 1.2 整合思路分析 ###

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

*  Mybatis程序核心对象分析
    
    ![在这里插入图片描述][aed6a10828cc4127bd60cf218a84ec59.png_pic_center]
    
    从图中可以获取到，真正需要交给Spring管理的是SqlSessionFactory
 *  整合Mybatis，就是将Mybatis用到的内容交给Spring管理，分析下配置文件
    
    ![在这里插入图片描述][c7986d29bb184eeb991ebe50dbbe893d.png_pic_center]
    
    **说明:**
    
     *  第一行读取外部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包 ####

<dependencies>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>5.2.15.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.2.10</version>
            </dependency>
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>3.5.10</version>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.30</version>
            </dependency>
            
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-jdbc</artifactId>
                <version>5.2.12.RELEASE</version>
            </dependency>
            
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis-spring</artifactId>
                <version>2.0.7</version>
            </dependency>
        </dependencies>

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

//配置类注解
    @Configuration
    //包扫描，主要扫描的是项目中的UserServiceImpl类
    @ComponentScan("com.dcxuexi")
    public class SpringConfig {
        
    }

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

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

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 dataSource = new DruidDataSource();
            dataSource.setDriverClassName(driver);
            dataSource.setUrl(url);
            dataSource.setUsername(userName);
            dataSource.setPassword(password);
            return dataSource;
        }
    }

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

//配置类注解
    @Configuration
    //包扫描，主要扫描的是项目中的UserServiceImpl类
    @ComponentScan("com.dcxuexi")
    @PropertySource("classpath:jdbc.properties")
    @Import(JdbcConfig.class)
    public class SpringConfig {
        
    }

#### 步骤5:创建Mybatis配置类并配置SqlSessionFactory ####

public class MybatisConfig {
        
        //定义Bean，返回SqlSessionFactoryBean，用户生成SqlSessionFactory对象
        @Bean
        public SqlSessionFactoryBean sqlSessionFactoryBean(DataSource dataSource){
        
            SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
            //设置模型类的别名扫描
            sqlSessionFactoryBean.setTypeAliasesPackage("com.dcxuexi.domain");
            // 设置数据源
            sqlSessionFactoryBean.setDataSource(dataSource);
            return sqlSessionFactoryBean;
        }
    
        //定义Bean，返回MapperScannerConfigurer 对象
        @Bean
        public MapperScannerConfigurer mapperScannerConfigurer(){
        
            MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
            mapperScannerConfigurer.setBasePackage("com.dcxuexi.dao");
            return mapperScannerConfigurer;
        }
    }

**说明:**

*  使用SqlSessionFactoryBean封装SqlSessionFactory需要的环境信息
    
    ![在这里插入图片描述][1efbb7010be7449a8484bbbae48a5b05.png_pic_center]
    
     *  SqlSessionFactoryBean是前面我们讲解FactoryBean的一个子类，在该类中将SqlSessionFactory的创建进行了封装，简化对象的创建，我们只需要将其需要的内容设置即可。
     *  方法中有一个参数为dataSource,当前Spring容器中已经创建了Druid数据源，类型刚好是DataSource类型，此时在初始化SqlSessionFactoryBean这个对象的时候，发现需要使用DataSource对象，而容器中刚好有这么一个对象，就自动加载了DruidDataSource对象。
 *  使用MapperScannerConfigurer加载Dao接口，创建代理对象保存到IOC容器中
    
    ![在这里插入图片描述][f0add87d2a33463f81eeb7d41011f44d.png_pic_center]
    
     *  这个MapperScannerConfigurer对象也是MyBatis提供的专用于整合的jar包中的类，用来处理原始配置文件中的mappers相关配置，加载数据层的Mapper接口类
     *  MapperScannerConfigurer有一个核心属性basePackage，就是用来设置所扫描的包路径

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

//配置类注解
    @Configuration
    //包扫描，主要扫描的是项目中的UserServiceImpl类
    @ComponentScan("com.dcxuexi")
    @PropertySource("classpath:jdbc.properties")
    @Import({
        JdbcConfig.class,MybatisConfig.class})
    public class SpringConfig {
        
    }

#### 步骤7:编写运行类 ####

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

public class SpringMybatis {
        
        public static void main(String[] args) {
        
            AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
            UserService userService = context.getBean(UserService.class);
            User user = userService.findById(10);
            System.out.println(user);
        }
    }

#### 步骤8:运行程序 ####

![在这里插入图片描述][cb6ae0ee97654bc4b5e35085c96de4a1.png_pic_center]

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

*  SqlSessionFactoryBean
 *  MapperScannerConfigurer

## 3. Spring整合Junit ##

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

### 3.1 环境准备 ###

这块环境，大家可以直接使用Spring与Mybatis整合的环境即可。当然也可以重新创建一个，因为内容是一模一样，项目结构:

![在这里插入图片描述][000c571e19034daa8881f0919fa0467b.png_pic_center]

### 3.2 整合Junit步骤 ###

在上述环境的基础上，我们来对Junit进行整合。

#### 步骤1:引入依赖 ####

pom.xml

<dependencies>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>5.2.12.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.2.10</version>
            </dependency>
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>3.5.10</version>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.30</version>
            </dependency>
            
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-jdbc</artifactId>
                <version>5.2.12.RELEASE</version>
            </dependency>
            
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis-spring</artifactId>
                <version>2.0.7</version>
            </dependency>
            <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.12.RELEASE</version>
            </dependency>
        </dependencies>

#### 步骤2:编写测试类 ####

在test\\java下创建一个AccountServiceTest,这个名字任意

//设置类运行器
    @RunWith(SpringJUnit4ClassRunner.class)
    //设置Spring环境对应的配置类
    @ContextConfiguration(classes = {
        SpringConfiguration.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());
        }
    }

运行测试方法：

![在这里插入图片描述][d51569adfb2b489c8880e336725831d0.png_pic_center]

**注意:**

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

### 知识点1：@RunWith ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@RunWith</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>测试类注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>测试类定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设置JUnit运行器</td> 
  </tr> 
  <tr> 
   <td>属性</td> 
   <td>value（默认）：运行所使用的运行期</td> 
  </tr> 
 </tbody> 
</table>

### 知识点2：@ContextConfiguration ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@ContextConfiguration</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>测试类注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>测试类定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设置JUnit加载的Spring核心配置</td> 
  </tr> 
  <tr> 
   <td>属性</td> 
   <td>classes：核心配置类，可以使用数组的格式设定加载多个配置类<br>locations:配置文件，可以使用数组的格式设定加载多个配置文件名称</td> 
  </tr> 
 </tbody> 
</table>

## 项目代码 ##

*  [gitee 代码下载][gitee]
 *  [github 代码代码][github]

[ab2501d8cf454f63816361fc1fe52f3d.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/e6ee0f409cdc4436be74491967cd8a10.png
[aed6a10828cc4127bd60cf218a84ec59.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/643c963dd7e143d9b363c93c91bbce48.png
[c7986d29bb184eeb991ebe50dbbe893d.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/7730c61dfbdb4dfbb9f118ebbdfd39e0.png
[1efbb7010be7449a8484bbbae48a5b05.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/6b57718385484f2788d99c0115aebf3c.png
[f0add87d2a33463f81eeb7d41011f44d.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/ed8e875161fd493ea5296403e283e69a.png
[cb6ae0ee97654bc4b5e35085c96de4a1.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/56a5d52ba2f44060a89e5e4280c0ea28.png
[000c571e19034daa8881f0919fa0467b.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/1478b49f8e5b41beb4580af8f0e706ef.png
[d51569adfb2b489c8880e336725831d0.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/0d6f3106fc6746faa89905bc5e2e661f.png
[gitee]: https://gitee.com/DchuangDB/sping-projeck
[github]: https://github.com/dcbut/spring