MyBatis-Plus快速开发

小鱼儿 2024-03-31 12:01 52阅读 0赞

## 1. 代码生成器原理分析 ##

观察我们之前写的代码，会发现其中也会有很多重复内容，比如：

![在这里插入图片描述][a96973a99f47422fb6051b71b3f6b379.png_pic_center]

那我们就想，如果我想做一个Order模块的开发，是不是只需要将内容全部更换成`Order`即可，如：

![在这里插入图片描述][85a9da76c7eb4dc5a8e502f5fafce8a6.png_pic_center]

所以我们会发现，做任何模块的开发，对于这段代码，基本上都是对红色部分的调整，所以我们把去掉红色内容的东西称之为模板，红色部分称之为参数，以后只需要传入不同的参数，就可以根据模板创建出不同模块的dao代码。

除了Dao可以抽取模块，其实我们常见的类都可以进行抽取，只要他们有公共部分即可。再来看下模型类的模板：

![在这里插入图片描述][dfe3989a7f6c4dc3b94cabef7eceb754.png_pic_center]

*  ① 可以根据数据库表的表名来填充
 *  ② 可以根据用户的配置来生成ID生成策略
 *  ③可以根据数据库表字段名称来填充

所以只要我们知道是对哪张表进行代码生成，这些内容我们都可以进行填充。

分析完后，我们会发现，要想完成代码自动生成，我们需要有以下内容：

*  模板：MyBatisPlus提供，可以自己提供，但是麻烦，不建议
 *  数据库相关配置：读取数据库获取表和字段信息
 *  开发者自定义配置：手工配置，比如ID生成策略

## 2. 代码生成器实现 ##

### 步骤1：创建一个Maven项目 ###

![在这里插入图片描述][3d578a1ebd11441e90ae3a76744f8cfc.png_pic_center]

![在这里插入图片描述][1f65e29baf5a4cb9ad4eca1f004e8e5f.png_pic_center]

![在这里插入图片描述][feb8f89283604878ab44be46efb3fa70.png_pic_center]

### 代码2：导入对应的jar包 ###

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    	<modelVersion>4.0.0</modelVersion>
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>2.7.6</version>
    		<relativePath/> 
    	</parent>
    	<groupId>com.dcxuexi</groupId>
    	<artifactId>springboot_mp_05_generator</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<name>springboot_mp_05_generator</name>
    	<description>Demo project for Spring Boot</description>
    	<properties>
    		<java.version>1.8</java.version>
    	</properties>
    	<dependencies>
    		
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    		
    		<dependency>
    			<groupId>com.baomidou</groupId>
    			<artifactId>mybatis-plus-boot-starter</artifactId>
    			<version>3.4.1</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>com.alibaba</groupId>
    			<artifactId>druid</artifactId>
    			<version>1.2.11</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>org.projectlombok</groupId>
    			<artifactId>lombok</artifactId>
    			<version>1.18.24</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>com.baomidou</groupId>
    			<artifactId>mybatis-plus-generator</artifactId>
    			<version>3.4.1</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>org.apache.velocity</groupId>
    			<artifactId>velocity-engine-core</artifactId>
    			<version>2.3</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>com.mysql</groupId>
    			<artifactId>mysql-connector-j</artifactId>
    			<scope>runtime</scope>
    		</dependency>
    		
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</dependency>
    	</dependencies>
    
    	<build>
    		<plugins>
    			<plugin>
    				<groupId>org.springframework.boot</groupId>
    				<artifactId>spring-boot-maven-plugin</artifactId>
    			</plugin>
    		</plugins>
    	</build>
    
    </project>

### 步骤3：编写引导类 ###

@SpringBootApplication
    public class SpringbootMp05GeneratorApplication {
        
    
    	public static void main(String[] args) {
        
    		SpringApplication.run(SpringbootMp05GeneratorApplication.class, args);
    	}
    
    }

### 步骤4：创建代码生成类 ###

package com.dcxuexi;
    
    
    import com.baomidou.mybatisplus.generator.AutoGenerator;
    import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
    import com.baomidou.mybatisplus.generator.config.GlobalConfig;
    import com.baomidou.mybatisplus.generator.config.PackageConfig;
    import com.baomidou.mybatisplus.generator.config.StrategyConfig;
    import com.baomidou.mybatisplus.annotation.IdType;
    /***
     * @Title CodeGenerator
     * @Description TOTD
     * @Auter DongChuang
     * @Date 2022/11/26 16:34
     * @Version 1.0.0
     */
    public class CodeGenerator {
        
        public static void main(String[] args) {
        
            //1.获取代码生成器的对象
            AutoGenerator autoGenerator = new AutoGenerator();
    
            //设置数据库相关配置
            DataSourceConfig dataSourceConfig = new DataSourceConfig();
    
            dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
            dataSourceConfig.setUrl("jdbc:localhost:3306/mybatis");
            dataSourceConfig.setUsername("root");
            dataSourceConfig.setPassword("root");
            autoGenerator.setDataSource(dataSourceConfig);
    
            //设置全局配置
            GlobalConfig globalConfig = new GlobalConfig();
            globalConfig.setOutputDir(System.getProperty("user.dir")+"/springboot_mp_05_generator/src/main/java");    //设置代码生成位置
            globalConfig.setOpen(false);    //设置生成完毕后是否打开生成代码所在的目录
            globalConfig.setAuthor("DongChuang");    //设置作者
            globalConfig.setFileOverride(true);     //设置是否覆盖原始生成的文件
            globalConfig.setMapperName("%sDao");    //设置数据层接口名，%s为占位符，指代模块名称
            globalConfig.setIdType(IdType.AUTO);   //设置Id生成策略
            autoGenerator.setGlobalConfig(globalConfig);
    
            //设置包名相关配置
            PackageConfig packageInfo = new PackageConfig();
            packageInfo.setParent("com.dcxuexi");   //设置生成的包名，与代码所在位置不冲突，二者叠加组成完整路径
            packageInfo.setEntity("domain");    //设置实体类包名
            packageInfo.setMapper("dao");   //设置数据层包名
            autoGenerator.setPackageInfo(packageInfo);
    
            //策略设置
            StrategyConfig strategyConfig = new StrategyConfig();
            strategyConfig.setInclude("platform_user","platform_region","platform_mobile_belong");  //设置当前参与生成的表名，参数为可变参数
            strategyConfig.setTablePrefix("platform_");  //设置数据库表的前缀名称，模块名 = 数据库表名 - 前缀名  例如： User = platform_user - platform_
            strategyConfig.setRestControllerStyle(true);    //设置是否启用Rest风格
            strategyConfig.setVersionFieldName("version");  //设置乐观锁字段名
            strategyConfig.setLogicDeleteFieldName("deleted");  //设置逻辑删除字段名
            strategyConfig.setEntityLombokModel(true);  //设置是否启用lombok
            autoGenerator.setStrategy(strategyConfig);
            //2.执行生成操作
            autoGenerator.execute();
    
    
        }
    }

`mybatis-plus-generator` 依赖的版本为`3.4.1`，使用的旧的代码生成器。官方文档：[代码生成器配置旧][Link 1]

如果依赖的版本是`3.5.1`版本及以上，需要使用新的代码生成器。官方文档：[代码生成器配置新][Link 2]

新的代码生成器代码，如下：

public class CodeGenerator {
        
        public static void main(String[] args) {
        
            FastAutoGenerator.create("jdbc:mysql://localhost:3306/mybatis",
                    "root","root")
                    .globalConfig(builder -> {
        
                        builder.outputDir(System.getProperty("user.dir")+"/springboot_mp_05_generator/src/main/java") //设置代码生成位置  /opt/baomidou/ 默认值: windows:D:// linux or mac : /tmp
                                .author("DongChuang") // 设置作者
                                .fileOverride() // 覆盖已生成文件 默认值:false
                                .commentDate("yyyy-MM-dd"); // 注释日期
                    })
                    .packageConfig(builder -> {
        
                        builder.parent("com.dcxuexi") // 设置父包名
                                .controller("controller")//Controller 包名 默认值:controller
                                .entity("entity")//Entity 包名 默认值:entity
                                .service("service")//Service 包名 默认值:service
                                .mapper("mapper") //Mapper 包名 默认值:mapper
                                .pathInfo(Collections.singletonMap(OutputFile.xml,System.getProperty("user.dir")+ "/springboot_mp_05_generator/src/main/resources/mapper")); // 设置mapper.xml存放路径
                                //默认存放在mapper的xml下
                    })
                    .strategyConfig(builder -> {
        
                        builder.addInclude("platform_user","platform_region","platform_mobile_belong")  //设置当前参与生成的表名，参数为可变参数
                                .addTablePrefix("platform_") // 设置过滤表前缀
                                .serviceBuilder()//service策略配置
                                .formatServiceFileName("%sService")
                                .formatServiceImplFileName("%sServiceImpl")
                                .entityBuilder()// 实体类策略配置
                                .idType(IdType.AUTO)//主键策略  雪花算法自动生成的id
                                // 自动填充配置
                                .enableLombok() //开启lombok
                                .logicDeleteColumnName("deleted")// 说明逻辑删除是哪个字段
                                .versionColumnName("version")// 说明乐观锁是哪个字段
                                .enableTableFieldAnnotation()// 属性加上注解说明
                                .controllerBuilder() //controller 策略配置
                                .formatFileName("%sController")
                                .enableRestStyle() // 开启RestController注解
                                .mapperBuilder()// mapper策略配置
                                .formatMapperFileName("%sMapper")
                                .enableMapperAnnotation()//@mapper注解开启
                                .formatXmlFileName("%sMapper");
                    })
                    .execute();
    
        }
    }

这里将自动生成的xml文件放在了main下的resource目录下，如果没有进行设置，默认存放在mapper的xml目录下。

但是存放在这个目录下的xml文件时不能被解析的需要在yml文件中配置

# mybatis-plus设置
    mybatis-plus:
      mapper-locations: classpath:mapper/*.xml #配置mapper xml文件的路径

### 步骤5：运行程序 ###

运行成功后，会在当前项目中生成很多代码，代码包含`controller`,`service`，`mapper`和`domain`

![在这里插入图片描述][87f6200c7de54bdf8f30554bac2a94c8.png_pic_center]

至此代码生成器就已经完成工作，我们能快速根据数据库表来创建对应的类，简化我们的代码开发。

## 3. MP中Service的CRUD ##

回顾我们之前业务层代码的编写，编写接口和对应的实现类：

public interface UserService{
        
    	
    }
    
    @Service
    public class UserServiceImpl implements UserService{
        
    
    }

接口和实现类有了以后，需要在接口和实现类中声明方法

public interface UserService{
        
    	public List<User> selectInfo(); 
    }
    
    @Service
    public class UserServiceImpl implements UserService{
        
        @Autowired
        private UserDao userDao;
        
    	public List<User> selectInfo(){
        
            return userDao.selectInfo();
        }
    }

MP看到上面的代码以后就说这些方法也是比较固定和通用的，那我来帮你抽取下，所以MP提供了一个Service接口和实现类，分别是：`IService`和`ServiceImpl`，后者是对前者的一个具体实现。

以后我们自己写的Service就可以进行如下修改：

public interface UserService extends IService<User>{
        
    	
    }
    
    @Service
    public class UserServiceImpl extends ServiceImpl<UserDao, User> implements UserService{
        
    
    }

修改以后的好处是，MP已经帮我们把业务层的一些基础的增删改查都已经实现了，可以直接进行使用。

编写测试类进行测试：

@SpringBootTest
    class SpringbootMp05GeneratorApplicationTests {
        
    
    	@Autowired
    	private UserService userService;
    
    	@Test
    	void contextLoads() {
        
    		List<User> userList = userService.selectInfo();
    		userList.forEach(System.out::println);
    	}
    
    }

运行测试方法打印：

![在这里插入图片描述][e67a04fa2eea4a6d812aa3df8e28f9f8.png_pic_center]

## 项目代码 ##

*  [gitee 代码下载][gitee]
 *  [github 代码下载][github]

[a96973a99f47422fb6051b71b3f6b379.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/9384389055944eed837f647e0dfc0ade.png
[85a9da76c7eb4dc5a8e502f5fafce8a6.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/1021e76e7dd2487787b55e6b530ed359.png
[dfe3989a7f6c4dc3b94cabef7eceb754.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/481e3bdefe5f47a2809b11f25ace3155.png
[3d578a1ebd11441e90ae3a76744f8cfc.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/f50eca3580504ef3b2885e0b2516face.png
[1f65e29baf5a4cb9ad4eca1f004e8e5f.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/23f2a3f2abd2443daad25c3543b7d9b2.png
[feb8f89283604878ab44be46efb3fa70.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/e3c0221384094c658b1f6a1202329e58.png
[Link 1]: https://baomidou.com/pages/061573/
[Link 2]: https://baomidou.com/pages/981406/
[87f6200c7de54bdf8f30554bac2a94c8.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/d2c0b406c2204abe8001852ced052ae5.png
[e67a04fa2eea4a6d812aa3df8e28f9f8.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/82eb9b8fde474338a5bf11cb3ab96458.png
[gitee]: https://gitee.com/DchuangDB/SpringBootProject
[github]: https://github.com/dcbut/SpringBootProject