整合Spring(三)—— 零xml配置Spring与mybatis的整合

写Java程序，操作数据库几乎是少不了的，在上一篇文章中对Spring进行了无xml方式的整合，本文将通过注解方式以mysql为例整合mybatis+druid。

pom文件

由于本文是在整合Spring(一) —— 零xml配置让一个Maven项目用上Spring容器文章的基础上进行整合的，因此有些必须的依赖，但是不是整合mybatis必须的依赖就没有体现。

另外第一篇文章提到的打包插件也是需要的，也不再赘述。

<!--mybatis整合-->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-jdbc</artifactId>
    <version>5.3.6</version>
</dependency>
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>2.1.0</version>
</dependency>
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.11</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.31</version>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.2.14</version>
</dependency>

<dependency>
    <groupId>com.alibaba.fastjson2</groupId>
    <artifactId>fastjson2</artifactId>
    <version>2.0.16</version>
</dependency>

项目结构

├── pom.xml
└── src
    ├── main
    │   ├── java
    │   │   └── it
    │   │       └── aspirin
    │   │           ├── HelloApplication.java
    │   │           ├── config
    │   │           │   └── MybatisConfig.java
    │   │           ├── controller
    │   │           │   └── HelloController.java
    │   │           ├── mapper
    │   │           │   └── ImageMapper.java
    │   │           └── service
    │   │               ├── ImageService.java
    │   │               └── impl
    │   │                   ├── ClickhouseImageServiceImpl.java
    │   │                   ├── ImageContext.java
    │   │                   └── MysqlImageServiceImpl.java
    │   └── resources
    │       ├── application.properties
    │       └── mapper
    │           └── ImageMapper.xml
    └── test

配置文件

配置文件主要包含数据库连接信息和mybatis要扫描的位置。

# mysql
spring.datasource.mysql.jdbc.driver=com.mysql.cj.jdbc.Driver
spring.datasource.mysql.jdbc.url=jdbc:mysql://localhost:3306/aspirin?useSSL=false
spring.datasource.mysql.jdbc.username=root
spring.datasource.mysql.jdbc.password=root

#clickhouse
spring.datasource.clickhouse.jdbc.driver=ru.yandex.clickhouse.ClickHouseDriver
spring.datasource.clickhouse.jdbc.url=jdbc:clickhouse://192.168.0.18:8124/water_disasters_yunguan_ms
spring.datasource.clickhouse.jdbc.username=default
spring.datasource.clickhouse.jdbc.password=clickhouse@911$

mybatis.mapper-locations=classpath:mapper/**/*.xml

配置类

配置类主要做了3件事：

1.指定要扫描的mapper类在哪里@MapperScan("it.aspirin.**.mapper")根据实际情况指定

2.加载mapper.xml配置文件：sqlSessionFactory()方法内，改方法需要配合配置文件中指定的位置

3.初始化druid连接池：dataSource()方法内

package it.aspirin.config;

import com.alibaba.druid.pool.DruidDataSource;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;

import javax.sql.DataSource;

@Configuration
@MapperScan("it.aspirin.**.mapper")
public class MybatisConfig {

    @Value("${spring.datasource.mysql.jdbc.driver}")
    private String driver;

    @Value("${spring.datasource.mysql.jdbc.url}")
    private String url;

    @Value("${spring.datasource.mysql.jdbc.username}")
    private String username;

    @Value("${spring.datasource.mysql.jdbc.password}")
    private String password;

    @Value("${mybatis.mapper-locations:mapper/*.xml}")
    private String mapperLocations;

    @Bean
    public SqlSessionFactory sqlSessionFactory() throws Exception {
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(dataSource());

        //根据配置文件路径扫描mybatis的mapper文件
        final PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        final Resource[] resources = resolver.getResources(mapperLocations);
        factoryBean.setMapperLocations(resources);
        return factoryBean.getObject();
    }

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

}

测试整合结果

通过上述步骤，整合就完成了，可以像写Springboot一样正常写mapper进行测试了。

mapper.xml

<?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="it.aspirin.mapper.ImageMapper">

    <select id="selectAllUsers" resultType="com.alibaba.fastjson2.JSONObject">
        select * from user;
    </select>
</mapper>

mapper.java

@Mapper
public interface ImageMapper {

    /**
     * 查询所有用户
     * @return
     */
    @Select("select * from user where id = 1")
    JSONObject getUser();

    List<JSONObject> selectAllUsers();

}

controller.java

在controller中我们通过注入的方式将mapper实例注入。

@Controller
public class HelloController {

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

    @Resource
    private ImageMapper imageMapper;

    public String sayHello(String name) {

        return driver + " hello " + name;
    }

    public JSONObject getUser(){
        return imageMapper.getUsers();
    }
}

总结

1.本文是整合Spring系列的第二篇，需要有一些第一篇的前置知识。

2.整合的核心内容只有配置类那个Java文件。即指定扫描mapper所在的包，指定mapper.xml所在的文件夹，以及整合连接池。

3.本文主要优点是实现了零xml的整合，实现并不复杂，但是网上如此实现的并不多。

4.本文还有一点没有实现，即整合多个数据源使用，待后续更新。