# 入门
CodeRd使用非常的简单,你可以通过网站在线生成Java实体类、各语言的框架或项目基础工程,也可以通过coderd命令 (opens new window)来快速生成。
# 立即使用
在模版库中挑选一套模版,你可以打开SpringBoot项目生成模版 (opens new window)或Eva权限系统模版 (opens new window)详情页。进入后点击立即生成按钮将打开代码执行器,如下图(以Eva为例)
选择你想要的配置后,点击右上角生成代码(如果提示请选择项目,请自行创建一个项目)。点击生成代码后按钮将被禁用,代码生成完成后将重新启用,并可以通过旁边的下载
按钮下载生成结果。
# 选择模版功能
一套基础工程模版通常会提供框架搭建、接口生成、部署脚步生成等功能,以Eva模版为例,默认情况下模版提供的是后端框架搭建的功能,如果你需要生成其它功能的代码,如接口生成等,可以按下图指示进行。
图中蓝色标记处为功能选择项,选择你需要的功能即可。
# 单表的代码生成
有些模版可以生成接口或页面,这类代码的生成需要依附于数据表,在CodeRd中我们称之为数据模型。以Eva模版的接口生成为例。
打开Eva权限系统模版 (opens new window),选择接口生成,如下图所示:
点击立即生成
按钮打开执行器,根据你的生成需求进行配置,如下图所示
点击数据模型页签
(如数据模型呈现灰色,表示您当前没有选中项目),如下图所示
添加数据模型
勾选你需要使用的数据模型(如没有模型需自行配置)
配置模型字段信息
配置完成后点击生成代码即可。
# 多表的代码生成
有些模版不仅支持单表的接口或页面生成,还能支持多表的生成,在CodeRd中,多表模型称之为关联模型。下面以Eva模版的接口生成功能为例展开说明
打开Eva权限系统模版 (opens new window),选择接口生成并点击立即生成按钮。
在数据模型页签中配置数据模型
添加关联模型
配置关联表
使用关联模型
配置关联表字段信息
到此关联模型及其关联表的字段配置就完成了。
关联模型无法选中
当关联模型无法选中时,说明该模版未支持多表生成的场景。
# 项目与模版的关系
项目是代码生成的上下文,用于记录项目的数据模型,生成配置等。一个项目可以使用多个模版来生成代码,一个模版也可以使用多个项目,两者是一个组合关系。所以在生成代码时需要指定一个项目。如果您使用的是coderd命令,则可以通过coderd use 项目英文名称
来指定默认项目。如不知道您的项目英文名称,可通过coderd project
查看项目列表。
# 使用命令
为了更方便的获取代码,CodeRd提供了同名命令coderd
。详情请阅读使用命令章节。
# 克隆模版
当生成的结果并不是我们想要的结果时,我们可以对模版进行克隆(仅会员用户可执行该操作),然后通过CodeRd IDE
进行调整。为了顺畅的改造代码,你需要阅读自定义模版章节。以Eva的接口生成模版为例,克隆模版如下图所示:
点击蓝色标记处的克隆按钮即可克隆。
无法克隆
有时候克隆按钮无法点击,那是因为作者将当前选中的版本设置为不允许克隆。例如Eva的前后端框架搭建因需要避免用户自行改造,导致接口和页面生成无法按照约定正确执行而禁用克隆。
会员到期后还能继续使用克隆的模版吗?
可以!但为了保护仅会员可用模版的权益,如果您克隆的是会员专属模版版本,则会员到期后您无法继续编辑和使用。(如果可继续使用,会出现克隆一份模版即可终身获取模版使用的权限,这对于模版作者来说是不允许的)。