MBG-通用mapper的使用
一、 MBG
1、 什么是MBG
MBG的mybatis的一个插件,可以根据创建的数据库表,生成对应的实体类,dao,mapper文件。
2、使用方法
2.1导入依赖和插件
<!--导入MBG依赖-->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.5</version>
</dependency>
<!--导入MBG插件-->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.5</version>
</plugin>
2.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>
<!--数据库驱动 mysql-connector-java-5.1.47.jar包的位置-->
<classPathEntry location="G:\maven\repository\mysql\mysql-connector-java\5.1.47\mysql-connector-java-5.1.47.jar"/>
<context id="mysql" targetRuntime="MyBatis3">
<!--是否忽略注释的生成 true -->
<commentGenerator>
<!-- 这个元素用来去除指定生成的注释中是否包含生成的日期 false:表示包含 -->
<!-- 如果生成日期,会造成即使修改一个字段,整个实体类所有属性都会发生变化,不利于版本控制,所以
设置为true -->
<property name="suppressDate" value="true" />
<!-- 是否去除自动生成的注释 true:是 : false:否 -->
<property name="suppressAllComments" value="true" />
</commentGenerator>
<!--数据库链接地址账号密码-->
<!--数据库链接URL,用户名、密码 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/yingx"
userId="账号"
password="密码">
</jdbcConnection>
<!--生成Model类存放位置 entity-->
<javaModelGenerator targetPackage="实体类位置" targetProject="./src/main/java">
<!--是否合并-->
<property name="enableSubPackages" value="true"/>
<!--去除空格-->
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!--生成映射文件存放位置-->
<sqlMapGenerator targetPackage="mapper映射文件位置" targetProject="./src/main/resources">
<!--是否合并-->
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!--生成Dao类存放位置-->
<javaClientGenerator type="XMLMAPPER" targetPackage="com.lbt.yingx_lbt.dao" targetProject="./src/main/java">
<!--是否合并-->
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
<!--生成对应表及类名-->
<!-- <table tableName="yx_admin" domainObjectName="Admin" ></table>-->
<table tableName="yx_user" domainObjectName="User" ></table>
<!--<table tableName="yx_category" domainObjectName="Category" ></table>-->
<!--<table tableName="yx_video" domainObjectName="Video" ></table>-->
<!-- <table tableName="yx_feedback" domainObjectName="Feedback" ></table>-->
<!--<table tableName="yx_log" domainObjectName="Log" ></table>-->
<!-- <table tableName="yx_like" domainObjectName="Like" ></table>-->
</context>
</generatorConfiguration>
快速生成
点击Maven-project,找到自己的项目,点击Plugins,再点击mybatis-generator,最后双击mybatis-generator:generate.
二、通用mapper
1、什么是通用mapper
在MBG的基础之上,解决了mybatis90%的增删改查单表操作。
2、使用方法
2.1、导入相关依赖
<!-- 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>
前提是要有对数据库驱动的依赖,最好加入lombok,简化开发:
<!--数据源的jar包-->
<dependency>
<groupId>commons-dbcp</groupId>
<artifactId>commons-dbcp</artifactId>
<version>1.4</version>
</dependency>
<!--数据库驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.38</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.4</version>
<scope>provided</scope>
</dependency>
2.2、配置相关参数(以Springboot为例)
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/数据库名
username: 账号
password: 密码
mybatis:
type-aliases-package: 实体类的全限定名
2.3、继承mapper
咋使用MBG生成的dao文件中,将类中所有内容删除,然后让这个类继承Mapper(注意:tk包下):
package com.lbt.yingx_lbt.dao;
import tk.mybatis.mapper.common.Mapper;
import com.lbt.yingx_lbt.entity.User;
public interface UserMapper extends Mapper<User> {
}
注意:要在启动类加入注解@MapperScan(“dao文件所在的包名”)
2.4、在生成的实体类中加入如下注解
@Data //写在类上,相当于@Setter+@Getter+@EqualsAndHashCode+@NoArgsConstructor
@AllArgsConstructor //写在类上,生成全部参数构造
@NoArgsConstructor//写在类上,生成无参构造
@Table(name = "t_user") //写在类上 指定实体类映射的数据库的表名
@Id //写在属性上 表示这个属性对应的是数据库表的主键字段
@Column(name="user_name") //写在属性上 如果实体属性名与数据库字段不一致,表示这个属性映射
的数据库字段名
@Transient //写在属性上 表示该属性在数据库不存在
3、使用详解(这里实体类以Admin为例,dao文件以AdminDao为例)
3.1、查询
3.1.1、查所有
List<Admin> admins = xxxDao.selectAll();
3.1.2、 根据id查询
Admin admin = adminDao.selectByPrimaryKey("1");
3.1.3、条件查询
查询时创建example对象(使用MBG生成实体类是会在实体类包下生成一个xxxExample类),
根据查询的条件设置查询条件,下面举例以id为例,实际使用过程中每个字段都可以用。
//设置查询条件
AdminExample example = new AdminExample();
example.createCriteria().andIdEqualTo("1");//id为1
example.createCriteria().andIdNotEqualTo("1"); //id不为1
example.createCriteria().andIdBetween("1","5"); //id在1到5之间
example.createCriteria().andIdNotBetween("1","5"); //id不在1到5之间
example.createCriteria().andIdIsNull(); //id为null
example.createCriteria().andIdIsNotNull(); //id不为null
example.createCriteria().andIdLike("%2%"); // 模糊条件
example.createCriteria().andIdNotLike("%2%"); // 模糊条件
example.createCriteria().andIdGreaterThan("1"); // > id(大于) 多少
example.createCriteria().andIdGreaterThanOrEqualTo("1"); // >= id(大于等于)多少
example.createCriteria().andIdLessThan("1"); // < id(小于) 多少
example.createCriteria().andIdLessThanOrEqualTo("1"); // <= id(小于等于) 多少
example.createCriteria().andIdIn(Arrays.asList("1","2","3")); //id满足集合数据的数据
example.createCriteria().andIdNotIn(Arrays.asList("1","2","3"));//id不满足集合数据的数据
example.setOrderByClause("upload_time desc" ); //排序查询
//查询数据
List<Admin> admins = adminDao.selectByExample(example);
3.1.4 查询一条数据
第一种:
//设置查询条件对象
Admin admin = new Admin();
admin.setId("5556");
//查询数据
Admin admins = adminDao.selectOne(admin);
第二种:
//设置查询条件
AdminExample example = new AdminExample();
example.createCriteria().andIdEqualTo("555");
//查询数据
Admin admin = adminDao.selectOneByExample(example);
3.1.5、分页查询
//相当于是一个条件,没有条件对所有数据进行分页
AdminExample example = new AdminExample();
//分页查询: 参数:忽略几条,获取几条数据
RowBounds rowBounds = new RowBounds(0,5);
List<Admin> admins = adminMapper.selectByExampleAndRowBounds(example,
rowBounds);
3.1.6、查询数量
第一种:根据传递对象内容进行查询,空对象表示所有数据,返回数量
Admin admin = new Admin();
admin.setPassword("111111");
int i = adminDao.selectCount(admin);
第二种:在中example设置条件,返回数量
AdminExample example = new AdminExample();
example.createCriteria().andPasswordEqualTo("111111");
int i = adminDao.selectCountByExample(example);
3.2、插入
3.2.1、根据对象插入数据
没有设置的数据为null。
第一种:
//封装对象数据
Admin admin=new Admin("1","nanan","123456");
//修改数据
adminDao.insert(admin);
第二种:
//封装对象数据
Admin admin=new Admin();
admin.setId("1");
admin.setUsername("nanan");
//修插入数据
adminDao.insertSelective(admin);
3.3、修改
3.3.1、根据主键修改数据
对象中没有赋值的字段数据会变为空
//设置要修改后的数据
Admin admin = new Admin();
admin.setId("5");
admin.setUsername("nanan");
//修改数据
adminDao.updateByPrimaryKey(admin);
3.3.2、根据主键可选择修改数据
对象中没有赋值的字段数据不会变为空
//设置要修改后的数据
Admin admin = new Admin();
admin.setId("5");
admin.setUsername("nanan");
//修改数据
adminDao.updateByPrimaryKeySelective(admin);
3.3.3、根据条件修改数据
对象中没有赋值的字段数据会变为空
//设置要修改后的数据
Admin admin = new Admin();
admin.setId("1");
admin.setUsername("nanan");
//添加修改条件
AdminExample example = new AdminExample();
example.createCriteria().andIdEqualTo("1");
//修改数据
adminMapper.updateByExample(admin,example)
3.3.4、根据条件可选择修改数据
对象中没有赋值的字段数据不会变为空
//设置要修改后的数据
Admin admin = new Admin();
admin.setId("1");
admin.setUsername("nanan");
//添加修改条件
AdminExample example = new AdminExample();
example.createCriteria().andIdEqualTo("1");
//修改数据
adminMapper.updateByExampleSelective(admin,example);
3.4、删除
3.4.1、根据id删除
adminDao.deleteByPrimaryKey("1");
3.4.2、根据条件删除
//添加删除条件
AdminExample example = new AdminExample();
example.createCriteria().andIdEqualTo("1");
//删除数据
adminMapper.deleteByExample(example);
3.4.3、根据对象数据删除
//添加删除条件对象
Admin admin = new Admin();
admin.setId("1");
//删除数据
adminDao.delete(admin);
3.5、其他
根据id查询该数据是否存在,返回结果是布尔类型的 true|false
boolean b = adminDao.existsWithPrimaryKey("1");