SpringBoot使用Mybatis-Generator

本文介绍如何将Maven和Mybatis-Generator配合使用。

image

简介

Mybatis-Generator是Mybatis提供的一个便捷型插件，自动可以为项目生产对应的实体类，Mapper，dao层。

官网文档：http://www.mybatis.org/generator/index.html

入门案例

本文使用SpringBoot结合Mybatis-Generator插件使用，数据库Mysql。

新建项目

新建一个SpringBoot项目。

依赖文件

在项目pom文件中，引入Mybatis-Generator插件，并且引入Mybatis和Mysql依赖。完整pom代码如下：

    4.0.0

    com.dalaoyang
    springboot_generator
    0.0.1-SNAPSHOT
    jar

    springboot_generator
    springboot_generator

    
        org.springframework.boot
        spring-boot-starter-parent
        1.5.15.RELEASE
         
    

    
        UTF-8
        UTF-8
        1.8
    

    
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
        
            org.springframework.boot
            spring-boot-starter-web
        
        
            org.mybatis.spring.boot
            mybatis-spring-boot-starter
            1.3.1
        

        
            org.springframework.boot
            spring-boot-devtools
            runtime
        
        
            mysql
            mysql-connector-java
            runtime
        
    

    
        
            
                org.mybatis.generator
                mybatis-generator-maven-plugin
                1.3.2
                
                    
                        mybatis-generator
                        deploy
                        
                            generate
                        
                    
                
                
                    
                    src/main/resources/mybatis-generator/generatorConfig.xml
                    true
                    true
                
                
                    
                        mysql
                        mysql-connector-java
                        5.1.46
                    
                    
                        org.mybatis.generator
                        mybatis-generator-core
                        1.3.2
                    
                
            
            
                org.springframework.boot
                spring-boot-maven-plugin
                
                    exec
                
            
        
    

配置Mybatis-Generator配置

在pom文件中配置的Mybatis-Generator 工具配置文件的位置新建一个generatorConfig.xml，（本文案例配置的位置是src/main/resources/mybatis-generator/generatorConfig.xml），配置文件代码如下，具体配置需要自行修改至自己的项目：

配置application.properties

配置项目的application.properties，其中数据库信息，Mapper地址之前都有过介绍，具体SpringBoot-Mybatis配置可以参考：
《SpringBoot+Mybatis+MySql学习》

本文配置如下：

## mapper xml 文件地址
mybatis.mapper-locations=classpath*:mapper/*Mapper.xml

##数据库url
spring.datasource.url=jdbc:mysql://localhost:3306/test?characterEncoding=utf8&useSSL=false
##数据库用户名
spring.datasource.username=root
##数据库密码
spring.datasource.password=123456
##数据库驱动
spring.datasource.driver-class-name=com.mysql.jdbc.Driver


#Mybatis Generator configuration
#dao类和实体类的位置
mybatis.project =src/main/java
#mapper文件的位置
mybatis.resources=src/main/resources

到这里其实配置就完成了，可以体验Mybatis-Generator插件的优点了，在右侧Maven处点击如图所示位置，如图：

image

点击完成后，可以看到Mapper，dao，实体类都已经创建好了，如图：

image

创建完成会给我生成几个默认的建当方法，如UserMapper代码如下：

package com.dalaoyang.dao;

import com.dalaoyang.entity.User;
import org.apache.ibatis.annotations.Mapper;

import java.util.List;

public interface UserMapper {
    /**
     * This method was generated by MyBatis Generator.
     * This method corresponds to the database table user
     *
     * @mbggenerated
     */
    int deleteByPrimaryKey(Long id);

    /**
     * This method was generated by MyBatis Generator.
     * This method corresponds to the database table user
     *
     * @mbggenerated
     */
    int insert(User record);

    /**
     * This method was generated by MyBatis Generator.
     * This method corresponds to the database table user
     *
     * @mbggenerated
     */
    User selectByPrimaryKey(Long id);

    /**
     * This method was generated by MyBatis Generator.
     * This method corresponds to the database table user
     *
     * @mbggenerated
     */
    List selectAll();

    /**
     * This method was generated by MyBatis Generator.
     * This method corresponds to the database table user
     *
     * @mbggenerated
     */
    int updateByPrimaryKey(User record);
}

UserMapper.xml代码如下：

  
    
    
    
    
  
  
    
    delete from user
    where id = #{id,jdbcType=BIGINT}
  
  
    
    
      SELECT LAST_INSERT_ID()
    
    insert into user (user_name, user_password)
    values (#{userName,jdbcType=VARCHAR}, #{userPassword,jdbcType=VARCHAR})
  
  
    
    update user
    set user_name = #{userName,jdbcType=VARCHAR},
      user_password = #{userPassword,jdbcType=VARCHAR}
    where id = #{id,jdbcType=BIGINT}
  
  
    
    select id, user_name, user_password
    from user
    where id = #{id,jdbcType=BIGINT}
  
  
    
    select id, user_name, user_password
    from user
  

测试使用

新增测试方法

在UserMapper上加入注解@Mapper表明是持久化映射层，启动类上加入注解@RestController进行测试，这里简单调用一个查询所有的方法selectAll，启动类代码如下:

@SpringBootApplication
@RestController
public class SpringbootGeneratorApplication {

    @Autowired
    private UserMapper userMapper;

    @GetMapping("/findAll")
    public List findAll(){
        return userMapper.selectAll();
    }

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

运行测试

运行项目，浏览器访问localhost:8080/findAll如图所示：

image

源码下载 ：大老杨码云