MBG(mybatis逆向工程)+通用mapper+lombok-阿里云开发者社区

一、MBG(mybatis-generator)逆向工程

1.1相关介绍

mybatis的一个插件,根据创建数据库表,生成实体类,dao,mapper文件

1.2.使用

1.导入jar

<!--导入MBG依赖-->
<dependency>
  <groupId>org.mybatis.generator</groupId>
  <artifactId>mybatis-generator-core</artifactId>
  <version>1.3.5</version>
</dependency>

2.导入插件

<!--导入MBG插件-->
<plugin>
  <groupId>org.mybatis.generator</groupId>
  <artifactId>mybatis-generator-maven-plugin</artifactId>
  <version>1.3.5</version>
</plugin>

3.添加generatorConfig.xml配置文件

注意：名字必须叫**generatorConfig.xml**

主要改：

数据库驱动，改为本地仓库的mysql的Jar包路径

数据库链接地址账号密码

生成Model类存放位置 entity，dao,mapper

生成对应表及类名

<?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>
    <!--数据库驱动-->
    <classPathEntry location="D:\develop\Repository\mysql\mysql-connector-java\8.0.16\mysql-connector-java-8.0.16.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.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/yingxue_app?serverTimezone=UTC"
                        userId="root"
                        password="root">
        </jdbcConnection>
        <!--生成Model类存放位置 entity-->
        <javaModelGenerator targetPackage="com.tjcu.entity" targetProject="./src/main/java">
            <!--是否合并-->
            <property name="enableSubPackages" value="true"/>
            <!--去除空格-->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!--生成映射文件存放位置-->
        <sqlMapGenerator targetPackage="com/tjcu/mapper" targetProject="./src/main/resources">
            <!--是否合并-->
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
        <!--生成Dao类存放位置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.tjcu.dao" targetProject="./src/main/java">
            <!--是否合并-->
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
        <!--生成对应表及类名-->
        <table tableName="yx_category" domainObjectName="Category" ></table>
        <!--<table tableName="banner" domainObjectName="Banner" ></table>-->
    </context>
</generatorConfiguration>

1.3 执行自动生成

在Idea右侧Maven窗口，展开当前module-->展开Plugins-->展开mybatis-generator
-->双击mybatis-generator:generate

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-b0YqAwpP-1641307265412)(image/image_1.png)]

二、通用mapper使用文档

通用 Mapper4 是一个可以实现任意 MyBatis 通用方法的框架，项目提供了常规的增删改查操作以及Example 相关的单表操作。

通用 Mapper 是为了解决 MyBatis 使用中 90% 的基本操作，使用它可以很方便的进行开发，可以节省开发人员大量的时间。

更多详细的使用可以参考官方文档：https://github.com/abel533/Mapper/wiki

2.1MBG与通用Mapper的关系及功能对比

2.2引入依赖

<!-- 通用Mapper的依赖 -->
<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper-spring-boot-starter</artifactId>
    <version>2.1.5</version>
</dependency>

2.3使用通用Mapper

步骤：

1> 删除MBG自动生成的mapper.xml文件

2> 修改MBG自动生成的dao接口

a) 删除MGB自动生成的dao接口中的所有方法

b) 继承通用Mapper

3> 在springboot的入口类中，增加新注解（如果2个注解都有则必须先导tk包中的）

@tk.mybatis.spring.annotation.MapperScan(“com.baizhi.dao”)

@org.mybatis.spring.annotation.MapperScan(“com.baizhi.yyl.dao”)

4> 在实体类中使用相关注解

修改MBG自动生成的dao接口

/**
 * (CategoryMapper)表数据库访问层
 *
 * @author 程序员小王
 * @since 2022-01-03 16:04:30
 */
public interface CategoryMapper extends Mapper<CategoryMapper> {
}

在实体类及属性上增加相关注解

@Table 用在类上，指定实体类对应的表名

@Id 用在属性上，表示属性对应的字段是主键字段

@Column 用在属性上，指定属性对应的实际字段名

@Transient用在属性上，表示属性在数据库中无对应字段(业务属性)

@Table(name = "t_user")    //用在类上 指定该实体类 对应的表名
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    @Id      // 用在属性上 表示这个属性对应的是表的主键字段
    private Integer id;
    @Column(name="user_name") //用在属性上 当实体属性名与字段名不一致时 必须使用，用来指定这个属性对应的实际字段名
    private String name;
    private Integer age;
    private Date  bir;
    @Transient   //用在属性上  表示该属性在数据库不存在（通常用在因业务增加的属性上）
    private String totalScore;
}

在springboot的入口类中，增加新注解（如果2个注解都有则必须先导tk包中的）@tk.mybatis.spring.annotation.MapperScan("com.baizhi.dao")<br />@org.mybatis.spring.annotation.MapperScan("com.baizhi.yyl.dao")

2.4.测试通用Mapper

1.查询

1.查询所有

List<Admin> admins = adminDao.selectAll();

2.根据主键id查询

Admin admin = adminDao.selectByPrimaryKey("1");

3.条件查询

条件查询时创建条件对象 example,根据要查询的字段设置查询条件，查询返回集合数据，下面以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);

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);

5.分页查询

跟据条件分页查询

//相当于是一个条件，没有条件对所有数据进行分页
AdminExample example = new AdminExample();
//分页查询： 参数：忽略几条,获取几条数据
RowBounds rowBounds = new RowBounds(0,5);
//查询
List<Admin> admins = adminMapper.selectByExampleAndRowBounds(example, rowBounds);

6.查询数量

根据传递对象内容进行查询，空对象表示所有数据，返回数量

Admin admin = new Admin();
admin.setPassword("111111");
int i = adminDao.selectCount(admin);

7.根据条件查询数量

在中example设置条件，返回数量

AdminExample example = new AdminExample();
example.createCriteria().andPasswordEqualTo("111111");
int i = adminDao.selectCountByExample(example);

2.插入

1.根据对象插入数据

没有设置的数据为null

//封装对象数据
Admin admin=new Admin("1","nanan","123456"); // 指定id的值是1
//修改数据
adminDao.insert(admin);

2.可选择插入数据

没有设置的数据为null

//封装对象数据
Admin admin=new Admin();  // 没指定id值，或以使用数据库中的自动生成
admin.setUsername("nanan");
//修插入数据
adminDao.insertSelective(admin);

3.修改

1.根据主键修改数据

对象中没有赋值的字段数据会变为null

//设置要修改后的数据
Admin admin = new Admin();
admin.setId("5");
admin.setUsername("nanan");
//修改数据
adminDao.updateByPrimaryKey(admin);

2.根据主键可选择修改数据

对象中没有赋值的字段数据不会变为null，而是保持原值

//设置要修改后的数据
Admin admin = new Admin();
admin.setId("5");
admin.setUsername("nanan");
//修改数据
adminDao.updateByPrimaryKeySelective(admin);

3.根据条件修改数据

对象中没有赋值的字段数据会变为空

//设置要修改后的数据
Admin admin = new Admin();
admin.setId("1");
admin.setUsername("nanan");
//添加修改条件
AdminExample example = new AdminExample();
example.createCriteria().andIdEqualTo("1");
//修改数据
adminMapper.updateByExample(admin,example);

4.根据条件可选择修改数据

对象中没有赋值的字段数据不会变为空

//设置要修改后的数据
Admin admin = new Admin();
admin.setId("1");
admin.setUsername("nanan");
//添加修改条件
AdminExample example = new AdminExample();
example.createCriteria().andIdEqualTo("1");
//修改数据
adminMapper.updateByExampleSelective(admin,example);

4.删除

1.根据id删除

adminDao.deleteByPrimaryKey("1");

2.根据条件删除

//添加删除条件
AdminExample example = new AdminExample();
example.createCriteria().andIdEqualTo("1");
//删除数据
adminMapper.deleteByExample(example);

3.根据对象数据删除

//添加删除条件对象
Admin admin = new Admin();
admin.setId("1");
//删除数据
adminDao.delete(admin);

5.其他api

根据id查询该数据是否存在，返回结果是布尔类型的 true|false

boolean b = adminDao.existsWithPrimaryKey("1");

2.5 扩展自己的dao接口方法

同原来的开发步骤一样

1> 定义接口方法

2> 定义mapper.xml文件实现dao接口及方法

3> 在application.properties中注册mapper文件

4> 入口类上扫描dao接口

@tk.mybatis.spring.annotation.MapperScan(“com.baizhi.dao”)

@org.mybatis.spring.annotation.MapperScan(“com.baizhi.yyl.dao”)

注意：如果2个MapperScan注解都有时，一定要必须先导tk包中的！！！

三、lombok的使用

概念：lombok是一个简化 Java 代码的工具

作用：Lombok能通过注解的方式，在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法

大致意思是Lombok通过增加一些“处理程序”，可以让java变得简洁、快速。
Lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率。
   例如开发中经常需要写的javabean，
   都需要花时间去添加相应的getter/setter，也
   许还要去写构造器、equals等方法，而且需要维护，当属性多时会出现大量的getter/setter方法，
   这些显得很冗长也没有太多技术含量，一旦修改属性，就容易出现忘记修改对应方法的失误。
Lombok能通过注解的方式，
    在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法。
     出现的神奇就是在源码中没有getter和setter方法，
     但是在编译生成的字节码文件中有getter和setter方法。
     这样就省去了手动重建这些代码的麻烦，使代码看起来更简洁些。

1.在pom.xml中引依赖

<!-- 引入lombok的依赖 -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.4</version>
    <scope>provided</scope>
</dependency>

2.常用注解

@Data

位置：类上

作用: 为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法

(集合了@ToString、@EqualsAndHashCode、@Getter/@Setter、@RequiredArgsConstructor的所有特性)

注意: 如为final属性，则不会为该属性生成setter方法

@Getter/@Setter

位置：类上属性上

作用：为类中所有的属性或者指定的属性生成get、set方法

@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor

位置: 类上

作用：为类生成无惨构造 | 部分参数构造器 | 全参构造器

注意: Lombok没法实现多种参数构造器的重载

MBG(mybatis逆向工程)+通用mapper+lombok

一、MBG(mybatis-generator)逆向工程

二、通用mapper使用文档

三、lombok的使用

热门文章

最新文章

相关课程

相关电子书