后端工程生成教程


年初的时候我写了一篇 Spring Boot 接口开发的文章,没有看过的可以先去考古一下:Spring Boot 接口开发

在你熟悉整个开发流程之后,你会发现其实很多模块的代码都是类似的。不同需求以及功能仅仅只是表结构差异而带来的代码不同。

对于后端开发人员而言,如 Dao 层接口、MyBatis 配置文件等等每次都手动的进行配置显然是极其耗时的,而且意义不大。

对于接口设计的真正核心应该是控制层不同接口方法的具体实现逻辑,而底层这些重复的代码更应该通过脚本等方式进行生成,而并非让人工去手动配置。

废话不多说,下面就介绍如何通过 IDEA 插件生成后端底层代码。

1. 项目依赖

生成的代码会用到一些注解,我们提前进行引入,所用到依赖如下:

<!-- mysql相关依赖 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>
<!-- 注意不能同时引用 mybatis 和 mybatis-spring 两个包 -->
<!-- 在兼容上会出现异常导致项目无法启动 -->
<!-- 使用 mybatis-spring-boot-starter 即可-->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.4</version>
</dependency>
<!-- 分页数据会使用 -->
<dependency>
    <groupId>org.springframework.data</groupId>
    <artifactId>spring-data-commons</artifactId>
    <version>2.6.2</version>
</dependency>

2. 插件安装

IDEA 打开 Setting ,在插件市场选择 Easy Code 进行安装。

3. 数据库连接

代码生成的依据是我们的数据表,它会自动根据表结构自动创建实体类,以及 Dao 层、 service 层、 controller 层以及 MyBatis 脚本文件。

因此我们需要先进行数据库连接选择相应的数据表。

IDEA 自带的数据库连接在最右侧,按如下所示进行操作。

填写数据库连接相应配置。

4. 代码生成

右击创建的数据库连接,选择相关的数据库,按回车打开数据库。

右击需要生成代码的表,选择 Generate Code

按照下图所示选择模块。

最终生成的代码样式如下:

5. 项目配置

代码生成之后我们还需要进行进一步配置才能启动项目。

默认生成的 Dao 层,即 Mapper 文件是没有添加 @Mapper 注解的,因此需要在项目启动类手动添加注解声明 Mapper 文件包路径进行扫描。

@MapperScan("xyz.ibudai.dao")
@SpringBootApplication
public class SpringDemoApplication {

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

同时需要在项目配置中添加 MyBatis 脚本文件路径。

mybatis:
  mapper-locations: classpath:mapper/*.xml
  type-aliases-package: xyz.ibudai.entity

至此所有配置步骤都已经完成,接下来启动工程即可。


文章作者: 烽火戏诸诸诸侯
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 烽火戏诸诸诸侯 !
  目录