java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > SpringBoot集成Mybatis

SpringBoot集成Mybatis并测试

作者：小乐乐的天台

这篇文章主要介绍了SpringBoot集成Mybatis并测试,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

首先我们先新建一个项目，需要选择以下依赖：

1、SpringBoot链接druid连接池

1、在pom文件中加入druid连接池场景启动器，如下所示：

<!-- druid 场景启动器 -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
    <version>1.2.3</version>
</dependency>

2、在全局配置类中添加以下配置：

spring:
  # application:
  #  name: dev-manager
  datasource:
    # 配置数据源类型
    type:
      com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/springboot_mybatis?useUnicode=true&characterEncoding=UTF-8
    username: root
    password: root
    # 初始化，最小，最大连接数
    initialSize: 3
    minidle: 3
    maxActive: 18
    # 获取数据库连接等待的超时时间
    maxWait: 60000
    # 配置多久进行一次检测，检测需要关闭的空闲连接 单位毫秒
    timeBetweenEvictionRunsMillis: 60000
    validationQuery: SELECT 1 FROM dual
    # 配置监控统计拦截的filters,去掉后，监控界面的sql无法统计
    # filters: stat,wall,log4j

    # 初始化时运行sql脚本
    schema: classpath:sql/schema.sql
    initialization-mode: always
    druid:
      stat-view-servlet:
        enabled: true

3、这个时候druid的数据链接其实是已经链接上了，下来我们可以配置一些druid的监控，先分析一下，在自动配置类中引入的DruidStatViewServletConfiguration就是监控的，可以生成一个监控界面。

@Configuration
@ConditionalOnClass({DruidDataSource.class})
@AutoConfigureBefore({DataSourceAutoConfiguration.class})
@EnableConfigurationProperties({DruidStatProperties.class, DataSourceProperties.class})
// DruidStatViewServletConfiguration 是配置监控的类
@Import({DruidSpringAopConfiguration.class, DruidStatViewServletConfiguration.class, DruidWebStatFilterConfiguration.class, DruidFilterConfiguration.class})
public class DruidDataSourceAutoConfigure {
}

4、当我们点击进入DruidStatViewServletConfiguration 类的时候，会发现当我们在全局配置文件中没有配置spring.datasource.druid.stat-view-servlet.enabled配置的时候，这个类将不生效，监控界面也就无法起来，代码如下：

@ConditionalOnWebApplication
@ConditionalOnProperty(
    name = {"spring.datasource.druid.stat-view-servlet.enabled"},
    havingValue = "true"
)
public class DruidStatViewServletConfiguration {
}

5、我们先不要在全局配置里面配置上面的属性，进入地址 http://localhost:8080/druid/login.html ，就会打不开，如下所示：

6、下面我们在全局配置文件中配置了这个配置之后，然后再打开监控的网站页面，如下所示：

spring:
  datasource:
	druid:
      stat-view-servlet:
        enabled: true

7、依据于DruidStatViewServletConfiguration类的下面代码，我们就可以类似的加一些其它的配置，就比如登录名密码什么的，代码如下：

application.yml配置

druid:
  stat-view-servlet:
    enabled: true
    login-username: root
    login-password: 123

2、SpringBoot集成Mybatis

2.1、引入Mybatis-generator

1、在pom文件中引入mybatis-generator插件，代码如下所示：

<!-- Mybatis-Generator插件，自动生成代码 -->
<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.2</version>
    <configuration>
        <configurationFile>${project.basedir}/src/main/resources/generatorConfig.xml</configurationFile>
        <overwrite>true</overwrite>
        <verbose>true</verbose>
    </configuration>
    <dependencies>
        <!-- 必须要引入数据库驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <!-- 必须要指定相应的版本 -->
            <version>8.0.22</version>
        </dependency>
    </dependencies>
</plugin>

2、加入上面引入的generatorConfig.xml文件，代码示例如下：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
    <!--数据库驱动
        使用dos命令时，需要配置数据库驱动
        -->
    <!--<classPathEntry location="D:\Java\apache-maven-3.5.4\repository\mysql\mysql-connector-java\8.0.15\mysql-connector-java-8.0.15.jar"/>-->
    <!-- context配置上下文，配置生成规则
        id 任意写
        MyBatis3DynamicSql  默认的，会生成带动态sql的CRUD
        MyBatis3            生成通用的查询，可以指定动态where的条件
        MyBatis3Simple      只生成简单的CRUD
    <context id="context" targetRuntime="MyBatis3Simple">
        <!-- 注释生成器 -->
        <!--<commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>-->
        <!--数据库链接地址账号密码-->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/springboot_mybatis?serverTimezone=UTC"
                        userId="root"
                        password="root">
        </jdbcConnection>
        <javaTypeResolver>
            <!--<property name="forceBigDecimals" value="false"/>-->
        </javaTypeResolver>
        <!--生成Model类存放位置
            targetPackage   生成到哪个包下
            targetProject   生成到当前文件的哪个对应路径下
        <javaModelGenerator targetPackage="cool.ale.pojo" targetProject="src/main/java">
            <!--<property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>-->
        </javaModelGenerator>
        <!--生成映射文件存放位置
        <sqlMapGenerator targetPackage="cool.ale.mapper" targetProject="src/main/resources">
            <!--<property name="enableSubPackages" value="true"/>-->
        </sqlMapGenerator>
        <!--生成Dao类存放位置
            type  指定生成的方式
                1、使用注解的方式生成
                2、使用接口绑定的方式生成（一定要配置sqlMapGenerator）
        <javaClientGenerator type="XMLMAPPER" targetPackage="cool.ale.mapper" targetProject="src/main/java">
        </javaClientGenerator>
        <!--生成对应表及类名
            domainObjectName  对应的实体类的名字
            mapperName  对应的mapper接口以及mapper.xml文件的名字-->
        <table tableName="emp" domainObjectName="Emp"></table>
        <table tableName="dept" domainObjectName="Dept"></table>
    </context>
</generatorConfiguration>

3、找到maven中这个插件，双击运行

2.2、集成mybatis并测试

1、在pom文件中引入mybatis和mysql的依赖，代码如下所示：

<!-- mybatis连接池，是mybatis自己提供 -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.2.0</version>
</dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>

2、在全局配置文件里面配置mapper-location的路径，指定mapper.xml文件在哪

# 设置mybatis的mapper-location
mybatis:
  mapper-locations: classpath:cool/ale/mapper/*Mapper.xml

3、在SpringBoot启动类的地方指定mapper接口的路径，如下所示：

@MapperScan("cool.ale.mapper")
public class SpringbootMybatisApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootMybatisApplication.class, args);
    }
}

4、写一个controller来测试刚才生成的CRUD代码：

package cool.ale.controller;

import cool.ale.mapper.EmpMapper;
import cool.ale.pojo.Emp;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
@RestController
@RequestMapping("/emp")
public class EmpController {
    @Autowired
    private EmpMapper empMapper;
    @RequestMapping("/all")
    public List<Emp> selectAll(){
        return empMapper.selectAll();
    }
}

5、成功截图如下：

3、其它

3.1、自定义druid链接池

1、在pom文件中加入依赖：

<!-- 缺少 druid 连接池 -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.2.3</version>
</dependency>

2、全局配置里面配置：

spring:
  # application:
  #  name: dev-manager
  datasource:
    # 配置数据源类型
    type:
      com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/springboot_mybatis?useUnicode=true&characterEncoding=UTF-8
    username: root
    password: root
    # 初始化，最小，最大连接数
    initialSize: 3
    minidle: 3
    maxActive: 18
    # 获取数据库连接等待的超时时间
    maxWait: 60000
    # 配置多久进行一次检测，检测需要关闭的空闲连接 单位毫秒
    timeBetweenEvictionRunsMillis: 60000
    validationQuery: SELECT 1 FROM dual
    # 配置监控统计拦截的filters,去掉后，监控界面的sql无法统计
    # filters: stat,wall,log4j
    # 初始化时运行sql脚本
    schema: classpath:sql/schema.sql
    initialization-mode: always

3、书写配置类，其实和刚才我们进入jar包写的方法差不多，代码如下：

package cool.ale.config;

import com.alibaba.druid.pool.DruidDataSource;
import com.alibaba.druid.support.http.StatViewServlet;
import com.alibaba.druid.support.http.WebStatFilter;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import javax.sql.DataSource;
@Configuration
// 当我们的全局配置文件配置了 spring.datasource.type 属性时，这个类才生效
@ConditionalOnProperty("spring.datasource.type")
public class DruidConfiguration {
    @Bean
    // 会绑定 application.yml 所有的 spring.datasource 开头的配置绑定到 DataSource
    @ConfigurationProperties("spring.datasource")
    public DataSource dataSource(){
        return new DruidDataSource();
    }
    /*// 第二种办法
    public DataSource dataSource(DataSourceProperties properties){
        // 根据配置动态创建一个 DataSource
        return properties.initializeDataSourceBuilder().build();
    }*/
    /**
     * 监控台的 servlet
     */
    public ServletRegistrationBean statViewServlet() {
        ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean();
        servletRegistrationBean.setServlet(new StatViewServlet());
        // 设置了这个属性之后，我们就可以通过 druid 地址去访问 druid 的一个监控台
        // 比如：http://localhost:8080/druid/login.html
        servletRegistrationBean.addUrlMappings("/druid/*");
        // 添加IP白名单
        servletRegistrationBean.addInitParameter("allow","127.0.0.1");
        // 添加IP黑名单，当白名单和黑名单重复时，黑名单优先级更高
        servletRegistrationBean.addInitParameter("deny","127.0.0.1");
        // 添加控制台管理用户
        servletRegistrationBean.addInitParameter("loginUsername","admin");
        servletRegistrationBean.addInitParameter("loginPassword","123456");
        // 是否能够重置数据
        servletRegistrationBean.addInitParameter("resetEnable","false");
        return servletRegistrationBean;
     * 配置服务过滤器：监控哪些访问
     *
     * @return 返回过滤器的配置对象
    public FilterRegistrationBean statFilter() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(new WebStatFilter());
        // 添加过滤器规则，所有的请求都会被拦截
        filterRegistrationBean.addUrlPatterns("/*");
        // 忽略过滤格式
        filterRegistrationBean.addInitParameter("exclusions","*.js,*.gif,*.jpg,/druid/*");
        return filterRegistrationBean;
}

3.2、SpringBoot的Mybatis其它配置

@Bean
@ConditionalOnMissingBean
public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
    SqlSessionFactoryBean factory = new SqlSessionFactoryBean();
    factory.setDataSource(dataSource);
    factory.setVfs(SpringBootVFS.class);
    // 设置Mybatis的全局配置文件
    if (StringUtils.hasText(this.properties.getConfigLocation())) {
        factory.setConfigLocation(this.resourceLoader.getResource(this.properties.getConfigLocation()));
    }

	// 有另一种定制方法的体现
	// 里面有一些关于mybatis全局配置文件的setting的实现
    this.applyConfiguration(factory);
    if (this.properties.getConfigurationProperties() != null) {
        factory.setConfigurationProperties(this.properties.getConfigurationProperties());
	// Mybatis的插件拦截器，
	// 我们只需要实现了一个Interceptor接口的拦截器注入到IOC容器中，就可以起作用
    if (!ObjectUtils.isEmpty(this.interceptors)) {
        factory.setPlugins(this.interceptors);
	// 设置数据库厂商ID
    if (this.databaseIdProvider != null) {
        factory.setDatabaseIdProvider(this.databaseIdProvider);
	// 去application.yml去找typeAliasesPackage属性，设置别名使用
    if (StringUtils.hasLength(this.properties.getTypeAliasesPackage())) {
        factory.setTypeAliasesPackage(this.properties.getTypeAliasesPackage());
	// 根据父类给子类设置别名
	// 去application.yml找aliasesSuperType属性
    if (this.properties.getTypeAliasesSuperType() != null) {
        factory.setTypeAliasesSuperType(this.properties.getTypeAliasesSuperType());
	// 通过包设置类型处理器
    if (StringUtils.hasLength(this.properties.getTypeHandlersPackage())) {
        factory.setTypeHandlersPackage(this.properties.getTypeHandlersPackage());
	// 通过类设置类型处理器
    if (!ObjectUtils.isEmpty(this.typeHandlers)) {
        factory.setTypeHandlers(this.typeHandlers);
	// 设置mapper-location
    if (!ObjectUtils.isEmpty(this.properties.resolveMapperLocations())) {
        factory.setMapperLocations(this.properties.resolveMapperLocations());
    Set<String> factoryPropertyNames = (Set)Stream.of((new BeanWrapperImpl(SqlSessionFactoryBean.class)).getPropertyDescriptors()).map(FeatureDescriptor::getName).collect(Collectors.toSet());
    Class<? extends LanguageDriver> defaultLanguageDriver = this.properties.getDefaultScriptingLanguageDriver();
    if (factoryPropertyNames.contains("scriptingLanguageDrivers") && !ObjectUtils.isEmpty(this.languageDrivers)) {
        factory.setScriptingLanguageDrivers(this.languageDrivers);
        if (defaultLanguageDriver == null && this.languageDrivers.length == 1) {
            defaultLanguageDriver = this.languageDrivers[0].getClass();
        }
    if (factoryPropertyNames.contains("defaultScriptingLanguageDriver")) {
        factory.setDefaultScriptingLanguageDriver(defaultLanguageDriver);
    return factory.getObject();
}

注意：但是上面的applyConfiguration方法点开之后我们会发现一个问题，要想定制Mybatis的全局配置中的settings，只有下面两种方法。
1、直接在SpringBoot的全局配置文件里面指定Mybatis的全局配置文件
2、在SpringBoot的全局配置文件配置configuration + 实现这个ConfigurationCustomizer类

private void applyConfiguration(SqlSessionFactoryBean factory) {
    org.apache.ibatis.session.Configuration configuration = this.properties.getConfiguration();
    // 当没有配置configuration 但是指定了mybatis的全局配置文件
    if (configuration == null && !StringUtils.hasText(this.properties.getConfigLocation())) {
        configuration = new org.apache.ibatis.session.Configuration();
    }
	// 当配置了configuration 并且实现了ConfigurationCustomizer类
    if (configuration != null && !CollectionUtils.isEmpty(this.configurationCustomizers)) {
        Iterator var3 = this.configurationCustomizers.iterator();
        while(var3.hasNext()) {
            ConfigurationCustomizer customizer = (ConfigurationCustomizer)var3.next();
            customizer.customize(configuration);
        }
    factory.setConfiguration(configuration);
}

到此这篇关于SpringBoot集成Mybatis并测试的文章就介绍到这了,更多相关SpringBoot集成Mybatis内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文