SpringBoot实战记录1:集成Mybatis

2020-08-13

× 文章目录

1. 简介
2. 环境
3. Mybatis集成及使用
4. Mybatis代码生成器的配置及使用

简介

这里记录springboot项目引入mybatis的流程及mybatis代码生成器的配置和使用

环境

idea
jdk1.8

Mybatis集成及使用

1. 引入pom依赖

<dependency>
   <groupId>org.mybatis.spring.boot</groupId>
   <artifactId>mybatis-spring-boot-starter</artifactId>
   <version>1.3.2</version>
</dependency>

2. 定义映射xml文件的路径

application.yml中加入mapper的xml文件路径配置

1
2
3

# MyBatis Mapper所对应的XML文件位置
mybatis:
  mapper-locations: classpath:/com/xjy/world/mapper/*Mapper.xml

3. 数据源配置

数据源可以结合springboot数据源在application.yml中配置

spring:
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    url: jdbc:mysql://ip:3306/test?serverTimezone=UTC
    username: root
    password: root

4. 定义一个tab_user表

DROP TABLE IF EXISTS `tab_user`;
CREATE TABLE `tab_user`  (
  `id` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL,
  `username` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
  `password` varchar(64) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
  `lastModify` datetime(0) NULL DEFAULT NULL,
  `createDate` datetime(0) NULL DEFAULT NULL,
  `version` int(11) NULL DEFAULT NULL,
  `roles` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = COMPACT;

5. 定义一个实体User类

@Data
public class User extends BaseData{
    private String userName;

    private String passWord;

    private String roles;

6. 定义一个Mapper接口

@Mapper
@Repository
public interface UserMapper {
    User getUserByUserName(String userName);
}

7. 定义UserMapper.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="com.xjy.world.dao.UserMapper">
    <select id="getUserByUserName" parameterType="String" resultType="com.xjy.world.company.model.User">
        select * from tab_user where username=#{userName}
    </select>
</mapper>

8. 调用查询

在Service实现类中调用即可

@Service
public class UserServiceImpl extends UserService {
    @Autowired
    private UserMapper userMapper;

	@Override
    public User getUserByUserName(String userName){
        return userMapper.getUserByUserName(userName);
    }
}

Mybatis代码生成器的配置及使用

为了简化开发，可以使用Mybatis代码生成器生成xml、Mapper、实体类等，下面方法为maven插件方法

1. 引入mybatis-generator插件

pom文件中加入如下配置

<!--mybatis-generator插件-->
<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.2</version>
    <configuration>
        <verbose>true</verbose>
        <overwrite>true</overwrite>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.21</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>
    <!--导入属性配置-->
    <properties resource="mybatis-generate/application.properties"></properties>

    <!--指定特定数据库的jdbc驱动jar包的位置-->
    <!--<classPathEntry location="${jdbc.driverLocation}"/>-->

    <context id="default" targetRuntime="MyBatis3">

        <!-- optional，旨在创建class时，对注释进行控制 -->
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <!--jdbc的数据库连接 -->
        <jdbcConnection
                driverClass="${spring.datasource.driver-class-name}"
                connectionURL="${spring.datasource.url}"
                userId="${spring.datasource.username}"
                password="${spring.datasource.password}">
        </jdbcConnection>


        <!-- 非必需，类型处理器，在数据库类型和java类型之间的转换控制-->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>


        <!-- Model模型生成器,用来生成含有主键key的类，记录类 以及查询Example类
            targetPackage     指定生成的model生成所在的包名
            targetProject     指定在该项目下所在的路径
        -->
        <javaModelGenerator targetPackage="com.xjy.world.demo.entity"
                            targetProject="src/main/java">

            <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="false"/>
            <!-- 是否对model添加 构造函数 -->
            <property name="constructorBased" value="true"/>
            <!-- 是否对类CHAR类型的列的数据进行trim操作 -->
            <property name="trimStrings" value="true"/>
            <!-- 建立的Model对象是否 不可改变  即生成的Model对象不会有 setter方法，只有构造方法 -->
            <property name="immutable" value="false"/>
        </javaModelGenerator>

        <!--Mapper映射文件生成所在的目录 为每一个数据库的表生成对应的SqlMap文件 -->
        <sqlMapGenerator targetPackage="com.xjy.world.demo.mapper"
                         targetProject="src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- 客户端代码，生成易于使用的针对Model对象和XML配置文件 的代码
                type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象
                type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象
                type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口
        -->
        <javaClientGenerator targetPackage="com.xjy.world.demo.dao"
                             targetProject="src/main/java" type="XMLMAPPER">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>


        <table tableName="tab_user" domainObjectName="TabUser"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
        </table>
    </context>
</generatorConfiguration>

3. 新增Run Configuration配置

新增maven类型的Run Configuration配置:

1	mybatis-generator:generate -e

4. 调用生成器

在生成规则中配置好需要映射的表以后，运行上述maven类型的Run Configuration项，即可生成对应的文件。

本文作者： 夏军谊
本文链接： https://www.xiajunyi.com/pages/p68.html
版权声明：本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可。转载请注明出处！

欢迎来到评论区