1. 简介
MyBatis Generator:
• 简称MBG,是一个专门为MyBatis框架使用者定制的代码生成器,可以快速的根据表生成对应的
映射文件,接口,以及bean类。支持基本的增删改查,以及QBC风格的条件查询。但是表连接、
存储过程等这些复杂sql的定义需要我们手工编写
Query By Criteria
Criteria
英
/kraɪˈtɪəriə/
n.
(评判或做决定的)标准,准则,尺度 (criterion 的复数)
• 官方文档地址
http://www.mybatis.org/generator/
• 官方工程地址
https://github.com/mybatis/generator/releases
- 帮助文档:旧版本,不需要 后面html
https://mybatis.org/generator/index.html
-
最新地址为:
<dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator</artifactId> <version>1.4.1</version> </dependency> //教程2017年3月,最新为1.3.5。使用1.3.2
2. 2017年3月 尚硅谷
MBG使用
1) jdbcConnection配置数据库连接信息
2) javaModelGenerator配置javaBean的生成策略
3) sqlMapGenerator 配置sql映射文件生成策略
4) javaClientGenerator配置Mapper接口的生成策略
5) table 配置要逆向解析的数据表
- tableName:表名
- domainObjectName:对应的javaBean名
– 2)运行代码生成器生成代码
Context标签
targetRuntime=“MyBatis3“可以生成带条件的增删改查
targetRuntime=“MyBatis3Simple“可以生成基本的增删改查
如果再次生成,建议将之前生成的数据删除,避免xml向后追加
mybatis-generator 1.3.2
mysql-connectior 5.1.37
mybatis-3.4.1
- eclipse项目
配置文件
<?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>
<!--
targetRuntime="MyBatis3Simple":生成简单版的CRUD
MyBatis3:豪华版
-->
<context id="DB2Tables" targetRuntime="MyBatis3">
<!-- jdbcConnection:指定如何连接到目标数据库 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://192.168.2.219:3306/mybatis?userSSL=false&userUnicode=true&characterEncoding=UTF-8"
userId="root"
password="123456">
</jdbcConnection>
<!-- -->
<javaTypeResolver >
<property name="forceBigDecimals" value="false" />
</javaTypeResolver>
<!-- javaModelGenerator:指定javaBean的生成策略
targetPackage="test.model":目标包名
targetProject="\MBGTestProject\src":目标工程
-->
<javaModelGenerator targetPackage="com.atguigu.mybatis.bean"
targetProject=".\src">
<property name="enableSubPackages" value="true" />
<property name="trimStrings" value="true" />
</javaModelGenerator>
<!-- sqlMapGenerator:sql映射生成策略: 映射文件的生成策略。xml生成的包,-->
<sqlMapGenerator targetPackage="com.atguigu.mybatis.dao"
targetProject=".\conf">
<property name="enableSubPackages" value="true" />
</sqlMapGenerator>
<!-- javaClientGenerator:指定mapper接口所在的位置 -->
<javaClientGenerator type="XMLMAPPER" targetPackage="com.atguigu.mybatis.dao"
targetProject=".\src">
<property name="enableSubPackages" value="true" />
</javaClientGenerator>
<!-- 指定要逆向分析哪些表:根据表要创建javaBean domainObjectName="Department"-->
<table tableName="user"></table>
</context>
</generatorConfiguration>
main方法调用
@Test
public void testMbg() throws Exception {
List<String> warnings = new ArrayList<String>();
boolean overwrite = true;
File configFile = new File("mbg.xml");
//InputStream inputStream = Resources.getResourceAsStream(resource);
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = cp.parseConfiguration(configFile);
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config,
callback, warnings);
myBatisGenerator.generate(null);
}
条件查询使用
SqlSession openSession = build.openSession();
DeptMapper mapper = openSession.getMapper(DeptMapper.class);
DeptExample example = new DeptExample();
//所有的条件都在example中封装
Criteria criteria = example.createCriteria();
//( deptName like ? and id > ? )
criteria.andDeptnameLike("%部%");
criteria.andIdGreaterThan(2);
//再次创建一个条件, 和 上个条件为 或者的关系
Criteria criteria2 = example.createCriteria();
criteria2.andEmailLike("%e%");
example.or(criteria2);
List<Dept> list = mapper.selectByExample(example);
for (Dept dept : list) {
System.out.println(dept);
}
select id, title, author, create_time, views from blog WHERE ( title like ? ) or( title like ? )
3. 项目
pom增加插件 和 引用
- build—plugins
- mybatis 3.5.5
- mysql-connector 8.0.29
- mybatis-generator-maven-plugin 1.4.0
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.3</version>
</dependency>
<!-- MyBatis 逆向生成插件 -->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.4.0</version>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.23</version>
</dependency>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.4.0</version>
</dependency>
</dependencies>
<configuration>
<!--配置文件的路径-->
<configurationFile>src/main/resources/lib/generatorConfig.xml</configurationFile>
<overwrite>true</overwrite>
</configuration>
</plugin>
generatorConfig文件
<?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="test" targetRuntime="MyBatis3">
<plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin"></plugin>
<plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>
<plugin type="org.mybatis.generator.plugins.ToStringPlugin"></plugin>
<plugin type="org.mybatis.generator.plugins.RenameExampleClassPlugin">
<property name="searchString" value="Example$"/>
<property name="replaceString" value="Criteria"/>
</plugin>
<commentGenerator>
<!-- 生成文件编码格式 -->
<property name="javaFileEncoding" value="UTF-8"/>
<!-- 这个元素用来去除指定生成的注释中是否包含生成的日期 false:表示保护 -->
<!-- 如果生成日期,会造成即使修改一个字段,整个实体类所有属性都会发生变化,不利于版本控制,所以设置为true -->
<property name="suppressDate" value="true"/>
<!-- 是否去除自动生成的注释 true:是 : false:否 -->
<property name="suppressAllComments" value="true"/>
</commentGenerator>
<!--数据库链接URL,用户名、密码 -->
<jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
connectionURL="jdbc:mysql://192.168.2.219:3306/mybatis?autoReconnect=true&useUnicode=true&characterEncoding=UTF-8&tinyInt1isBit=false"
userId="root" password="123456">
</jdbcConnection>
<javaTypeResolver>
<!-- This property is used to specify whether MyBatis Generator should
force the use of java.math.BigDecimal for DECIMAL and NUMERIC fields, -->
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<!-- 生成模型的包名和位置 -->
<javaModelGenerator targetPackage="com.hai.tempmybatis.entity"
targetProject="src/main/java">
<property name="enableSubPackages" value="true"/>
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!-- 生成映射文件的包名和位置 -->
<sqlMapGenerator targetPackage="com.hai.tempmybatis.mapper"
targetProject="src/main/resources">
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!-- 生成Mapper 接口的包名和位置-->
<javaClientGenerator type="XMLMAPPER"
targetPackage="com.hai.tempmybatis.mapper"
targetProject="src/main/java">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
<!-- 要生成哪些表-->
<table schema="" tableName="teacher"/>
</context>
</generatorConfiguration>
Tinyint配置
public class TinyintToIntegerResolver extends JavaTypeResolverDefaultImpl {
public TinyintToIntegerResolver() {
super.typeMap.put(-6, new JdbcTypeInformation("TINYINT", new FullyQualifiedJavaType(Integer.class.getName())));
}
}
<javaTypeResolver type="com.config.TinyintToIntegerResolver">
</javaTypeResolver>
4. 整合MyBatis
引入包
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.2</version>
<relativePath/>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.3</version>
</dependency>
<!-- MyBatis 逆向生成插件 -->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.4.0</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
application文件配置
spring.datasource.url=jdbc:mysql://192.168.2.219:3306/mybatis?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# 就是逆向生成 xml文件的位置。src/main/resources下的:
mybatis.mapper-locations=classpath:com/hai/tempmybatis/mapper/*.xml
mybatis.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
主类
@MapperScan("com.hai.tempmybatis.mapper") //扫描 mapper接口
@SpringBootApplication
public class TempMybatisApplication { }
- 流程结束,剩下的 逆向生成即可
实体类 接口 和 mapper.xml
com.hai.tempmybatis.entity
@Data
@NoArgsConstructor
public class User {
private Long id;
private String name;
private String pwd;
}
package com.hai.tempmybatis.mapper;
@Mapper //写不写都行
public interface UserMapper {
User findByName(@Param("name") String name);
int insert(@Param("name") String name, @Param("age") Integer age);
}
\src\main\resources\com\hai\tempmybatis\mapper\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.hai.tempmybatis.mapper.UserMapper">
<select id="findByName" resultType="com.hai.tempmybatis.entity.User">
SELECT * FROM user WHERE NAME = #{name}
</select>
<insert id="insert"> //有问题
INSERT INTO user(NAME, AGE) VALUES(#{name}, #{age})
</insert>
</mapper>
测试
@SuppressWarnings(value = "all")
@SpringBootTest
class TempMybatisApplicationTests {
@Autowired
private UserMapper userMapper;
@Autowired
private StudentMapper studentMapper; //逆向生成的,未注册bean,所以 上面抑制警告。
@Test
void contextLoads() {
User u = userMapper.findByName("张三");
System.out.println(u.getPwd() + u.getName());
for (Student student : studentMapper.selectByExample(null)) {
System.out.println(student.getName());
}
}
}
5. tkMapper
基于MyBatis提供了很多第三方插件,这些插件通常可以完成数据操作方法的封装、数据库逆向工程工作(根据数据表生成实体类、生成映射文件)
- myBatis-plus
- tkMapper
tkMapper是一个MyBatis插件,是在MyBatis的基础上提供了很多的工具,让开发变简单,提高开发效率。
- 提供了针对单表通用的数据库操作方法
- 提供了逆向工程(根据数据表生成实体类、Dao、映射文件)
添加 pom
<!-- https://mvnrepository.com/artifact/tk.mybatis/mapper-spring-boot-starter -->
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId>
<version>2.1.5</version>
</dependency>
修改启动类的@MapperScan
注解的包为tk.mybatis.spring.annotation.MapperScan
import tk.mybatis.spring.annotation.MapperScan;
//扫描 mapper接口
@MapperScan("com.hai.tempmybatis.mapper")
@SpringBootApplication
public class TempMybatisApplication { }
//注意了:使用:无法使用 tkMapper
import org.mybatis.spring.annotation.MapperScan;
新建表
CREATE TABLE `schools` (
`s_id` int(11) NOT NULL AUTO_INCREMENT COMMENT '学校id',
`s_name` varchar(100) NOT NULL COMMENT '学校名称',
`s_loc_provice` varchar(100) NOT NULL DEFAULT '' COMMENT '学校所处省',
`s_loc_city` varchar(100) DEFAULT '' COMMENT '学校所处市',
`s_loc_district` varchar(100) DEFAULT '' COMMENT '学校所处区',
`s_loc_specific` varchar(100) DEFAULT '' COMMENT '学校区下的具体位置',
PRIMARY KEY (`s_id`)
) ENGINE=MyISAM AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COMMENT='学校基本信息表';
实体类
package com.hai.tempmybatis.entity;
@Data
@NoArgsConstructor
@AllArgsConstructor
@Table(name = "schools") // 指定实体类对应的数据表的表名
public class School {
@Id
private Integer sId; //@Column(name = "s_id")
private String sName;
private String sLocProvice;
private String sLocCity;
private String sLocDistrict;
private String sLocSpecific; // 注意:该命名方式对应数据表:s_loc_specific
}
创建 dao
- Mapper接口
import tk.mybatis.mapper.common.Mapper;
import tk.mybatis.mapper.common.MySqlMapper;
package com.hai.tempmybatis.mapper;
public interface SchoolDao extends Mapper<School>, MySqlMapper<School> {
}
测试
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<scope>test</scope>
<version>4.13.2</version>
</dependency>
@RunWith(SpringRunner.class)
@SpringBootTest(classes = CompetitionApplication.class)
public class SchoolDaoTest {
@Autowired
private SchoolDao schoolDao;
@Test
public void test() {
}
}
@SpringBootTest
class TempMybatisApplicationTests {
@Autowired
private SchoolDao schoolDao;
@Test
public void test() {
School school = new School();
school.setSId(3);
school.setSName("成都大学");
school.setSLocProvice("四川省");
school.setSLocCity("成都市");
school.setSLocDistrict("成华区");
school.setSLocSpecific("成洛大道2025号");
int i = schoolDao.insert(school);
System.out.println(i);
}
}
条件查询
// 条件查询
// 1. 创建一个Example封装类别School查询条件
Example example = new Example(School.class);
// 2. 创建条件容器
Example.Criteria criteria = example.createCriteria();
// 3.选择sId == 1 或者 sId == 2的数据 ,这里的sId对应实体类的字段
criteria.andEqualTo("sId",1);
criteria.orEqualTo("sId",2);
// 4. 查询sName中含有`大学`字样的数据
criteria.andLike("sName", "%大学");
List<School> schoolList = schoolDao.selectByExample(example);
for (School school : schoolList) {
System.out.println(school);
}
// 查询记录总条数
System.out.println(schoolDao.selectCount(new School()));
// 查询记录总条数(满足条件)
System.out.println(schoolDao.selectCountByExample(example));
SELECT
*
FROM
schools
WHERE
(
( s_id = 1 OR s_id = 2 AND s_name LIKE "%大学" )
)
- ID是1的 或者 :(id为2,并且大学开头的)
分页查询
// 基本的分页查询
int pageNum = 2;
int pageSize = 10;
int start = (pageNum-1)*pageSize;
// 构造分页信息
RowBounds rowBounds = new RowBounds(start, pageSize);
List<School> schoolList = schoolDao.selectByRowBounds(new School(),rowBounds);
for (School school: schoolList) {
System.out.println(school);
}
// 带有条件的分页查询
Example example = new Example(School.class);
Example.Criteria criteria = example.createCriteria();
criteria.andEqualTo("sId",1);
int pageNum = 1;
int pageSize = 10;
int start = (pageNum-1)*pageSize;
RowBounds rowBounds = new RowBounds(start, pageSize);
List<School> schoolList = schoolDao.selectByExampleAndRowBounds(example,rowBounds);
for (School school: schoolList) {
System.out.println(school);
}
tkMapper的逆向生成
引入插件
<!-- https://mvnrepository.com/artifact/org.mybatis.generator/mybatis-generator-maven-plugin -->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.5</version>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.27</version>
</dependency>
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper</artifactId>
<version>4.1.5</version>
</dependency>
</dependencies>
<configuration>
<configurationFile>${basedir}/src/main/resources/lib/tkMbg.xml</configurationFile>
</configuration>
</plugin>
配置文件
- /resources/lib/tkMbg.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>
<!-- 引入数据库连接配置 MyBatis3Simple-->
<context id="Mysql" targetRuntime="MyBatis3" defaultModelType="flat">
<property name="beginningDelimiter" value=""></property>
<property name="endimgDelimiter" value=""></property>
<!-- 配置GeneralDao-->
<!--<plugin type="tk.mybatis.mapper.generator.MapperPlugin">
<property name="mappers" value="com.hai.tempmybatis.general.GeneralDao"></property>
</plugin>-->
<commentGenerator>
<!-- 是否去除自动生成的注释 true:是 : false:否 -->
<property name="suppressAllComments" value="true"/>
</commentGenerator>
<!-- 配置数据库连接-->
<!--数据库链接URL,用户名、密码 -->
<jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
connectionURL="jdbc:mysql://192.168.2.219:3306/mybatis?autoReconnect=true&useUnicode=true&characterEncoding=UTF-8&tinyInt1isBit=false"
userId="root" password="123456">
</jdbcConnection>
<!-- 配置实体类存放路径-->
<javaModelGenerator targetPackage="com.hai.tempmybatis.entity" targetProject="src/main/java"/>
<!-- 配置XML 存放路径-->
<sqlMapGenerator targetPackage="/" targetProject="src/main/resources/com/hai/tempmybatis/mapper"/>
<!-- 配置 DAO 存放路径-->
<javaClientGenerator targetPackage="com.hai.tempmybatis.mapper" targetProject="src/main/java" type="XMLMAPPER"/>
<!-- 配置需要指定生成的数据库和表 %代表所有表-->
<!-- <table tableName="%">-->
<!-- mysql 配置 -->
<!-- <generatedKey column="id" sqlStatement="Mysql" identity="true"/>-->
<!-- </table>-->
<!-- 生成指定表 -->
<!--<table tableName="goods">
<generatedKey column="g_id" sqlStatement="Mysql" identity="true"></generatedKey>
</table>-->
<table tableName="blog" ></table>
</context>
</generatorConfiguration>
点击Maven插件处:mybatis-generator:generate 运行
- 这里生成的还是 MGB,哈哈哈,一样,并没有什么变化。