TerminusHQ / trantor-demo

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Trantor Demo

1. Trantor 应用结构

通常,工程包含两个模块 module-apimodule-servermodule-api 用于申明模型等信息,可供其他工程引用,module-server 包含视图、行为等信息, 可作为服务提供服务。以下是 demo 的代码组织结构:

.
├── README.md
├── demo-api
│   ├── demo-api.iml
│   ├── pom.xml
│   └── src
│       └── main
│           └── java
│               └── io
│                   └── terminus
│                       └── trantor
│                           └── demo
│                               ├── DemoModuleDefinition.java
│                               └── model
│                                   └── User.java
├── demo-server
│   ├── demo-server.iml
│   ├── pom.xml
│   └── src
│       └── main
│           ├── java
│           │   └── io
│           │       └── terminus
│           │           └── trantor
│           │               └── demo
│           │                   ├── DemoApplication.java
│           │                   ├── action
│           │                   │   └── UserChartAction.java
│           │                   ├── controller
│           │                   │   └── HealthCheckController.java
│           │                   ├── dao
│           │                   │   └── UserRepository.java
│           │                   ├── dict
│           │                   │   └── UserRegisterType.java
│           │                   └── serveraction
│           │                       └── UserServerAction.java
│           └── resources
│               ├── application.yml
│               └── trantor
│                   └── resources
│                       └── terminus_trantor_demo
│                           ├── activity-page-user-in-charts.json
│                           ├── user-actions.json
│                           ├── user-custom-actions.json
│                           ├── user-detail-view.xml
│                           ├── user-filter-admin-list-view.xml
│                           ├── user-form-view.xml
│                           ├── user-list-view.xml
│                           ├── user-register-view.xml
│                           └── view-manifest.json
├── demo.iml
├── dice.yml
├── mvnw
├── mvnw.cmd
├── pipeline.yml
└── pom.xml

重点关注内容:

  • 模块元信息定义,见 DemoModuleDefinition.java
  • 视图、行为等定义, 见 src/main/resources/trantor/terminus_trantor_demo 下内容
  • 应用配置信心,见 application.yml

注意: demo-server 下的视图信息都放在 terminus_trantor_demo 目录(即: src/main/resources/trantor/terminus_trantor_demo)下, 目录名称要与 module-api 下 DemoModuleDefinition.java 里定义的 module key 保持一致。

2. 如何运行?

2.1 安装 Docker

2.2 安装 trantor-cli

MacOS 下(确保已安装 HomeBrew):

brew tap TerminusHQ/trantor
brew install trantor

安装完成后,配置 host:

127.0.0.1 trantor.terminus.io

更详细的安装文档见: https://yuque.antfin-inc.com/terminus-trantor/cookbook/cli

2.3 启动 trantor 环境

$trantor run

或指定版本

$trantor run 0.10

2.4 上报信息至 metastore

通过 trantor 提供的 maven plugin(见: demo-server pom.xml), 执行:

$mvn compile -Dtrantor.deploy=true

上报元信息(@TModel, @TAction 等注解类 & resources 下定义的视图文件)至指定 metastore(pom.xml 配置), 这时也会在 metastore 中创建好对应的 数据库表(即 @TModel 注解的类)

2.5 配置应用启动依赖的 trantor 环境

执行:

$trantor env

拷贝环境变量至应用启动配置中

2.6 启动应用程序

2.7 创建应用 & 配置菜单

打开之前通过 trantor cli 运行的 交付控制台(http://trantor.terminus.io:8099),进入 运行态模式->local 环境详情,添加应用,并为应用 配置菜单, 如图:

菜单配置如下图:

配置完成后,打开 trantor cli 运行的 统一工作台(http://trantor.terminus.io:8098), 可看到之前添加的视图,最终效果如下图:

3. 其他

1、dice.yml和pipeline.yml是部署在Dice平台必备的配置文件。若不使用Dice部署,则可以忽略。 2、如果有其他使用上的疑问,请查阅 Trantor 官方文档

About


Languages

Language:Java 100.0%