• MyBatis Generator 1.4.0 使用(基础篇)


    MyBatis Generator 1.4.0 使用(基础篇)

    注意:
    JDK版本:jdk-11.0.6
    Maven版本:apache-maven-3.6.3
    IDE版本:Spring Tool Suite 4.6.1.RELEASE
    MyBatis Generator 版本: 1.4.0
    MySQL数据库:MySQL 8.0.13


    第一部分:构建数据库

    一、表结构(User表)

    在这里插入图片描述

    二、初始数据

    在这里插入图片描述

    三、建表语句

    CREATE TABLE `user`  (
      `id` int(11) NOT NULL AUTO_INCREMENT,
      `name` varchar(255) NULL DEFAULT NULL,
      `age` int(11) NULL DEFAULT NULL,
      PRIMARY KEY (`id`)
    ) 
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6

    第二部分:项目搭建

    一、构建Maven项目

    项目目录结构如下:

    在这里插入图片描述

    二、添加项目依赖

    
    			org.mybatis
    			mybatis
    			3.5.4
    
    
    
    			org.mybatis.dynamic-sql
    			mybatis-dynamic-sql
    			1.1.4
    
    
    
    			org.mybatis.generator
    			mybatis-generator-maven-plugin
    			1.4.0
    
    
    
    			mysql
    			mysql-connector-java
    			8.0.19
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23

    三、创建 generatorConfig.xml 文件

    注意:这里通过插件自动创建generatorConfig.xml文件

    1、给IDE安装MyBatis Generator插件
    在这里插入图片描述
    2、搜索并安装插件

    在这里插入图片描述
    3、创建 generatorConfig.xml 文件

    项目上右键 -> new -> other

    在这里插入图片描述
    在这里插入图片描述
    4、通过插件创建的 generatorConfig.xml 文件内容如下:

    
    
    
      
        
        
        
        
        
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12

    5、generatorConfig.xml内容简要说明如下:

    具体配置内容可参考官方文档(文章末尾会提供官方网址)

    在这里插入图片描述

    四、自动生成文件

    1、运行并生成对应文件

    在这里插入图片描述
    2、生成文件目录结构

    在这里插入图片描述
    3、生成的文件内容

    UserDynamicSqlSupport.java

    package com.dao;
    
    import java.sql.JDBCType;
    import javax.annotation.Generated;
    import org.mybatis.dynamic.sql.SqlColumn;
    import org.mybatis.dynamic.sql.SqlTable;
    
    public final class UserDynamicSqlSupport {
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4817318+08:00", comments="Source Table: user")
        public static final User user = new User();
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4827334+08:00", comments="Source field: user.id")
        public static final SqlColumn id = user.id;
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4827334+08:00", comments="Source field: user.name")
        public static final SqlColumn name = user.name;
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4827334+08:00", comments="Source field: user.age")
        public static final SqlColumn age = user.age;
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4827334+08:00", comments="Source Table: user")
        public static final class User extends SqlTable {
            public final SqlColumn id = column("id", JDBCType.INTEGER);
    
            public final SqlColumn name = column("name", JDBCType.VARCHAR);
    
            public final SqlColumn age = column("age", JDBCType.INTEGER);
    
            public User() {
                super("user");
            }
        }
    }
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33

    UserMapper.java

    package com.dao;
    
    import static com.dao.UserDynamicSqlSupport.*;
    import static org.mybatis.dynamic.sql.SqlBuilder.*;
    
    import java.util.Collection;
    import java.util.List;
    import java.util.Optional;
    import javax.annotation.Generated;
    import org.apache.ibatis.annotations.DeleteProvider;
    import org.apache.ibatis.annotations.InsertProvider;
    import org.apache.ibatis.annotations.Mapper;
    import org.apache.ibatis.annotations.Result;
    import org.apache.ibatis.annotations.ResultMap;
    import org.apache.ibatis.annotations.Results;
    import org.apache.ibatis.annotations.SelectProvider;
    import org.apache.ibatis.annotations.UpdateProvider;
    import org.apache.ibatis.type.JdbcType;
    import org.mybatis.dynamic.sql.BasicColumn;
    import org.mybatis.dynamic.sql.delete.DeleteDSLCompleter;
    import org.mybatis.dynamic.sql.delete.render.DeleteStatementProvider;
    import org.mybatis.dynamic.sql.insert.render.InsertStatementProvider;
    import org.mybatis.dynamic.sql.insert.render.MultiRowInsertStatementProvider;
    import org.mybatis.dynamic.sql.select.CountDSLCompleter;
    import org.mybatis.dynamic.sql.select.SelectDSLCompleter;
    import org.mybatis.dynamic.sql.select.render.SelectStatementProvider;
    import org.mybatis.dynamic.sql.update.UpdateDSL;
    import org.mybatis.dynamic.sql.update.UpdateDSLCompleter;
    import org.mybatis.dynamic.sql.update.UpdateModel;
    import org.mybatis.dynamic.sql.update.render.UpdateStatementProvider;
    import org.mybatis.dynamic.sql.util.SqlProviderAdapter;
    import org.mybatis.dynamic.sql.util.mybatis3.MyBatis3Utils;
    
    import com.entity.User;
    
    @Mapper
    public interface UserMapper {
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4837321+08:00", comments="Source Table: user")
        BasicColumn[] selectList = BasicColumn.columnList(id, name, age);
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4827334+08:00", comments="Source Table: user")
        @SelectProvider(type=SqlProviderAdapter.class, method="select")
        long count(SelectStatementProvider selectStatement);
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4827334+08:00", comments="Source Table: user")
        @DeleteProvider(type=SqlProviderAdapter.class, method="delete")
        int delete(DeleteStatementProvider deleteStatement);
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4827334+08:00", comments="Source Table: user")
        @InsertProvider(type=SqlProviderAdapter.class, method="insert")
        int insert(InsertStatementProvider insertStatement);
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4827334+08:00", comments="Source Table: user")
        @InsertProvider(type=SqlProviderAdapter.class, method="insertMultiple")
        int insertMultiple(MultiRowInsertStatementProvider multipleInsertStatement);
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4827334+08:00", comments="Source Table: user")
        @SelectProvider(type=SqlProviderAdapter.class, method="select")
        @ResultMap("UserResult")
        Optional selectOne(SelectStatementProvider selectStatement);
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4827334+08:00", comments="Source Table: user")
        @SelectProvider(type=SqlProviderAdapter.class, method="select")
        @Results(id="UserResult", value = {
            @Result(column="id", property="id", jdbcType=JdbcType.INTEGER, id=true),
            @Result(column="name", property="name", jdbcType=JdbcType.VARCHAR),
            @Result(column="age", property="age", jdbcType=JdbcType.INTEGER)
        })
        List selectMany(SelectStatementProvider selectStatement);
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4837321+08:00", comments="Source Table: user")
        @UpdateProvider(type=SqlProviderAdapter.class, method="update")
        int update(UpdateStatementProvider updateStatement);
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4837321+08:00", comments="Source Table: user")
        default long count(CountDSLCompleter completer) {
            return MyBatis3Utils.countFrom(this::count, user, completer);
        }
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4837321+08:00", comments="Source Table: user")
        default int delete(DeleteDSLCompleter completer) {
            return MyBatis3Utils.deleteFrom(this::delete, user, completer);
        }
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4837321+08:00", comments="Source Table: user")
        default int deleteByPrimaryKey(Integer id_) {
            return delete(c -> 
                c.where(id, isEqualTo(id_))
            );
        }
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4837321+08:00", comments="Source Table: user")
        default int insert(User record) {
            return MyBatis3Utils.insert(this::insert, record, user, c ->
                c.map(id).toProperty("id")
                .map(name).toProperty("name")
                .map(age).toProperty("age")
            );
        }
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4837321+08:00", comments="Source Table: user")
        default int insertMultiple(Collection records) {
            return MyBatis3Utils.insertMultiple(this::insertMultiple, records, user, c ->
                c.map(id).toProperty("id")
                .map(name).toProperty("name")
                .map(age).toProperty("age")
            );
        }
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4837321+08:00", comments="Source Table: user")
        default int insertSelective(User record) {
            return MyBatis3Utils.insert(this::insert, record, user, c ->
                c.map(id).toPropertyWhenPresent("id", record::getId)
                .map(name).toPropertyWhenPresent("name", record::getName)
                .map(age).toPropertyWhenPresent("age", record::getAge)
            );
        }
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4837321+08:00", comments="Source Table: user")
        default Optional selectOne(SelectDSLCompleter completer) {
            return MyBatis3Utils.selectOne(this::selectOne, selectList, user, completer);
        }
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4837321+08:00", comments="Source Table: user")
        default List select(SelectDSLCompleter completer) {
            return MyBatis3Utils.selectList(this::selectMany, selectList, user, completer);
        }
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4837321+08:00", comments="Source Table: user")
        default List selectDistinct(SelectDSLCompleter completer) {
            return MyBatis3Utils.selectDistinct(this::selectMany, selectList, user, completer);
        }
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4847324+08:00", comments="Source Table: user")
        default Optional selectByPrimaryKey(Integer id_) {
            return selectOne(c ->
                c.where(id, isEqualTo(id_))
            );
        }
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4847324+08:00", comments="Source Table: user")
        default int update(UpdateDSLCompleter completer) {
            return MyBatis3Utils.update(this::update, user, completer);
        }
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4847324+08:00", comments="Source Table: user")
        static UpdateDSL updateAllColumns(User record, UpdateDSL dsl) {
            return dsl.set(id).equalTo(record::getId)
                    .set(name).equalTo(record::getName)
                    .set(age).equalTo(record::getAge);
        }
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4847324+08:00", comments="Source Table: user")
        static UpdateDSL updateSelectiveColumns(User record, UpdateDSL dsl) {
            return dsl.set(id).equalToWhenPresent(record::getId)
                    .set(name).equalToWhenPresent(record::getName)
                    .set(age).equalToWhenPresent(record::getAge);
        }
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4847324+08:00", comments="Source Table: user")
        default int updateByPrimaryKey(User record) {
            return update(c ->
                c.set(name).equalTo(record::getName)
                .set(age).equalTo(record::getAge)
                .where(id, isEqualTo(record::getId))
            );
        }
    
        @Generated(value="org.mybatis.generator.api.MyBatisGenerator", date="2020-05-15T17:00:52.4847324+08:00", comments="Source Table: user")
        default int updateByPrimaryKeySelective(User record) {
            return update(c ->
                c.set(name).equalToWhenPresent(record::getName)
                .set(age).equalToWhenPresent(record::getAge)
                .where(id, isEqualTo(record::getId))
            );
        }
    }
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
    • 67
    • 68
    • 69
    • 70
    • 71
    • 72
    • 73
    • 74
    • 75
    • 76
    • 77
    • 78
    • 79
    • 80
    • 81
    • 82
    • 83
    • 84
    • 85
    • 86
    • 87
    • 88
    • 89
    • 90
    • 91
    • 92
    • 93
    • 94
    • 95
    • 96
    • 97
    • 98
    • 99
    • 100
    • 101
    • 102
    • 103
    • 104
    • 105
    • 106
    • 107
    • 108
    • 109
    • 110
    • 111
    • 112
    • 113
    • 114
    • 115
    • 116
    • 117
    • 118
    • 119
    • 120
    • 121
    • 122
    • 123
    • 124
    • 125
    • 126
    • 127
    • 128
    • 129
    • 130
    • 131
    • 132
    • 133
    • 134
    • 135
    • 136
    • 137
    • 138
    • 139
    • 140
    • 141
    • 142
    • 143
    • 144
    • 145
    • 146
    • 147
    • 148
    • 149
    • 150
    • 151
    • 152
    • 153
    • 154
    • 155
    • 156
    • 157
    • 158
    • 159
    • 160
    • 161
    • 162
    • 163
    • 164
    • 165
    • 166
    • 167
    • 168
    • 169
    • 170
    • 171
    • 172
    • 173
    • 174
    • 175
    • 176
    • 177

    User.java

    package com.entity;
    
    import javax.annotation.Generated;
    
    public class User {
    	@Generated(value = "org.mybatis.generator.api.MyBatisGenerator", date = "2020-05-15T17:00:52.4787336+08:00", comments = "Source field: user.id")
    	private Integer id;
    
    	@Generated(value = "org.mybatis.generator.api.MyBatisGenerator", date = "2020-05-15T17:00:52.4787336+08:00", comments = "Source field: user.name")
    	private String name;
    
    	@Generated(value = "org.mybatis.generator.api.MyBatisGenerator", date = "2020-05-15T17:00:52.4797336+08:00", comments = "Source field: user.age")
    	private Integer age;
    
    	@Generated(value = "org.mybatis.generator.api.MyBatisGenerator", date = "2020-05-15T17:00:52.4787336+08:00", comments = "Source field: user.id")
    	public Integer getId() {
    		return id;
    	}
    
    	@Generated(value = "org.mybatis.generator.api.MyBatisGenerator", date = "2020-05-15T17:00:52.4787336+08:00", comments = "Source field: user.id")
    	public void setId(Integer id) {
    		this.id = id;
    	}
    
    	@Generated(value = "org.mybatis.generator.api.MyBatisGenerator", date = "2020-05-15T17:00:52.4797336+08:00", comments = "Source field: user.name")
    	public String getName() {
    		return name;
    	}
    
    	@Generated(value = "org.mybatis.generator.api.MyBatisGenerator", date = "2020-05-15T17:00:52.4797336+08:00", comments = "Source field: user.name")
    	public void setName(String name) {
    		this.name = name;
    	}
    
    	@Generated(value = "org.mybatis.generator.api.MyBatisGenerator", date = "2020-05-15T17:00:52.4797336+08:00", comments = "Source field: user.age")
    	public Integer getAge() {
    		return age;
    	}
    
    	@Generated(value = "org.mybatis.generator.api.MyBatisGenerator", date = "2020-05-15T17:00:52.4797336+08:00", comments = "Source field: user.age")
    	public void setAge(Integer age) {
    		this.age = age;
    	}
    
    }
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45

    第三部分:运行与测试

    一、编写Properties文件

    jdbc.properties

    jdbc.driverClass=数据库Driver
    jdbc.url=数据库URL
    jdbc.username=数据库Username
    jdbc.password=数据库Password
    
    • 1
    • 2
    • 3
    • 4

    二、编写MyBatis配置文件

    mybatis-config.xml

    
    
    
    
    
    
      
        
          
          
          	
            
            
            
            
          
        
      
      
      	
      
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22

    三、编写测试类

    AppTest.java

    package com.MybatisGeneratorDemo;
    
    import static com.dao.UserDynamicSqlSupport.age;
    import static com.dao.UserDynamicSqlSupport.id;
    import static com.dao.UserDynamicSqlSupport.name;
    import static com.dao.UserDynamicSqlSupport.user;
    import static org.mybatis.dynamic.sql.SqlBuilder.select;
    
    import java.io.IOException;
    import java.io.InputStream;
    import java.util.List;
    
    import org.apache.ibatis.io.Resources;
    import org.apache.ibatis.session.SqlSession;
    import org.apache.ibatis.session.SqlSessionFactory;
    import org.apache.ibatis.session.SqlSessionFactoryBuilder;
    import org.junit.Test;
    import org.mybatis.dynamic.sql.render.RenderingStrategy;
    import org.mybatis.dynamic.sql.select.render.SelectStatementProvider;
    
    import com.dao.UserMapper;
    import com.entity.User;
    
    public class AppTest {
    
    	@Test
    	public void testSelectByExample() throws IOException {
    		String mybatisConfigPath = "mybatis-config.xml";
    		InputStream inputStream = Resources.getResourceAsStream(mybatisConfigPath);
    		SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    
    		try (SqlSession session = sqlSessionFactory.openSession()) {
    			UserMapper mapper = session.getMapper(UserMapper.class);
    			@SuppressWarnings("deprecation")
    			SelectStatementProvider selectStatement = select(id, name, age).from(user).where().build()
    					.render(RenderingStrategy.MYBATIS3);
    			List rows = mapper.selectMany(selectStatement);
    			System.out.println(rows);
    		}
    	}
    }
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41

    四、运行结果

    在这里插入图片描述

    四、项目整体目录结构

    在这里插入图片描述
    MyBatis Generator官方网址

  • 相关阅读:
    【Linux】管理文件和目录的命令大全
    开具数电票如何减少认证频次?
    Springboot整合Prometheus-自定义指标
    Yolov5 v7.0目标检测——详细记录环境配置、自定义数据处理、模型训练与常用错误解决方法(数据集为河道漂浮物)
    03基于 Vue2.x 的 Vuex3.x .
    Ubuntu systemd.service服务单元配置详解
    基于C语言设计的植物大战僵尸小游戏
    C#基础入门教程-基本语法
    vue学习
    CST初级教程 二
  • 原文地址:https://blog.csdn.net/m0_67391683/article/details/126460101