引言:
随着微服务架构的流行和分布式系统的发展,Java Spring Boot应用程序变得越来越复杂。开发者经常寻找能够提高效率、减少重复工作的工具,而代码生成器就是其中的佼佼者。今天,我们将探讨ucode-cms-code-spring-boot-starter
,这是一个为Spring Boot项目设计的代码生成工具,旨在为开发者提供快速、可靠的代码生成能力。
一. 介绍
ucode-cms-code-spring-boot-starter
是Java代码生成器2.0的重要组成部分,这个库能够帮助开发者通过自动生成代码的方式,快速搭建起项目的基础结构。它的核心理念是基于模板的代码生成,使得代码生成更加灵活和适应性强。
二. 特点和优势
此代码生成器的特点在于其轻量级的设计以及与Spring Boot框架无缝整合的能力。它不仅能够自动创建标准的MVC代码,还能生成Service、Repository、Entity和DTO等类,大大加速了开发流程。与此同时,由于采用了beta版本标签,这个库还在积极的开发和完善之中,欢迎社区的反馈与贡献。
三. 主要功能
ucode-cms-code-spring-boot-starter
的主要功能包括但不限于:
- 实体类到数据库脚本的自动生成
- 数据访问层(Repository)的自动构建
- 服务层(Service)接口及其实现类的自动生成
- 控制器层(Controller)的模板代码生成
四. 快速开始
①添加依赖:
<dependency>
<groupId>xin.altitude.cms</groupId>
<artifactId>ucode-cms-code-spring-boot-starter</artifactId>
<version>1.6.3.1-beta</version>
</dependency>
关联依赖也要添加,如果有,可以忽略
<dependency>
<groupId>xin.altitude.cms</groupId>
<artifactId>ucode-cms-common</artifactId>
<version>1.6.3.1-beta</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.0</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
②添加配置
#配置数据库连接
spring:
datasource:
username: root
password: root
url: jdbc:mysql://localhost:3306/yu
driver-class-name: com.mysql.jdbc.Driver
ucode:
code:
# project-dir: 项目前缀
package-name: 'com.yu' #包名
③添加启动类
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
启动项目,查看控制台日志,点击链接进入可视化控制台
界面。形如:
========点击(http://localhost:8080/#/gen)进入代码生成器控制台========
④可视化界面
勾选表结构,点击生成,重启项目,相应的代码生效。
⑤查看生成结构
⑥测试功能
五. 高级使用
在完成简单入门体验后,需要了解代码生成的高级部分,即全局配置。在项目中搜索类名CodeProperties
即可查看所有内置可供修改的参数,在全局yml
文件中覆盖默认值即可完成修改,按需配置。
①单表处理
当全局配置ucode.code.joinQuery = false
或者使用默认配置时,则仅处理单表结构。将表名、字段名、字段类型、备注信息转化为SSM风格的源代码。
②多表连接
当在全局配置ucode.code.joinQuery = true
时,则手动开启主外键查询,系统会自动读取表的主外键关系,并将其转化为连接查询的源代码。
②主要参数
参数 | 默认值 | 使用备注 |
---|---|---|
ucode.code.projectDir | 空 | 用户自定义多模块 项目需要指定项目名 |
ucode.code.removeTablePrefix | false | 根据需要是否在生成代码时移除表前缀 |
ucode.code.packageName | xin.altitude.front | 配置用户自己的包名 |
ucode.code.useLombok | true | 默认使用Lombok |
ucode.code.filterSysTable | true | 默认过滤不显示系统表 |
ucode.code.joinQuery | false | 是否使用连接查询(默认单表查询) |
ucode.code.xml.addXml | false | 虽然说不建议使用XML文件编写SQL,但仍提高可开启开关 |
ucode.code.mapper.useCache | true | 默认开启二级缓存,自定义业务缓存可关闭 |
ucode.code.filterSysTable | true | 默认忽略sys 开始的表名 |
注意,如果配置xml文件不生效,请确保版本号不低于1.6.2
。
结论:
ucode-cms-code-spring-boot-starter
是一款功能强大且易于使用的Java代码生成器,能够显著提升开发效率。通过对此工具的深入理解和妥善应用,开发者可以更快地构建出健壮的Spring Boot应用程序,专注于核心业务逻辑的编写。