模块定义

Trantor将模块的定义抽象为了更易于理解的yaml文件。下面将详细解读trantor.yml在不同情况下的各个参数。

制品项目下的模块定义

product:
  key: first_product
  version: 0.0.1-SNAPSHOT
  dependencies:
  - key: base
module:
  key: example_module
  name: example_module
  packageName: io.terminus.trantor.example
  version: 0.0.1-SNAPSHOT
  description: Trantor module example

父标签	属性	类型	必填	解释	备注
-	product	Object	是	模块所属项目	在没有standardProduct标签时候代表制品项目
product	key	String	是	模块所属项目的唯一标识符	可在交付控制台的项目列表查看
product	version	Object	是	模块所属项目的版本	-
product	dependencies	List	否	当前项目依赖的trantor模块	-
product.dependencies	key	String	是	依赖模块的唯一标识符	-
-	module	Object	是	模块	-
module	key	String	是	模块唯一标识符	模块 key 只能由小写字母和下划线组成 ^[a-z][a-z0-9_]{0,63}$
module	name	String	否	模块的名称用于展示	可以为中文，但不能有特殊字符。例如 /r/n
module	packageName	String	是	模块的包路径	package 决定了在扫描 模型、视图、行为 等资源的范围。
module	version	Object	是	模块的版本	此处模块的版本遵循maven的版本规则
module	description	String	否	模块的描述信息	可以为中文，但不能有特殊字符。例如 /r/n

定制项目下的模块定义

product:
  key: trantor
  version: 0.0.0-SNAPSHOT
  dependencies:
  - key: base
standardProduct:
  key: parana
  version: 1.0.0.RELEASE
  dependencies:
  - key: user-center
module:
  key: example_module
  name: example_module
  packageName: io.terminus.trantor.example
  version: 0.0.1-SNAPSHOT
  description: Trantor module example

父标签	属性	类型	必填	解释	备注
-	product	Object	是	模块所属项目	-
product	key	String	是	模块所属项目的唯一标识符	可在交付控制台的项目列表查看
product	version	Object	是	模块所属项目的版本	-
product	dependencies	List	否	当前项目依赖的trantor模块	-
product.dependencies	key	String	是	依赖模块的唯一标识符	-
-	standardProduct	Object	是	定制项目所依赖的制品	-
standardProduct	key	String	-	定制项目所依赖的制品的唯一标识符	-
standardProduct	version	String	-	定制项目所依赖的制品的版本	-
standardProduct	dependencies	List	否	依赖的制品模块	-
standardProduct.dependencies	key	String	是	依赖制品模块的唯一标识符	-
-	module	Object	是	模块	-
module	key	String	是	模块唯一标识符	模块 key 只能由小写字母和下划线组成 ^[a-z][a-z0-9_]{0,63}$
module	name	String	是	模块的名称用于展示	可以为中文，但不能有特殊字符。例如 /r/n
module	packageName	String	是	模块的包路径	package 决定了在扫描 模型、视图、行为 等资源的范围。
module	version	Object	是	模块的版本	此处模块的版本遵循maven的版本规则
module	description	String	是	模块的描述信息	可以为中文，但不能有特殊字符。例如 /r/n