Spring Cloud微服务之Mybatis-Plus代码生成器整合（四）

Spring Boot与Mybatis-Plus整合，以及整合代码生成器

在parent模块中确定依赖的版本

确定依赖的版本

<!--确定依赖的版本-->
<properties>
    <mybatis-plus.version>3.0.5</mybatis-plus.version>
    <velocity.version>2.0</velocity.version>
    <fastjson.version>1.2.28</fastjson.version>
</properties>

锁定依赖的版本

<!--mybatis-plus 持久层-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>${mybatis-plus.version}</version>
</dependency>

<!-- velocity 模板引擎, Mybatis Plus 代码生成器需要 -->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>${velocity.version}</version>
</dependency>

<!--fastjson-->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>${fastjson.version}</version>
</dependency>

在service模块引入父级依赖包，提供给他的子模块service_user使用

<!--mybatis-plus-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
</dependency>

<!-- velocity 模板引擎, Mybatis Plus 代码生成器需要 -->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
</dependency>

<!--fastjson-->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
</dependency>

配置application.properties

加入Mybatis-Plus配置

#配置mapper xml文件的路径
mybatis-plus.mapper-locations=classpath:com/itydf/eduservice/mapper/xml/*.xml
# mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

完整application.properties

# 服务端口
server.port=9901

# 环境设置：dev、test、prod
spring.profiles.active=dev

# mysql数据库连接
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/db_itcloud?useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456

#返回json的全局时间格式
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
spring.jackson.time-zone=GMT+8

#配置mapper xml文件的路径
mybatis-plus.mapper-locations=classpath:com/itydf/eduservice/mapper/xml/*.xml

# mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

在CrmUserApplication启动类中加入mapper扫描

@MapperScan("com.itydf.eduservice.mapper")

使用Mybatis-Plus代码生成器创建controller、service、mapper、entity等基本代码

在test模块测试中创建一个代码生成器类，如下：

/**
 * @author yandongfa
 * @since 2020/5/12
 */
public class CodeGenerator {

    @Test
    public void run() {

        // 1、创建代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 2、全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        //本地项目的绝对路径
        gc.setOutputDir("F:\\SpringBoot_Project\\itydf_parent\\service\\service_user" + "/src/main/java");

        //添加注释
        gc.setAuthor("yandongfa");
        gc.setOpen(false);                  //生成后是否打开资源管理器
        gc.setFileOverride(false);          //重新生成时文件是否覆盖
        //比如默认IUserService去掉I
        gc.setServiceName("%sService");	    //去掉Service接口的首字母I

        gc.setIdType(IdType.ID_WORKER);      //主键策略
        gc.setDateType(DateType.ONLY_DATE);  //定义生成的实体类中日期类型
        gc.setSwagger2(false);                //不开启Swagger2模式

        mpg.setGlobalConfig(gc);

        // 3、数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/db_itcloud?serverTimezone=GMT%2B8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        // 4、包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("eduservice"); //模块名
        //会创建如：com.itydf.eduservice.controller包
        pc.setParent("com.itydf");
        pc.setController("controller");
        pc.setEntity("entity");
        pc.setService("service");
        pc.setMapper("mapper");
        mpg.setPackageInfo(pc);

        // 5、策略配置
        StrategyConfig strategy = new StrategyConfig();
        //表名称修改
        strategy.setInclude("crm_user");

        strategy.setNaming(NamingStrategy.underline_to_camel);//数据库表映射到实体的命名策略
        strategy.setTablePrefix(pc.getModuleName() + "_"); //生成实体时去掉表前缀

        strategy.setColumnNaming(NamingStrategy.underline_to_camel);//数据库表字段映射到实体的命名策略
        strategy.setEntityLombokModel(true); // lombok 模型 @Accessors(chain = true) setter链式操作

        strategy.setRestControllerStyle(true); //restful api风格控制器
        strategy.setControllerMappingHyphenStyle(true); //url中驼峰转连字符

        mpg.setStrategy(strategy);

        // 6、执行
        mpg.execute();
    }
}

先在本地创建一个数据库，新建一张表为crm_user，根据需求，再运行该代码。

创建数据库，创建crm_user表

DROP TABLE IF EXISTS `crm_user`;
CREATE TABLE `crm_user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `userName` varchar(255) DEFAULT NULL,
  `password` varchar(255) DEFAULT NULL,
  `createTime` datetime DEFAULT NULL,
  `updateTime` datetime DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;

INSERT INTO `crm_user` VALUES ('1', 'admin', '123456', '2020-05-12 23:35:27', '2020-05-12 23:35:30');

结果

如下可看到自动生成的结构：

编写CrmUserController.java，测试MySQL连接

Mybatis-Plus代码生成器根据我们配置的规则整合了Mybatis-Plus，直接注入service接口即可使用

@RestController
@RequestMapping("/eduservice/crm-user")
public class CrmUserController {

    //直接注入CrmUserService
    @Autowired
    private CrmUserService crmUserService;

    /***
     * 查询用户所有信息
     * @return
     */
    @GetMapping(value = "list")
    public List<CrmUser> findAll(){
        return crmUserService.list(null);   //无条件，查询所有
    }

}

访问接口测试效果

http://localhost:9901/eduservice/crm-user/list