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`)
)
第二部分:项目搭建
一、构建Maven项目
项目目录结构如下:
二、添加项目依赖
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.4</version>
</dependency>
<dependency>
<groupId>org.mybatis.dynamic-sql</groupId>
<artifactId>mybatis-dynamic-sql</artifactId>
<version>1.1.4</version>
</dependency>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.4.0</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.19</version>
</dependency>
三、创建 generatorConfig.xml 文件
注意:这里通过插件自动创建generatorConfig.xml文件
1、给IDE安装MyBatis Generator插件
2、搜索并安装插件
3、创建 generatorConfig.xml 文件
项目上右键 -> new -> other
4、通过插件创建的 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>
<context id="context1">
<jdbcConnection connectionURL="???" driverClass="???" password="???" userId="???" />
<javaModelGenerator targetPackage="???" targetProject="???" />
<javaClientGenerator targetPackage="???" targetProject="???" type="XMLMAPPER" />
<table schema="???" tableName="???">
<columnOverride column="???" property="???" />
</table>
</context>
</generatorConfiguration>
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<Integer> 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<String> 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<Integer> 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<Integer> id = column("id", JDBCType.INTEGER);
public final SqlColumn<String> name = column("name", JDBCType.VARCHAR);
public final SqlColumn<Integer> age = column("age", JDBCType.INTEGER);
public User() {
super("user");
}
}
}
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<User> 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<User> 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<User> 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<User> 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<User> 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<User> 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<User> 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<User> 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<User> 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<UpdateModel> updateAllColumns(User record, UpdateDSL<UpdateModel> 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<UpdateModel> updateSelectiveColumns(User record, UpdateDSL<UpdateModel> 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))
);
}
}
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;
}
}
第三部分:运行与测试
一、编写Properties文件
jdbc.properties
jdbc.driverClass=数据库Driver
jdbc.url=数据库URL
jdbc.username=数据库Username
jdbc.password=数据库Password
二、编写MyBatis配置文件
mybatis-config.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "mybatis-3-config.dtd" >
<configuration>
<!-- 引入外部资源文件 -->
<properties resource="jdbc.properties"></properties>
<!-- 配置环境 -->
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<!-- 配置连接信息 -->
<property name="driver" value="${jdbc.driverClass}"/>
<property name="url" value="${jdbc.url}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper class="com.dao.UserMapper"/>
</mappers>
</configuration>
三、编写测试类
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<User> rows = mapper.selectMany(selectStatement);
System.out.println(rows);
}
}
}