SpringBoot项目中MybatisPlus的使用

深藏阁楼爱情的钟 2022-05-13 12:04 323阅读 0赞

## SpringBoot项目中MybatisPlus的使用 ##

本文主要内容：

*  **自动生成代码**
 *  **CURD**

--------------------

**本文在上一篇基础上做修改：**使用IDEA创建一个SpringBoot项目  
[https://blog.csdn.net/litte\_frog/article/details/82666185][https_blog.csdn.net_litte_frog_article_details_82666185]  
使用的是springboot2.0.4版本

#### 一、自动生成代码 ####

目前mp更新到3.0，本文都是参考官网文档  
传送门：[http://mp.baomidou.com/guide/quick-start.html][http_mp.baomidou.com_guide_quick-start.html]

1、添加依赖，在pom文件中添加以下依赖：

<dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.0.1</version>
    </dependency>

2、创建生成代码的类CodeGenerator，根据自己的需求修改配置策略等

public class CodeGenerator { 
    
        /** * <p> * 读取控制台内容 * </p> */
        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.isNotEmpty(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("Auto-CodeGenerator");
            gc.setOpen(false);
            mpg.setGlobalConfig(gc);
    
            // 数据源配置
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setUrl("jdbc:mysql://localhost:3306/frog?useUnicode=true&useSSL=false&characterEncoding=utf8");
            // dsc.setSchemaName("public");
            dsc.setDriverName("com.mysql.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("123456");
            mpg.setDataSource(dsc);
    
            // 包配置
            PackageConfig pc = new PackageConfig();
            //pc.setModuleName(scanner("模块名"));
            pc.setParent("com.frog.mybatisplus");
            mpg.setPackageInfo(pc);
    
            // 自定义配置
            InjectionConfig cfg = new InjectionConfig() {
                @Override
                public void initMap() {
                    // to do nothing
                }
            };
            List<FileOutConfig> focList = new ArrayList<>();
            focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
                @Override
                public String outputFile(TableInfo tableInfo) {
                    // 自定义输入文件名称
                    if (pc.getModuleName() == null) {
                        return projectPath + "/src/main/resources/mapper/"
                                 + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
                    } else {
                        return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                                + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
                    }
                }
            });
            cfg.setFileOutConfigList(focList);
            mpg.setCfg(cfg);
            mpg.setTemplate(new TemplateConfig().setXml(null));
    
            // 策略配置
            StrategyConfig strategy = new StrategyConfig();
            strategy.setNaming(NamingStrategy.underline_to_camel);
            strategy.setColumnNaming(NamingStrategy.underline_to_camel);
            //strategy.setSuperEntityClass("com.baomidou.ant.common.BaseEntity");
            //strategy.setEntityLombokModel(false);
            //strategy.setSuperControllerClass("com.baomidou.ant.common.BaseController");
            strategy.setInclude(scanner("表名"));
            //strategy.setSuperEntityColumns("id");
            strategy.setControllerMappingHyphenStyle(true);
            //strategy.setTablePrefix(pc.getModuleName() + "_");
            mpg.setStrategy(strategy);
            mpg.setTemplateEngine(new FreemarkerTemplateEngine());
            mpg.execute();
        }
    }

3、执行main方法，在控制台输入表名（模块名），执行完毕后查看项目结构  
![这里写图片描述][70]  
项目结构  
![这里写图片描述][70 1]

#### 二、简单的CURD ####

接下来做一个最简单的CURD  
1、在启动类上添加MapperScan注解值为自己mapper类存放的路径，不然启动会报错

@SpringBootApplication
    @MapperScan("com.frog.mybatisplus.mapper")
    public class MybatisPlusApplication { 
    
        public static void main(String[] args) {
            SpringApplication.run(MybatisPlusApplication.class, args);
        }
    }

2、打开生成的Controller写几个测试接口

/** * <p> * 前端控制器 * </p> * * @author Auto-CodeGenerator * @since 2018-09-13 */
    @RestController
    @RequestMapping("/frog-test")
    public class FrogTestController { 
    
        @Autowired
        private IFrogTestService frogTestService;
    
        /** * 查询 * @return */
        @RequestMapping(
                value = "selectAll",
                method = RequestMethod.GET)
        public List<FrogTest> selectList() {
            QueryWrapper<FrogTest> queryWrapper = new QueryWrapper<>();
            queryWrapper.orderByDesc("date");
            return frogTestService.list(queryWrapper);
        }
    
        /** * 添加 * @return */
        @RequestMapping(
                value = "insert",
                method = RequestMethod.POST)
        public Boolean insert(@RequestBody FrogTest entity) {
            return frogTestService.save(entity);
        }
    
    }

将@Controller该为@RestController，因为以接口方式测试：  
3、启动项目并打开PostMan测试  
![这里写图片描述][70 2]  
![这里写图片描述][70 3]  
![这里写图片描述][70 4]  
测试成功  
4、MP的通用CURD方法  
使用代码生成器生成的service都会继承IService这个类，这个类提供很多常用的方法，我们可以直接使用，方便很多。  
![这里写图片描述][70 5]

生成的mapper都继承BaseMapper这个类：  
![这里写图片描述][70 6]

5、自定义sql  
如果我们有业务需要编写复杂的sql，也可以编写自定义sql。首先在mapper类中添加方法：

public interface FrogTestMapper extends BaseMapper<FrogTest> { 
    
        /** * 自定义修改的sql * @param entity * @return */
        Boolean updateMy (FrogTest entity);
    
    }

在xml中编写自定义sql：  
![这里写图片描述][70 7]

<update id="updateMy" parameterType="com.frog.mybatisplus.entity.FrogTest">
           UPDATE frog_test t SET t.state = '1' WHERE t.name = #{name}
    </update>

controller中调用该方法：

@Autowired
        private FrogTestMapper mapper;
    
        /** * 修改：使用自己写的sql * @return */
        @RequestMapping(
                value = "update",
                method = RequestMethod.POST)
        public Boolean update(@RequestBody FrogTest entity) {
            return mapper.updateMy(entity);
        }

测试报错  
![这里写图片描述][70 8]  
根据提示我们需要配置，能扫描到mapper.xml文件，在application.yml文件中增加如下配置：

mybatis-plus:
      mapper-locations: classpath*:mapper/*.xml
      type-aliases-package: com.frog.mybatisplus.entity
      check-config-location: true
      executor-type: simple
      global-config:
          refresh: true

含义分别为：  
**config-location:**  
MyBatis Mapper 所对应的 XML 文件位置，如果您在 Mapper 中有自定义方法（XML 中有自定义实现），需要进行该配置，告诉 Mapper 所对应的 XML 文件位置。  
**type-aliases-package:**  
MyBaits 别名包扫描路径，通过该属性可以给包中的类注册别名，注册后在 Mapper 对应的 XML 文件中可以直接使用类名，而不用使用全限定的类名（即 XML 中调用的时候不用包含包名）。  
**check-config-location:**  
启动时是否检查 MyBatis XML 文件的存在，默认不检查。  
**executor-type:**   
通过该属性可指定 MyBatis 的执行器，MyBatis 的执行器总共有三种：  
ExecutorType.SIMPLE：该执行器类型不做特殊的事情，为每个语句的执行创建一个新的预处理语句（PreparedStatement）  
ExecutorType.REUSE：该执行器类型会复用预处理语句（PreparedStatement）  
ExecutorType.BATCH：该执行器类型会批量执行所有的更新语句  
**refresh:**  
是否自动刷新 Mapper 对应的 XML 文件，默认不自动刷新。如果配置了该属性，Mapper 对应的 XML 文件会自动刷新，更改 XML 文件后，无需再次重启工程，由此节省大量时间。

--------------------

再次启动测试，成功！

[https_blog.csdn.net_litte_frog_article_details_82666185]: https://blog.csdn.net/litte_frog/article/details/82666185
[http_mp.baomidou.com_guide_quick-start.html]: http://mp.baomidou.com/guide/quick-start.html
[70]: /images/20220513/6fd275d41faa4b95826ada816bd21544.png
[70 1]: /images/20220513/3345a93967ca4f36afedc628e65553fd.png
[70 2]: /images/20220513/f02d3e86ed8748f79ef7d801374ad501.png
[70 3]: /images/20220513/0b065c1a82464560be79e72b386b9aa9.png
[70 4]: /images/20220513/478fd3c46c8b425491a2944c3fbacb71.png
[70 5]: /images/20220513/1c483876d6db4855a629aaf0cafb5049.png
[70 6]: /images/20220513/07dfa5a8036c4b21a555ce845144a562.png
[70 7]: /images/20220513/bb2c4ceffa0f43299f596495eac0927c.png
[70 8]: /images/20220513/cedfc36bd594402dacc5e68aae0ab09b.png