码迷,mamicode.com
首页 > 其他好文 > 详细

Mybatis-plus

时间:2021-04-15 12:27:49      阅读:0      评论:0      收藏:0      [点我收藏+]

标签:scanner   view   unicode   ons   ids   hid   父类   查询语句   tostring   

一、快速开发

1.添加依赖

<!--mybatis-plus-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.1</version>
</dependency>
<!--thymeleaf模板-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!--web模板-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--mysql数据库驱动-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>
<!--lombok-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

2.配置

application.properties配置文件

# 应用名称
spring.application.name=mybatis-plus
# 应用服务 WEB 访问端口
server.port=8089
# 数据库驱动:
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# 数据源名称
spring.datasource.name=defaultDataSource
# 数据库连接地址
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis?serverTimezone=UTC
# 数据库用户名&密码:
spring.datasource.username=root
spring.datasource.password=123

application.yml配置文件

#端口号
server:
  port: 8089
# 配置数据源
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis?useSSL=false&charaterEncoding=UTF-8&serverTimezone=Asia/Shanghai
    username: root
    password: 123
  application:
    name: mybatis-plus
  groovy:
    #templates配置
    template:
      # 在构建 URL 时添加到视图名称前的前缀(默认值: classpath:/templates/ )
      suffix: classpath:/templates/
      # 检查模板是否存在,然后再呈现
      check-template-location: true
#配置日志输出
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

3.编码

编写Blog实体类

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Blog {
    private String id;
    private String title;
    private String author;
    private Date createTime;
    private int views;
}

编写Mapper类继承BaseMapper

//标注实体类
@Repository
public interface BlogMapper extends BaseMapper<Blog> {
}

在主启动类上添加mapper包扫描注解

@MapperScan("com.zhoupiyao.mapper")

测试类

@SpringBootTest
class MybatisPlusApplicationTests {
    //可以使用简单的单表查询
    @Autowired
    private BlogMapper blogMapper;
    @Test
    void contextLoads() {
      //查询所有blog
        List<Blog> blogs = blogMapper.selectList(null);
//        for (Blog blog : blogs) {
//            System.out.println(blog);
//        }
//        等价于
        blogs.forEach(System.out::println);
    }
}

二、配置日志输出

在配置文件中加入:

#配置日志输出
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

也可以选择其他日志输出方式,但可能需要导入依赖,例如log4j。

三、CRUD操作

1.主键生成策略

1.默认主键生成策略:雪花算法

snowflake(雪花)算法是Twitter开源的分布式ID生成算法,结果是一个long类型的ID 。其核心思想:使用41bit作为毫秒数,10bit作为机器的ID(5bit数据中心,5bit的机器ID),12bit作为毫秒内的流水号(意味着每个节点在每个毫秒可以产生4096个ID),最后还有一个符号位,永远是0。

当不指定id插入数据时,mybatis会主键自动生成19位的全局唯一id。

插入数据

Blog blog = new Blog();
blog.setAuthor("周皮妖");
blog.setTitle("沮丧的一天");
blog.setCreateTime(new Date());
blog.setViews(100);
blogMapper.insert(blog);

输出结果

==>  Preparing: INSERT INTO blog ( id, title, author, create_time, views ) VALUES ( ?, ?, ?, ?, ? )
==> Parameters: 1382120691462115329(Long), 沮丧的一天(String), 周皮妖(String), 2021-04-14 07:57:06.009(Timestamp), 100(Integer)

2.主键自增策略

必须开启数据表主键的自动增长功能

给主键对应的实体类属性添加注解。

@TableId(type = IdType.AUTO)

3.不同注解对应的主键生成策略

public enum IdType {
    AUTO(0),  //数据库id自增
    NONE(1),  //未设置主键
    INPUT(2), //手动输入
    ID_WORKER(3),//默认的全局唯一id
    ID_WORKER_STR(3),//默认的全局唯一id(字符串格式)
    UUID(4);  //全局唯一 uuid
}

2.自动填充

为了简化创建、更新时间的繁琐操作,通过自动填充可以自动插入创建、更新时间。

1.在数据库添加gmt_creategmt_modified字段分别作为数据库字段的创建时间和修改时间。

2.在实体类中添加gmtCreategmtModified属性,并添加注解。

@TableField(fill = FieldFill.INSERT)
private Date gmtCreate;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date gmtModified;

3.处理器

创建MyMetaObjectHandler类并实现MetaObjectHandler接口,重写insertFill和updateFill方法。

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("自动插入了数据");
        this.setFieldValByName("gmtCreate",new Date(),metaObject);
      //插入创建时间同时插入更新时间
        this.setFieldValByName("gmtModified",new Date(),metaObject);
    }
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("自动修改了数据");
        this.setFieldValByName("gmtModified", new Date(),metaObject);
    }
}

3.乐观锁

当要更新一条记录的时候,希望这条记录没有被别人更新。

乐观锁实现方式:

1.取出记录时,获取当前version

2.更新时,带上这个version

3.执行更新时, set version = newVersion where version = oldVersion,

4.如果version不对,就更新失败

例如:

//先获取version
update table set name="", version = version+1 where id="" and version =oldVersion

使用方法:

1.在数据库添加version字段,并且设置默认值为1.

2.在实体类添加version字段,并增加乐观锁注解@Version

@Version//乐观锁注解
private Integer version;

3.创建配置类MybatisPlusConfig

//扫描mapper包
@MapperScan("com.zhoupiyao.mapper")
//启动事务管理
@EnableTransactionManagement
//标注配置类
@Configuration
public class MybatisPlusConfig {
    /**
     * 旧版--已过时
     */
//    @Bean
//    public OptimisticLockerInterceptor optimisticLockerInterceptor(){
//        return new OptimisticLockerInterceptor();
//    }
    /**
     * 新版
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
        mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return mybatisPlusInterceptor;
    }
}

4.乐观锁测试

按正常逻辑最终传入blog修改会把之前传入blog2修改覆盖,但是因为乐观锁的原因,当传入blog2修改后,对应数据行的version+1,再当传入blog修改时因为读取的还是之前的version所有where语句不通过则无法进行修改!

public void  optimisticLockerTest(){
//        模拟插队操作
//        1.线程1
    Blog blog = blogMapper.selectById(1382204497045069831L);
    blog.setAuthor("小猫咪");
    blog.setTitle("失败的一天");
//        2.线程2
    Blog blog2 = blogMapper.selectById(1382204497045069831L);
    blog2.setAuthor("小狗");
    blog2.setTitle("成功的一天");
    blogMapper.updateById(blog2);

    blogMapper.updateById(blog);
    //正是因为乐观锁,插入blog2而不会被blog覆盖-----插入小狗...!!
}

4.查询

//通过id查询单个用户
selectById(id)
//查询所有用户,没有queryWrapper填null
selectList(queryWrapper querywrapper)
//通过多个id查询多个用户
selectBatchIds(Collection 集合)
//map条件查询
selectByMap(map)

5.分页查询

1.配置类MybatisPlusConfig中注入Bean

// 旧版
@Bean
public PaginationInterceptor paginationInterceptor() {
    PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
    // 设置请求的页面大于最大页后操作, true调回到首页,false 继续请求  默认false
    // paginationInterceptor.setOverflow(false);
    // 设置最大单页限制数量,默认 500 条,-1 不受限制
    // paginationInterceptor.setLimit(500);
    // 开启 count 的 join 优化,只针对部分 left join
    paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));
    return paginationInterceptor;
}

// 最新版
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
    return interceptor;
}

2.分页测试

@Test
public void queryPageTest() {
    //参数1:第几页
    //参数2:每页几条
    Page<Blog> page = new Page<>(1,5);
    Page<Blog> blogPage = blogMapper.selectPage(page, null);
    List<Blog> blogs = blogPage.getRecords();
    blogs.forEach(System.out::println);
}

6.逻辑删除

说明:

只对自动注入的sql起效:

插入: 不作限制

查找: 追加where条件过滤掉已删除数据,且使用 wrapper.entity 生成的where条件会忽略该字段

更新: 追加where条件防止更新到已删除数据,且使用 wrapper.entity 生成的where条件会忽略该字段

删除: 转变为 更新

逻辑删除是为了方便数据恢复和保护数据本身价值等等的一种方案,但实际就是删除。

如果你需要频繁查出来看就不应使用逻辑删除,而是以一个状态去表示。

1.数据库创建字段deleted,默认值0表示未删除,1表示已删除!

2.实体类添加属性deleted并添加逻辑删除域注解

@TableLogic//逻辑删除
private Integer deleted;

3.在application.yml中配置

#配置日志输出
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
    db-config:
      #逻辑删除
      logic-delete-value: 1
      logic-not-delete-value: 0
      logic-delete-field: deleted

4.sql解析

删除语句(实际上是修改语句)

==>  Preparing: UPDATE blog SET deleted=1 WHERE id=? AND deleted=0

查询语句

==>  Preparing: SELECT id,title,author,views,gmt_create,gmt_modified,version,deleted FROM blog WHERE deleted=0 LIMIT ?

四、条件构造器

AbstractWrapper

1.eq

等于 =

eq(R column, Object val)
eq(boolean condition, R column, Object val)

例: eq("name", "老王")--->name = ‘老王‘

2.ne

不等于 <>

ne(R column, Object val)
ne(boolean condition, R column, Object val)

例: ne("name", "老王")--->name <> ‘老王‘

3.gt

大于 >

gt(R column, Object val)
gt(boolean condition, R column, Object val)

例: gt("age", 18)--->age > 18

4.ge

大于等于 >=

ge(R column, Object val)
ge(boolean condition, R column, Object val)

例: ge("age", 18)--->age >= 18

5.lt

小于 <

lt(R column, Object val)
lt(boolean condition, R column, Object val)

例: lt("age", 18)--->age < 18

6.le

小于等于 <=

le(R column, Object val)
le(boolean condition, R column, Object val)

例: le("age", 18)--->age <= 18

7.between
between(R column, Object val1, Object val2)
between(boolean condition, R column, Object val1, Object val2)

例: between("age", 18, 30)--->age在 18 ~ 30区间的

8.notbetween
notBetween(R column, Object val1, Object val2)
notBetween(boolean condition, R column, Object val1, Object val2)

例: notbetween("age", 18, 30)--->age不在 18 ~ 30区间的

9.like
like(R column, Object val)  
like(boolean condition, R column, Object val)

例:
like("name", "周") ==> SQL: name like %周%
notlike("name", "周") ==> SQL: name not like %周%
likeRight("name", "周") ==> SQL: name like 周%
likeLeft("name", "周") ==> SQL: name like %周

10.inSql
inSql(R column, String inValue)
inSql(boolean condition, R column, String inValue)

例: inSql("id", "select id from table where id < 3") ==> id in (select id from table where id < 3)

更多条件构造请参考:https://mp.baomidou.com/guide/wrapper.html

五、代码生成器

代码生成配置类

//执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
public class CodeGenerator {
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + ":");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "!");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("jobob");
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("密码");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模块名"));
        pc.setParent("com.baomidou.ant");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 , 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化!!
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录,自定义目录用");
                if (fileType == FileType.MAPPER) {
                    // 已经生成 mapper 文件判断存在,不想重新生成返回 false
                    return !new File(filePath).exists();
                }
                // 允许生成模板文件
                return true;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定义输出模板
        //指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
        strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

1.添加依赖

MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖,需要手动添加相关依赖:

添加代码生成器依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.2</version>
</dependency>

Velocity(默认):

<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>
</dependency>

Freemarker:

<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.31</version>
</dependency>

Beetl:

<dependency>
    <groupId>com.ibeetl</groupId>
    <artifactId>beetl</artifactId>
    <version>3.3.2.RELEASE</version>
</dependency>

2.编写配置

配置 GlobalConfig

GlobalConfig globalConfig = new GlobalConfig();
globalConfig.setOutputDir(System.getProperty("user.dir") + "/src/main/java");
globalConfig.setAuthor("jobob");
globalConfig.setOpen(false);

配置 DataSourceConfig

DataSourceConfig dataSourceConfig = new DataSourceConfig();
dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
dataSourceConfig.setDriverName("com.mysql.jdbc.Driver");
dataSourceConfig.setUsername("root");
dataSourceConfig.setPassword("password");

Mybatis-plus

标签:scanner   view   unicode   ons   ids   hid   父类   查询语句   tostring   

原文地址:https://www.cnblogs.com/yzxzpy-1012/p/14659786.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!