mybatis-plus 1 —— 整合 Springboot、代码自动生成

前言

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。本文将其与 Springboot 整合，并演示一些 MP 好用的特性

版本

Springboot：2.3.3.RELEASE
MP：3.4.0

整合示例

先体会一段整合示例，初步了解 MP

依赖

	<dependencies>
        
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starterartifactId>
        dependency>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-testartifactId>
        dependency>
		<dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-jdbcartifactId>
        dependency>
        <dependency>
            <groupId>mysqlgroupId>
            <artifactId>mysql-connector-javaartifactId>
        dependency>

		
        <dependency>
            <groupId>com.baomidougroupId>
            <artifactId>mybatis-plus-boot-starterartifactId>
            <version>3.4.0version>
        dependency>
    dependencies>

	
	<dependency>
	    <groupId>com.baomidougroupId>
	    <artifactId>mybatis-plus-generatorartifactId>
	    <version>3.4.2version>
	dependency>
	
	<dependency>
		<groupId>org.freemarkergroupId>
		<artifactId>freemarkerartifactId>
		<version>2.3.30version>
	dependency>

引入 Springboot 和 MP 依赖

配置文件

# DataSource Config
spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/copy_test?characterEncoding=utf-8
    username: test
    password: test

本地 Mysql 库测试，创建一张 user 表，字段见 实体类

相关类

// 实体类
@Data
public class User {
     
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

// Mapper 接口，继承 BaseMapper
// 不同于传统的 mybatis，不用写任何代码
public interface UserMapper extends BaseMapper<User> {
     

}

// 启动类，指定 MapperScan
@SpringBootApplication
@MapperScan("com.xsn.mapper")
public class Application {
     

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

}

定义 user 表对应的 实体类，创建 UserMapper 类，不用写其他代码

测试

@RunWith(SpringRunner.class)
@SpringBootTest
public class Test1 {
     

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
     
        System.out.println(("----- selectAll method test ------"));
        List<User> userList = userMapper.selectList(null);
        userList.forEach(System.out::println);
    }
}

结果：
User(id=1, name=1, age=1, email=1)
User(id=2, name=2, age=2, email=2)

不用写任何代码，我们就实现了 查询

代码生成

MP 提供了很多好用的特性，比如我们可以通过简单的 配置类，生成对应的实体类、Service 等代码。我们在 MP官网 提供的示例配置类基础上稍加改动，举例生成 user 表相关代码

// 演示例子，执行 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.isNotEmpty(ipt)) {
     
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }

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

        // 全局配置
        GlobalConfig gc = new GlobalConfig();

        // 因为本人搭建的测试过程是多 moudle 的，这个地方手动指定了 具体 moudle
        String projectPath = System.getProperty("user.dir") + "/services/mybatis-plus";

        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("xsn");
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://192.168.137.101:3306/copy_test?characterEncoding=utf-8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("test");
        dsc.setPassword("test");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模块名"));
        pc.setParent("com.xsn");
        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();
    }

}

直接运行 main 方法，生成对应代码到指定模块（包路径）下

生成效果如下

其中包括 controller service mapper 和对应的 Mapper.xml

====================controller=========================

@RestController
@RequestMapping("/test/user")
public class UserController {
     

}

====================service=========================

public interface IUserService extends IService<User> {
     

}
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {
     

}

====================entity=========================

@Data
@EqualsAndHashCode(callSuper = false)
// 自己添加无参构造
@NoArgsConstructor
public class User implements Serializable {
     

    private static final long serialVersionUID = 1L;

	// id 自增，我们也可以指定 INPUT NONE 等
    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;

    private String name;

    private Integer age;

    private String email;

	// 自己添加的构造方法
    public User(String name, Integer age, String email) {
     
        this.name = name;
        this.age = age;
        this.email = email;
    }
}

====================mapper=========================

// 跟我们在 整合示例demo 中声明的一样
public interface UserMapper extends BaseMapper<User> {
     

}

总结

此章节介绍了 MP 和 Springboot 的整合，以及 代码生成 的特性，这可以为我们的开发提供极大的便利。下一章节我们介绍 MP 对 CRUD 的封装，也是 MP 的核心部分

下一篇：mybatis-plus 2 —— CRUD 封装的使用