使用 Java 和 Spring Boot 为 Postgres 数据库生成 REST API

wufei123 2025-01-26 阅读:63 评论:0

本教程演示如何使用 monstarillo 为 postgresql 数据库生成 java api。该 api 使用 spring boot 和 springdoc 进行构建和文档记录，并支持对数据库表执行 crud 操作，同时还包含单元测...

本教程演示如何使用 monstarillo 为 postgresql 数据库生成 java api。该 api 使用 spring boot 和 springdoc 进行构建和文档记录，并支持对数据库表执行 crud 操作，同时还包含单元测试。

准备工作：

已安装 Monstarillo。
PostgreSQL 数据库（例如 Chinook 数据库，建议使用 Docker 部署）。
已安装 Java 和 Java IDE（例如 IntelliJ）。
Git。

步骤一：获取模板

克隆包含 Monstarillo 模板的仓库，使用 java-api 文件夹中的模板。

步骤二：设置输出目录

决定生成的代码存放位置。本例中，假设使用 Docker 运行 Monstarillo，并将 ~/shared-volume 目录挂载到容器中。代码将生成在 ~/shared-volume/code-gen-output 目录下 (Monstarillo 会自动创建此目录)。如果在本地运行，请相应调整路径。

步骤三：修改 templates.json 文件

修改 java-api/postgres/templates.json 文件。此文件中的 templates 数组定义了 Monstarillo 运行的模板、文件名和存放位置。tags 数组定义了模板中使用的标签，例如 packagepath、templateroot 和 outputpath。

templateroot: 指向克隆的仓库中 java-api 文件夹的路径 (Docker: /usr/local/monstarillo/shared-templates/java-api；本地: /home/patrick/code/patrick-templates/java-api 请根据实际情况修改)。
outputpath: 指向代码生成目标文件夹的路径 (Docker: /usr/local/monstarillo/code-gen-output/java-01；本地: /home/patrick/code-gen-output/java-01 请根据实际情况修改)。
packagebase: 用于设置包名。
artifactid, groupid: 用于生成的 pom.xml 文件。
applicationclassname: 生成的应用程序主类名。
modelpropertysurrondstring: 用于生成模型类时处理列名 (例如驼峰式命名)。

使用 Java 和 Spring Boot 为 Postgres 数据库生成 REST API

步骤四：运行 Monstarillo

使用以下命令运行 Monstarillo 生成代码 (请替换为您的数据库密码)：

Docker:

PHP

docker run --volume=/mnt/c/code:/usr/local/monstarillo 
--network=host 
monstarillo/monstarillo:latest postgres 
--t /usr/local/monstarillo/shared-templates/java-api/postgres/templates.json  
--u postgres 
--p <your database="" password=""> 
--db "chinhook-db" 
--host "localhost" 
--schema "public"

本地:

PHP

monstarillo postgres 
--t /home/patrick/code/patricks-monstarillo-templates/java-api/templates.json  
--u postgres 
--p <your database="" password=""> 
--db "chinhook-db" 
--host "localhost" 
--schema "public"