springboot mybatis 配置

本文介绍mybatis、mybatis-generator配置使用。

依赖安装

<!--添加mysql相关插件-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
    <version>8.0.17</version>
</dependency>
<!--添加mybatis相关插件-->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.0</version>
</dependency>
<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.3.5</version>
</dependency>
<!--添加mybatis分页插件支持 根据需求可要可不要-->
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>5.0.0</version>
</dependency>

添加数据源&mybatis配置

springboot中mybatis配置文档：http://mybatis.org/spring-boo...

application.properties添加如下内容:

#================== mysql数据库 =====================#
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/maven-test?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

#================== mybatis =====================#
#映射文件路径
mybatis.mapper-locations=classpath:mybatis/mapper/*Mapper.xml
#指定mybatis生成包
mybatis.type-aliases-package=com.chenglulu.mybatis.entity.*
#指定mybatis配置文件路径
mybatis.config-location=classpath:mybatis/mybatis-config.xml

mybatis配置文件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="cacheEnabled" value="true"/>
        <!-- 全局启用或禁用延迟加载 -->
        <setting name="lazyLoadingEnabled" value="true"/>
        <!-- 允许或不允许多种结果集从一个单独的语句中返回 -->
        <setting name="multipleResultSetsEnabled" value="true"/>
        <!-- 使用列标签代替列名 -->
        <setting name="useColumnLabel" value="true"/>
        <!-- 允许JDBC支持生成的键 -->
        <setting name="useGeneratedKeys" value="false"/>
        <!-- 配置默认的执行器 -->
        <setting name="defaultExecutorType" value="SIMPLE"/>
        <!-- 设置超时时间 -->
        <setting name="defaultStatementTimeout" value="60"/>
        <!-- 设置驼峰标识 -->
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>
    <plugins>
        <plugin interceptor="com.github.pagehelper.PageInterceptor" />
    </plugins>
<!--    <mappers>-->
<!--        <package name="classpath:mybatis/mapper/*Mapper.xml"></package>-->
<!--    </mappers>-->
</configuration>

mybatis-generator配置

在classpath:mybatis路径下新建mybatis-generator.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>
    <!--classPathEntry:数据库的JDBC驱动,换成你自己的驱动位置 可选 -->
    <!--    <classPathEntry  location="/Users/chenglulu/Documents/mysql-connector-java-8.0.17.jar"/>-->
    <!-- 一个数据库一个con≤text,defaultModelType="flat" 大数据字段，不分表 --> 
    <context id="MysqlTables" targetRuntime="MyBatis3" defaultModelType="flat">
        <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表；一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖 -->
        <property name="autoDelimitKeywords" value="true"/>
        <!-- 生成的Java文件的编码 -->
        <property name="javaFileEncoding" value="utf-8"/>
        <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； -->
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <!-- 格式化java代码 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
        <!-- 格式化XML代码 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
        <!-- 注释 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
            <!-- 是否取消注释 -->
            <property name="suppressDate" value="false"/> <!-- 是否生成注释代时间戳-->
        </commentGenerator>
        <!-- jdbc连接-->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
 connectionURL="jdbc:mysql://localhost:3306/maven-test?serverTimezone=UTC" userId="root"
 password="che021392">
            <property name="nullCatalogMeansCurrent" value="true" />
        </jdbcConnection>
        <!-- 类型转换 -->
        <javaTypeResolver>
            <!-- 是否使用bigDecimal， false可自动转化以下类型（Long, Integer, Short, etc.） -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <!-- 生成实体类地址 -->
        <javaModelGenerator targetPackage="com.chenglulu.mybatis.entity" targetProject="src/main/java">
            <!-- 是否允许子包 是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false"/>
            <!-- 是否对modal添加构造函数 -->
            <property name="constructorBased" value="true"/>
            <!-- 从数据库返回的值去掉前后空格 -->
            <property name="trimStrings" value="true"/>
            <!-- 建立modal对象是否不可改变 即生成的modal对象不会有setter方法，只有构造方法 -->
            <property name="immutable" value="false"/>
        </javaModelGenerator>
        <!-- 生成map.xml文件存放地址 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources/mybatis">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>
        <!-- 生成接口dao -->
        <javaClientGenerator targetPackage="com.chenglulu.mybatis.dao" targetProject="src/main/java" type="XMLMAPPER">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>
        <!-- table可以有多个,每个数据库中的表都可以写一个table，tableName表示要匹配的数据库表,也可以在tableName属性中通过使用%通配符来匹配所有数据库表,只有匹配的表才会自动生成文件 enableSelectByPrimaryKey相应的配置表示是否生成相应的接口 -->
        <table tableName="users"
                schema="root"
                domainObjectName="Users"
                enableCountByExample="true"
                enableUpdateByExample="true"
                enableDeleteByExample="true"
                enableSelectByExample="true"
                selectByExampleQueryId="true"
                enableSelectByPrimaryKey="true"
                enableUpdateByPrimaryKey="true"
                enableDeleteByPrimaryKey="true">
        </table>
    </context>
</generatorConfiguration>

pom.xml配置

• 添加资源打包

<resources>
    <resource>
        <directory>src/main/resources</directory>
        <includes>
            <include>**/*.properties</include>
            <include>**/*.yml</include>
            <include>**/*.xml</include>
        </includes>
        <filtering>true</filtering>
    </resource>
</resources>

• 添加mybatis-generator配置插件

<plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>${plugins.mybatis.generator.maven.version}</version>
                <configuration>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                    <configurationFile>src/main/resources/mybatis/mybatis-generator.xml</configurationFile>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>org.mybatis.generator</groupId>
                        <artifactId>mybatis-generator-core</artifactId>
                        <version>1.3.5</version>
                    </dependency>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>${dep.mysql.connector.java.version}</version>
                    </dependency>
                </dependencies>
            </plugin>

启动类添加mapper接口扫描

@SpringBootApplication
@MapperScan(basePackages = {"com.chenglulu.mybatis.dao"})
public class MySpringBootApplication {
    public static void main(String[] args){
        SpringApplication.run(MySpringBootApplication.class, args);
    }
}

示例

maven-test数据库

首先新建maven-test数据库，并新建users表，如下图：

users表结构如下：

生成mapper、dao实体类

执行mvn mybatis-generator:generate -e命令:

• 连接数据库，数据库为mybatis-generator.xml中配置的数据库连接
• 生成实体类，对应mybatis-generator.xml中table表

生成文件如下：

• 生成UsersMapper.xml文件

• 生成mapper、dao实体类

Service使用

package com.chenglulu.service.database;
import com.chenglulu.controller.users.domain.FindUsersParams;
import com.chenglulu.enums.UserDeleteEnum;
import com.chenglulu.enums.UserStatusEnum;
import com.chenglulu.mybatis.dao.UsersMapper;
import com.chenglulu.mybatis.entity.Users;
import com.chenglulu.mybatis.entity.UsersExample;
import com.chenglulu.utils.CommonUtils;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.collections4.CollectionUtils;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.Date;
import java.util.List;
@Service
@Slf4j
public class UsersDatabase {
    @Autowired(required=false)
    private UsersMapper usersMapper;
    /**
    * 新建用户 * @param users Users
    * @return boolean 
    */ 
    public Users insertUser(Users users){
        Date date = new Date();
        users.setId(CommonUtils.getUuid());
        users.setCreateTime(date);
        users.setUpdateTime(date);
        users.setStatus(UserStatusEnum.OK.getCode());
        users.setDelete(UserDeleteEnum.NORMAL.getCode());
        int insertResult = usersMapper.insertSelective(users);
        log.info("insertUser insertResult = {}", insertResult);
        if(insertResult == 1){
            return users;
        }
        return null;
    }
    /**
    * 查询用户列表 * @param params FindUsersParams
    * @return List<Users>
    */
    public List<Users> findUsers(FindUsersParams params){
        UsersExample example = new UsersExample();
        UsersExample.Criteria criteria = example.createCriteria();
        // 按照创建时间 降序排列, id 升序排列； ASC升序，DESC降序，多个条件用逗号分隔
        example.setOrderByClause("create_time desc, id asc");
        if(StringUtils.isNotBlank(params.getUserId())){
            criteria.andIdEqualTo(params.getUserId());
        }
        // 用户名模糊查询
        if(StringUtils.isNotBlank(params.getUsername())){
            criteria.andUserNameLike("%" + params.getUsername() + "%");
        }
        // 手机号查询
        if(StringUtils.isNotBlank(params.getPhone())){
            criteria.andPhoneEqualTo(params.getPhone());
        }
        // 邮箱模糊查询
        if(StringUtils.isNotBlank(params.getEmail())){
            criteria.andEmailEqualTo("%" + params.getEmail() + "%");
        }
        // 删除状态查询
        if(params.getDelete() != null){
            criteria.andDeleteEqualTo(params.getDelete());
        }
        // 多状态过滤
        if(CollectionUtils.isNotEmpty(params.getStatusList())){
            criteria.andStatusIn(params.getStatusList());
        }
        List<Users> usersList = usersMapper.selectByExample(example);
        log.info("findUsers usersList = {}", usersList);
        return usersList;
    }
}